sanger/sequencescape

View on GitHub
lib/generators/api_v2/templates/app/resources/api/v2/%underscore%_resource.rb.tt

Summary

Maintainability
Test Coverage
# frozen_string_literal: true

module Api
  module V2
    # Provides a JSON API representation of <%= name %>
    # See: http://jsonapi-resources.com/ for JSONAPI::Resource documentation
    class <%= camelcase %>Resource < BaseResource
      # Constants...

      # immutable # uncomment to make the resource immutable

      # model_name / model_hint if required

      default_includes :uuid_object

      # Associations:

      # Attributes
      attribute :uuid, readonly: true

      # Filters

      # Custom methods
      # These shouldn't be used for business logic, and a more about
      # I/O and isolating implementation details.

      # Class method overrides
    end
  end
end