fix(ipa): Add ignore list for nouns in OperationID Validation #901
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tools/spectral/ipa/rulesets/functions/utils/operationIdGeneration.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/utils/operationIdGeneration.js
Outdated
Show resolved
Hide resolved
Co-authored-by: Lovisa Berggren <[email protected]>
This reverts commit 97d448f.
| function: 'IPA104ValidOperationID' | ||
| functionOptions: | ||
| methodName: 'get' | ||
| ignoreList: |
There was a problem hiding this comment.
Suggested change
| ignoreList: | |
| ignorePluralizationList: |
[Nit] Name suggestion, I feel like ignoreList can be interpreted as operation id ignore list.
There was a problem hiding this comment.
Will go back and change now
| severity: warn | ||
| given: '#GetOperationObject' | ||
| then: | ||
| function: 'IPA104ValidOperationID' |
There was a problem hiding this comment.
Could you add to the rule description an explanation of the ignore list option and what it is used for? Similar to
openapi/tools/spectral/ipa/rulesets/IPA-126.yaml
Lines 18 to 21 in ec9a70b
lovisaberggren
approved these changes
Aug 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Added a list of nouns that should never be singularized during OperationID validation. This list is solely to avoid typos in acronyms that appear in resource paths. Sparked by comment on OperationID corrections.
This PR will be followed by a PATCH version bump to the IPA package.
Jira ticket: CLOUDP-338775