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

Sorting for list endpoints #555

Open
m-mohr opened this issue Dec 18, 2024 · 0 comments
Open

Sorting for list endpoints #555

m-mohr opened this issue Dec 18, 2024 · 0 comments
Labels
minor requires a minor-version (x.1.0 for example)

Comments

@m-mohr
Copy link
Member

m-mohr commented Dec 18, 2024

Discussion started here: #550 (comment)

I think we could directly add parameters to the API, we already have it implicitly for the STAC part (through the sort extension) and could simply copy that to the other endpoints. That should be low effort (on the specification side).

We'd probably not define default values (i.e. if not provided it's up to the implementation), but we can recommend defaults.

We have pagination defined for the following endpoints and the following recommendations probably make sense:

  • /collections: id
  • /processes: id
  • /process_graphs: id
  • /services: created (property not required though => nevertheless: creation sequence/time)
  • /jobs created
  • /files path
  • logs (services and jobs): time (property not required though => nevertheless: logging sequence/time)
  • /workspaces: not sure (creation? but there's no corresponding property for it)
  • /orders: order:date

By the way, pagination in the Web Editor is pretty complex and leads to various complexities and potentially confusing behaviour the way it is implemented right now. The "refresh" button should probably be removed.

leave it to clients to fill in the UX gaps (e.g. show alphabetical even if pagination is not like that)

Whenever I tried that, it felt really weird. Especially, if sorted alphabetically, it's completely confusing if you paginate and start from A again on every page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor requires a minor-version (x.1.0 for example)
Projects
None yet
Development

No branches or pull requests

1 participant