Skip to content

Conversation

dpopp07
Copy link
Contributor

@dpopp07 dpopp07 commented Sep 17, 2024

The rule only applied to "input" schemas, which are more important to check for the attributes, but the API Handbook recommends the attributes for repsonse schemas as well. This commit expands the rule to check for those scenarios.

PR summary

PR Checklist

General checklist

Please make sure that your PR fulfills the following requirements:

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

Checklist for adding a new validation rule:

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

The rule only applied to "input" schemas, which are more important to check for
the attributes, but the API Handbook recommends the attributes for repsonse
schemas as well. This commit expands the rule to check for those scenarios.

Signed-off-by: Dustin Popp <dpopp07@gmail.com>
@dpopp07 dpopp07 force-pushed the dp/response-string-attributes branch from b0779c5 to 7d8f77f Compare September 17, 2024 17:55
@dpopp07 dpopp07 requested a review from padamstx September 17, 2024 19:15
Copy link
Contributor

@padamstx padamstx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dpopp07 dpopp07 merged commit 9e703ec into main Sep 17, 2024
4 checks passed
@dpopp07 dpopp07 deleted the dp/response-string-attributes branch September 17, 2024 21:09
ibm-devx-sdk pushed a commit that referenced this pull request Sep 17, 2024
## @ibm-cloud/openapi-ruleset [1.21.2](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/openapi-ruleset@1.21.1...@ibm-cloud/openapi-ruleset@1.21.2) (2024-09-17)

### Bug Fixes

* **ibm-string-attributes:** expand rule to apply to response schemas ([#682](#682)) ([9e703ec](9e703ec))
@ibm-devx-sdk
Copy link

🎉 This PR is included in version 1.21.2 🎉

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 17, 2024
## ibm-openapi-validator [1.22.2](https://github.com/IBM/openapi-validator/compare/ibm-openapi-validator@1.22.1...ibm-openapi-validator@1.22.2) (2024-09-17)

### Bug Fixes

* **ibm-string-attributes:** expand rule to apply to response schemas ([#682](#682)) ([9e703ec](9e703ec))

### Dependencies

* **@ibm-cloud/openapi-ruleset:** upgraded to 1.21.2
@ibm-devx-sdk
Copy link

🎉 This PR is included in version 1.22.2 🎉

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

Your semantic-release bot 📦🚀

@ibm-devx-sdk
Copy link

🎉 This PR is included in version 1.4.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
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants