active_model_serializers

https://github.com/rails-api/active_model_serializers

Ruby

ActiveModel::Serializer implementation and Rails hooks

ActiveModelSerializers::Adapter::JsonApi#pagination_links_for

{http://jsonapi.org/format/#fetching-pagination Pagination Links}
pagination
definition:
  first : pageObject
  last  : pageObject
  prev  : pageObject
  next  : pageObject
structure:
  {
    first: pageObject,
    last: pageObject,
    prev: pageObject,
    next: pageObject
  }

pageObject
definition:
  oneOf
    URI
    null

description:
  The <x> page of data
structure:
  if has_page?
    'http://example.com/some-page?page[number][x]'
  else
    nil
  end
prs:
  https://github.com/rails-api/active_model_serializers/pull/1041

Source | Google | Stack overflow

Edit

git clone [email protected]:rails-api/active_model_serializers.git

cd active_model_serializers

open lib/active_model_serializers/adapter/json_api.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-ActiveModelSerializers--Adapter--JsonApi-pagination_links_for-for-pr

# Commit to git

git add lib/active_model_serializers/adapter/json_api.rbgit commit -m "better docs for ActiveModelSerializers::Adapter::JsonApi#pagination_links_for"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-ActiveModelSerializers--Adapter--JsonApi-pagination_links_for-for-pr

hub pull-request

# Celebrate!