Module: Groovestack::Base::GraphQL::Documentation

Defined in:

lib/groovestack/base.rb,
lib/groovestack/base/graphql/documentation/fields.rb,
lib/groovestack/base/graphql/documentation/arguments.rb

Constant Summary

Fields =

rubocop:disable Style/OpenStructUse

OpenStruct.new({
  created_at: 'time of record creation',
  id: 'a unique record identifier',
  relation_count: 'total number of records in a given scope',
  updated_at: 'time of last record update'
})

Arguments =

rubocop:disable Style/OpenStructUse

OpenStruct.new({
  id: 'a unique record identifier',
  page: 'page number of the paginated results',
  per_page: 'number of records per page of the paginated results',
  sort_field: 'field to sort the results by (i.e. created_at)',
  sort_order: 'order with which to sort the results (i.e. ASC, DESC)',
  filter: 'hash of parameters by which to filter the results (i.e. { ids: [1,2,3] })'
})