Skip to content

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)

This PR was used to trigger the API Ref's job - this results in the (autogenerated) PR: https://github.com/ibexa/documentation-developer/pull/new/openapi-together

The full changes are in #3059, to make it possible to preview the final result.

@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
@@ -4,3 +4,8 @@ openapi:
logo:
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

uses: actions/checkout@v4
with:
ref: ${{ steps.version_and_branches.outputs.base_branch }}
ref: openapi-file
Copy link
Contributor Author

@mnocon mnocon Feb 10, 2026

Choose a reason for hiding this comment

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

This one and the one below: TMP Changes that need to be reverted before merge, otherwise the API workflow would not detect my changes

@sonarqubecloud
Copy link

@mnocon mnocon marked this pull request as ready for review February 10, 2026 14:43
@mnocon mnocon requested a review from a team February 10, 2026 14:45
@ibexa-workflow-automation-1 ibexa-workflow-automation-1 bot requested review from adriendupuis, dabrt and julitafalcondusza and removed request for a team February 10, 2026 14:45
@mnocon
Copy link
Contributor Author

mnocon commented Feb 11, 2026

Closing because #3059 was merged

@mnocon mnocon closed this Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants