Skip to content

Commit a114313

Browse files
reference the relevant section of the spec in definitions (#2792)
1 parent a8bd1a5 commit a114313

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

schemas/v3.1/schema.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@
7474
"unevaluatedProperties": false,
7575
"$defs": {
7676
"info": {
77+
"$comment": "https://spec.openapis.org/oas/v3.1.0#info-object",
7778
"type": "object",
7879
"properties": {
7980
"title": {
@@ -106,6 +107,7 @@
106107
"unevaluatedProperties": false
107108
},
108109
"contact": {
110+
"$comment": "https://spec.openapis.org/oas/v3.1.0#contact-object",
109111
"type": "object",
110112
"properties": {
111113
"name": {
@@ -122,6 +124,7 @@
122124
"unevaluatedProperties": false
123125
},
124126
"license": {
127+
"$comment": "https://spec.openapis.org/oas/v3.1.0#license-object",
125128
"type": "object",
126129
"properties": {
127130
"name": {
@@ -154,6 +157,7 @@
154157
"unevaluatedProperties": false
155158
},
156159
"server": {
160+
"$comment": "https://spec.openapis.org/oas/v3.1.0#server-object",
157161
"type": "object",
158162
"properties": {
159163
"url": {
@@ -177,6 +181,7 @@
177181
"unevaluatedProperties": false
178182
},
179183
"server-variable": {
184+
"$comment": "https://spec.openapis.org/oas/v3.1.0#server-variable-object",
180185
"type": "object",
181186
"properties": {
182187
"enum": {
@@ -200,6 +205,7 @@
200205
"unevaluatedProperties": false
201206
},
202207
"components": {
208+
"$comment": "https://spec.openapis.org/oas/v3.1.0#components-object",
203209
"type": "object",
204210
"properties": {
205211
"schemas": {
@@ -275,6 +281,7 @@
275281
"unevaluatedProperties": false
276282
},
277283
"paths": {
284+
"$comment": "https://spec.openapis.org/oas/v3.1.0#paths-object",
278285
"type": "object",
279286
"patternProperties": {
280287
"^/": {
@@ -285,6 +292,7 @@
285292
"unevaluatedProperties": false
286293
},
287294
"path-item": {
295+
"$comment": "https://spec.openapis.org/oas/v3.1.0#path-item-object",
288296
"type": "object",
289297
"properties": {
290298
"summary": {
@@ -329,6 +337,7 @@
329337
}
330338
},
331339
"operation": {
340+
"$comment": "https://spec.openapis.org/oas/v3.1.0#operation-object",
332341
"type": "object",
333342
"properties": {
334343
"tags": {
@@ -388,6 +397,7 @@
388397
"unevaluatedProperties": false
389398
},
390399
"external-documentation": {
400+
"$comment": "https://spec.openapis.org/oas/v3.1.0#external-documentation-object",
391401
"type": "object",
392402
"properties": {
393403
"description": {
@@ -405,6 +415,7 @@
405415
"unevaluatedProperties": false
406416
},
407417
"parameter": {
418+
"$comment": "https://spec.openapis.org/oas/v3.1.0#parameter-object",
408419
"type": "object",
409420
"properties": {
410421
"name": {
@@ -638,6 +649,7 @@
638649
}
639650
},
640651
"request-body": {
652+
"$comment": "https://spec.openapis.org/oas/v3.1.0#request-body-object",
641653
"type": "object",
642654
"properties": {
643655
"description": {
@@ -672,6 +684,7 @@
672684
}
673685
},
674686
"content": {
687+
"$comment": "https://spec.openapis.org/oas/v3.1.0#fixed-fields-10",
675688
"type": "object",
676689
"additionalProperties": {
677690
"$ref": "#/$defs/media-type"
@@ -681,6 +694,7 @@
681694
}
682695
},
683696
"media-type": {
697+
"$comment": "https://spec.openapis.org/oas/v3.1.0#media-type-object",
684698
"type": "object",
685699
"properties": {
686700
"schema": {
@@ -704,6 +718,7 @@
704718
"unevaluatedProperties": false
705719
},
706720
"encoding": {
721+
"$comment": "https://spec.openapis.org/oas/v3.1.0#encoding-object",
707722
"type": "object",
708723
"properties": {
709724
"contentType": {
@@ -772,6 +787,7 @@
772787
}
773788
},
774789
"responses": {
790+
"$comment": "https://spec.openapis.org/oas/v3.1.0#responses-object",
775791
"type": "object",
776792
"properties": {
777793
"default": {
@@ -787,6 +803,7 @@
787803
"unevaluatedProperties": false
788804
},
789805
"response": {
806+
"$comment": "https://spec.openapis.org/oas/v3.1.0#response-object",
790807
"type": "object",
791808
"properties": {
792809
"description": {
@@ -829,6 +846,7 @@
829846
}
830847
},
831848
"callbacks": {
849+
"$comment": "https://spec.openapis.org/oas/v3.1.0#callback-object",
832850
"type": "object",
833851
"$ref": "#/$defs/specification-extensions",
834852
"additionalProperties": {
@@ -850,6 +868,7 @@
850868
}
851869
},
852870
"example": {
871+
"$comment": "https://spec.openapis.org/oas/v3.1.0#example-object",
853872
"type": "object",
854873
"properties": {
855874
"summary": {
@@ -882,6 +901,7 @@
882901
}
883902
},
884903
"link": {
904+
"$comment": "https://spec.openapis.org/oas/v3.1.0#link-object",
885905
"type": "object",
886906
"properties": {
887907
"operationRef": {
@@ -930,6 +950,7 @@
930950
}
931951
},
932952
"header": {
953+
"$comment": "https://spec.openapis.org/oas/v3.1.0#header-object",
933954
"type": "object",
934955
"properties": {
935956
"description": {
@@ -997,6 +1018,7 @@
9971018
}
9981019
},
9991020
"tag": {
1021+
"$comment": "https://spec.openapis.org/oas/v3.1.0#tag-object",
10001022
"type": "object",
10011023
"properties": {
10021024
"name": {
@@ -1016,6 +1038,7 @@
10161038
"unevaluatedProperties": false
10171039
},
10181040
"reference": {
1041+
"$comment": "https://spec.openapis.org/oas/v3.1.0#reference-object",
10191042
"type": "object",
10201043
"properties": {
10211044
"$ref": {
@@ -1032,13 +1055,15 @@
10321055
"unevaluatedProperties": false
10331056
},
10341057
"schema": {
1058+
"$comment": "https://spec.openapis.org/oas/v3.1.0#schema-object",
10351059
"$dynamicAnchor": "meta",
10361060
"type": [
10371061
"object",
10381062
"boolean"
10391063
]
10401064
},
10411065
"security-scheme": {
1066+
"$comment": "https://spec.openapis.org/oas/v3.1.0#security-scheme-object",
10421067
"type": "object",
10431068
"properties": {
10441069
"type": {
@@ -1322,6 +1347,7 @@
13221347
}
13231348
},
13241349
"security-requirement": {
1350+
"$comment": "https://spec.openapis.org/oas/v3.1.0#security-requirement-object",
13251351
"type": "object",
13261352
"additionalProperties": {
13271353
"type": "array",
@@ -1331,6 +1357,7 @@
13311357
}
13321358
},
13331359
"specification-extensions": {
1360+
"$comment": "https://spec.openapis.org/oas/v3.1.0#specification-extensions",
13341361
"patternProperties": {
13351362
"^x-": true
13361363
}

0 commit comments

Comments
 (0)