Skip to content

Clarify exactly which query parameters are reserved #951

@ethanresnick

Description

@ethanresnick

The spec says things like:

The filter query parameter is reserved for filtering data.

and

The page query parameter is reserved for pagination.

But it's pretty clear that we don't (only) mean the literal parameters named page and filter... we also mean parameters like page[offset]. (Moreover, the concept of a named query parameter isn't even in RFC 3986, so we should probably mention that it's actually an idea we're getting from—I think—HTML forms.)

We could fix this issue by just specifying the [...] form, but I wonder if there's an opportunity here to clean up the design a bit (as reserving too many query parameters is a bad idea anyway, and the notion of a query parameter being "reserved but not specified" has never made much sense to me).

For now, though, I just wanted to document the issue. Ref: http://stackoverflow.com/questions/33838358/jsonapi-org-correct-way-to-use-pagination-using-the-page-query-string

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      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