Skip to content
This repository was archived by the owner on Jun 6, 2024. It is now read-only.
This repository was archived by the owner on Jun 6, 2024. It is now read-only.

Request argument schema #257

@multimeric

Description

@multimeric

The JSON API spec outlines a few (optional) query parameters for the requests:

  • include, which determines which related resources should be included
  • fields[TYPE] which includes or excludes fields from the response schema
  • sort, which controls sorting the response
  • page, which controls the amount of items per page and the index of the page
  • filter, which filters the response data

Now obviously marsmallow-jsonapi can't handle the logic for all this, but it seems reasonable that this library could supply some validation. The associated Webargs project seems ideal for this.

For example, we could provide an abstract parent schema for GET query parameters, which users can inherit from, which apply some of the JSON API recommendations for these parameters.

Would this be in the scope of this project? I might have time to write a PR for this. But I wanted to sound this out first.

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