getodk / central

ODK Central is a server that is easy to use, very fast, and stuffed with features that make data collection easier. Contribute and make the world a better place! ✨🗄✨
https://docs.getodk.org/central-intro/
Apache License 2.0
127 stars 155 forks source link

Rename uuid property to id in REST API #679

Closed matthew-white closed 4 months ago

matthew-white commented 4 months ago

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 commented 4 months ago

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.