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

Change entities REST order to match OData order #1097

Merged
merged 1 commit into from
Mar 6, 2024

Conversation

ktuite
Copy link
Member

@ktuite ktuite commented Mar 5, 2024

Closes getodk/central#582

What has been done to verify that this works as intended?

Tests

Why is this the best possible solution? Were any other approaches considered?

The ../entities REST endpoint was returning entities ordered by entity def id, which doesn't seem very meaningful. That part has been removed and now entities are returned in a stable order that matches the odata endpoint.

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

I hope no one is relying on that other weird order. It wasn't documented.

Does this change require updates to the API documentation? If so, please update docs/api.md as part of this PR.

We could keep not documenting the order here. The odata endpoint has a more explicit and controllable query param for ordering entities.

Before submitting this PR, please make sure you have:

  • run make test and confirmed all checks still pass OR confirm CircleCI build passes
  • verified that any code from external sources are properly credited in comments or that everything is internally sourced

@ktuite ktuite requested a review from matthew-white March 6, 2024 18:49
@ktuite ktuite merged commit 7839e07 into master Mar 6, 2024
5 checks passed
@ktuite ktuite deleted the ktuite/stable-entity-order branch March 6, 2024 19:48
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.

REST endpoint for …/entities does not use a stable order
2 participants