This section is organized by operational domain rather than by raw path dump.
Use these pages together:
Interactive API Surfaces
- Swagger UI:
/docs
- OpenAPI JSON:
/openapi.json
These should remain the source of truth for exact request and response schemas.
Scope Note
The checked-in openapi.json is useful, but on this branch some newer routes have landed in the router code before the exported schema was refreshed. The pages in this section were assembled from both the OpenAPI snapshot and the active route modules under routers/.
Route Families
| Domain | What it covers |
|---|
| Datasets | ingestion, deduplication, CSW search and registration, point queries, thumbnails, cache seeding |
| OGC | WMS/WCS/WFS dispatch, multi-dataset requests, style SLDs, mapcache proxy routes |
| Terrain | terrain tile generation, TileJSON, MBTiles unpacking, mago terrain helpers |
| Jobs | async submission, polling, cleanup, HySpex campaigns, metadata repair |
| Runtime and admin | config, auth, health, root redirect, storage cleanup, cache-layer operations, viewer pages |
How To Use This Section
- Start with the domain page for your workflow.
- Use Swagger UI when you need exact request bodies, query parameters, or live response schemas.
- Use Operator Workflows when you need task-oriented guidance rather than endpoint lookup.
| Route family | Purpose |
|---|
GET /wms/{dataset_id} | dataset WMS |
GET or POST /wms/multi | multi-dataset WMS |
GET /wcs/{dataset_id} | coverage export |
GET /wfs/{dataset_id} | footprint feature access |
Terrain
| Route family | Purpose |
|---|
POST /terrain/{dataset_id}/generate | create terrain tiles |
GET /terrain/{dataset_id}/tilejson.json | TileJSON |
GET /terrain/{dataset_id}/tiles/{z}/{x}/{y}.png | XYZ tile |
POST /terrain/merge | merge datasets |
POST /terrain/mago | Cesium terrain generation |
Jobs
| Route family | Purpose |
|---|
GET /jobs | list jobs |
GET /jobs/{job_id} | inspect job |
POST /jobs/{job_id}/cancel | cancel job |
DELETE /jobs/{job_id} | delete job record |
POST /jobs/hyspex-csw-parent | queue HySpex parent batch |
GET /jobs/hyspex-csw-campaigns/{campaign_id} | aggregate campaign status |
MapCache and Config
| Route family | Purpose |
|---|
GET /config | read effective config |
POST /config | persist config changes |
GET /mapcache/cache/layers | list cache layers |
POST /mapcache/cache/cleanup | cleanup tiles |
POST /mapcache/cache/cleanup-layers | remove whole cache layers |
Auth and Viewer Routes
| Route family | Purpose |
|---|
POST /token and POST /login | issue bearer token |
GET /ui/ | legacy operator frontend |
GET /ui-react/ | React operator frontend |
GET /maplibre/view | browser map viewer |
GET /cesium/* | Cesium test and helper pages |
Suggested Usage Pattern
Use this documentation for platform-level behavior and workflows, and use Swagger UI when you need:
- exact request bodies
- query parameter constraints
- current response schema details
- endpoint-by-endpoint try-it-now validation