-
Notifications
You must be signed in to change notification settings - Fork 82
REST API Reference: version OpenAPI specification in the repo #3007
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Preview of modified filesPreview of modified Markdown: |
| @@ -4,3 +4,8 @@ openapi: | |||
| logo: | |||
| maxWidth: '76px!important' | |||
| maxHeight: '26px' | |||
| downloadUrls: | |||
| - title: Download as YAML | |||
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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
|
|
Closing because #3059 was merged |



Versioning the API file on GitHub allows us to:
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.