active_model_serializers

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

Ruby

ActiveModel::Serializer implementation and Rails hooks

ActiveModelSerializers::Adapter::JsonApi#success_document

{http://jsonapi.org/format/#document-top-level Primary data}
definition:
  ☐ toplevel_data (required)
  ☐ toplevel_included
  ☑ toplevel_meta
  ☑ toplevel_links
  ☑ toplevel_jsonapi
structure:
 {
   data: toplevel_data,
   included: toplevel_included,
   meta: toplevel_meta,
   links: toplevel_links,
   jsonapi: toplevel_jsonapi
 }.reject! {|_,v| v.nil? }
rubocop:disable Metrics/CyclomaticComplexity

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-success_document-for-pr

# Commit to git

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

# 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-success_document-for-pr

hub pull-request

# Celebrate!