feat(new-rule): ibm-well-defined-dictionaries - Githubissues

IBM / openapi-validator

Configurable and extensible validator/linter for OpenAPI documents

Apache License 2.0

481 stars 88 forks source link

feat(new-rule): ibm-well-defined-dictionaries #644

Closed dpopp07 closed 7 months ago

dpopp07 commented 7 months ago

PR summary

Adds a rule to ensure that dictionary types are well defined, meaning:

All values in the dictionary must conform to a single type
Schemas are not hybrid model-dictionaries (defining both properties and additional properties)

PR Checklist

General checklist

Please make sure that your PR fulfills the following requirements:

[x] The commit message follows the Angular Commit Message Guidelines.
[x] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been added / updated (for bug fixes / features)
[x] Dependencies have been updated as needed
[x] .secrets.baseline updated as needed?

Checklist for adding a new validation rule:

[x] Added new validation rule definition (packages/ruleset/src/rules/*.js, index.js)
[x] If necessary, added new validation rule implementation (packages/ruleset/src/functions/*.js, updated index.js)
[x] Added new rule to default configuration (packages/ruleset/src/ibm-oas.js)
[x] Added tests for new rule (packages/ruleset/test/*.test.js)
[x] Added docs for new rule (docs/ibm-cloud-rules.md)

ibm-devx-sdk commented 7 months ago

:tada: This PR is included in version 1.15.0 :tada:

The release is available on npm package (@latest dist-tag)

Your semantic-release bot :package::rocket:

ibm-devx-sdk commented 7 months ago

:tada: This PR is included in version 1.16.0 :tada:

The release is available on npm package (@latest dist-tag)

Your semantic-release bot :package::rocket:

ibm-devx-sdk commented 6 months ago

:tada: This PR is included in version 1.3.1 :tada:

The release is available on npm package (@latest dist-tag)

Your semantic-release bot :package::rocket: