openmobilityfoundation / mobility-data-specification

A data standard to enable right-of-way regulation and two-way communication between mobility companies and local governments.
https://www.openmobilityfoundation.org/about-mds/
Other
685 stars 231 forks source link

Policy/Geography response.updated vs. other response.last_updated #842

Closed thekaveman closed 1 year ago

thekaveman commented 1 year ago

Issue

Policy describes its schema with a top-level updated key with its value "a timestamp indicating the last time the data was updated". Geography does the same.

Other APIs like Provider describe Data Latency Requirements and use last_updated in the top-level response to indicate the same thing.

Suggestion

Align on a single field name for all APIs.

schnuerle commented 1 year ago

So you think Policy should use last_updated too? I agree and I think we should make this change. May be ok to do it while finishing the MDS 2.0 release.

cc @jean-populus @S-eb

thekaveman commented 1 year ago

Maybe since Policy and Geography already use updated, Provider is the outlier with last_updated and so we should align Provider to be the same as Policy/Geography?

In any case, as long as we align and use a consistent field name everywhere, the specific choice doesn't matter as much.

schnuerle commented 1 year ago

I think last_updated is the way to go, as we do in CDS now. https://github.com/openmobilityfoundation/curb-data-specification/blob/main/general-information.md#rest-endpoints

marie-x commented 1 year ago

Agree, last_updated everywhere.

thekaveman commented 1 year ago

Done for Geography in the spec in #858 and for Geography OpenAPI in openmobilityfoundation/mds-openapi#21

schnuerle commented 1 year ago

I've updated MDS 2.0 with last_updated across Policy, Geography, Jurisdiction, and Stops (in data types).

Ready to close this issue when @thekaveman does the updates for OpenAPI.

thekaveman commented 1 year ago

Done for Policy OpenAPI in https://github.com/openmobilityfoundation/mds-openapi/pull/20