chore: do not override theme.openapi with ConfigReferenceDocs node type #1495
+12
−73
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: c072ac7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Coverage report
Show files with reduced coverage 🔻
Test suite run success738 tests passing in 102 suites. Report generated by 🧪jest coverage report action from c072ac7 |
tatomyr
force-pushed
the
chore/do-not-override-theme-openapi-with-config-reference-docs-type
branch
from
fc37b3d
to
fd30e15
Compare
tatomyr
commented
May 31, 2024
| @@ -0,0 +1,6 @@ | |||
| --- | |||
There was a problem hiding this comment.
Added the changeset to let users know that something has changed in the config validation.
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.
What/Why/How?
Getting rid of overwriting
theme.openapiwith theConfigReferenceDocsnode type as it's going to come from the Redocly config package soon.Essentially, it removes the Reference Docs highlighting in redocly.yaml's
theme.openapi(for the time being it will allow any fields there; after releasing these changes to the Redocly config package it will be restricted to the new syntax).The validation still be present inside the deprecated
features.openapifield though.Reference
Related changes in the Redocly config package: https://github.com/Redocly/redocly/pull/8628
Testing
Screenshots (optional)
Check yourself
Security