8000 rewritten to focus more on the intent · masterT/json-api@93660d6 · GitHub
[go: up one dir, main page]

Skip to content

Commit 93660d6

Browse files
authored
rewritten to focus more on the intent
1 parent 01aea64 commit 93660d6

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

_format/1.1/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -319,9 +319,12 @@ The top-level [links object][links] **MAY** contain the following members:
319319
Schema) for the current document.
320320
* [pagination] links for the primary data.
321321

322-
> Note: The `self` link in the top-level `links` object must contain the query parameters provided by the client
323-
> to generate the current response document. This includes but is not limited to
324-
> query parameters used for [inclusion of related resources][fetching resources],
322+
> Note: The `self` link in the top-level `links` object allows a client to
323+
> refresh the data represented by the current response document. The client
324+
> should be able to use the provided link without applying any additional
325+
> information. Therefore the link must contain the query parameters provided
326+
> by the client to generate the response document. This includes but is not
327+
> limited to query parameters used for [inclusion of related resources][fetching resources],
325328
> [sparse fieldsets][fetching sparse fieldsets], [sorting][fetching sorting],
326329
> [pagination][fetching pagination] and [filtering][fetching filtering].
327330

0 commit comments

Comments
 (0)
0