CLOUDP-331821: Add op ID override validation #841
Merged
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
lovisaberggren
commented
Jul 24, 2025
| }; | ||
|
|
||
| describe('tools/spectral/ipa/rulesets/functions/utils/extensions.js', () => { | ||
| describe('hasMethodWithVerbOverride', () => { |
There was a problem hiding this comment.
Refactored custom method rule approach to apply to each operation instead of each path in the OAS.
This method not needed, removed test
lovisaberggren
commented
Jul 24, 2025
| expect(generateOperationID('update', '/groups/{groupId}/clusters/{clusterName}')).toEqual('updateGroupCluster'); | ||
| expect(generateOperationID('pause', '/groups/{groupId}/clusters/{clusterName}')).toEqual('pauseGroupCluster'); | ||
| }); | ||
| describe('generateOperationID', () => { |
There was a problem hiding this comment.
Added a describe to wrap these as part of generateOperationID function
lovisaberggren
commented
Jul 24, 2025
| * @param endpoint the endpoint to evaluate | ||
| * @returns {boolean} true if the endpoint has a nested method with the extension, otherwise false | ||
| */ | ||
| export function hasMethodWithVerbOverride(endpoint) { |
There was a problem hiding this comment.
Refactored custom method rule approach to apply to each operation instead of each path in the OAS.
This method not needed anymore
sphterry
reviewed
Jul 24, 2025
tools/spectral/ipa/rulesets/functions/utils/validations/validateOperationIdAndReturnErrors.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/utils/validations/validateOperationIdAndReturnErrors.js
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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
Jira ticket: CLOUDP-331821
Adding support for operation ID override validation. Errors are returned when:
Additional changes
Moved the operation ID validation logic to a shared validation function called by each rule.
Added try catches to each rule in case of spectral errors.
Refactored custom method rule approach to apply to each operation instead of each path in the OAS.
Testing
Added unit tests for each introduced function.
Follow-ups
The rules are not yet enabled. This will be done with E2E testing in a later ticket.