Skip to content

submissions/odata: allow filtering by instanceId (__id)#1630

Merged
matthew-white merged 5 commits intogetodk:masterfrom
alxndrsn:odata-filter-id
Oct 19, 2025
Merged

submissions/odata: allow filtering by instanceId (__id)#1630
matthew-white merged 5 commits intogetodk:masterfrom
alxndrsn:odata-filter-id

Conversation

@alxndrsn
Copy link
Contributor

@alxndrsn alxndrsn commented Oct 15, 2025

Closes getodk/central#1401

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

New tests, existing tests.

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

Follows the pattern of other similar code.

Is the __id correct for the filter field's name? Should it be e.g. __system/id?

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?

Adds an extra option for odata filtering of submissions.

Regression risks seem minimal, unless users can create custom fields called __id.

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

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

@alxndrsn alxndrsn marked this pull request as ready for review October 15, 2025 08:37
@github-project-automation github-project-automation bot moved this to 🕒 backlog in ODK Central Oct 15, 2025
@alxndrsn alxndrsn moved this from 🕒 backlog to ✏️ in progress in ODK Central Oct 15, 2025
@alxndrsn alxndrsn changed the title submissions: allow filtering by instanceId (__id) submissions/odata: allow filtering by instanceId (__id) Oct 15, 2025
@matthew-white
Copy link
Member

Just a random aside, but you don't need to add PRs to the project if there's already an issue associated with them. We just add PRs to the project when we want to track the status of the work (for planning or timeline reasons or for release notes), yet there's no associated issue to use.

@matthew-white
Copy link
Member

@alxndrsn, I'm going to go ahead and merge. Hope that's OK! I know you usually prefer to merge your own PRs, but the timeline on mapping-related things is pretty tight, and we need this change on staging by Tuesday.

@matthew-white
Copy link
Member

If any changes need to be made, that could happen in a follow-up PR.

@matthew-white matthew-white merged commit 2261c0a into getodk:master Oct 19, 2025
6 of 7 checks passed
@github-project-automation github-project-automation bot moved this from ✏️ in progress to ✅ done in ODK Central Oct 19, 2025
@alxndrsn alxndrsn deleted the odata-filter-id branch October 21, 2025 06:49
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.

Add ability to filter OData by __id

2 participants