OpenAPI¶
DMS publishes an OpenAPI schema when API documentation is enabled.
URLs¶
| URL | Tool |
|---|---|
/openapi.json |
OpenAPI schema |
/docs |
Swagger UI |
/redoc |
ReDoc |
Access is controlled by the environment. Do not enable public API documentation in production unless your organization intends to expose it.
Generated schema¶
The repository contains an exported docs/openapi.json. Regenerate it with
scripts/export_openapi.py when the API changes.
Security¶
API documentation can reveal endpoint names, parameters, and models. Protect it with the same network controls as the API itself.