Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ibm-no-required-properties-in-optional-body): introduced new rule #683

Merged
merged 2 commits into from
Sep 19, 2024

Conversation

padamstx
Copy link
Member

@padamstx padamstx commented Sep 17, 2024

PR summary

This commit introduces the new "ibm-no-required-properties-in-optional-body" validation rule, and deprecates the "ibm-no-optional-properties-in-required-body" rule. Essentially, we're just changing the rule id, but we are providing backward compatibility by retaining (but deprecating) the old rule id.

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)

@padamstx padamstx self-assigned this Sep 17, 2024
This commit introduces the new "ibm-no-required-properties-
in-optional-body" validation rule, and deprecates the
"ibm-no-optional-properties-in-required-body" rule.
Essentially, we're just changing the rule id, but we are
providing backward compatibility by retaining (but deprecating)
the old rule id.

Signed-off-by: Phil Adams <phil_adams@us.ibm.com>
Copy link
Member

@dpopp07 dpopp07 left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

Though, for commit messages for new rules I've been using the format new-rule: <rule id>. I hadn't really payed attention to the fact that we used different formats until now 🙂 Perhaps we should make those consistent

@padamstx padamstx merged commit 7dd1553 into main Sep 19, 2024
4 checks passed
@padamstx padamstx deleted the issue-3987 branch September 19, 2024 18:22
ibm-devx-sdk pushed a commit that referenced this pull request Sep 19, 2024
# @ibm-cloud/openapi-ruleset [1.22.0](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/openapi-ruleset@1.21.2...@ibm-cloud/openapi-ruleset@1.22.0) (2024-09-19)

### Features

* **ibm-no-required-properties-in-optional-body:** introduced new rule ([#683](#683)) ([7dd1553](7dd1553))
@ibm-devx-sdk
Copy link

🎉 This PR is included in version 1.22.0 🎉

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.23.0 🎉

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