Skip to content

Add /openapi.yaml endpoint to serve the OpenAPI specification#869

Merged
saswatamcode merged 2 commits intoobservatorium:mainfrom
simonpasquier:bundle-openapi
Jan 28, 2026
Merged

Add /openapi.yaml endpoint to serve the OpenAPI specification#869
saswatamcode merged 2 commits intoobservatorium:mainfrom
simonpasquier:bundle-openapi

Conversation

@simonpasquier
Copy link
Copy Markdown
Contributor

The first commit 0acaf39 moves the current specification to a singe file.
The second commit 947c4d6 adds a new /openapi.yaml endpoint.

This commit bundles the OpenAPI specification into a single file which
makes it possible to be used by online OpenAPI editors.

The YAML file has been generated by the `bundle` command of the Redocly
tool (https://redocly.com/docs/cli).

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
@simonpasquier
Copy link
Copy Markdown
Contributor Author

cc @saswatamcode

squat
squat previously approved these changes Jan 27, 2026
Copy link
Copy Markdown
Member

@squat squat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool!

This commit adds a new `/openapi.yaml` endpoint which serves the current
OpenAPI specification which is read from the static YAML definition
(thanks to the `embed` standard library).

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
@saswatamcode saswatamcode merged commit 9bb1743 into observatorium:main Jan 28, 2026
5 checks passed
@simonpasquier simonpasquier deleted the bundle-openapi branch January 28, 2026 10:24
Copilot AI pushed a commit that referenced this pull request Feb 26, 2026
* change: bundle the OpenAPI spec into a single file

This commit bundles the OpenAPI specification into a single file which
makes it possible to be used by online OpenAPI editors.

The YAML file has been generated by the `bundle` command of the Redocly
tool (https://redocly.com/docs/cli).

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

* feat: add an OpenAPI endpoint

This commit adds a new `/openapi.yaml` endpoint which serves the current
OpenAPI specification which is read from the static YAML definition
(thanks to the `embed` standard library).

Signed-off-by: Simon Pasquier <spasquie@redhat.com>

---------

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants