Merge pull request json-api#1604 from jelhan/patch-4

dgeb · web-flow · commit 0ce877de6e95 · 2022-02-04T11:55:30.000-05:00
Clarify query parameters for top-level self link
diff --git a/_format/1.1/index.md b/_format/1.1/index.md
@@ -319,6 +319,15 @@ The top-level [links object][links] **MAY** contain the following members:
   Schema) for the current document.
 * [pagination] links for the primary data.
 
+> Note: The `self` link in the top-level `links` object allows a client to
+> refresh the data represented by the current response document. The client
+> should be able to use the provided link without applying any additional
+> information. Therefore the link must contain the query parameters provided
+> by the client to generate the response document. This includes but is not
+> limited to query parameters used for [inclusion of related resources][fetching resources],
+> [sparse fieldsets][fetching sparse fieldsets], [sorting][fetching sorting],
+> [pagination][fetching pagination] and [filtering][fetching filtering].
+
 The document's "primary data" is a representation of the resource or collection
 of resources targeted by a request.
 
