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

api: allow flow segment paging using opaque key #75

Merged
merged 2 commits into from
Jul 29, 2024

Conversation

philipnbbc
Copy link
Contributor

Details

Allow the next page link to include a "page" query parameter that allows the next page to be retrieved. If the TAMS implementations uses the "page" parameter then it will likely leave the "timerange" query parameter unchanged.

Marking this change as a feature rather than a breaking change because clients should be treating the query parameters of a page link as opaque (given that the "page" parameter is opaque and any potential relationship with the other parameters is unknown).

Pivotal Story (if relevant)

Story URL: https://www.pivotaltracker.com/story/show/187930075

Related PRs

Where appropriate. Indicate order to be merged.

Submitter PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • API version has been incremented if necessary
  • ADR status has been updated, and ADR implementation has been recorded
  • Documentation updated (README, etc.)
  • PR added to Pivotal story (if relevant)
  • Follow-up stories added to Pivotal

Reviewer PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • Design makes sense, and fits with our current code base
  • Code is easy to follow
  • PR size is sensible
  • Commit history is sensible and tidy

Info on PRs

The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.

Allow the next page link to include a "page" query parameter that allows
the next page to be retrieved. If the TAMS implementations uses "page"
then it will likely leave the "timerange" query parameter unchanged.

Marking this change as a feature rather than a breaking change because
clients should be treating the query parameters of a page link as opaque.

sem-ver: feature
@philipnbbc philipnbbc requested a review from a team as a code owner July 22, 2024 10:32
@j616 j616 self-assigned this Jul 29, 2024
Copy link
Contributor

@j616 j616 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. As mentioned, we seem to be missing headers on HEAD requests for pages endpoints. I've added a ticket for this.

@philipnbbc philipnbbc merged commit aca34f7 into main Jul 29, 2024
5 checks passed
@philipnbbc philipnbbc deleted the philipn-segments-page-key branch July 29, 2024 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants