CLOUDP 328959: OperationID Validation functions for Create, Delete, and Update methods #805
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
matt-condon
reviewed
Jul 4, 2025
tools/spectral/ipa/rulesets/functions/IPA108ValidOperationID.js
Outdated
Show resolved
Hide resolved
wtrocki
reviewed
Jul 4, 2025
wtrocki
reviewed
Jul 4, 2025
matt-condon
reviewed
Jul 4, 2025
tools/spectral/ipa/rulesets/functions/IPA108ValidOperationID.js
Outdated
Show resolved
Hide resolved
Co-authored-by: Matt Condon <[email protected]>
|
@yelizhenden-mdb For clarification:
I've prioritised speed here, my motivation is to get the list of changes together ASAP. |
tools/spectral/ipa/rulesets/functions/IPA106ValidOperationID.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/IPA106ValidOperationID.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/IPA107ValidOperationID.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/IPA108ValidOperationID.js
Outdated
Show resolved
Hide resolved
andreaangiolillo
approved these changes
Jul 7, 2025
tools/spectral/ipa/rulesets/functions/IPA106ValidOperationID.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/IPA106ValidOperationID.js
Outdated
Show resolved
Hide resolved
| message: | ||
| 'Invalid OperationID. The Operation ID must start with the verb “create” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form. ', | ||
| path: ['paths', '/api/atlas/v2/groups/{groupId}/invites', 'post'], | ||
| severity: DiagnosticSeverity.Warning, |
There was a problem hiding this comment.
Just asking to learn:
I’m not fully sure how severity: off behaves. Does it completely disable the rule, or does it still run but return errors with DiagnosticSeverity.Off?
If it’s the first case, can we assume the rule isn't being tested at all?
There was a problem hiding this comment.
Severity off still runs the rule but hides the errors, which is what i want here until the package and extension are supported (ie: closer to the time of correction). The rule isn't being tested because it's not active yet, but I have run the tests on error and warning severity and they pass.
There was a problem hiding this comment.
Perfect! Thanks ❤️
yelizhenden-mdb
approved these changes
Jul 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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-328959
Further comments
Exception support to be added in separate ticket. Rules are not enabled.