diff --git a/tools/spectral/.spectral.yaml b/tools/spectral/.spectral.yaml index 174a6949cf..cd60bca978 100644 --- a/tools/spectral/.spectral.yaml +++ b/tools/spectral/.spectral.yaml @@ -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: + 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."