Skip to content

Commit c93005b

Browse files
bf4bf4
committed
Try to improve readability on github
1 parent 627a628 commit c93005b

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

‎docs/jsonapi/schema.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ Example supported requests
2626
- Relationships
2727
- GET /articles/1/relationships/comments
2828
- GET /articles/1/relationships/author
29-
- Optional: [Inclusion of related resources](http://jsonapi.org/format/#fetching-includes) `ActiveModel::Serializer::Fieldset`
29+
- Optional: [Inclusion of related resources](http://jsonapi.org/format/#fetching-includes) `AM::Serializer::Fieldset`
3030
- GET /articles/1?`include`=comments
3131
- GET /articles/1?`include`=comments.author
3232
- GET /articles/1?`include`=author,comments.author
3333
- GET /articles/1/relationships/comments?`include`=comments.author
34-
- Optional: [Sparse Fieldsets](http://jsonapi.org/format/#fetching-sparse-fieldsets) `ActiveModel::Serializer::Fieldset`
34+
- Optional: [Sparse Fieldsets](http://jsonapi.org/format/#fetching-sparse-fieldsets) `AM::Serializer::Fieldset`
3535
- GET /articles?`include`=author&`fields`[articles]=title,body&`fields`[people]=name
3636
- Optional: [Sorting](http://jsonapi.org/format/#fetching-sorting)
3737
- GET /people?`sort`=age
@@ -55,31 +55,31 @@ Example supported requests
5555
| JSON API object | JSON API properties | Required | ActiveModelSerializers representation |
5656
|-----------------------|----------------------------------------------------------------------------------------------------|----------|---------------------------------------|
5757
| schema | oneOf (success, failure, info) | |
58-
| success | data, included, meta, links, jsonapi | | ActiveModel::SerializableResource
59-
| success.meta | meta | | ActiveModel::Serializer::Adapter::Base#meta
60-
| success.included | UniqueArray(resource) | | ActiveModel::Serializer::Adapter::JsonApi#serializable_hash_for_collection
58+
| success | data, included, meta, links, jsonapi | | AM::SerializableResource
59+
| success.meta | meta | | AM::Serializer::Adapter::Base#meta
60+
| success.included | UniqueArray(resource) | | AM::Serializer::Adapter::JsonApi#serializable_hash_for_collection
6161
| success.data | data | |
62-
| success.links | allOf (links, pagination) | | ActiveModel::Serializer::Adapter::JsonApi#links_for
62+
| success.links | allOf (links, pagination) | | AM::Serializer::Adapter::JsonApi#links_for
6363
| success.jsonapi | jsonapi | |
6464
| failure | errors, meta, jsonapi | errors |
6565
| failure.errors | UniqueArray(error) | | #1004
6666
| meta | Object | |
67-
| data | oneOf (resource, UniqueArray(resource)) | | ActiveModel::Serializer::Adapter::JsonApi#serializable_hash_for_collection,#serializable_hash_for_single_resource
68-
| resource | String(type), String(id),<br>attributes, relationships,<br>links, meta | type, id | ActiveModel::Serializer::Adapter::JsonApi#primary_data_for
67+
| data | oneOf (resource, UniqueArray(resource)) | | AM::Serializer::Adapter::JsonApi#serializable_hash_for_collection,#serializable_hash_for_single_resource
68+
| resource | String(type), String(id),<br>attributes, relationships,<br>links, meta | type, id | AM::Serializer::Adapter::JsonApi#primary_data_for
6969
| links | Uri(self), Link(related) | | #1028, #1246, #1282
7070
| link | oneOf (linkString, linkObject) | |
7171
| link.linkString | Uri | |
7272
| link.linkObject | Uri(href), meta | href |
73-
| attributes | patternProperties(<br>`"^(?!relationships$|links$)\\w[-\\w_]*$"`),<br>any valid JSON | | ActiveModel::Serializer#attributes, ActiveModel::Serializer::Adapter::JsonApi#resource_object_for
74-
| relationships | patternProperties(<br>`"^\\w[-\\w_]*$"`);<br>links, relationships.data, meta | | ActiveModel::Serializer::Adapter::JsonApi#relationships_for
75-
| relationships.data | oneOf (relationshipToOne, relationshipToMany) | | ActiveModel::Serializer::Adapter::JsonApi#resource_identifier_for
73+
| attributes | patternProperties(<br>`"^(?!relationships$|links$)\\w[-\\w_]*$"`),<br>any valid JSON | | AM::Serializer#attributes, AM::Serializer::Adapter::JsonApi#resource_object_for
74+
| relationships | patternProperties(<br>`"^\\w[-\\w_]*$"`);<br>links, relationships.data, meta | | AM::Serializer::Adapter::JsonApi#relationships_for
75+
| relationships.data | oneOf (relationshipToOne, relationshipToMany) | | AM::Serializer::Adapter::JsonApi#resource_identifier_for
7676
| relationshipToOne | anyOf(empty, linkage) | |
7777
| relationshipToMany | UniqueArray(linkage) | |
7878
| empty | null | |
79-
| linkage | String(type), String(id), meta | type, id | ActiveModel::Serializer::Adapter::JsonApi#primary_data_for
80-
| pagination | pageObject(first), pageObject(last),<br>pageObject(prev), pageObject(next) | | ActiveModel::Serializer::Adapter::JsonApi::PaginationLinks#serializable_hash
79+
| linkage | String(type), String(id), meta | type, id | AM::Serializer::Adapter::JsonApi#primary_data_for
80+
| pagination | pageObject(first), pageObject(last),<br>pageObject(prev), pageObject(next) | | AM::Serializer::Adapter::JsonApi::PaginationLinks#serializable_hash
8181
| pagination.pageObject | oneOf(Uri, null) | |
82-
| jsonapi | String(version), meta | | ActiveModel::Serializer::Adapter::JsonApi::ApiObjects::JsonApi
82+
| jsonapi | String(version), meta | | AM::S::Adapter::JsonApi::ApiObjects::JsonApi
8383
| error | String(id), links, String(status),<br>String(code), String(title),<br>String(detail), error.source, meta | |
8484
| error.source | String(pointer), String(parameter) | |
8585
| pointer | [JSON Pointer RFC6901](https://tools.ietf.org/html/rfc6901) | |

0 commit comments

Comments
 (0)