Reference¶

REST API¶

Overview and route reference for the platform REST API:

The Oasis REST API
API

Interactive API reference (OpenAPI)¶

The full Platform v1 / v2 REST APIs, rendered from their OpenAPI schemas:

Platform v2 REST API
Platform v1 REST API

How the schemas are kept current

The OpenAPI schemas are persisted in-repo under _static/schemas/ and rendered here with Redoc (vendored standalone bundle). They are generated from the Django app with drf-spectacular (.github/workflows/build-schema.yml); a CI step should regenerate and commit them on release so they track the code (replacing the manually-committed snapshot). This fixes the previous situation where the schemas existed only as short-lived CI artifacts. Example analysis_settings.json / .xsd are in the repo docs/ folder; the settings schemas themselves are owned by ODS Tools.