feat: enable schema-related rules for AsyncAPI and Arazzo#2183
Merged
feat: enable schema-related rules for AsyncAPI and Arazzo#2183
Conversation
🦋 Changeset detectedLatest commit: 88af5be 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 |
Contributor
|
555b031 to
ff6779d
Compare
JLekawa
reviewed
Jul 21, 2025
JLekawa
approved these changes
Jul 21, 2025
c7f77ab to
426bb84
Compare
| import type { UserContext } from '../../walk.js'; | ||
|
|
||
| export const NoSchemaTypeMismatch: Oas3Rule | Oas2Rule = () => { | ||
| export const NoSchemaTypeMismatch: Oas3Rule | Oas2Rule | Async3Rule | Async2Rule = () => { |
Contributor
There was a problem hiding this comment.
Should there be Arazzo1 as well?
It seems you are using the cast anyway.
'no-schema-type-mismatch': NoSchemaTypeMismatch as Arazzo1Rule,
Collaborator
Author
There was a problem hiding this comment.
You are right. Thanks!
426bb84 to
5f67f54
Compare
DmitryAnansky
approved these changes
Jul 21, 2025
5f67f54 to
88af5be
Compare
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
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?
enabled the no-required-schema-properties-undefined, no-enum-type-mismatch, and no-schema-type-mismatch rules for AsyncAPI and Arazzo (since they also utilize JSON Schema), and adjusted the severities in our recommended and minimal rulesets. Please refer to the table for a comparison.
Reference
Resolves #2128
Internal conversation: https://redoc-ly.slack.com/archives/C02UHE7EL3E/p1752846829965679
Testing
Screenshots (optional)
Check yourself
Security