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

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

Closed
thekaveman opened this issue Apr 23, 2023 · 7 comments
Closed
Labels
Geography Items related to the Geography API Policy Specific to the Policy API question Further information is requested Schema Implications for JSON Schema or OpenAPI
Milestone

Comments

@thekaveman
Copy link
Collaborator

thekaveman commented Apr 23, 2023

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.

@thekaveman thekaveman added the question Further information is requested label Apr 23, 2023
@thekaveman thekaveman changed the title Policy response.updated vs. other response.last_updated Policy/Geography response.updated vs. other response.last_updated Apr 23, 2023
@schnuerle
Copy link
Member

schnuerle commented Apr 24, 2023

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

@schnuerle schnuerle transferred this issue from openmobilityfoundation/mds-openapi Apr 24, 2023
@schnuerle schnuerle added this to the 2.0.0 milestone Apr 24, 2023
@schnuerle schnuerle added State Machine Changes in the vehicle state events and state machine diagram Policy Specific to the Policy API labels Apr 24, 2023
@thekaveman thekaveman added Schema Implications for JSON Schema or OpenAPI Geography Items related to the Geography API and removed State Machine Changes in the vehicle state events and state machine diagram labels Apr 24, 2023
@thekaveman
Copy link
Collaborator Author

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
Copy link
Member

schnuerle commented Apr 24, 2023

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
Copy link
Collaborator

marie-x commented Apr 25, 2023

Agree, last_updated everywhere.

@thekaveman
Copy link
Collaborator Author

thekaveman commented May 2, 2023

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

@schnuerle
Copy link
Member

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
Copy link
Collaborator Author

Done for Policy OpenAPI in openmobilityfoundation/mds-openapi#20

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Geography Items related to the Geography API Policy Specific to the Policy API question Further information is requested Schema Implications for JSON Schema or OpenAPI
Projects
None yet
Development

No branches or pull requests

3 participants