Skip to content

Commit

Permalink
Demote links->self to MAY status to match previous version
Browse files Browse the repository at this point in the history
  • Loading branch information
rartino authored May 17, 2023
1 parent b0e7405 commit 00f6149
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -632,7 +632,6 @@ The response MAY also return resources related to the primary data in the field:
The :field:`links` field SHOULD include the following links objects:

- **self**: a links object giving the URL from which the response was obtained.
- **describedby**: a links object giving the URL for a schema that describes the response.
The URL SHOULD resolve into a JSON formatted response returning a JSON object with top level :field:`$schema` and/or :field:`$id` fields that can be used by the client to identify the schema format.

Expand All @@ -652,6 +651,10 @@ The response MAY also return resources related to the primary data in the field:
- **last**: the last page of data.
- **first**: the first page of data.

Finally, the :field:`links` field MAY also include the following links object:

- **self**: a links object giving the URL from which the response was obtained.

- **included**: a list of `JSON:API resource objects <http://jsonapi.org/format/1.1/#document-resource-objects>`__ related to the primary data contained in :field:`data`.
Responses that contain related resources under :field:`included` are known as `compound documents <https://jsonapi.org/format/1.1/#document-compound-documents>`__ in the JSON:API.

Expand Down

0 comments on commit 00f6149

Please sign in to comment.