docs(api): expose OpenAPI (Swagger) specification for OpenCRE REST API #709
+244
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Dependencies / stacking context
chore(ci): enforce Python formatting via pre-commit to prevent recurring CI failures (#707).
Please review #707 before reviewing this PR.
Summary
This PR exposes the OpenCRE OpenAPI (Swagger) specification via a public REST endpoint.
Building on the initial OpenAPI definition added earlier, this change makes the specification available at runtime so that external tools (Swagger UI, SDK generators, Postman, AI agents) can automatically discover and consume the OpenCRE API.
What’s included
GET /rest/v1/openapi.yamldocs/api/openapi.yamlWhy this matters
Exposing the OpenAPI spec enables:
This completes the core requirement of having a formally documented and accessible API surface.
Scope
Related issues
Verification
GET /rest/v1/openapi.yamlsuccessfully returns the OpenAPI specification