Sha256: c970dbded0f6730ac26f4e7434d93ceb6bf773e1cc8a86c26ffa9566c67de143

Contents?: true

Size: 1.47 KB

Versions: 55

Compression:

Stored size: 1.47 KB

Contents

<%- unless omit_comments? -%>
# Define how to query and persist a given model.
# Further Resource documentation: https://jsonapi-suite.github.io/jsonapi_compliable/JsonapiCompliable/Resource.html
<%- end -%>
<% module_namespacing do -%>
class <%= class_name %>Resource < ApplicationResource
  <%- unless omit_comments? -%>
  # Used for associating this resource with a given input.
  # This should match the 'type' in the corresponding serializer.
  <%- end -%>
  type :<%= type %>
  <%- unless omit_comments? -%>
  # Associate to a Model object so we know how to persist.
  <%- end -%>
  model <%= model_klass %>
  <%- unless omit_comments? -%>
  # Customize your resource here. Some common examples:
  #
  # === Allow ?filter[name] query parameter ===
  # allow_filter :name
  #
  # === Enable total count, when requested ===
  # allow_stat total: [:count]
  #
  # === Allow sideloading/sideposting of relationships ===
  # belongs_to :foo,
  #   foreign_key: :foo_id,
  #   resource: FooResource,
  #   scope: -> { Foo.all }
  #
  # === Custom sorting logic ===
  # sort do |scope, att, dir|
  #   ... code ...
  # end
  #
  # === Change default sort ===
  # default_sort([{ title: :asc }])
  #
  # === Custom pagination logic ===
  # paginate do |scope, current_page, per_page|
  #   ... code ...
  # end
  #
  # === Change default page size ===
  # default_page_size(10)
  #
  # === Change how we resolve the scope ===
  # def resolve(scope)
  #   ... code ...
  # end
  <%- end -%>
end
<% end -%>

Version data entries

55 entries across 55 versions & 1 rubygems

Version Path
jsonapi_compliable-0.11.34 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.33 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.32 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.31 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.30 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.29 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.28 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.27 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.26 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.25 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.24 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.23 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.22 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.21 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.20 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.19 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.18 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.17 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.16 lib/generators/jsonapi/templates/resource.rb.erb
jsonapi_compliable-0.11.15 lib/generators/jsonapi/templates/resource.rb.erb