8000 allow relationship paths in query parameter families · roy-coder/json-api@5b3b34d · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 5b3b34d

Browse files
authored
allow relationship paths in query parameter families
1 parent 6
8000
1e0067 commit 5b3b34d

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

_format/1.2/index.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2091,13 +2091,19 @@ family.
20912091

20922092
A "query parameter family" is the set of all query parameters whose name starts
20932093
with a "base name", followed by zero or more instances of empty square brackets
2094-
(i.e. `[]`) or square-bracketed legal [member names]. The family is referred to
2094+
(i.e. `[]`), square-bracketed legal [member names] or square-bracketed
2095+
dot-separated lists of legal member names. The family is referred to
20952096
by its base name.
20962097

20972098
For example, the `filter` query parameter family includes parameters named:
20982099
`filter`, `filter[x]`, `filter[]`, `filter[x][]`, `filter[][]`, `filter[x][y]`,
2099-
etc. However, `filter[_]` is not a valid parameter name in the family, because
2100-
`_` is not a valid [member name][member names].
2100+
`filter[x.y]`, etc. However, `filter[_]` is not a valid parameter name in the
2101+
family, because `_` is not a valid [member name][member names].
2102+
2103+
> Note: Dot separated lists of legal member names are intended to be used for
2104+
> relationship paths. E.g. this allows filtering strategies using relationship
2105+
> paths as defined for [sorting][fetching sorting] in query parameters such as
2106+
> `GET /posts?sort=author.name&filter[author.status]=active`.
21012107
21022108
### <a href="#extension-query-parameters" id="extension-query-parameters" class="headerlink"></a> Extension-Specific Query Parameters
21032109

0 commit comments

Comments
 (0)
0