-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmodel-response-ruleset.yaml
444 lines (432 loc) · 17.2 KB
/
model-response-ruleset.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
#
# Copyright 2019-2022 Groupe BPCE
#
# Licensed under the Apache License, Version 2.0 (the License);
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an AS IS BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# TODO Modification des guidelines pour ajouter "location" dans Error pour indiquer où est l'attribut en erreur (body, query, path, header)
# TODO Modification de model response pour ajouter location
# TODO Modification des tests pour ajouter location
# TODO Ajout required pour type et enum sur les properties dans le modèle Error
# TODO Modification des tests pour contrôler le required
# TODO info to alert when additionalInformation is used
# TODO warn to alert when there's no pagination on collection
# TODO warn to alert when required query parameter (use optional with default value if possible)
rules:
response-schema-is-defined-oas2:
formats: ['oas2']
recommended: true
description: A 2xx (except 204), 4xx or 5xx response must return data
message: "{{description}} ({{path}})"
severity: error
tags:
- model response
given: $.paths.*.*.responses[?(/^2(?!04)..|4..|5..$/.test(@property))]
then:
- field: schema
function: truthy
response-schema-is-defined-oas3:
formats: ['oas3']
recommended: true
description: A 2xx (except 204), 4xx or 5xx response must return data
message: "{{description}} ({{path}})"
severity: error
tags:
- model response
given: $.paths.*.*.responses[?(/^2(?!04)..|4..|5..$/.test(@property))]
then:
- function: schema
functionOptions:
schema:
$schema: "http://json-schema.org/draft-07/schema#"
additionalProperties: true
required:
- content
properties:
content:
type: object
minProperties: 1
additionalProperties:
type: object
required:
- schema
properties:
schema:
type: object
response-schema-is-not-defined-for-204-or-3xx:
recommended: true
description: A 204 No Content or 3xx redirection response cannot return data
message: "{{description}} ({{path}})"
severity: error
tags:
- model response
given: $.paths.*.*.responses[?(/^204|3..$/.test(@property))]
then:
- field: schema # oas 2
function: falsy
- field: content # oas 3
function: falsy
response-schema-is-an-object:
recommended: true
description: A success (2xx, except 204) or an error (4xx or 5xx) must return an object
message: "{{description}} ({{path}})"
severity: error
tags:
- model response
given:
- $.paths.*.*.responses[?(/^2(?!04)..|4..|5..$/.test(@property))].schema # oas2
- $.paths.*.*.responses[?(/^2(?!04)..|4..|5..$/.test(@property))].content.'application/json'.schema # oas3
then:
- function: schema
functionOptions:
# Pay attention! It's a JSON Schema of the expected Schema (Inception!)
schema:
$schema: "http://json-schema.org/draft-07/schema#"
type: object
properties:
type:
type: string
enum:
- object
response-error-schema-is-valid:
recommended: true
description: An error must conform to standard schema
message: "{{description}} ({{path}}) {{error}}"
severity: error
tags:
- model response
given:
- $.paths.*.*.responses[?(/4..|5../.test(@property))].schema # oas2
- $.paths.*.*.responses[?(/4..|5../.test(@property))].content.'application/json'.schema # oas3
then:
function: schema
functionOptions:
schema:
# Pay attention! It's a JSON Schema of the expected Schema (Inception!)
$schema: "http://json-schema.org/draft-04/schema#"
type: object
required:
- required
- properties
properties:
# Required properties (only errors)
required:
type: array
items:
type: string
enum:
- errors
minItems: 1
maxItems: 1
# Root object property (errors)
properties:
type: object
additionalProperties: false
required:
- errors
properties:
errors:
type: object
required:
- type
- items
properties:
type:
type: string
enum:
- array
items:
type: object
required:
- properties
- required
properties:
required:
type: array
items:
type: string
enum:
- code
- message
minItems: 2
properties:
type: object
additionalProperties: false
properties:
code:
type: object
properties:
type:
type: string
enum:
- string
message:
type: object
properties:
type:
type: string
enum:
- string
attribute:
type: object
properties:
type:
type: string
enum:
- string
path:
type: object
properties:
type:
type: string
enum:
- string
location:
type: object
required:
- type
- enum
properties:
type:
type: string
enum:
- string
enum:
type: array
items:
type: string
enum:
- BODY
- QUERY
- PATH
- HEADER
minItems: 4
maxItems: 4
additionalInformation:
type: object
# This check (additionalInformation content being described) should be in a separate rule as a warning because peopletend to use generic error object
#required:
# - properties
#properties:
# type:
# type: string
# enum:
# - object
# properties:
# type: object
response-collection-schema-is-valid:
recommended: true
description: A list response (get /resources or post /resources/search) must be an object with a mandatory property items which is a list and optional additionalInformation and page (pagination) properties
message: "{{description}} ({{path}})"
severity: error
tags:
- model response
given:
- $.paths[?(/(s|i?es|ves)$/i.test(@property))].get.responses.200.schema # oas2
- $.paths[?(/(s|i?es|ves)$/i.test(@property))].get.responses.200.content.'application/json'.schema # oas3
# https://github.com/stoplightio/spectral/issues/1920
- $.paths[?(/search$/.test(@property))].post.responses.200.schema # oas2
- $.paths[?(/search$/.test(@property))].post.responses.200.content.'application/json'.schema # oas3
then:
function: schema
functionOptions:
schema:
# Pay attention! It's a JSON Schema of the expected Schema (Inception!)
$schema: "http://json-schema.org/draft-04/schema#"
type: object
required:
- properties
properties:
properties:
type: object
additionalProperties: false
required:
- items
properties:
items:
type: object
required:
- type
- items
properties:
type:
type: string
enum:
- array
items:
type: object
# Testing that items are objects and not atomics or array in another rule
additionalInformation:
type: object
# Testing additionalInformation is an object and not atomic or array in another rule
page:
type: object
# Testing page object format in another rule
response-collection-items-schema-is-valid:
recommended: true
description: The items property of a list response (get /resources or post /resources/search) must be an array of object (no atomic like string or number nor array)
message: "{{description}} ({{path}})"
severity: error
tags:
- model response
given:
# Same regex as response-collection-schema-is-valid, no need to test again that part
- $.paths[?(/(s|i?es|ves)$/i.test(@property))].get.responses.200.schema.properties.items.items # oas2
- $.paths[?(/(s|i?es|ves)$/i.test(@property))].get.responses.200.content.'application/json'.schema.properties.items.items # oas3
# https://github.com/stoplightio/spectral/issues/1920
- $.paths[?(/search$/.test(@property))].post.responses.200.schema.properties.items.items # oas2
- $.paths[?(/search$/.test(@property))].post.responses.200.content.'application/json'.schema.properties.items.items # oas3
then:
- function: schema
functionOptions:
# Pay attention! It's a JSON Schema of the expected Schema (Inception!)
schema:
$schema: "http://json-schema.org/draft-04/schema#"
type: object
properties:
type:
type: string
enum:
- object
response-collection-additional-information-schema-is-valid:
recommended: true
description: The additionalInformation property of a list response (get /resources or post /resources/search) must be an object (no atomic like string or number nor array)
message: "{{description}} ({{path}})"
severity: error
tags:
- model response
given:
# Same regex as response-collection-schema-is-valid, no need to test again that part
- $.paths[?(/(s|i?es|ves)$/i.test(@property))].get.responses.200.schema.properties.additionalInformation
- $.paths[?(/(s|i?es|ves)$/i.test(@property))].get.responses.200.content.'application/json'.schema.properties.additionalInformation
# https://github.com/stoplightio/spectral/issues/1920
- $.paths[?(/search$/.test(@property))].post.responses.200.schema.properties.additionalInformation
- $.paths[?(/search$/.test(@property))].post.responses.200.content.'application/json'.schema.properties.additionalInformation
then:
- function: schema
functionOptions:
# Pay attention! It's a JSON Schema of the expected Schema (Inception!)
schema:
$schema: "http://json-schema.org/draft-04/schema#"
type: object
properties:
type:
type: string
enum:
- object
response-collection-page-schema-is-valid:
recommended: true
description: The page property of a list response (get /resources or post /resources/search) which provide pagination data must conform to standard schema
message: "{{description}} ({{path}}) ({{error}})"
severity: error
tags:
- model response
given:
# Same regex as response-collection-schema-is-valid, no need to test again that part
- $.paths[?(/(s|i?es|ves)$/i.test(@property))].get.responses.200.schema.properties.page
- $.paths[?(/(s|i?es|ves)$/i.test(@property))].get.responses.200.content.'application/json'.schema.properties.page
# https://github.com/stoplightio/spectral/issues/1920
- $.paths[?(/search$/.test(@property))].post.responses.200.schema.properties.page
- $.paths[?(/search$/.test(@property))].post.responses.200.content.'application/json'.schema.properties.page
then:
- function: schema
functionOptions:
# Pay attention! It's a JSON Schema of the expected Schema (Inception!)
schema:
$schema: "http://json-schema.org/draft-07/schema#"
oneOf:
- type: object
properties:
properties:
type: object
additionalProperties: false
required:
- pageNumber
- pageSize
properties:
pageSize:
type: object
additionalProperties: true
properties:
type:
type: string
enum:
- number
- integer
pageNumber:
type: object
additionalProperties: true
properties:
type:
type: string
enum:
- number
- integer
totalElements:
type: object
additionalProperties: true
properties:
type:
type: string
enum:
- number
- integer
totalPages:
type: object
additionalProperties: true
properties:
type:
type: string
enum:
- number
- integer
- type: object
properties:
properties:
type: object
additionalProperties: false
required:
- after
properties:
before:
type: object
properties:
type:
type: string
enum:
- string
after:
type: object
properties:
type:
type: string
enum:
- string
response-no-empty-required:
recommended: true
description: A response without any high level required property is not recommended
message: '{{description}} ({{path}})'
severity: warn
tags:
- model response
given:
- $.paths.*.*.responses.*.schema
- $.paths.*.*.responses.*.content.'application/json'.schema
- $.paths.*.*.responses.*.schema.properties.items.items
- $.paths.*.*.responses.*.content.'application/json'.schema.properties.items.items
then:
- field: required
function: truthy
- field: required
function: length
functionOptions:
min: 1