Change entities REST order to match OData order #1097
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
make test
and confirmed all checks still pass OR confirm CircleCI build passes