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

Headers must follow Hyphenated-Pascal-Case notation

Browse Source
This commit is contained in:
Jarzyna, Andrzej
2019-11-21 15:58:53 +01:00
parent d100c3ffc8
commit 40aa54d799
1 changed files with 15 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
.spectral.yml
View File

@@ -75,6 +75,18 @@ rules:
functionOptions: functionOptions:
notMatch: "/^X-([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/" notMatch: "/^X-([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/"
headers-hyphenated-pascal-case:
description: All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation
severity: error
given: "$..parameters[?(@.in == 'header')].name"
message: "'HTTP' headers MUST follow 'Hyphenated-Pascal-Case' notation"
recommended: true
type: style
then:
function: pattern
functionOptions:
match: "/^([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/"
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
# Only OAS2 rules # Only OAS2 rules
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
@@ -270,19 +282,9 @@ rules:
# Not implemented # Not implemented
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
# Waiting for implementation of casing for hyphenated pascal case in spectral # ---------------------------------------------------------------------------
# headers-hyphenated-pascal-case: # Other rules which are redundant or not feasible
# description: All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation # ---------------------------------------------------------------------------
# severity: error
# given: $..parameters[*].in
# heders-no-x-headers:
# description: All `HTTP` headers SHOULD NOT include `X-` headers (https://tools.ietf.org/html/rfc6648). All non-standard headers are named without the `X-` prefix.
# severity: warning
# given: $..parameters[*].in
# ---------------------------------------------------------------------------
## Other rules which are redundant or not feasible
# ---------------------------------------------------------------------------
# fields-date-iso8601: # fields-date-iso8601:
# description: Date and time MUST follow [`ISO 8601` standard](https://www.iso.org/iso-8601-date-and-time-format.html) # description: Date and time MUST follow [`ISO 8601` standard](https://www.iso.org/iso-8601-date-and-time-format.html)