docs: add Overlay linting guides #2470
Open
+480
−0
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
🦋 Changeset detectedLatest commit: 6ced875 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 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 |
jeremyfiel
force-pushed
the
feat/overlay-linting-guides
branch
from
a9fc155 to
6ced875
Compare
2 tasks
tatomyr
changed the title
adamaltman
reviewed
Dec 19, 2025
|
|
||
| The default setting for this rule (in the `recommended` and `minimal` configuration) is `error`. | ||
|
|
||
| This is an essential rule. Do not turned it off, except in rare and special cases. |
Member
There was a problem hiding this comment.
Suggested change
| This is an essential rule. Do not turned it off, except in rare and special cases. | |
| This is an essential rule. Do not turn it off, except in rare and special cases. |
Member
|
Is there overlay bundling here (a decorator) too? |
Contributor
Author
|
Don't believe bundling is implemented. I copied this content from the arazzo version so I'll make those updates to the text too |
JLekawa
reviewed
Dec 22, 2025
| "@redocly/openapi-core": patch | ||
| --- | ||
|
|
||
| Add Overlay linting guides. |
Contributor
There was a problem hiding this comment.
Suggested change
| Add Overlay linting guides. | |
| Added a linting guides for OpenAPI Overlay. |
|
|
||
| The default setting for this rule (in the `recommended` and `minimal` configuration) is `error`. | ||
|
|
||
| This is an essential rule. Do not turned it off, except in rare and special cases. |
Contributor
There was a problem hiding this comment.
Suggested change
| This is an essential rule. Do not turned it off, except in rare and special cases. | |
| This is an essential rule. Do not turn it off, except in rare and special cases. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
updates #1830
What/Why/How?
Add Overlay linting guides
Reference
Testing
Needs a screenshot from github actions. i don't use them so don't know how to create one. Can you please add one?
Screenshots (optional)
Check yourself
Security