|
2 | 2 |
|
3 | 3 | ## JSON API Requests
|
4 | 4 |
|
5 |
| -[Query Parameters Spec](http://jsonapi.org/format/#query-parameters) |
| 5 | +- [Query Parameters Spec](http://jsonapi.org/format/#query-parameters) |
6 | 6 |
|
7 | 7 | Headers:
|
8 | 8 |
|
@@ -65,22 +65,22 @@ Example supported requests
|
65 | 65 | | failure.errors | UniqueArray(error) | | #1004
|
66 | 66 | | meta | Object | |
|
67 | 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), attributes, relationships, links, meta | type, id | ActiveModel::Serializer::Adapter::JsonApi#primary_data_for |
| 68 | +| resource | String(type), String(id),<br>attributes, relationships,<br>links, meta | type, id | ActiveModel::Serializer::Adapter::JsonApi#primary_data_for |
69 | 69 | | links | Uri(self), Link(related) | | #1028, #1246, #1282
|
70 | 70 | | link | oneOf (linkString, linkObject) | |
|
71 | 71 | | link.linkString | Uri | |
|
72 | 72 | | link.linkObject | Uri(href), meta | href |
|
73 |
| -| attributes | patternProperites(`"^(?!relationships$|links$)\\w[-\\w_]*$"`), any valid JSON | | ActiveModel::Serializer#attributes, ActiveModel::Serializer::Adapter::JsonApi#resource_object_for |
74 |
| -| relationships | patternProperites(`"^\\w[-\\w_]*$"`); links, relationships.data, meta | | ActiveModel::Serializer::Adapter::JsonApi#relationships_for |
| 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 | 75 | | relationships.data | oneOf (relationshipToOne, relationshipToMany) | | ActiveModel::Serializer::Adapter::JsonApi#resource_identifier_for
|
76 | 76 | | relationshipToOne | anyOf(empty, linkage) | |
|
77 | 77 | | relationshipToMany | UniqueArray(linkage) | |
|
78 | 78 | | empty | null | |
|
79 | 79 | | linkage | String(type), String(id), meta | type, id | ActiveModel::Serializer::Adapter::JsonApi#primary_data_for
|
80 |
| -| pagination | pageObject(first), pageObject(last), pageObject(prev), pageObject(next) | | ActiveModel::Serializer::Adapter::JsonApi::PaginationLinks#serializable_hash |
| 80 | +| pagination | pageObject(first), pageObject(last),<br>pageObject(prev), pageObject(next) | | ActiveModel::Serializer::Adapter::JsonApi::PaginationLinks#serializable_hash |
81 | 81 | | pagination.pageObject | oneOf(Uri, null) | |
|
82 | 82 | | jsonapi | String(version), meta | | ActiveModel::Serializer::Adapter::JsonApi::ApiObjects::JsonApi
|
83 |
| -| error | String(id), links, String(status), String(code), String(title), String(detail), error.source, meta | | |
| 83 | +| error | String(id), links, String(status),<br>String(code), String(title),<br>String(detail), error.source, meta | | |
84 | 84 | | error.source | String(pointer), String(parameter) | |
|
85 | 85 | | pointer | [JSON Pointer RFC6901](https://tools.ietf.org/html/rfc6901) | |
|
86 | 86 |
|
|
0 commit comments