Get swagger document

The OpenAPI document for this instance: the four dataset routes, their query options, and the full column schema of every dataset with business labels.

Request

No parameters and no body.

Response

A standard OpenAPI 3 document. Every column carries its business label as an OpenAPI description.

Notes

Generated from the running build, so it always matches the instance you are talking to.

For schema work prefer GET /odata/v1/$metadata: the CSDL document is the richer of the two, because it also states the key columns and the nullability of every field, and it is what BI and ETL tools read. Use this document when your tooling speaks OpenAPI and nothing else.

Like $metadata, this describes types rather than value sets — a status column appears as a string. What it can contain is in Datasets → Column values.