Skip to content

Comments

feat(ibm-redirect-response-body): introduce new validation rule#758

Merged
diatrcz merged 12 commits intomainfrom
lt/add-redirect-rule
Sep 23, 2025
Merged

feat(ibm-redirect-response-body): introduce new validation rule#758
diatrcz merged 12 commits intomainfrom
lt/add-redirect-rule

Conversation

@diatrcz
Copy link
Contributor

@diatrcz diatrcz commented Aug 26, 2025

Introduces a new rule that runs various checks on the on response body based the response's status code.

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 has been updated as needed
  • npm run update-utilities has been run if any files in packages/utilities/src have been updated

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)
  • Added scoring rubric entry for new rule (packages/validator/src/scoring-tool/rubric.js)

Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
@diatrcz diatrcz marked this pull request as ready for review September 16, 2025 10:11
@diatrcz diatrcz requested a review from pyrooka September 16, 2025 10:11
Copy link
Member

@pyrooka pyrooka left a comment

Choose a reason for hiding this comment

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

A few small issues to fix - as we discussed in person. And please update documentation of the response-status-codes rule too.

Copy link
Member

@pyrooka pyrooka left a comment

Choose a reason for hiding this comment

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

Just another set of comments. :)

Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
@diatrcz diatrcz requested a review from pyrooka September 23, 2025 07:57
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Copy link
Member

@pyrooka pyrooka left a comment

Choose a reason for hiding this comment

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

Looks pretty good, great work! 🚀

Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
@diatrcz diatrcz changed the title feat(ibm-response-status-body): introduce new validation rule feat(ibm-redirect-response-body): introduce new validation rule Sep 23, 2025
@diatrcz diatrcz merged commit ac0d8dc into main Sep 23, 2025
7 checks passed
@diatrcz diatrcz deleted the lt/add-redirect-rule branch September 23, 2025 12:17
ibm-devx-sdk pushed a commit that referenced this pull request Sep 23, 2025
# @ibm-cloud/openapi-ruleset [1.33.0](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/openapi-ruleset@1.32.1...@ibm-cloud/openapi-ruleset@1.33.0) (2025-09-23)

### Features

* **ibm-redirect-response-body:** introduce new validation rule ([#758](#758)) ([ac0d8dc](ac0d8dc))
@ibm-devx-sdk
Copy link

🎉 This PR is included in version 1.33.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 23, 2025
# ibm-openapi-validator [1.37.0](https://github.com/IBM/openapi-validator/compare/ibm-openapi-validator@1.36.1...ibm-openapi-validator@1.37.0) (2025-09-23)

### Features

* **ibm-redirect-response-body:** introduce new validation rule ([#758](#758)) ([ac0d8dc](ac0d8dc))

### Dependencies

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

🎉 This PR is included in version 1.37.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