CLOUDP-284437: Add Spectral rule to ensure operationId uses camelcase #284
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
gssbzn
reviewed
Nov 14, 2024
| description: operationId should be camelCased. | ||
| given: "$.paths[*]..operationId" | ||
| severity: error | ||
| then: |
There was a problem hiding this comment.
can you add a message like
Suggested change
| then: | |
| message: "Operation ID should be camelCase: {{property}}." | |
| then: |
so we can see what the current value is?
There was a problem hiding this comment.
good point! I will update it
There was a problem hiding this comment.
I updated to use {{value}} which gives the message 40221:26 error xgen-docs-operationId-camel-case Operation ID should be camelCase: grantMongoDBEmployeeAccess.
Using {{property}} does not give a useful message 40221:26 error xgen-docs-operationId-camel-case Operation ID should be camelCase: operationId.
There was a problem hiding this comment.
perfect I wasn't sure what the right interpolation was, thanks for fixing it
lovisaberggren
approved these changes
Nov 15, 2024
blva
approved these changes
Nov 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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-284437