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

Rename uuid property to id in REST API #679

Closed
matthew-white opened this issue Jul 3, 2024 · 1 comment
Closed

Rename uuid property to id in REST API #679

matthew-white opened this issue Jul 3, 2024 · 1 comment
Labels
backend Requires a change to the API server entities Multiple Encounter workflows frontend Requires a change to the UI

Comments

@matthew-white
Copy link
Member

We use different names for the entity UUID in different places:

The goal of this issue is to enhance consistency by replacing uuid in the REST API with id. Maybe we could do so in a way that would be backwards compatible (e.g., returning both id and uuid).

That said, there is some precedent within the REST API of naming the unique identifier something other than id. Submissions are uniquely identified by their instance ID, but the instance ID is named instanceId within the REST API, not id.

@matthew-white
Copy link
Member Author

We discussed this on a call yesterday. Renaming uuid to id in the REST API would be a breaking change, so we've decided not to make this change. Going forward for new features in the future, we'll try to set up more consistency between names in Collect vs. Central.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Requires a change to the API server entities Multiple Encounter workflows frontend Requires a change to the UI
Projects
None yet
Development

No branches or pull requests

1 participant