Skip to content

REST API Reference: version OpenAPI specification in the repo#3007

Draft
mnocon wants to merge 3 commits into5.0from
openapi-file
Draft

REST API Reference: version OpenAPI specification in the repo#3007
mnocon wants to merge 3 commits into5.0from
openapi-file

Conversation

@mnocon
Copy link
Contributor

@mnocon mnocon commented Jan 14, 2026

Versioning the API file on GitHub allows us to:

  1. See the latest changes to the file when doing a release, making release notes easier
  2. Makes it easier to plug in into LLMs to reason about Ibexa's API (something I'd like to expand in the future)

Tested in: #3049

REST API Reference: https://ez-systems-developer-documentation--3049.com.readthedocs.build/en/3049/api/rest_api/rest_api_reference/rest_api_reference.html

@github-actions
Copy link

Preview of modified files

Preview of modified Markdown:

@mnocon mnocon changed the title REST API Reference: version OpenAPI specification in YAML format. REST API Reference: version OpenAPI specification in the repo Feb 6, 2026
maxWidth: '76px!important'
maxHeight: '26px'
downloadUrls:
- title: Download as YAML
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These links need to point to the actual files on github - but they don't exist in this PR, only in the autogenerated one

I don't want to merge these changes together yet to make it easier to review.

Doc: https://redocly.com/docs/realm/config/openapi/download-urls

--REQUIRED.-- An absolute URL to the file.

I'm not 100% happy with this, but don't see another solution that will work when we release 6.0

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 6, 2026

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.

1 participant