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.

Sign up for GitHub

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

Jump to bottom

Determine http api pagination method #8391

Closed
SyntaxColoring opened this issue Sep 22, 2021 · 2 comments
Closed

Determine http api pagination method #8391

SyntaxColoring opened this issue Sep 22, 2021 · 2 comments
Labels
protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). spike Unsized research spike ticket

Comments

@SyntaxColoring
Copy link
Contributor

SyntaxColoring commented Sep 22, 2021 •
edited
Loading

  • Take inventory of which HTTP API resources are likely to need pagination
    • "Needs pagination" is itself not well-defined right now, but it probably means something like "is a collection with a potentially unbounded number of elements"
  • Investigate API patterns and figure out which one is most appropriate for us (page-based vs. cursor-based, size-based vs. number-of-resources-based, HATEOAS links vs. other kinds of tokens, ...)
    • If cursor-based, what happens if the resource that the cursor pointed to is deleted?
  • Spike should anticipate future cloud-based APIs as well and determine what, if any, consistency between LAN and Cloud needs to be established

Acceptance criteria

  • Document on confluence listing prescribed first stab at pagination method, circulated and agreed to by stakeholders (AUI, CS).
@SyntaxColoring SyntaxColoring added robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs labels Sep 22, 2021
@SyntaxColoring
Copy link
Contributor Author

Some prior discussion: #8006 (comment)

@mattwelch mattwelch added the spike Unsized research spike ticket label Sep 30, 2021
@mattwelch mattwelch changed the title Paginate the HTTP resources that need it Determine http api pagination method Sep 30, 2021
@mcous
Copy link
Contributor

mcous commented Jun 17, 2022

Closing as complete

@mcous mcous closed this as completed Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). spike Unsized research spike ticket
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mattwelch @mcous @SyntaxColoring