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

Improve REST API docs #850

Closed
lastalfriday opened this issue Apr 26, 2023 · 2 comments
Closed

Improve REST API docs #850

lastalfriday opened this issue Apr 26, 2023 · 2 comments
Labels
Schema Implications for JSON Schema or OpenAPI
Milestone

Comments

@lastalfriday
Copy link

lastalfriday commented Apr 26, 2023

https://github.com/openmobilityfoundation/mobility-data-specification/blob/2.0.0-rc1/agency/README.md#vehicles

You should consider making the docs a bit more clear here.
What we actually have on /vehicles is 3 endpoints

  1. GET /vehicles
  2. GET /vehicles/{vehicle uuid}
  3. POST /vehicles
  • 1 and 2 should each have a seperate doc point.
  • 1 and 2 should be GET and not really POST endpoints?
  • 1 returns an array and 2 returns an object? This is unclear from the docs
  • 3 should strickly return 201 status code

This might also count for other places, I just started implementing the 2.0 specs, and I seem to recall these confusing things when implementing 1.0 as well

image

@thekaveman thekaveman added the Schema Implications for JSON Schema or OpenAPI label Apr 26, 2023
@thekaveman thekaveman added this to the 2.0.0 milestone Apr 26, 2023
@thekaveman
Copy link
Collaborator

This will all be described in OpenAPI 3.1 -- See #832 and openmobilityfoundation/mds-openapi for more details.

@lastalfriday
Copy link
Author

Ah, right, much better. Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Schema Implications for JSON Schema or OpenAPI
Projects
None yet
Development

No branches or pull requests

2 participants