Skip to content

Commit ce9b2fd

Browse files
committed
Updates language related to the media-type of the reports endpoint.
1 parent 5bd0f3b commit ce9b2fd

2 files changed

Lines changed: 2 additions & 1 deletion

File tree

general-information.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ The list of allowed `vehicle_type` values in MDS. Aligning with [GBFS vehicle ty
351351

352352
MDS APIs must handle requests for specific versions of the specification from clients.
353353

354-
Versioning must be implemented through the use of a custom media-type, `application/vnd.mds+json`, combined with a required `version` parameter.
354+
Versioning must be implemented through the use of a custom media-type, `application/vnd.mds+json`, combined with a required `version` parameter. The one exception is the `/reports` endpoint, which returns CSV files instead of JSON, and so uses `application/vnd.mds+csv` as its media-type. (`csv` is not a [standard media-type suffix](https://www.iana.org/assignments/media-type-structured-suffix/media-type-structured-suffix.xml), but we consider this the least confusing option.)
355355

356356
The version parameter specifies the dot-separated combination of major and minor versions from a published version of the specification. For example, the media-type for version `1.0.1` would be specified as `application/vnd.mds+json;version=1.0`
357357

provider/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,7 @@ The authenticated reports are monthly, historic flat files that may be pre-gener
359359
**Endpoint:** `/reports`
360360
**Method:** `GET`
361361
**[Beta feature][beta]:** Yes (as of 1.1.0). [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/672)
362+
**Usage note:** This endpoint uses media-type `application/vnd.mds+csv` instead of `application/vnd.mds+json`, see [Versioning][versioning].
362363
**Schema:** TBD when out of beta
363364
**`data` Filename:** monthly file named by year and month, e.g. `/reports/YYYY-MM.csv`
364365
**`data` Payload:** monthly CSV files with the following structure:

0 commit comments

Comments
 (0)