-
Notifications
You must be signed in to change notification settings - Fork 8
/
.spectral.yml
1543 lines (1454 loc) · 75.9 KB
/
.spectral.yml
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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
description: "# [{json:api}](https://jsonapi.org/) - [v1.0](https://jsonapi.org/format/1.0/)\r\n>
A Specification for Building APIs in JSON\r\n\r\nJSON:API is a specification for
how a client should request that resources be fetched or modified, and how a server
should respond to those requests.\r\n\r\nJSON:API is designed to minimize both the
number of requests and the amount of data transmitted between clients and servers.
This efficiency is achieved without compromising readability, flexibility, or discoverability.\r\n\r\nJSON:API
requires use of the JSON:API media type `application/vnd.api+json` for exchanging
data.\r\n\r\n\r\n---\r\nThis styleguide ruleset can be found on GitHub: [spectral-jsonapi-ruleset](https://github.com/jmlue42/spectral-jsonapi-ruleset) "
extends:
- spectral:oas
formats:
- oas3.1
aliases:
AllContentSchemas:
- "$.paths..content['application/vnd.api+json'].schema"
ResourceObjects:
- "$.paths..responses..content[application/vnd.api+json].schema.properties.data.properties"
- "$.paths..responses..content[application/vnd.api+json].schema.properties.data.allOf[*].properties"
- "$.paths..responses..content[application/vnd.api+json].schema.properties.data.items.properties"
- "$.paths..responses..content[application/vnd.api+json].schema.properties.data.items.allOf[*].properties"
- "$.paths..content[application/vnd.api+json].schema.properties.included.items.properties"
- "$.paths..content[application/vnd.api+json].schema.properties.included.items.allOf[*].properties"
- "$.paths..patch.requestBody.content[application/vnd.api+json].schema.properties.data.properties"
- "$.paths..patch.requestBody.content[application/vnd.api+json].schema.properties.data.allOf[*].properties"
POSTResourceObjects:
- "$.paths..post.requestBody.content[application/vnd.api+json].schema.properties.data.properties"
- "$.paths..post.requestBody.content[application/vnd.api+json].schema.properties.data.allOf[*].properties"
LinkObjects:
- "#AllContentSchemas..properties[links]"
MetaObjects:
- "#AllContentSchemas..properties[meta]"
Relationships:
- "#AllContentSchemas..properties[relationships]"
RelationshipData:
- "#Relationships..data"
POSTRelationships:
- "$.paths..post.requestBody.content[application/vnd.api+json].schema.properties.data.properties[relationships].properties[*]"
- "$.paths..post.requestBody.content[application/vnd.api+json].schema.properties.data.allOf[*].properties[relationships].properties[*]"
PATCHRelationships:
- "$.paths..patch.requestBody.content[application/vnd.api+json].schema.properties.data.properties[relationships].properties[*]"
- "$.paths..patch.requestBody.content[application/vnd.api+json].schema.properties.data.allOf[*].properties[relationships].properties[*]"
SingleErrorResponses:
- "$.paths..responses[?(@property > '400' && @property < '500')].content[application/vnd.api+json].schema.properties.errors"
- "$.paths..responses[?(@property > '500' && @property < '600')].content[application/vnd.api+json].schema.properties.errors"
- "$.paths..responses[default].content[application/vnd.api+json].schema.properties.errors"
ErrorObjects:
- "$.paths..responses[default,400,500].content[application/vnd.api+json].schema.properties.errors.items.properties"
- "$.paths..responses[default,400,500].content[application/vnd.api+json].schema.properties.errors.items.allOf[*].properties"
- "$.paths..responses[?(@property > '400' && @property < '500')].content[application/vnd.api+json].schema.properties.errors.items.properties"
- "$.paths..responses[?(@property > '400' && @property < '500')].content[application/vnd.api+json].schema.properties.errors.items.allOf[*].properties"
- "$.paths..responses[?(@property > '500' && @property < '600')].content[application/vnd.api+json].schema.properties.errors.items.properties"
- "$.paths..responses[?(@property > '500' && @property < '600')].content[application/vnd.api+json].schema.properties.errors.items.allOf[*].properties"
rules:
# ---------------------------------------------------------------------------
# Section 4 Content Negotiation
# ---------------------------------------------------------------------------
content-type:
description: "Clients and Servers **MUST** send all JSON:API data as Content-Type:
`application/vnd.api+json` without any media type parameters.\r\n\r\n**Invalid
Examples:**\r\n```YAML\r\nrequestBody:\r\n content:\r\n application/json\r\n\r\nresponses:\r\n
\ '200':\r\n content:\r\n application/json\r\n```\r\n\r\n**Valid Examples:**\r\n```YAML\r\nrequestBody:\r\n
\ content:\r\n application/vnd.api+json\r\n\r\nresponses:\r\n '200':\r\n
\ content:\r\n application/vnd.api+json\r\n```\r\n\r\nRelated specification
information can be found [here](https://jsonapi.org/format/1.0/#content-negotiation-servers)."
documentationUrl: "https://jsonapi.org/format/1.0/#content-negotiation"
message: "content MUST be 'application/vnd.api+json'"
severity: error
given:
- "$.paths..requestBody.content"
- "$.paths..responses..content"
then:
field: "@key"
function: enumeration
functionOptions:
values:
- application/vnd.api+json
406-response-code:
description: "Servers **MUST** document and support response code **406** paths
in case of invalid `ACCEPT` media values.\r\n\r\n**Invalid Example:**\r\n```YAML\r\npaths:\r\n
\ /myResources:\r\n get:\r\n responses:\r\n '200':\r\n $ref:
'#/components/responses/MyResource_Collection'\r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\npaths:\r\n
\ /myResources:\r\n get:\r\n responses:\r\n '200':\r\n $ref:
'#/components/responses/MyResource_Collection'\r\n '406':\r\n $ref:
'#/components/responses/406Error'\r\n```\r\n\r\nRelated specification information
can be found [here](https://jsonapi.org/format/1.0/#content-negotiation-servers)."
documentationUrl: "https://jsonapi.org/format/1.0/#content-negotiation-servers"
message: "All paths must support response codes: 406"
severity: error
given: "$.paths..responses"
then:
field: "406"
function: truthy
415-response-code:
description: "Servers **MUST** document and support response code **415** on `POST`
or `PATCH` paths in case of invalid `Content-Type` media values.\r\n\r\n**Invalid
Example:**\r\n```YAML\r\npaths:\r\n /myResources:\r\n post:\r\n responses:\r\n
\ '200':\r\n $ref: '#/components/responses/MyResource_Collection'\r\n```\r\n\r\n**Valid
Example:**\r\n```YAML\r\npaths:\r\n /myResources:\r\n post:\r\n responses:\r\n
\ '200':\r\n $ref: '#/components/responses/MyResource_Collection'\r\n
\ '415':\r\n $ref: '#/components/responses/415Error'\r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#content-negotiation-servers)."
documentationUrl: "https://jsonapi.org/format/1.0/#content-negotiation-servers"
message: "POST and PATCH paths must support response code: 415"
severity: error
given: "$.paths[*][post,patch].responses"
then:
field: "415"
function: truthy
# ---------------------------------------------------------------------------
# Section 5 Document Structure
# Section 5.1 Top Level Object Schema
# ---------------------------------------------------------------------------
top-level-json-object:
description: "A JSON object **MUST** be at the root of every JSON:API request/response
body containing data\r\n\r\nValid Examples:\r\n```YAML\r\ncontent:\r\n application/vnd.api+json:\r\n
\ schema:\r\n type: object\r\n```\r\n\r\nRelated specification information
can be found [here](https://jsonapi.org/format/1.0/#document-top-level)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-top-level"
message: "Request/response body must be wrapped in root level JSON object"
severity: error
given: "#AllContentSchemas"
then:
field: type
function: enumeration
functionOptions:
values:
- object
top-level-json-properties:
description: "Root JSON object **MUST** follow the jsonapi schema\r\n\r\n**Schema
Rules:**\r\n- **MUST** contain at least one of: `data`, `errors`, `meta` properties\r\n-
`data` and `errors` **MAY NOT** coexist in the same document\r\n- **MAY** contain:
`jsonapi`,`links`,`included`\r\n- if `included` exists, `data` is **REQUIRED**\r\n\r\n**Invalid
Examples:**\r\n```YAML\r\ntype: object\r\nproperties:\r\n data:\r\n type:
object\r\n errors:\r\n type: array\r\n\r\ntype: object\r\nproperties:\r\n
\ links:\r\n type: object\r\n included:\r\n type: array\r\n```\r\n\r\n**Valid
Examples:**\r\n```YAML\r\ntype: object\r\nproperties:\r\n jsonapi:\r\n type:
object\r\n links:\r\n type: object\r\n meta:\r\n type: object\r\n
\ data:\r\n type: object\r\n included:\r\n type: array\r\n\r\n\r\ntype:
object\r\nproperties:\r\n errors:\r\n type: array\r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-top-level)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-top-level"
message: "Root JSON object MUST follow the jsonapi schema"
severity: error
given: "#AllContentSchemas"
then:
field: "properties"
function: schema
functionOptions:
dialect: "draft2020-12"
schema:
type: object
anyOf:
- required: ["data"]
- required: ["errors"]
- required: ["meta"]
not:
anyOf:
- required: ["data","errors"]
dependentRequired:
included: ["data"]
properties:
data:
type: object
properties:
type:
type: string
enum:
- object
- array
- "null"
errors:
type: object
properties:
type:
type: string
enum:
- array
meta:
type: object
properties:
type:
type: string
enum:
- object
jsonapi:
type: object
properties:
type:
type: string
enum:
- object
links:
type: object
properties:
type:
type: string
enum:
- object
included:
type: object
properties:
type:
type: string
enum:
- array
# ---------------------------------------------------------------------------
# Section 5.2 Resource Objects
# ---------------------------------------------------------------------------
resource-object-properties:
description: "Verify allowed properties in Resource Objects\r\n\r\n**Allowed properties:**
`id`,`type`,`attributes`,`relationships`,`links`,`meta`\r\n\r\n**Invalid Example:**\r\n```YAML\r\ntype:
object\r\nproperties:\r\n id:\r\n type: string\r\n format: uri\r\n example:
4257c52f-6c78-4747-8106-e185c081436b\r\n type:\r\n type: string\r\n enum:\r\n
\ - resources\r\n name:\r\n type: string\r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\ntype:
object\r\nrequired:\r\n - id\r\n - type\r\n - attributes\r\n - relationships\r\nproperties:\r\n
\ id:\r\n type: string\r\n format: uri\r\n example: 4257c52f-6c78-4747-8106-e185c081436b\r\n
\ type:\r\n type: string\r\n enum:\r\n - resources\r\n attributes:\r\n
\ type: object\r\n relationships:\r\n type: object\r\n meta:\r\n type:
object\r\n links:\r\n type: object\r\n```\r\n\r\nRelated specification information
can be found [here](https://jsonapi.org/format/1.0/#document-resource-objects)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-objects"
message: "'data' objects/items MUST meet Resource Object restrictions"
severity: error
given:
- "#ResourceObjects"
- "#POSTResourceObjects"
then:
- field: type
function: truthy
- field: "@key"
function: enumeration
functionOptions:
values:
- id
- type
- attributes
- relationships
- links
- meta
# TODO:// Error throws incorrectly (too much) in an allOf scenario where one item is valid, but the other does not. Changed to warn for now.
resource-object-id-required:
description: "Verify `id` property exists in Resource Object (except POST requestBody)\r\n\r\n**Valid
Example:**\r\n```YAML\r\n# path..responses...\r\n# path.patch.requestBody...\r\n\r\ntype:
object\r\nrequired:\r\n - id\r\n - type\r\nproperties:\r\n id:\r\n type:
string\r\n format: uuid\r\n example: 4257c52f-6c78-4747-8106-e185c081436b\r\n
\ type:\r\n type: string\r\n meta:\r\n type: object\r\n```\r\n**NOTE:**
Currently this rule triggers against `allOf` structures unless all items have
`id`. Until this is corrected it is set as a warning.\r\n\r\n\r\nRelated specification
information can be found [here](https://jsonapi.org/format/1.0/#document-resource-objects)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-objects"
message: "Could be missing 'id' property. Please verify the resource."
severity: warn
given: "#ResourceObjects"
then:
field: id
function: truthy
# ---------------------------------------------------------------------------
# Section 5.2.1 Resource Objects - Identification
# ---------------------------------------------------------------------------
resource-object-property-types:
description: "`id` and `type` **MUST** be of type `string`\r\n\r\n**Invalid Example:**\r\n```YAML\r\ntype:
object\r\nproperties:\r\n id:\r\n type: number\r\n type:\r\n type: string\r\n
\ enum:\r\n - resources\r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\ntype:
object\r\nrequired:\r\n - id\r\n - type\r\nproperties:\r\n id:\r\n type:
string\r\n format: uri\r\n example: 4257c52f-6c78-4747-8106-e185c081436b\r\n
\ type:\r\n type: string\r\n enum:\r\n - resources\r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-resource-object-identification)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-object-identification"
message: "'id' and 'type' MUST be of type 'string'"
severity: error
given:
- "#ResourceObjects.id"
- "#ResourceObjects.type"
- "#POSTResourceObjects.type"
then:
field: type
function: enumeration
functionOptions:
values:
- string
# ---------------------------------------------------------------------------
# Section 5.2.2 Resource Objects - Fields
# ---------------------------------------------------------------------------
resource-object-reserved-fields:
description: "`id` and `type` **MUST NOT** exist in `attributes` or `relationships`\r\n\r\n**Invalid
Example:**\r\n```YAML\r\ntype: object\r\nrequired:\r\n - id\r\n - type\r\n
\ - attributes\r\nproperties:\r\n id:\r\n type: string\r\n format: uri\r\n
\ example: 4257c52f-6c78-4747-8106-e185c081436b\r\n type:\r\n type: string\r\n
\ enum:\r\n - resources\r\n attributes:\r\n type: object\r\n properties:\r\n
\ id:\r\n type: number\r\n type:\r\n type: string\r\n```\r\n\r\n**Valid
Example:**\r\n```YAML\r\ntype: object\r\nrequired:\r\n - id\r\n - type\r\n
\ - attributes\r\nproperties:\r\n id:\r\n type: string\r\n format: uri\r\n
\ example: 4257c52f-6c78-4747-8106-e185c081436b\r\n type:\r\n type: string\r\n
\ enum:\r\n - resources\r\n attributes:\r\n type: object\r\n properties:\r\n
\ name:\r\n type: string\r\n descrpition:\r\n type:
string\r\n meta:\r\n type: object\r\n links:\r\n type: object\r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-resource-object-fields)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-object-fields"
message: "'id' and 'type' MUST NOT exist in 'attributes' or 'relationships'"
severity: error
given: "#AllContentSchemas..properties[attributes,relationships].properties"
then:
- field: id
function: falsy
- field: type
function: falsy
# ---------------------------------------------------------------------------
# Section 5.2.3 Resource Objects - Attributes
# ---------------------------------------------------------------------------
attributes-object-type:
description: "`attributes` property **MUST** be an `object`\r\n\r\n**Invalid Examples:**\r\n```YAML\r\n#
data (Resource Object)\r\n# ... \r\nproperties:\r\n attributes:\r\n type:
array \r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\n# data (Resource Object)\r\n#
... \r\nproperties:\r\n attributes:\r\n type: object\r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-resource-object-attributes)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-object-attributes"
message: "The value of 'attributes' property MUST be an object"
severity: error
given: "#AllContentSchemas..properties[attributes]"
then:
field: type
function: enumeration
functionOptions:
values:
- object
attributes-object-properties:
description: "`attributes` object **MUST NOT** contain a `relationships` or `links`
property\r\n\r\n**Invalid Example:**\r\n```YAML\r\n# data (Resource Object)\r\n#
... \r\nproperties:\r\n attributes:\r\n type: object\r\n required:\r\n
\ - name\r\n properties:\r\n name:\r\n type: string\r\n example:
do-hickey\r\n description:\r\n type: string\r\n example:
thing that does stuff\r\n links:\r\n type: array\r\n items:\r\n
\ type: string\r\n relationships:\r\n type: array\r\n
\ items:\r\n type: string\r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\n#
data (Resource Object)\r\n# ... \r\nproperties:\r\n attributes:\r\n type:
object\r\n required:\r\n - name\r\n properties:\r\n name:\r\n
\ type: string\r\n example: do-hickey\r\n description:\r\n
\ type: string\r\n example: thing that does stuff\r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-resource-object-attributes)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-object-attributes"
message: "Attributes object MUST NOT contain a 'relationships' or 'links' property"
severity: error
given: "#AllContentSchemas..properties[attributes]..properties"
then:
- field: relationships
function: falsy
- field: links
function: falsy
attributes-object-foreign-keys:
description: "Foreign Keys **SHOULD NOT** appear in `attributes`. **RECOMMEND**
using `relationships`\r\n\r\nAlthough has-one foreign keys (e.g. author_id)
are often stored internally alongside other information to be represented in
a resource object, these keys **SHOULD NOT** appear as attributes.\r\n\r\nForiegn
keys are supported through the use of [relationships](https://jsonapi.org/format/1.0/#document-resource-object-relationships)
and [related resource links](https://jsonapi.org/format/1.0/#document-resource-object-related-resource-links).\r\n\r\n**Example:**
Use relationship primary data rather than foreign key.\r\n```YAML\r\ntype: object\r\nproperties:\r\n
\ id:\r\n type: string\r\n format: uuid\r\n type:\r\n type: string\r\n
\ enum:\r\n - widgets\r\n attributes:\r\n type: object\r\n required:\r\n
\ - name\r\n properties:\r\n account_id:\r\n type:
string\r\n name:\r\n type: string\r\n example: do-hickey\r\n
\ description:\r\n type: string\r\n example: thing that
does stuff\r\n relationships:\r\n type: object\r\n properties:\r\n manufacturer:
#<------ a widget has a relationship with a manufacturer\r\n type: object\r\n
\ required:\r\n - links\r\n - data\r\n properties:\r\n
\ data:\r\n type: object\r\n properties:\r\n
\ id: #<---------- primary/foreign key value\r\n type:
string\r\n format: uuid\r\n type:\r\n type:
string\r\n enum:\r\n - businesses\r\n```\r\n**NOTE:**
This would normally be a severity of `hint`, though this can be missed visually
in vscode. Until this changes it will be a severity of `info`.\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-resource-object-attributes)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-object-attributes"
message: "Foreign key? If so, it would be better to remove and use a relationship."
severity: info
given: "#AllContentSchemas..properties[attributes]..properties[*]~"
then:
function: pattern
functionOptions:
notMatch: ".*_id$"
# ---------------------------------------------------------------------------
# Section 5.2.4 Resource Objects - Relationships (Addresses 5.2.6 and 5.3)
# ---------------------------------------------------------------------------
relationships-object-type:
description: "relationships **MUST** be an `object`\r\n\r\n**Invalid Example:**\r\n```YAML\r\nrelationships:\r\n
\ type: array\r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\nrelationships:\r\n
\ type: object\r\n```\r\n\r\nRelated specification information can be found
[here](https://jsonapi.org/format/1.0/#document-resource-object-relationships)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-object-relationships"
message: "Relationships MUST be an object"
severity: error
given: "#Relationships"
then:
field: type
function: enumeration
functionOptions:
values:
- object
relationship-schema:
description: "relationship object **MUST** follow the schema\r\n\r\n**Schema Rules:**\r\n-
**MUST** contain at least one of: `links`,`data`,`meta`\r\n- `links` object
**MUST** contain at least one of: `self`, `related`\r\n- `data` **MAY** be `null`,
single or array of resource identifiers\r\n- `meta` **MUST** be an `object`\r\n\r\n**Valid
Example:**\r\n```YAML\r\n'relationshipNameSingle':\r\n type: object\r\n required:\r\n
\ - links\r\n - data\r\n properties:\r\n links:\r\n type: object\r\n
\ required:\r\n - self\r\n - related\r\n properties:\r\n
\ self:\r\n $ref: '#/components/schemas/Link'\r\n example:
http://api.domain.com/v1/myResources/{id}/relationships/manufacturers\r\n related:\r\n
\ type: string\r\n example: http://api.domain.com/v1/manufacturers/{id}\r\n
\ data:\r\n type: object\r\n required:\r\n - id\r\n -
type\r\n properties:\r\n id:\r\n type: string\r\n format:
uri\r\n example: 4257c52f-6c78-4747-8106-e185c081436b\r\n type:\r\n
\ type: string\r\n enum:\r\n - 'relationshipNamePlural'\r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-resource-object-relationships)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-object-relationships"
message: "relationship object MUST follow the schema"
severity: error
given: "#Relationships.properties[*]"
then:
- field: type
function: enumeration
functionOptions:
values:
- object
- field: properties
function: schema
functionOptions:
dialect: "draft2020-12"
schema:
type: object
anyOf:
- required: ["links"]
- required: ["data"]
- required: ["meta"]
properties:
links:
type: object
properties:
type:
type: string
enum:
- object
properties:
type: object
anyOf:
- required: ["self"]
- required: ["related"]
properties:
self:
type: object
related:
type: object
data:
type: object
properties:
type:
type: string
enum:
- object
- array
- "null"
meta:
type: object
properties:
type:
type: string
enum:
- object
additionalProperties: false
relationship-data-properties:
description: "relationship `data` **MAY** only contain: `id`, `type` and `meta`\r\n\r\nInvalid
Example:\r\n```YAML\r\ntype: object\r\nrequired:\r\n - id\r\n - type\r\nproperties:\r\n
\ id:\r\n type: string\r\n format: uuid\r\n example: 2357c52f-6c78-4747-8106-e185c08143aa\r\n
\ type:\r\n type: string\r\n attributes:\r\n type: object\r\n meta:\r\n
\ type: object\r\n```\r\n\r\nValid Example:\r\n```YAML\r\ntype: object\r\nrequired:\r\n
\ - id\r\n - type\r\nproperties:\r\n id:\r\n type: string\r\n format:
uuid\r\n example: 2357c52f-6c78-4747-8106-e185c08143aa\r\n type:\r\n type:
string\r\n meta:\r\n type: object\r\n```\r\n\r\nRelated specification information
can be found [here](https://jsonapi.org/format/1.0/#document-resource-identifier-objects)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-identifier-objects"
message: "relationship data May only contain: 'id', 'type' and 'meta'"
severity: error
given:
- "#RelationshipData.properties"
- "#RelationshipData.allOf[*].properties"
- "#RelationshipData.items.properties"
- "#RelationshipData.items.allOf[*].properties"
then:
field: "@key"
function: enumeration
functionOptions:
values:
- id
- type
- meta
relationship-data-schema:
description: "relationship data items **MUST** follow schema\r\n\r\n**Schema Rules:**\r\n-
`id` **MUST** be a `string`\r\n- `type` **MUST** be a `string`\r\n- `meta` **MUST**
be an `object`\r\n\r\n**Invalid Examples:**\r\n```YAML\r\ntype: object\r\nrequired:\r\n
\ - id\r\n - type\r\nproperties:\r\n id:\r\n type: number\r\n type:\r\n
\ type: number\r\n meta:\r\n type: object\r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\ntype:
object\r\nrequired:\r\n - id\r\n - type\r\nproperties:\r\n id:\r\n type:
string\r\n format: uuid\r\n example: 2357c52f-6c78-4747-8106-e185c08143aa\r\n
\ type:\r\n type: string\r\n meta:\r\n type: object \r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-resource-identifier-objects)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-resource-identifier-objects"
message: "relationship data items MUST follow schema"
severity: error
given:
- "#RelationshipData.properties"
- "#RelationshipData.allOf[0].properties"
- "#RelationshipData.items.properties"
- "#RelationshipData.items.allOf[0].properties"
then:
function: schema
functionOptions:
dialect: "draft2020-12"
schema:
type: object
required: ["id","type"]
properties:
id:
type: object
properties:
type:
type: string
enum:
- string
type:
type: object
properties:
type:
type: string
enum:
- string
meta:
type: object
properties:
type:
type: string
enum:
- object
# ---------------------------------------------------------------------------
# Section 5.5 Resource Objects - Meta Information
# ---------------------------------------------------------------------------
meta-object:
description: "`meta` property **MUST** be of type `object`\r\n\r\n**Invalid Examples:**\r\n```YAML\r\nproperties:\r\n
\ meta:\r\n type: string \r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\nproperties:\r\n
\ meta:\r\n type: object\r\n```\r\n\r\nRelated specification information
can be found [here](https://jsonapi.org/format/1.0/#document-meta)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-meta"
message: "'meta' property MUST be of type object"
severity: error
given: "#MetaObjects"
then:
field: type
function: enumeration
functionOptions:
values:
- object
# ---------------------------------------------------------------------------
# Section 5.6 Resource Objects - Links
# ---------------------------------------------------------------------------
links-object:
description: "`links` property **MUST** be an `object`\r\n\r\n**Invalid Examples:**\r\n```YAML\r\nproperties:\r\n
\ links:\r\n type: array \r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\nproperties:\r\n
\ links:\r\n type: object\r\n```\r\n\r\nRelated specification information
can be found [here](https://jsonapi.org/format/1.0/#document-links)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-links"
message: "'links' property MUST be an object"
severity: error
given: "#LinkObjects"
then:
field: type
function: enumeration
functionOptions:
values:
- object
links-object-schema:
description: "A link **MUST** be represented as either a `string` containing the
link's URL or an `object`.\r\n\r\n**Invalid Examples:**\r\n```YAML\r\nproperties:\r\n
\ links:\r\n type: object\r\n properties:\r\n self:\r\n type:
number\r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\nproperties:\r\n links:\r\n
\ type: object\r\n properties:\r\n self:\r\n oneOf:\r\n
\ - type: string\r\n format: uri\r\n - type:
object\r\n required:\r\n - href\r\n properties:\r\n
\ href:\r\n type: string\r\n format:
uri\r\n meta:\r\n type: object \r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-links)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-links"
message: "'link' properties must be of type string or object"
severity: error
given: "#LinkObjects.properties[*]..[?(@property === 'type')]^"
then:
field: type
function: enumeration
functionOptions:
values:
- string
- object
links-object-schema-properties:
description: "objects contained within a `links` object **MUST** contain `href`
(string) and **MAY** contain `meta`\r\n\r\nA link **MUST** be represented as
either a `string` containing the link's URL or an `object`.\r\n\r\n**Invalid
Examples:**\r\n```YAML\r\nproperties:\r\n links:\r\n type: object\r\n properties:\r\n
\ self:\r\n oneOf:\r\n - type: string\r\n format:
uri\r\n - type: object\r\n properties:\r\n url:\r\n
\ type: string\r\n format: uri\r\n meta:\r\n
\ type: object \r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\nproperties:\r\n
\ links:\r\n type: object\r\n properties:\r\n self:\r\n oneOf:\r\n
\ - type: string\r\n format: uri\r\n - type:
object\r\n required:\r\n - href\r\n properties:\r\n
\ href:\r\n type: string\r\n format:
uri\r\n meta:\r\n type: object \r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-links)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-links"
message: "objects contained within a links object MUST contain 'href' (string) and MAY contain 'meta'"
severity: error
given: "#LinkObjects.properties..properties"
then:
- field: "@key"
function: enumeration
functionOptions:
values:
- href
- meta
- field: href
function: truthy
- field: href.type
function: enumeration
functionOptions:
values:
- string
# ---------------------------------------------------------------------------
# Section 5.7 Resource Objects - JSON:API Object
# ---------------------------------------------------------------------------
jsonapi-object:
description: "`jsonapi` object **MUST** match schema\r\n\r\n**Schema Rules:**\r\n-
`jsonapi` **MUST** be an `object`\r\n- **MUST** contain `string` `version`\r\n\r\n**Valid
Example:**\r\n```YAML\r\nproperties:\r\n jsonapi:\r\n type: object\r\n properties:\r\n
\ version:\r\n type: string\r\n example: '1.0'\r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#document-jsonapi-object)."
documentationUrl: "https://jsonapi.org/format/1.0/#document-jsonapi-object"
message: "jsonapi object MUST match schema"
severity: error
given: "#AllContentSchemas..properties[?(@property === 'jsonapi')]"
then:
- field: type
function: enumeration
functionOptions:
values:
- object
- field: "properties[*]~"
function: enumeration
functionOptions:
values:
- version
- field: properties.version
function: truthy
- field: properties.version.type
function: enumeration
functionOptions:
values:
- string
# ---------------------------------------------------------------------------
# Section 6 Fetching Data
# Section 6.1
# Section 6.2 Responses Codes - 200, 404
# ---------------------------------------------------------------------------
get-200-response-code:
description: "`GET` requests **MUST** support response code 200\r\n\r\n**Invalid
Example:**\r\n```YAML\r\npaths:\r\n /myResources/{id}:\r\n get:\r\n responses:\r\n
\ '404':\r\n $ref: '#/components/responses/404Error'\r\n```\r\n\r\n**Valid
Examples:**\r\n```YAML\r\npaths:\r\n /myResources/{id}:\r\n get:\r\n responses:\r\n
\ '200':\r\n $ref: '#/components/responses/MyResource_Single'\r\n
\ '404':\r\n $ref: '#/components/responses/404Error'\r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#fetching-resources-responses)."
documentationUrl: "https://jsonapi.org/format/1.0/#fetching-resources-responses"
message: "GET paths must support response code: 200"
severity: error
given: "$.paths[*][get].responses"
then:
field: "200"
function: truthy
# TODO:// verify a 404 response exists on a GET request that returns a single resource
# ---------------------------------------------------------------------------
# Section 6.3 Fetching Resources - Inclusion of Related Resources
# ---------------------------------------------------------------------------
400-response-code:
description: "Servers **MUST** document and support response code **400** for
all paths\r\n\r\n**Invalid Example:**\r\n```YAML\r\npaths:\r\n /myResources:\r\n
\ get:\r\n responses:\r\n '200':\r\n $ref: '#/components/responses/MyResource_Collection'\r\n```\r\n\r\n**Valid
Example:**\r\n```YAML\r\npaths:\r\n /myResources:\r\n get:\r\n responses:\r\n
\ '200':\r\n $ref: '#/components/responses/MyResource_Collection'\r\n
\ '400':\r\n $ref: '#/components/responses/400Error'\r\n```"
message: "All paths must support response codes: 400"
severity: error
given: "$.paths..responses"
then:
field: "400"
function: truthy
include-parameter:
description: "`include` query param **MUST** be a string array (csv)\r\n\r\n**Valid
Example:**\r\n```YAML\r\nname: include\r\ndescription: csv formatted parameter
of relationship names to include in response\r\nin: query\r\nstyle: form\r\nexplode:
false\r\nschema:\r\ntype: array\r\nitems:\r\n type: string\r\nexample: [\"ratings\",\"comments.author\"]\r\n```\r\nExample
query string: `/articles/1?include=comments.author,ratings`\r\n\r\nRelated specification
information can be found [here](https://jsonapi.org/format/1.0/#fetching-includes)."
documentationUrl: "https://jsonapi.org/format/1.0/#fetching-includes"
message: "'include' query param MUST be a string array (csv)"
severity: error
given: "$.paths..parameters[*][?(@property === 'name' && @ === 'include')]^"
then:
- field: in
function: enumeration
functionOptions:
values:
- query
- field: style
function: truthy
- field: style
function: enumeration
functionOptions:
values:
- form
- field: explode
function: defined
- field: explode
function: falsy
- field: schema
function: schema
functionOptions:
dialect: "draft2020-12"
schema:
type: object
properties:
type:
type: string
enum:
- array
items:
type: object
properties:
type:
type: string
enum:
- string
# ---------------------------------------------------------------------------
# Section 6.4 Fetching Resources - Sparse Fieldsets
# ---------------------------------------------------------------------------
fields-parameter:
description: "`fields` query param **MUST** be a `deepObject`\r\n\r\n**Valid Example:**\r\n```YAML\r\nname:
fields\r\ndescription: schema for 'fields' query parameter\r\nin: query\r\nschema:\r\n
\ type: object\r\nstyle: deepObject\r\nexample:\r\n people: \"name\"\r\n articles:
\"title,body\"\r\n```\r\nExample query string: `/articles?fields[articles]=title,body&fields[people]=name`\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#fetching-sparse-fieldsets)."
documentationUrl: "https://jsonapi.org/format/1.0/#fetching-sparse-fieldsets"
message: "'fields' query param MUST be a deepObject"
severity: error
given: "$.paths..parameters[*][?(@property === 'name' && @ === 'fields')]^"
then:
- field: in
function: enumeration
functionOptions:
values:
- query
- field: style
function: truthy
- field: style
function: enumeration
functionOptions:
values:
- deepObject
- field: schema
function: schema
functionOptions:
dialect: "draft2020-12"
schema:
type: object
properties:
type:
type: string
enum:
- object
# ---------------------------------------------------------------------------
# Section 6.5 Fetching Resources - Sorting
# ---------------------------------------------------------------------------
sort-parameter:
description: "`sort` query param **MUST** be a string array (csv)\r\n\r\n**Valid
Example:**\r\n```YAML\r\nname: sort\r\ndescription: csv formatted parameter
of fields to sort by\r\nin: query\r\nstyle: form\r\nexplode: false\r\nschema:\r\n
\ type: array\r\n items:\r\n type: string\r\nexample: [\"-age\",\"name\"]\r\n```\r\nExample
query string: `/people?sort=-age,name`\r\n\r\nRelated specification information
can be found [here](https://jsonapi.org/format/1.0/#fetching-sorting)."
documentationUrl: "https://jsonapi.org/format/1.0/#fetching-sorting"
message: "'sort' query param MUST be a string array (csv)"
severity: error
given: "$.paths..parameters[*][?(@property === 'name' && @ === 'sort')]^"
then:
- field: in
function: enumeration
functionOptions:
values:
- query
- field: style
function: truthy
- field: style
function: enumeration
functionOptions:
values:
- form
- field: explode
function: defined
- field: explode
function: falsy
- field: schema
function: schema
functionOptions:
dialect: "draft2020-12"
schema:
type: object
properties:
type:
type: string
enum:
- array
items:
type: object
properties:
type:
type: string
enum:
- string
# ---------------------------------------------------------------------------
# Section 6.6 Fetching Resources - Pagination
# ---------------------------------------------------------------------------
# TODO:// verify 'page' param only on collections
page-parameter:
description: "`page` query param **MUST** follow schema\r\n\r\n**Schema Rules:**\r\n-
**MUST** be type `object`\r\n- **MUST** be style `deepObject`\r\n- contents
depend on strategy:\r\n - cursor: `string` `cursor` and `int32` `limit`\r\n
\ - offset: `int32` `offset` and `int32` `limit`\r\n\r\n**Valid Examples:**\r\n```YAML\r\nname:
page\r\ndescription: Paging parameter, cursor based.\r\nin: query\r\nschema:\r\n
\ type: object\r\n required: [\"cursor\",\"limit\"]\r\n properties:\r\n cursor:\r\n
\ type: string\r\n limit:\r\n type: integer\r\n format: int32\r\nstyle:
deepObject\r\n\r\nname: page\r\ndescription: Paging parameter, offset based.\r\nin:
query\r\nschema:\r\n type: object\r\n required: [\"offset\",\"limit\"]\r\n
\ properties:\r\n cursor:\r\n type: integer\r\n format: int32\r\n
\ limit:\r\n type: integer\r\n format: int32\r\nstyle: deepObject\r\n```\r\nExample
query string: \r\n- `/myResources?page[cursor]=fdsJ34lkjSfjsdfk&page[limit]=10`\r\n-
`/myResources?page[offset]=2&page[limit]=10`\r\n\r\nRelated specification information
can be found [here](https://jsonapi.org/format/1.0/#fetching-pagination)."
documentationUrl: "https://jsonapi.org/format/1.0/#fetching-pagination"
message: "'page' query param MUST follow schema"
severity: error
given: "$.paths..parameters[*][?(@property === 'name' && @ === 'page')]^"
then:
- field: in
function: enumeration
functionOptions:
values:
- query
- field: style
function: truthy
- field: style
function: enumeration
functionOptions:
values:
- deepObject
- field: schema
function: schema
functionOptions:
dialect: "draft2020-12"
schema:
type: object
properties:
type:
type: string
enum:
- object
properties:
type: object
additionalProperties: false
properties:
cursor:
type: object
properties:
type:
type: string
enum: ["string"]
offset:
type: object
properties:
type:
type: string
enum: ["integer"]
format:
type: string
enum: ["int32"]
minimum:
type: integer
minimum: 0
limit:
type: object
properties:
type:
type: string
enum: ["integer"]
format:
type: string
enum: ["int32"]
# TODO:// verify first,last,prev,next links only on collections
# ---------------------------------------------------------------------------
# Section 6.7 Fetching Resources - Filtering
# ---------------------------------------------------------------------------
# TODO:// verify 'filter' param only on collections
# ---------------------------------------------------------------------------
# Section 7.1 Creating Resources
# ---------------------------------------------------------------------------
# TODO:// support x-http-method-override: PATCH
post-requests-single-object:
description: "POST requests **MUST** only contain a single resource object\r\n\r\n**Invalid
Example:**\r\n```YAML\r\ncontent:\r\n application/vnd.api+json:\r\n schema:\r\n
\ type: object\r\n required:\r\n - data\r\n properties:\r\n
\ data:\r\n type: array\r\n items: \r\n $ref:
'#/components/schemas/MyResourcePostObject'\r\n```\r\n\r\n**Valid Example:**\r\n```YAML\r\ncontent:\r\n
\ application/vnd.api+json:\r\n schema:\r\n type: object\r\n required:\r\n
\ - data\r\n properties:\r\n data:\r\n $ref: '#/components/schemas/MyResourcePostObject'\r\n```\r\n\r\nRelated
specification information can be found [here](https://jsonapi.org/format/1.0/#crud-creating)."
documentationUrl: "https://jsonapi.org/format/1.0/#crud-creating"
message: "POST requests MAY only contain a single resource object"
severity: error
given: "$.paths..post.requestBody.content[application/vnd.api+json].schema.properties.data[?(@property==='type' && @ === 'array')]"
then:
function: falsy
post-relationships:
description: "If relationships exist in POST request, `data` is REQUIRED\r\n\r\n**Invalid
Example:**\r\n```YAML\r\nrelationships:\r\n type: object\r\n properties:\r\n