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
676 stars 232 forks source link

Improve REST API docs #850

Closed lastalfriday closed 1 year ago

lastalfriday commented 1 year ago

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

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 commented 1 year ago

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

lastalfriday commented 1 year ago

Ah, right, much better. Thank you