Skip to content

Conversation

@diatrcz
Copy link
Contributor

@diatrcz diatrcz commented Oct 14, 2025

Extends the ibm-major-version-in-path rule so it validates that the version number is the first segment of the API's path if the version number is located in the path.

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>
@diatrcz diatrcz requested a review from pyrooka October 14, 2025 11:42
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 comments, otherwise it looks good!

Update: please use a bit more descriptive commit message when merging this PR. Something like

fix(ibm-major-version-in-path): extend rule to check major version is the first segment

should be fine.

Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
@diatrcz diatrcz requested a review from pyrooka October 22, 2025 15:36
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.

LGTM!

@diatrcz diatrcz changed the title fix(ibm-major-version-in-path): update validation rule fix(ibm-major-version-in-path): extend rule to check major version is the first segment Oct 27, 2025
@diatrcz diatrcz merged commit ed61873 into main Oct 27, 2025
7 checks passed
@diatrcz diatrcz deleted the lt/fix-version-path branch October 27, 2025 15:58
ibm-devx-sdk pushed a commit that referenced this pull request Oct 27, 2025
## @ibm-cloud/openapi-ruleset [1.33.2](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/openapi-ruleset@1.33.1...@ibm-cloud/openapi-ruleset@1.33.2) (2025-10-27)

### Bug Fixes

* **ibm-major-version-in-path:** extend rule to check major version is the first segment ([#766](#766)) ([ed61873](ed61873))
@ibm-devx-sdk
Copy link

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

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.

4 participants