Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(spectral): separate rule for path parameters

Browse Source
This commit is contained in:
Anatolii Zetilov
2020-03-25 16:39:47 +02:00
parent 580cc0cee9
commit bc51ece3bf
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
.spectral.yml
View File

@@ -10,7 +10,7 @@ rules:
operation-2xx-response: error operation-2xx-response: error
adidas-paths-kebab-case: adidas-paths-kebab-case:
description: All YAML/JSON paths MUST follow kebab-case with template variables in camelCase description: All YAML/JSON paths MUST follow kebab-case
severity: warn severity: warn
recommended: true recommended: true
message: "{{property}} is not kebab-case: {{error}}" message: "{{property}} is not kebab-case: {{error}}"
@@ -18,7 +18,18 @@ rules:
then: then:
function: pattern function: pattern
functionOptions: functionOptions:
match: "^\/([a-z0-9]+(-[a-z0-9]+)*)?(\/[a-z0-9]+(-[a-z0-9]+)*|\/{[a-z][a-zA-Z0-9]+})*$" # doesn't allow /asasd{asdas}sadas pattern or not closed braces match: "^\/([a-z0-9]+(-[a-z0-9]+)*)?(\/[a-z0-9]+(-[a-z0-9]+)*|\/{.+})*$" # doesn't allow /asasd{asdas}sadas pattern or not closed braces
adidas-path-parameters-camelCase-alphanumeric:
description: Path parameters MUST follow camelCase
severity: warn
recommended: true
message: "{{property}} path parameter is not camelCase: {{error}}"
given: $..parameters[?(@.in == 'path')].name
then:
function: pattern
functionOptions:
match: "^[a-z][a-zA-Z0-9]+$"
adidas-definitions-camelCase-alphanumeric: adidas-definitions-camelCase-alphanumeric:
description: All YAML/JSON definitions MUST follow fields-camelCase and be ASCII alphanumeric characters or `_` or `$`. description: All YAML/JSON definitions MUST follow fields-camelCase and be ASCII alphanumeric characters or `_` or `$`.