MobilityData / mobility-feed-api

Apache License 2.0
9 stars 3 forks source link

Swagger documentation changes #284

Closed emmambd closed 9 months ago

emmambd commented 9 months ago
jcpitre commented 9 months ago

mobilitydatabase.org/terms-and-conditions gives a 404 error

jcpitre commented 9 months ago

The same examples are used for gtfs_feeds and gtfs_rt_feeds queries, but they can't both return valid data with the same producer_url for example. We will need to duplicate some of the parameter specifications in the yaml file so they go with gtfs_feeds or gtfs_rt_feeds

emmambd commented 9 months ago

@jcpitre It 404s because the page doesn't exist yet since we haven't done the redirect. Currently is https://beta.mobilitydatabase.org/terms-and-conditions

emmambd commented 9 months ago

@jcpitre Some suggestions of examples for the different endpoints now that I can test (no 500 error). Aiming for geographic diversity here:

/v1/feeds:

producer_url: https://exo.quebec/ provider: Exo

v1/feeds/{id}:

mdb-1921

v1/gtfs-feeds:

mdb-1984 with its associated fields

v1/gtfs-feeds/{id}:

mdb-1089

/v1/gtfs-rt-feeds:

provider: Tri Delta Transit producer_url: https://api.511.org entity_types: vp, sa, tu

/v1/gtfs-feeds/datasets

(whatever GTFS feed in the database has several dataset downloads)

v1/datasets/gtfs/{id}

a dataset from the feed in /v1/gtfs-feeds/datasets