Skip to content

CLOUDP-284437: Add Spectral rule to ensure operationId uses camelcase #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 15, 2024
Merged

CLOUDP-284437: Add Spectral rule to ensure operationId uses camelcase #284

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5cf019f
CLOUDP-284437: Add Spectral rule to ensure operationId uses camelcase
andreaangiolillo Nov 13, 2024
81b8a22
CLOUDP-284437: Add Spectral rule to ensure operationId uses camelcase
andreaangiolillo Nov 13, 2024
b5efb2e
Update .spectral.yaml
andreaangiolillo Nov 13, 2024
470a810
Merge remote-tracking branch 'origin/main' into CLOUDP-284437
andreaangiolillo Nov 14, 2024
9b9bd61
Update .spectral.yaml
andreaangiolillo Nov 14, 2024
9c5fe9d
Merge remote-tracking branch 'origin/main' into CLOUDP-284437
andreaangiolillo Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions tools/spectral/.spectral.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,16 @@ rules:
functionOptions:
match: "^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$"

xgen-docs-operationId-camel-case:
description: operationId should be camelCased.
given: "$.paths[*]..operationId"
severity: error
message: "Operation ID should be camelCase: {{value}}."
then:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point! I will update it

Copy link
Collaborator Author

@andreaangiolillo andreaangiolillo Nov 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perfect I wasn't sure what the right interpolation was, thanks for fixing it

function: casing
functionOptions:
type: camel

xgen-docs-parameter-examples-or-schema:
message: "No example or schema provided for {{property}}."
description: "Without providing a well defined schema or example(s) an API consumer will have a hard time knowing how to interact with this API."
Expand Down
Loading