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

Expose action with entity #755

Merged
merged 2 commits into from Apr 4, 2024
Merged

Expose action with entity #755

merged 2 commits into from Apr 4, 2024

Conversation

seadowg
Copy link
Member

@seadowg seadowg commented Apr 3, 2024

Work for getodk/collect#6031

This will allow a client to determine that an exposed entity is an update and handle edge cases around that (like the one described in the attached issue).

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

Updated tests.

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

This is quite a simple change. I considered also removing the versioning logic from JavaRosa now that clients will have access to the action and theoretically could handle it for themselves. However, I wanted to keep the entity exposed as simple to deal with as possible - an UPDATE is communicating "update the entity with this id to this version with this label and properties".

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?

Shouldn't change anything on client side as the change is purely additive.

@seadowg seadowg marked this pull request as ready for review April 3, 2024 12:35
@seadowg seadowg requested a review from lognaturel April 3, 2024 12:36
Copy link
Member

@lognaturel lognaturel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’ll let you merge in case you want to update wording first!

@seadowg seadowg merged commit 5ae6894 into getodk:master Apr 4, 2024
3 checks passed
@seadowg seadowg deleted the entity-actions branch April 4, 2024 09:29
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.

None yet

2 participants