feat(TU-26042): switch redocly bundle to yaml format #185
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this allows support for openapi specs that use circular references (such as forms-api's Fields property)
|
🥷 Code experts: no user matched threshold 10 See details
Knowledge based on git-blame: To learn more about /:\ gitStream - Visit our Docs |
seborama
changed the title
rdumont
approved these changes
Jun 5, 2025
|
🎉 This PR is included in version 1.31.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This allows support for openapi specs that use circular references (such as forms-api's Fields property).
redoclydoes not have the ability to control circular references when bundling the spec in JSON format.api-docs's CI using a transformation to resolve this problem.However, repos that reference the published components, that are generated by api-docs, will still be faced with the circular reference (e.g. https://typeform.design/api-docs/schema/Field.yaml).
api-docs's CI is solely responsible for generating the "official"openapi.jsonspec bundle. It downloads all theopenapi.yamlfiles from the other API repos and bundles them with the common models defined inapi-docs.The
validate-openapistep of theci-standard-checksaction exists as an early detection of potential spec bundling issues thatapi-docs's CI could face. It is solely a check. While this PR changes the output format to YAML will not affect the CI executed byapi-docs, not will it change its JSON format.