active_model_serializers

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

Ruby

ActiveModel::Serializer implementation and Rails hooks

ActiveModelSerializers::Adapter::JsonApi#failure_document

{http://jsonapi.org/format/#errors JSON API Errors}
TODO: look into caching
definition:
  ☑ toplevel_errors array (required)
  ☐ toplevel_meta
  ☐ toplevel_jsonapi
structure:
  {
    errors: toplevel_errors,
    meta: toplevel_meta,
    jsonapi: toplevel_jsonapi
  }.reject! {|_,v| v.nil? }
prs:
 https://github.com/rails-api/active_model_serializers/pull/1004

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

# Commit to git

git add lib/active_model_serializers/adapter/json_api.rbgit commit -m "better docs for ActiveModelSerializers::Adapter::JsonApi#failure_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-failure_document-for-pr

hub pull-request

# Celebrate!