Skip to content
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

Clarify no pagination on static provider endpoints /trips and /status_changes #424

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
5 changes: 4 additions & 1 deletion provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,10 @@ MDS defines [JSON Schema](https://json-schema.org/) files for [`trips`][trips-sc

### Pagination

`provider` APIs may decide to paginate the data payload. If so, pagination must comply with the [JSON API](http://jsonapi.org/format/#fetching-pagination) specification.
The `/trips` and `/status_changes` APIs should not use pagination.
If providers choose to use pagination for the `/events` endpoint the pagination
must comply with the [JSON API](http://jsonapi.org/format/#fetching-pagination)
specification.

The following keys must be used for pagination links:

Expand Down