fix(ibm-well-defined-dictionaries): include patternProperties in validation #713
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
…dation Currently, the rule only considers dictionaries defined with `additionalProperties`. OpenAPI 3.1.x supports defining dictionaries with `patternProperties`, so this commit adds consideration for this field in its validation, in addition to `additionalProperties`. Signed-off-by: Dustin Popp <[email protected]>
dpopp07
force-pushed
the
dp/fix-well-defined-dictionaries
branch
from
43008a9 to
2f2ce01
Compare
padamstx
approved these changes
Jan 10, 2025
| @@ -7328,8 +7328,8 @@ paths: | |||
| This rule validates that any dictionary schemas are well defined and that all values share a single type. | |||
| Dictionaries are defined as object type schemas that have variable key names. They are distinct from model types, | |||
| which are objects with pre-defined properties. A schema must not define both concrete properties and variable key names. | |||
| Practically, this means a schema must explicitly define a `properties` object or an `additionalProperties` schema, but not both. | |||
| If used, the `additionalProperties` schema must define a concrete type. The concrete type of the values must not be a dictionary itself. See the <a href="https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-types">IBM Cloud API Handbook documentation on types</a> for more info. | |||
| Practically, this means a schema must explicitly define a `properties` object or an `(additional|pattern)Properties` schema, but not both. | |||
There was a problem hiding this comment.
I never realized that our API handbook was this opinionated on "properties" vs "additionalProperties" 😂
There was a problem hiding this comment.
It's new-ish guidance 🙂 but good guidance, I think!
ibm-devx-sdk
pushed a commit
that referenced
this pull request
Jan 10, 2025
## @ibm-cloud/openapi-ruleset [1.28.1](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/[email protected]...@ibm-cloud/[email protected]) (2025-01-10) ### Bug Fixes * **ibm-well-defined-dictionaries:** include patternProperties in validation ([#713](#713)) ([ad7134d](ad7134d))
|
🎉 This PR is included in version 1.28.1 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.32.1 🎉 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.
Currently, the rule only considers dictionaries defined with
additionalProperties. OpenAPI 3.1.x supports defining dictionaries withpatternProperties, so this commit adds consideration for this field in its validation, in addition toadditionalProperties.PR summary
PR Checklist
General checklist
Please make sure that your PR fulfills the following requirements:
.secrets.baselinehas been updated as needednpm run generate-utilities-docshas been run if any files inpackages/utilities/srchave been updated