feat(ibm-required-array-properties-in-response): add new validator rule #684
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
padamstx
commented
Sep 24, 2024
dpopp07
approved these changes
Sep 24, 2024
packages/ruleset/src/rules/required-array-properties-in-response.js
Outdated
Show resolved
Hide resolved
packages/ruleset/src/functions/required-array-properties-in-response.js
Outdated
Show resolved
Hide resolved
packages/ruleset/src/functions/required-array-properties-in-response.js
Outdated
Show resolved
Hide resolved
packages/ruleset/src/functions/required-array-properties-in-response.js
Outdated
Show resolved
Hide resolved
This commit introduces the new 'ibm-required-array-properties-in-response' validator rule, which enforces API Handbook guidance related to array properties defined within response schemas. This rule will look for and warn about any array properties defined as optional within each response body's schema (and any sub-schemas reachable from there). Signed-off-by: Phil Adams <[email protected]>
padamstx
force-pushed
the
new-array-rule
branch
from
ccfa072 to
1460cdd
Compare
ibm-devx-sdk
pushed a commit
that referenced
this pull request
Sep 24, 2024
# @ibm-cloud/openapi-ruleset-utilities [1.4.0](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/[email protected]...@ibm-cloud/[email protected]) (2024-09-24) ### Features * **ibm-required-array-properties-in-response:** add new validator rule ([#684](#684)) ([7cc4be2](7cc4be2))
|
🎉 This PR is included in version 1.4.0 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
ibm-devx-sdk
pushed a commit
that referenced
this pull request
Sep 24, 2024
# @ibm-cloud/openapi-ruleset [1.23.0](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/[email protected]...@ibm-cloud/[email protected]) (2024-09-24) ### Features * **ibm-required-array-properties-in-response:** add new validator rule ([#684](#684)) ([7cc4be2](7cc4be2)) ### Dependencies * **@ibm-cloud/openapi-ruleset-utilities:** upgraded to 1.4.0
|
🎉 This PR is included in version 1.23.0 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
ibm-devx-sdk
pushed a commit
that referenced
this pull request
Sep 24, 2024
# ibm-openapi-validator [1.24.0](https://github.com/IBM/openapi-validator/compare/[email protected]@1.24.0) (2024-09-24) ### Features * **ibm-required-array-properties-in-response:** add new validator rule ([#684](#684)) ([7cc4be2](7cc4be2)) ### Dependencies * **@ibm-cloud/openapi-ruleset:** upgraded to 1.23.0
|
🎉 This PR is included in version 1.24.0 🎉 The release is available on npm package (@latest dist-tag) 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.
PR summary
This commit introduces the new 'ibm-required-array-properties-in-response' validator rule, which enforces API Handbook guidance related to array properties defined within response schemas.
This rule will look for and warn about any array properties defined as optional within each response body's schema (and any sub-schemas reachable from there).
PR Checklist
General checklist
Please make sure that your PR fulfills the following requirements:
Checklist for adding a new validation rule: