8000 Order extension query parameter name rules first. · roy-coder/json-api@cf47c68 · GitHub
[go: up one dir, main page]

Skip to content
65FC

Commit cf47c68

Browse files
committed
Order extension query parameter name rules first.
In addition, be specific about the query parameter name following the colon.
1 parent 578aad7 commit cf47c68

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

_format/1.1/index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2091,6 +2091,13 @@ For example, the `filter` query parameter family includes parameters named:
20912091
etc. However, `filter[_]` is not a valid parameter name in the family, because
20922092
`_` is not a valid [member name][member names].
20932093

2094+
### <a href="#extension-query-parameters" id="extension-query-parameters" class="headerlink"></a> Extension-Specific Query Parameters
2095+
2096+
The base name of every query parameter introduced by an extension **MUST** be
2097+
prefixed with the extension's namespace followed by a colon (`:`). The
2098+
remainder of the base name **MUST** contain only the characters \[a-z\] (U+0061
2099+
to U+007A, "a-z").
2100+
20942101
### <a href="#query-parameters-custom" id="query-parameters-custom" class="headerlink"></a> Implementation-Specific Query Parameters
20952102

20962103
Implementations **MAY** support custom query parameters. However, the names of
@@ -2109,12 +2116,6 @@ parameter from this specification, it **MUST** return `400 Bad Request`.
21092116
> \[a-z\], JSON:API is reserving the ability to standardize additional query
21102117
> parameters later without conflicting with existing implementations.
21112118
2112-
### <a href="#extension-query-parameters" id="extension-query-parameters" class="headerlink"></a> Extension-Specific Query Parameters
2113-
2114-
Extensions **MAY** define custom query parameters. The name of every new query
2115-
parameter introduced by an extension **MUST** be prefixed with the extension's
2116-
namespace followed by a colon (`:`).
2117-
21182119
## <a href="#errors" id="errors" class="headerlink"></a> Errors
21192120

21202121
### <a href="#errors-processing" id="errors-processing" class="headerlink"></a> Processing Errors

0 commit comments

Comments
 (0)
0