Skip to content

allow relationship paths in query parameter families #1692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
allow relationship paths in query parameter families
  • Loading branch information
jelhan authored Apr 21, 2023
commit 5b3b34d97fefcd78509ec7c456f12d718e8f75d2
12 changes: 9 additions & 3 deletions _format/1.2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2091,13 +2091,19 @@ family.

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

For example, the `filter` query parameter family includes parameters named:
`filter`, `filter[x]`, `filter[]`, `filter[x][]`, `filter[][]`, `filter[x][y]`,
etc. However, `filter[_]` is not a valid parameter name in the family, because
`_` is not a valid [member name][member names].
`filter[x.y]`, etc. However, `filter[_]` is not a valid parameter name in the
family, because `_` is not a valid [member name][member names].

> Note: Dot separated lists of legal member names are intended to be used for
> relationship paths. E.g. this allows filtering strategies using relationship
> paths as defined for [sorting][fetching sorting] in query parameters such as
> `GET /posts?sort=author.name&filter[author.status]=active`.

### <a href="#extension-query-parameters" id="extension-query-parameters" class="headerlink"></a> Extension-Specific Query Parameters

Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy