Add support for jsonapi top level member #1147
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
beauby
force-pushed
the
add-top-level-jsonapi
branch
2 times, most recently
from
2f40b25 to
336972d
Compare
beauby
force-pushed
the
add-top-level-jsonapi
branch
5 times, most recently
from
47509d8 to
c3c992c
Compare
| @@ -9,3 +9,5 @@ The following configuration options can be set on `ActiveModel::Serializer.confi | |||
| ## JSON API | |||
|
|
|||
| - `jsonapi_resource_type`: Whether the `type` attributes of resources should be singular or plural. Possible values: `:singular, :plural`. Default: `:plural`. | |||
| - `jsonapi_toplevel_member`: Whether to include a [top level JSON API member](http://jsonapi.org/format/#document-jsonapi-object) in the response document. Default: `false`. | |||
| - `jsonapi_version`: The latest version of the spec the API conforms to. Used when `jsonapi_toplevel_member` is `true`. Default: `'1.0'`. | |||
|
This is cool, I'm not sure about the adapter options, feels like edge cases for me that might add complexity to maintain. |
|
Hmm namespacing config options... I remember someone very wise mentioning that in #1097 :p |
|
So lets remove the adapter options? So can add it if someone supports/needs it 😁 |
beauby
force-pushed
the
add-top-level-jsonapi
branch
2 times, most recently
from
9b8716b to
1a167f8
Compare
beauby
force-pushed
the
add-top-level-jsonapi
branch
from
1a167f8 to
8ab4c4a
Compare
|
Done 👍 |
|
I'm good with this. 👍 |
| end | ||
|
|
||
| def test_toplevel_jsonapi_meta | ||
| with_adapter :json_api do |
There was a problem hiding this comment.
no need for with_adapter. Just pass in adapter: :json_api
| @@ -8,6 +8,8 @@ module Configuration | |||
| base.config.array_serializer = ActiveModel::Serializer::ArraySerializer | |||
| base.config.adapter = :flatten_json | |||
| base.config.jsonapi_resource_type = :plural | |||
| base.config.jsonapi_toplevel_member = false | |||
| base.config.jsonapi_version = '1.0' | |||
There was a problem hiding this comment.
should be in the JsonApi adapter IMHO
There was a problem hiding this comment.
Yeah, that makes sense.
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 16, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 16, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 16, 2015
|
Alternative implementation at #1050 which was rebased to include this work |
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 16, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 18, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 18, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 18, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 18, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 18, 2015
|
needs rebase :-( |
|
Closing in favor of #1050. |
bf4
added a commit
to beauby/active_model_serializers
that referenced
this pull request
Sep 21, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 21, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 21, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 21, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 21, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 21, 2015
bf4
added a commit
to bf4/active_model_serializers
that referenced
this pull request
Sep 21, 2015
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
C.f. http://jsonapi.org/format/#document-top-level
Supports :
jsonapi_toplevel_member, that decides whether a top leveljsonapimember will be included in each serialized resource, which defaults tofalse,jsonapi_version, which defaults to1.0,jsonapi_toplevel_meta.This PR is based on #1121 for convenience.