1
1
# CAMARA Project - linting ruleset - documentation avaialable here:
2
2
# https://github.com/camaraproject/Commonalities/blob/main/documentation/Linting-rules.md
3
- # 31.01.2024 - initial version
3
+ # Changelog:
4
+ # - 31.01.2024: Initial version
5
+ # - 19.03.2024: Corrected camara-http-methods rule
6
+
4
7
5
8
extends : " spectral:oas"
6
9
functions :
@@ -108,7 +111,7 @@ rules:
108
111
then :
109
112
function : pattern
110
113
functionOptions :
111
- match : " ^(get|put|post|delete|patch|options)$"
114
+ match : " ^(get|put|post|delete|patch|options|parameters )$"
112
115
recommended : true # Set to true/false to enable/disable this rule
113
116
114
117
camara-get-no-request-body :
@@ -156,7 +159,7 @@ rules:
156
159
field : description
157
160
function : truthy
158
161
recommended : true # Set to true/false to enable/disable this rule
159
-
162
+
160
163
camara-parameters-descriptions :
161
164
message : " Parameter description is missing or empty: {{error}}"
162
165
severity : warn
@@ -168,7 +171,7 @@ rules:
168
171
field : description
169
172
function : truthy
170
173
recommended : true # Set to true/false to enable/disable this rule
171
-
174
+
172
175
camara-response-descriptions :
173
176
message : " Parameter description is missing or empty: {{error}}"
174
177
severity : warn
@@ -193,7 +196,7 @@ rules:
193
196
field : description
194
197
function : truthy
195
198
recommended : true # Set to true/false to enable/disable this rule
196
-
199
+
197
200
camara-operation-summary :
198
201
message : " Operation Summary Warning: Each operation should include a short summary for better understanding."
199
202
severity : warn
@@ -255,4 +258,4 @@ rules:
255
258
function : pattern
256
259
functionOptions :
257
260
match : " ^\/ ([a-z0-9]+(-[a-z0-9]+)*)?(\/ [a-z0-9]+(-[a-z0-9]+)*|\/ {.+})*$" # doesn't allow /asasd{asdas}sadas pattern or not closed braces
258
- recommended : true # Set to true/false to enable/disable this rule
261
+ recommended : true # Set to true/false to enable/disable this rule
0 commit comments