forked from OAI/OpenAPI-Specification
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathv3.0.3.html
More file actions
4096 lines (4091 loc) · 303 KB
/
v3.0.3.html
File metadata and controls
4096 lines (4091 loc) · 303 KB
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
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><title>OpenAPI Specification v3.0.3 | Introduction, Definitions, & More</title><meta name="description" content="The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs."><link rel="canonical" href="https://spec.openapis.org/oas/latest.html" /><script src="../js/respec-oai.js" class="remove"></script><script class="remove">var respecConfig = {"specStatus":"base","editors":[{"name":"Darrel Miller "},{"name":"Jeremy Whitlock "},{"name":"Marsh Gardiner "},{"name":"Mike Ralphson "},{"name":"Ron Ratovsky "}],"formerEditors":[{"name":"Uri Sarid "},{"name":"Jason Harmon "},{"name":"Tony Tam "}],"publishDate":"2020-02-20T00:00:00.000Z","subtitle":"Version 3.0.3","processVersion":2017,"edDraftURI":"https://github.com/OAI/OpenAPI-Specification/","github":{"repoURL":"https://github.com/OAI/OpenAPI-Specification/","branch":"master"},"shortName":"OAS","noTOC":false,"lint":false,"additionalCopyrightHolders":"the Linux Foundation","includePermalinks":true};</script><!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-831873-42"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-831873-42');
</script>
</head><body><style>#respec-ui { visibility: hidden; }h1,h2,h3 { color: #629b34; }a[href] { color: #45512c; }body:not(.toc-inline) #toc h2 { color: #45512c; }table { display: block; width: 100%; overflow: auto; }table th { font-weight: 600; }table th, table td { padding: 6px 13px; border: 1px solid #dfe2e5; }table tr { background-color: #fff; border-top: 1px solid #c6cbd1; }table tr:nth-child(2n) { background-color: #f6f8fa; }pre { background-color: #f6f8fa !important; }/** * GitHub Gist Theme * Author : Louis Barranqueiro - https://github.com/LouisBarranqueiro */ .hljs { display: block; background: white; padding: 0.5em; color: #333333; overflow-x: auto; } .hljs-comment, .hljs-meta { color: #969896; } .hljs-string, .hljs-variable, .hljs-template-variable, .hljs-strong, .hljs-emphasis, .hljs-quote { color: #df5000; } .hljs-keyword, .hljs-selector-tag, .hljs-type { color: #a71d5d; } .hljs-literal, .hljs-symbol, .hljs-bullet, .hljs-attribute { color: #0086b3; } .hljs-section, .hljs-name { color: #63a35c; } .hljs-tag { color: #333333; } .hljs-title, .hljs-attr, .hljs-selector-id, .hljs-selector-class, .hljs-selector-attr, .hljs-selector-pseudo { color: #795da3; } .hljs-addition { color: #55a532; background-color: #eaffea; } .hljs-deletion { color: #bd2c00; background-color: #ffecec; } .hljs-link { text-decoration: underline; } </style><h1 id="title">OpenAPI Specification v3.0.3 </h1><section id="abstract" title="What is the OpenAPI Specification?">The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.</section><section class="notoc" id="sotd"><h2>Status of This Document</h2>The source-of-truth for the specification is the GitHub markdown file referenced above.</section>
<section><h1>OpenAPI Specification</h1>
<section><h3>Version 3.0.3</h3>
<p>The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in <a href="https://tools.ietf.org/html/bcp14">BCP 14</a> [[!RFC2119]] [[!RFC8174]] when, and only when, they appear in all capitals, as shown here.</p>
<p>This document is licensed under <a href="https://www.apache.org/licenses/LICENSE-2.0.html">The Apache License, Version 2.0</a>.</p>
</section></section></section><section><h1>Introduction</h1>
<p>The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.</p>
<p>An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.</p>
<!-- /TOC -->
</section><section><h1><dfn>Definitions</dfn></h1>
<p><a id="oasDocument"></a><section><h4><span><dfn>OpenAPI Document</dfn></span></h4></p>
<p>A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification.</p>
<p><a id="pathTemplating"></a></section><section><h4><span><dfn>Path Templating</dfn></span></h4></p>
<p>Path templating refers to the usage of template expressions, delimited by curly braces ({}), to mark a section of a URL path as replaceable using path parameters.</p>
<p>Each template expression in the path MUST correspond to a path parameter that is included in the <a href="#path-item-object">Path Item</a> itself and/or in each of the Path Item’s <a href="#operation-object">Operations</a>.</p>
<p><a id="mediaTypes"></a></section><section><h4><span><dfn>Media Types</dfn></span></h4></p>
<p>Media type definitions are spread across several resources.
The media type definitions SHOULD be in compliance with [[!RFC6838]].</p>
<p>Some examples of possible media type definitions:</p>
<pre class="highlight "><code>
text/plain; charset=utf-8
application/json
application/vnd.github+json
application/vnd.github.v3+json
application/vnd.github.v3.raw+json
application/vnd.github.v3.text+json
application/vnd.github.v3.html+json
application/vnd.github.v3.full+json
application/vnd.github.v3.diff
application/vnd.github.v3.patch
</code></pre>
<p><a id="httpCodes"></a></section><section><h4><span><dfn>HTTP Status Codes</dfn></span></h4></p>
<p>The HTTP Status Codes are used to indicate the status of the executed operation.
The available status codes are defined by [[!RFC7231]] and registered status codes are listed in the <a href="https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml">IANA Status Code Registry</a>.</p>
</section></section></section></section><section><h1>Specification</h1>
<section><h2>Versions</h2>
<p>The OpenAPI Specification is versioned using <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning 2.0.0</a> (semver) and follows the semver specification.</p>
<p>The <code>major</code>.<code>minor</code> portion of the semver (for example <code>3.0</code>) SHALL designate the OAS feature set. Typically, <em><code>.patch</code></em> versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between <code>3.0.0</code> and <code>3.0.1</code> for example.</p>
<p>Each new minor version of the OpenAPI Specification SHALL allow any OpenAPI document that is valid against any previous minor version of the Specification, within the same major version, to be updated to the new Specification version with equivalent semantics. Such an update MUST only require changing the <code>openapi</code> property to the new minor version.</p>
<p>For example, a valid OpenAPI 3.0.2 document, upon changing its <code>openapi</code> property to <code>3.1.0</code>, SHALL be a valid OpenAPI 3.1.0 document, semantically equivalent to the original OpenAPI 3.0.2 document. New minor versions of the OpenAPI Specification MUST be written to ensure this form of backward compatibility.</p>
<p>An OpenAPI document compatible with OAS 3.*.* contains a required <a href="#oasVersion"><code>openapi</code></a> field which designates the semantic version of the OAS that it uses. (OAS 2.0 documents contain a top-level version field named <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerObject"><code>swagger</code></a> and value <code>"2.0"</code>.)</p>
</section><section><h2>Format</h2>
<p>An OpenAPI document that conforms to the OpenAPI Specification is itself a JSON object, which may be represented either in JSON or YAML format.</p>
<p>For example, if a field has an array value, the JSON array representation will be used:</p>
<pre class="nohighlight"><code>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"field"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span> <span class="hljs-number">1</span><span class="hljs-punctuation">,</span> <span class="hljs-number">2</span><span class="hljs-punctuation">,</span> <span class="hljs-number">3</span> <span class="hljs-punctuation">]</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<p>All field names in the specification are <strong>case sensitive</strong>.
This includes all fields that are used as keys in a map, except where explicitly noted that keys are <strong>case insensitive</strong>.</p>
<p>The schema exposes two types of fields: Fixed fields, which have a declared name, and Patterned fields, which declare a regex pattern for the field name.</p>
<p>Patterned fields MUST have unique names within the containing object.</p>
<p>In order to preserve the ability to round-trip between YAML and JSON formats, YAML version <a href="https://yaml.org/spec/1.2/spec.html">1.2</a> is RECOMMENDED along with some additional constraints:</p>
<ul>
<li>Tags MUST be limited to those allowed by the <a href="https://yaml.org/spec/1.2/spec.html#id2803231">JSON Schema ruleset</a>.</li>
<li>Keys used in YAML maps MUST be limited to a scalar string, as defined by the <a href="https://yaml.org/spec/1.2/spec.html#id2802346">YAML Failsafe schema ruleset</a>.</li>
</ul>
<p><strong>Note:</strong> While APIs may be defined by OpenAPI documents in either YAML or JSON format, the API request and response bodies and other content are not required to be JSON or YAML.</p>
<p><a id="documentStructure"></a></section><section><h2><span>Document Structure</span></h2></p>
<p>An OpenAPI document MAY be made up of a single document or be divided into multiple, connected parts at the discretion of the user. In the latter case, <code>$ref</code> fields MUST be used in the specification to reference those parts as follows from the <a href="https://json-schema.org">JSON Schema</a> definitions.</p>
<p>It is RECOMMENDED that the root OpenAPI document be named: <code>openapi.json</code> or <code>openapi.yaml</code>.</p>
<p><a id="dataTypes"></a></section><section><h2><span>Data Types</span></h2></p>
<p>Primitive data types in the OAS are based on the types supported by the <a href="https://tools.ietf.org/html/draft-wright-json-schema-00#section-4.2">JSON Schema Specification Wright Draft 00</a>.
Note that <code>integer</code> as a type is also supported and is defined as a JSON number without a fraction or exponent part.
<code>null</code> is not supported as a type (see <a href="#schemaNullable"><code>nullable</code></a> for an alternative solution).
Models are defined using the <a href="#schemaObject">Schema Object</a>, which is an extended subset of JSON Schema Specification Wright Draft 00.</p>
<p><a id="dataTypeFormat"> </a>Primitives have an optional modifier property: <code>format</code>.
OAS uses several known formats to define in fine detail the data type being used.
However, to support documentation needs, the <code>format</code> property is an open <code>string</code>-valued property, and can have any value.
Formats such as <code>"email"</code>, <code>"uuid"</code>, and so on, MAY be used even though undefined by this specification.
Types that are not accompanied by a <code>format</code> property follow the type definition in the JSON Schema. Tools that do not recognize a specific <code>format</code> MAY default back to the <code>type</code> alone, as if the <code>format</code> is not specified.</p>
<p>The formats defined by the OAS are:</p>
<table>
<thead>
<tr>
<th><a href="#dataTypes"><code>type</code></a></th>
<th><a href="#dataTypeFormat"><code>format</code></a></th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>integer</code></td>
<td><code>int32</code></td>
<td>signed 32 bits</td>
</tr>
<tr>
<td><code>integer</code></td>
<td><code>int64</code></td>
<td>signed 64 bits (a.k.a long)</td>
</tr>
<tr>
<td><code>number</code></td>
<td><code>float</code></td>
<td></td>
</tr>
<tr>
<td><code>number</code></td>
<td><code>double</code></td>
<td></td>
</tr>
<tr>
<td><code>string</code></td>
<td></td>
<td></td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>byte</code></td>
<td>base64 encoded characters</td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>binary</code></td>
<td>any sequence of octets</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td></td>
<td></td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>date</code></td>
<td>As defined by <code>full-date</code> - <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6">[!RFC3339]</a></td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>date-time</code></td>
<td>As defined by <code>date-time</code> - <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6">[!RFC3339]</a></td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>password</code></td>
<td>A hint to UIs to obscure input.</td>
</tr>
</tbody>
</table>
<p><a id="richText"></a></section><section><h2><span>Rich Text Formatting</span></h2></p>
<p>Throughout the specification <code>description</code> fields are noted as supporting CommonMark markdown formatting.
Where OpenAPI tooling renders rich text it MUST support, at a minimum, markdown syntax as described by <a href="https://spec.commonmark.org/0.27/">CommonMark 0.27</a>. Tooling MAY choose to ignore some CommonMark features to address security concerns.</p>
<p><a id="relativeReferences"></a></section><section><h2><span>Relative References in URLs</span></h2></p>
<p>Unless specified otherwise, all properties that are URLs MAY be relative references as defined by [[!RFC3986]].
Relative references are resolved using the URLs defined in the <a href="#serverObject"><code>Server Object</code></a> as a Base URI.</p>
<p>Relative references used in <code>$ref</code> are processed as per <a href="https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03">JSON Reference</a>, using the URL of the current document as the base URI. See also the <a href="#referenceObject">Reference Object</a>.</p>
</section><section><h2>Schema</h2>
<p>In the following description, if a field is not explicitly <strong>REQUIRED</strong> or described with a MUST or SHALL, it can be considered OPTIONAL.</p>
<p><a id="oasObject"></a><section><h3><span>OpenAPI Object</span></h3></p>
<p>This is the root document object of the <a href="#oasDocument">OpenAPI document</a>.</p>
<section><h4>Fixed Fields</h4>
<table>
<thead>
<tr>
<th>Field Name</th>
<th style="text-align:center">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a id="oasVersion"> </a>openapi</td>
<td style="text-align:center"><code>string</code></td>
<td><strong>REQUIRED</strong>. This string MUST be the <a href="https://semver.org/spec/v2.0.0.html">semantic version number</a> of the <a href="#versions">OpenAPI Specification version</a> that the OpenAPI document uses. The <code>openapi</code> field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is <em>not</em> related to the API <a href="#infoVersion"><code>info.version</code></a> string.</td>
</tr>
<tr>
<td><a id="oasInfo"> </a>info</td>
<td style="text-align:center"><a href="#infoObject">Info Object</a></td>
<td><strong>REQUIRED</strong>. Provides metadata about the API. The metadata MAY be used by tooling as required.</td>
</tr>
<tr>
<td><a id="oasServers"> </a>servers</td>
<td style="text-align:center">[<a href="#serverObject">Server Object</a>]</td>
<td>An array of Server Objects, which provide connectivity information to a target server. If the <code>servers</code> property is not provided, or is an empty array, the default value would be a <a href="#serverObject">Server Object</a> with a <a href="#serverUrl">url</a> value of <code>/</code>.</td>
</tr>
<tr>
<td><a id="oasPaths"> </a>paths</td>
<td style="text-align:center"><a href="#pathsObject">Paths Object</a></td>
<td><strong>REQUIRED</strong>. The available paths and operations for the API.</td>
</tr>
<tr>
<td><a id="oasComponents"> </a>components</td>
<td style="text-align:center"><a href="#componentsObject">Components Object</a></td>
<td>An element to hold various schemas for the specification.</td>
</tr>
<tr>
<td><a id="oasSecurity"> </a>security</td>
<td style="text-align:center">[<a href="#securityRequirementObject">Security Requirement Object</a>]</td>
<td>A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement (<code>{}</code>) can be included in the array.</td>
</tr>
<tr>
<td><a id="oasTags"> </a>tags</td>
<td style="text-align:center">[<a href="#tagObject">Tag Object</a>]</td>
<td>A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the <a href="#operationObject">Operation Object</a> must be declared. The tags that are not declared MAY be organized randomly or based on the tools’ logic. Each tag name in the list MUST be unique.</td>
</tr>
<tr>
<td><a id="oasExternalDocs"> </a>externalDocs</td>
<td style="text-align:center"><a href="#externalDocumentationObject">External Documentation Object</a></td>
<td>Additional external documentation.</td>
</tr>
</tbody>
</table>
<p>This object MAY be extended with <a href="#specificationExtensions">Specification Extensions</a>.</p>
<p><a id="infoObject"></a></section></section><section><h3><span>Info Object</span></h3></p>
<p>The object provides metadata about the API.
The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.</p>
<section><h4>Fixed Fields</h4>
<table>
<thead>
<tr>
<th>Field Name</th>
<th style="text-align:center">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a id="infoTitle"> </a>title</td>
<td style="text-align:center"><code>string</code></td>
<td><strong>REQUIRED</strong>. The title of the API.</td>
</tr>
<tr>
<td><a id="infoDescription"> </a>description</td>
<td style="text-align:center"><code>string</code></td>
<td>A short description of the API. <a href="https://spec.commonmark.org/">CommonMark syntax</a> MAY be used for rich text representation.</td>
</tr>
<tr>
<td><a id="infoTermsOfService"> </a>termsOfService</td>
<td style="text-align:center"><code>string</code></td>
<td>A URL to the Terms of Service for the API. MUST be in the format of a URL.</td>
</tr>
<tr>
<td><a id="infoContact"> </a>contact</td>
<td style="text-align:center"><a href="#contactObject">Contact Object</a></td>
<td>The contact information for the exposed API.</td>
</tr>
<tr>
<td><a id="infoLicense"> </a>license</td>
<td style="text-align:center"><a href="#licenseObject">License Object</a></td>
<td>The license information for the exposed API.</td>
</tr>
<tr>
<td><a id="infoVersion"> </a>version</td>
<td style="text-align:center"><code>string</code></td>
<td><strong>REQUIRED</strong>. The version of the OpenAPI document (which is distinct from the <a href="#oasVersion">OpenAPI Specification version</a> or the API implementation version).</td>
</tr>
</tbody>
</table>
<p>This object MAY be extended with <a href="#specificationExtensions">Specification Extensions</a>.</p>
</section><section><h4>Info Object Example</h4>
<pre class="nohighlight"><code>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"title"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Sample Pet Store App"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"This is a sample server for a pet store."</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"termsOfService"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"http://example.com/terms/"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"contact"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"API Support"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"http://www.example.com/support"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"email"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"support@example.com"</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"license"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Apache 2.0"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"https://www.apache.org/licenses/LICENSE-2.0.html"</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"version"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"1.0.1"</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<pre class="nohighlight"><code>
<span class="hljs-attr">title:</span> <span class="hljs-string">Sample</span> <span class="hljs-string">Pet</span> <span class="hljs-string">Store</span> <span class="hljs-string">App</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">This</span> <span class="hljs-string">is</span> <span class="hljs-string">a</span> <span class="hljs-string">sample</span> <span class="hljs-string">server</span> <span class="hljs-string">for</span> <span class="hljs-string">a</span> <span class="hljs-string">pet</span> <span class="hljs-string">store.</span>
<span class="hljs-attr">termsOfService:</span> <span class="hljs-string">http://example.com/terms/</span>
<span class="hljs-attr">contact:</span>
<span class="hljs-attr">name:</span> <span class="hljs-string">API</span> <span class="hljs-string">Support</span>
<span class="hljs-attr">url:</span> <span class="hljs-string">http://www.example.com/support</span>
<span class="hljs-attr">email:</span> <span class="hljs-string">support@example.com</span>
<span class="hljs-attr">license:</span>
<span class="hljs-attr">name:</span> <span class="hljs-string">Apache</span> <span class="hljs-number">2.0</span>
<span class="hljs-attr">url:</span> <span class="hljs-string">https://www.apache.org/licenses/LICENSE-2.0.html</span>
<span class="hljs-attr">version:</span> <span class="hljs-number">1.0</span><span class="hljs-number">.1</span>
</code></pre>
<p><a id="contactObject"></a></section></section><section><h3><span>Contact Object</span></h3></p>
<p>Contact information for the exposed API.</p>
<section><h4>Fixed Fields</h4>
<table>
<thead>
<tr>
<th>Field Name</th>
<th style="text-align:center">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a id="contactName"> </a>name</td>
<td style="text-align:center"><code>string</code></td>
<td>The identifying name of the contact person/organization.</td>
</tr>
<tr>
<td><a id="contactUrl"> </a>url</td>
<td style="text-align:center"><code>string</code></td>
<td>The URL pointing to the contact information. MUST be in the format of a URL.</td>
</tr>
<tr>
<td><a id="contactEmail"> </a>email</td>
<td style="text-align:center"><code>string</code></td>
<td>The email address of the contact person/organization. MUST be in the format of an email address.</td>
</tr>
</tbody>
</table>
<p>This object MAY be extended with <a href="#specificationExtensions">Specification Extensions</a>.</p>
</section><section><h4>Contact Object Example</h4>
<pre class="nohighlight"><code>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"API Support"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"http://www.example.com/support"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"email"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"support@example.com"</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<pre class="nohighlight"><code>
<span class="hljs-attr">name:</span> <span class="hljs-string">API</span> <span class="hljs-string">Support</span>
<span class="hljs-attr">url:</span> <span class="hljs-string">http://www.example.com/support</span>
<span class="hljs-attr">email:</span> <span class="hljs-string">support@example.com</span>
</code></pre>
<p><a id="licenseObject"></a></section></section><section><h3><span>License Object</span></h3></p>
<p>License information for the exposed API.</p>
<section><h4>Fixed Fields</h4>
<table>
<thead>
<tr>
<th>Field Name</th>
<th style="text-align:center">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a id="licenseName"> </a>name</td>
<td style="text-align:center"><code>string</code></td>
<td><strong>REQUIRED</strong>. The license name used for the API.</td>
</tr>
<tr>
<td><a id="licenseUrl"> </a>url</td>
<td style="text-align:center"><code>string</code></td>
<td>A URL to the license used for the API. MUST be in the format of a URL.</td>
</tr>
</tbody>
</table>
<p>This object MAY be extended with <a href="#specificationExtensions">Specification Extensions</a>.</p>
</section><section><h4>License Object Example</h4>
<pre class="nohighlight"><code>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Apache 2.0"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"https://www.apache.org/licenses/LICENSE-2.0.html"</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<pre class="nohighlight"><code>
<span class="hljs-attr">name:</span> <span class="hljs-string">Apache</span> <span class="hljs-number">2.0</span>
<span class="hljs-attr">url:</span> <span class="hljs-string">https://www.apache.org/licenses/LICENSE-2.0.html</span>
</code></pre>
<p><a id="serverObject"></a></section></section><section><h3><span>Server Object</span></h3></p>
<p>An object representing a Server.</p>
<section><h4>Fixed Fields</h4>
<table>
<thead>
<tr>
<th>Field Name</th>
<th style="text-align:center">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a id="serverUrl"> </a>url</td>
<td style="text-align:center"><code>string</code></td>
<td><strong>REQUIRED</strong>. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in <code>{</code>brackets<code>}</code>.</td>
</tr>
<tr>
<td><a id="serverDescription"> </a>description</td>
<td style="text-align:center"><code>string</code></td>
<td>An optional string describing the host designated by the URL. <a href="https://spec.commonmark.org/">CommonMark syntax</a> MAY be used for rich text representation.</td>
</tr>
<tr>
<td><a id="serverVariables"> </a>variables</td>
<td style="text-align:center">Map[<code>string</code>, <a href="#serverVariableObject">Server Variable Object</a>]</td>
<td>A map between a variable name and its value. The value is used for substitution in the server’s URL template.</td>
</tr>
</tbody>
</table>
<p>This object MAY be extended with <a href="#specificationExtensions">Specification Extensions</a>.</p>
</section><section><h4>Server Object Example</h4>
<p>A single server would be described as:</p>
<pre class="nohighlight"><code>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"https://development.gigantic-server.com/v1"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Development server"</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<pre class="nohighlight"><code>
<span class="hljs-attr">url:</span> <span class="hljs-string">https://development.gigantic-server.com/v1</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">Development</span> <span class="hljs-string">server</span>
</code></pre>
<p>The following shows how multiple servers can be described, for example, at the OpenAPI Object’s <a href="#oasServers"><code>servers</code></a>:</p>
<pre class="nohighlight"><code>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"servers"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"https://development.gigantic-server.com/v1"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Development server"</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"https://staging.gigantic-server.com/v1"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Staging server"</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"https://api.gigantic-server.com/v1"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Production server"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">]</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<pre class="nohighlight"><code>
<span class="hljs-attr">servers:</span>
<span class="hljs-bullet">-</span> <span class="hljs-attr">url:</span> <span class="hljs-string">https://development.gigantic-server.com/v1</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">Development</span> <span class="hljs-string">server</span>
<span class="hljs-bullet">-</span> <span class="hljs-attr">url:</span> <span class="hljs-string">https://staging.gigantic-server.com/v1</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">Staging</span> <span class="hljs-string">server</span>
<span class="hljs-bullet">-</span> <span class="hljs-attr">url:</span> <span class="hljs-string">https://api.gigantic-server.com/v1</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">Production</span> <span class="hljs-string">server</span>
</code></pre>
<p>The following shows how variables can be used for a server configuration:</p>
<pre class="nohighlight"><code>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"servers"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"https://{username}.gigantic-server.com:{port}/{basePath}"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"The production API server"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"variables"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"username"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"default"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"demo"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"this value is assigned by the service provider, in this example `gigantic-server.com`"</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"port"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"enum"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
<span class="hljs-string">"8443"</span><span class="hljs-punctuation">,</span>
<span class="hljs-string">"443"</span>
<span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"default"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"8443"</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"basePath"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"default"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"v2"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">]</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<pre class="nohighlight"><code>
<span class="hljs-attr">servers:</span>
<span class="hljs-bullet">-</span> <span class="hljs-attr">url:</span> <span class="hljs-string">https://{username}.gigantic-server.com:{port}/{basePath}</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">The</span> <span class="hljs-string">production</span> <span class="hljs-string">API</span> <span class="hljs-string">server</span>
<span class="hljs-attr">variables:</span>
<span class="hljs-attr">username:</span>
<span class="hljs-comment"># note! no enum here means it is an open value</span>
<span class="hljs-attr">default:</span> <span class="hljs-string">demo</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">this</span> <span class="hljs-string">value</span> <span class="hljs-string">is</span> <span class="hljs-string">assigned</span> <span class="hljs-string">by</span> <span class="hljs-string">the</span> <span class="hljs-string">service</span> <span class="hljs-string">provider,</span> <span class="hljs-string">in</span> <span class="hljs-string">this</span> <span class="hljs-string">example</span> <span class="hljs-string">`gigantic-server.com`</span>
<span class="hljs-attr">port:</span>
<span class="hljs-attr">enum:</span>
<span class="hljs-bullet">-</span> <span class="hljs-string">'8443'</span>
<span class="hljs-bullet">-</span> <span class="hljs-string">'443'</span>
<span class="hljs-attr">default:</span> <span class="hljs-string">'8443'</span>
<span class="hljs-attr">basePath:</span>
<span class="hljs-comment"># open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2`</span>
<span class="hljs-attr">default:</span> <span class="hljs-string">v2</span>
</code></pre>
<p><a id="serverVariableObject"></a></section></section><section><h3><span>Server Variable Object</span></h3></p>
<p>An object representing a Server Variable for server URL template substitution.</p>
<section><h4>Fixed Fields</h4>
<table>
<thead>
<tr>
<th>Field Name</th>
<th style="text-align:center">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a id="serverVariableEnum"> </a>enum</td>
<td style="text-align:center">[<code>string</code>]</td>
<td>An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.</td>
</tr>
<tr>
<td><a id="serverVariableDefault"> </a>default</td>
<td style="text-align:center"><code>string</code></td>
<td><strong>REQUIRED</strong>. The default value to use for substitution, which SHALL be sent if an alternate value is <em>not</em> supplied. Note this behavior is different than the <a href="#schemaObject">Schema Object’s</a> treatment of default values, because in those cases parameter values are optional. If the <a href="#serverVariableEnum"><code>enum</code></a> is defined, the value SHOULD exist in the enum’s values.</td>
</tr>
<tr>
<td><a id="serverVariableDescription"> </a>description</td>
<td style="text-align:center"><code>string</code></td>
<td>An optional description for the server variable. <a href="https://spec.commonmark.org/">CommonMark syntax</a> MAY be used for rich text representation.</td>
</tr>
</tbody>
</table>
<p>This object MAY be extended with <a href="#specificationExtensions">Specification Extensions</a>.</p>
<p><a id="componentsObject"></a></section></section><section><h3><span>Components Object</span></h3></p>
<p>Holds a set of reusable objects for different aspects of the OAS.
All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.</p>
<section><h4>Fixed Fields</h4>
<table>
<thead>
<tr>
<th>Field Name</th>
<th style="text-align:left">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a id="componentsSchemas"> </a> schemas</td>
<td style="text-align:left">Map[<code>string</code>, <a href="#schemaObject">Schema Object</a> | <a href="#referenceObject">Reference Object</a>]</td>
<td>An object to hold reusable <a href="#schemaObject">Schema Objects</a>.</td>
</tr>
<tr>
<td><a id="componentsResponses"> </a> responses</td>
<td style="text-align:left">Map[<code>string</code>, <a href="#responseObject">Response Object</a> | <a href="#referenceObject">Reference Object</a>]</td>
<td>An object to hold reusable <a href="#responseObject">Response Objects</a>.</td>
</tr>
<tr>
<td><a id="componentsParameters"> </a> parameters</td>
<td style="text-align:left">Map[<code>string</code>, <a href="#parameterObject">Parameter Object</a> | <a href="#referenceObject">Reference Object</a>]</td>
<td>An object to hold reusable <a href="#parameterObject">Parameter Objects</a>.</td>
</tr>
<tr>
<td><a id="componentsExamples"> </a> examples</td>
<td style="text-align:left">Map[<code>string</code>, <a href="#exampleObject">Example Object</a> | <a href="#referenceObject">Reference Object</a>]</td>
<td>An object to hold reusable <a href="#exampleObject">Example Objects</a>.</td>
</tr>
<tr>
<td><a id="componentsRequestBodies"> </a> requestBodies</td>
<td style="text-align:left">Map[<code>string</code>, <a href="#requestBodyObject">Request Body Object</a> | <a href="#referenceObject">Reference Object</a>]</td>
<td>An object to hold reusable <a href="#requestBodyObject">Request Body Objects</a>.</td>
</tr>
<tr>
<td><a id="componentsHeaders"> </a> headers</td>
<td style="text-align:left">Map[<code>string</code>, <a href="#headerObject">Header Object</a> | <a href="#referenceObject">Reference Object</a>]</td>
<td>An object to hold reusable <a href="#headerObject">Header Objects</a>.</td>
</tr>
<tr>
<td><a id="componentsSecuritySchemes"> </a> securitySchemes</td>
<td style="text-align:left">Map[<code>string</code>, <a href="#securitySchemeObject">Security Scheme Object</a> | <a href="#referenceObject">Reference Object</a>]</td>
<td>An object to hold reusable <a href="#securitySchemeObject">Security Scheme Objects</a>.</td>
</tr>
<tr>
<td><a id="componentsLinks"> </a> links</td>
<td style="text-align:left">Map[<code>string</code>, <a href="#linkObject">Link Object</a> | <a href="#referenceObject">Reference Object</a>]</td>
<td>An object to hold reusable <a href="#linkObject">Link Objects</a>.</td>
</tr>
<tr>
<td><a id="componentsCallbacks"> </a> callbacks</td>
<td style="text-align:left">Map[<code>string</code>, <a href="#callbackObject">Callback Object</a> | <a href="#referenceObject">Reference Object</a>]</td>
<td>An object to hold reusable <a href="#callbackObject">Callback Objects</a>.</td>
</tr>
</tbody>
</table>
<p>This object MAY be extended with <a href="#specificationExtensions">Specification Extensions</a>.</p>
<p>All the fixed fields declared above are objects that MUST use keys that match the regular expression: <code>^[a-zA-Z0-9\.\-_]+$</code>.</p>
<p>Field Name Examples:</p>
<pre class="highlight "><code>
User
User_1
User_Name
user-name
my.org.User
</code></pre>
</section><section><h4>Components Object Example</h4>
<pre class="nohighlight"><code>
<span class="hljs-attr">"components"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"schemas"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"GeneralError"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"object"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"properties"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"code"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"integer"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"format"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"int32"</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"message"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"string"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"Category"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"object"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"properties"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"id"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"integer"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"format"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"int64"</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"string"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"Tag"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"object"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"properties"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"id"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"integer"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"format"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"int64"</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"string"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"parameters"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"skipParam"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"skip"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"in"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"query"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"number of items to skip"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"required"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">true</span></span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"schema"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"integer"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"format"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"int32"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"limitParam"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"limit"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"in"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"query"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"max records to return"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"required"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">true</span></span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"schema"</span> <span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"integer"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"format"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"int32"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"responses"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"NotFound"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Entity not found."</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"IllegalInput"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Illegal input for operation."</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"GeneralError"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"General Error"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"content"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"application/json"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"schema"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"$ref"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"#/components/schemas/GeneralError"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"securitySchemes"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"api_key"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"apiKey"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"api_key"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"in"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"header"</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"petstore_auth"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"oauth2"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"flows"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"implicit"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"authorizationUrl"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"http://example.org/api/oauth/dialog"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"scopes"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"write:pets"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"modify pets in your account"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"read:pets"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"read your pets"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<pre class="nohighlight"><code>
<span class="hljs-attr">components:</span>
<span class="hljs-attr">schemas:</span>
<span class="hljs-attr">GeneralError:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">object</span>
<span class="hljs-attr">properties:</span>
<span class="hljs-attr">code:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">integer</span>
<span class="hljs-attr">format:</span> <span class="hljs-string">int32</span>
<span class="hljs-attr">message:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">string</span>
<span class="hljs-attr">Category:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">object</span>
<span class="hljs-attr">properties:</span>
<span class="hljs-attr">id:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">integer</span>
<span class="hljs-attr">format:</span> <span class="hljs-string">int64</span>
<span class="hljs-attr">name:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">string</span>
<span class="hljs-attr">Tag:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">object</span>
<span class="hljs-attr">properties:</span>
<span class="hljs-attr">id:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">integer</span>
<span class="hljs-attr">format:</span> <span class="hljs-string">int64</span>
<span class="hljs-attr">name:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">string</span>
<span class="hljs-attr">parameters:</span>
<span class="hljs-attr">skipParam:</span>
<span class="hljs-attr">name:</span> <span class="hljs-string">skip</span>
<span class="hljs-attr">in:</span> <span class="hljs-string">query</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">number</span> <span class="hljs-string">of</span> <span class="hljs-string">items</span> <span class="hljs-string">to</span> <span class="hljs-string">skip</span>
<span class="hljs-attr">required:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">schema:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">integer</span>
<span class="hljs-attr">format:</span> <span class="hljs-string">int32</span>
<span class="hljs-attr">limitParam:</span>
<span class="hljs-attr">name:</span> <span class="hljs-string">limit</span>
<span class="hljs-attr">in:</span> <span class="hljs-string">query</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">max</span> <span class="hljs-string">records</span> <span class="hljs-string">to</span> <span class="hljs-string">return</span>
<span class="hljs-attr">required:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">schema:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">integer</span>
<span class="hljs-attr">format:</span> <span class="hljs-string">int32</span>
<span class="hljs-attr">responses:</span>
<span class="hljs-attr">NotFound:</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">Entity</span> <span class="hljs-string">not</span> <span class="hljs-string">found.</span>
<span class="hljs-attr">IllegalInput:</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">Illegal</span> <span class="hljs-string">input</span> <span class="hljs-string">for</span> <span class="hljs-string">operation.</span>
<span class="hljs-attr">GeneralError:</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">General</span> <span class="hljs-string">Error</span>
<span class="hljs-attr">content:</span>
<span class="hljs-attr">application/json:</span>
<span class="hljs-attr">schema:</span>
<span class="hljs-string">$ref:</span> <span class="hljs-string">'#/components/schemas/GeneralError'</span>
<span class="hljs-attr">securitySchemes:</span>
<span class="hljs-attr">api_key:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">apiKey</span>
<span class="hljs-attr">name:</span> <span class="hljs-string">api_key</span>
<span class="hljs-attr">in:</span> <span class="hljs-string">header</span>
<span class="hljs-attr">petstore_auth:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">oauth2</span>
<span class="hljs-attr">flows:</span>
<span class="hljs-attr">implicit:</span>
<span class="hljs-attr">authorizationUrl:</span> <span class="hljs-string">http://example.org/api/oauth/dialog</span>
<span class="hljs-attr">scopes:</span>
<span class="hljs-attr">write:pets:</span> <span class="hljs-string">modify</span> <span class="hljs-string">pets</span> <span class="hljs-string">in</span> <span class="hljs-string">your</span> <span class="hljs-string">account</span>
<span class="hljs-attr">read:pets:</span> <span class="hljs-string">read</span> <span class="hljs-string">your</span> <span class="hljs-string">pets</span>
</code></pre>
<p><a id="pathsObject"></a></section></section><section><h3><span>Paths Object</span></h3></p>
<p>Holds the relative paths to the individual endpoints and their operations.
The path is appended to the URL from the <a href="#serverObject"><code>Server Object</code></a> in order to construct the full URL. The Paths MAY be empty, due to <a href="#securityFiltering">ACL constraints</a>.</p>
<section><h4>Patterned Fields</h4>
<table>
<thead>
<tr>
<th>Field Pattern</th>
<th style="text-align:center">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a id="pathsPath"> </a>/{path}</td>
<td style="text-align:center"><a href="#pathItemObject">Path Item Object</a></td>
<td>A relative path to an individual endpoint. The field name MUST begin with a forward slash (<code>/</code>). The path is <strong>appended</strong> (no relative URL resolution) to the expanded URL from the <a href="#serverObject"><code>Server Object</code></a>’s <code>url</code> field in order to construct the full URL. <a href="#pathTemplating">Path templating</a> is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it’s up to the tooling to decide which one to use.</td>
</tr>
</tbody>
</table>
<p>This object MAY be extended with <a href="#specificationExtensions">Specification Extensions</a>.</p>
</section><section><h4>Path Templating Matching</h4>
<p>Assuming the following paths, the concrete definition, <code>/pets/mine</code>, will be matched first if used:</p>
<pre class="highlight "><code>
/pets/{petId}
/pets/mine
</code></pre>
<p>The following paths are considered identical and invalid:</p>
<pre class="highlight "><code>
/pets/{petId}
/pets/{name}
</code></pre>
<p>The following may lead to ambiguous resolution:</p>
<pre class="highlight "><code>
/{entity}/me
/books/{id}
</code></pre>
</section><section><h4>Paths Object Example</h4>
<pre class="nohighlight"><code>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"/pets"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"get"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Returns all pets from the system that the user has access to"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"responses"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"200"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"A list of pets."</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"content"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"application/json"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"schema"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"array"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"items"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"$ref"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"#/components/schemas/pet"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<pre class="nohighlight"><code>
<span class="hljs-string">/pets:</span>
<span class="hljs-attr">get:</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">Returns</span> <span class="hljs-string">all</span> <span class="hljs-string">pets</span> <span class="hljs-string">from</span> <span class="hljs-string">the</span> <span class="hljs-string">system</span> <span class="hljs-string">that</span> <span class="hljs-string">the</span> <span class="hljs-string">user</span> <span class="hljs-string">has</span> <span class="hljs-string">access</span> <span class="hljs-string">to</span>
<span class="hljs-attr">responses:</span>
<span class="hljs-attr">'200':</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">A</span> <span class="hljs-string">list</span> <span class="hljs-string">of</span> <span class="hljs-string">pets.</span>
<span class="hljs-attr">content:</span>
<span class="hljs-attr">application/json:</span>
<span class="hljs-attr">schema:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">array</span>
<span class="hljs-attr">items:</span>
<span class="hljs-string">$ref:</span> <span class="hljs-string">'#/components/schemas/pet'</span>
</code></pre>
<p><a id="pathItemObject"></a></section></section><section><h3><span>Path Item Object</span></h3></p>
<p>Describes the operations available on a single path.
A Path Item MAY be empty, due to <a href="#securityFiltering">ACL constraints</a>.
The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.</p>
<section><h4>Fixed Fields</h4>
<table>
<thead>
<tr>
<th>Field Name</th>
<th style="text-align:center">Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a id="pathItemRef"> </a>$ref</td>
<td style="text-align:center"><code>string</code></td>
<td>Allows for an external definition of this path item. The referenced structure MUST be in the format of a <a href="#pathItemObject">Path Item Object</a>. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined.</td>
</tr>
<tr>
<td><a id="pathItemSummary"> </a>summary</td>
<td style="text-align:center"><code>string</code></td>
<td>An optional, string summary, intended to apply to all operations in this path.</td>
</tr>
<tr>
<td><a id="pathItemDescription"> </a>description</td>
<td style="text-align:center"><code>string</code></td>
<td>An optional, string description, intended to apply to all operations in this path. <a href="https://spec.commonmark.org/">CommonMark syntax</a> MAY be used for rich text representation.</td>
</tr>
<tr>
<td><a id="pathItemGet"> </a>get</td>
<td style="text-align:center"><a href="#operationObject">Operation Object</a></td>
<td>A definition of a GET operation on this path.</td>
</tr>
<tr>
<td><a id="pathItemPut"> </a>put</td>
<td style="text-align:center"><a href="#operationObject">Operation Object</a></td>
<td>A definition of a PUT operation on this path.</td>
</tr>
<tr>
<td><a id="pathItemPost"> </a>post</td>
<td style="text-align:center"><a href="#operationObject">Operation Object</a></td>
<td>A definition of a POST operation on this path.</td>
</tr>
<tr>
<td><a id="pathItemDelete"> </a>delete</td>
<td style="text-align:center"><a href="#operationObject">Operation Object</a></td>
<td>A definition of a DELETE operation on this path.</td>
</tr>
<tr>
<td><a id="pathItemOptions"> </a>options</td>
<td style="text-align:center"><a href="#operationObject">Operation Object</a></td>
<td>A definition of a OPTIONS operation on this path.</td>
</tr>
<tr>
<td><a id="pathItemHead"> </a>head</td>
<td style="text-align:center"><a href="#operationObject">Operation Object</a></td>
<td>A definition of a HEAD operation on this path.</td>
</tr>
<tr>
<td><a id="pathItemPatch"> </a>patch</td>
<td style="text-align:center"><a href="#operationObject">Operation Object</a></td>
<td>A definition of a PATCH operation on this path.</td>
</tr>
<tr>
<td><a id="pathItemTrace"> </a>trace</td>
<td style="text-align:center"><a href="#operationObject">Operation Object</a></td>
<td>A definition of a TRACE operation on this path.</td>
</tr>
<tr>
<td><a id="pathItemServers"> </a>servers</td>
<td style="text-align:center">[<a href="#serverObject">Server Object</a>]</td>
<td>An alternative <code>server</code> array to service all operations in this path.</td>
</tr>
<tr>
<td><a id="pathItemParameters"> </a>parameters</td>
<td style="text-align:center">[<a href="#parameterObject">Parameter Object</a> | <a href="#referenceObject">Reference Object</a>]</td>
<td>A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a <a href="#parameterName">name</a> and <a href="#parameterIn">location</a>. The list can use the <a href="#referenceObject">Reference Object</a> to link to parameters that are defined at the <a href="#componentsParameters">OpenAPI Object’s components/parameters</a>.</td>
</tr>
</tbody>
</table>
<p>This object MAY be extended with <a href="#specificationExtensions">Specification Extensions</a>.</p>
</section><section><h4>Path Item Object Example</h4>
<pre class="nohighlight"><code>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"get"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Returns pets based on ID"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"summary"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Find pets by ID"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"operationId"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"getPetsById"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"responses"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"200"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"pet response"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"content"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"*/*"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"schema"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"array"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"items"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"$ref"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"#/components/schemas/Pet"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"default"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"error payload"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"content"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"text/html"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"schema"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"$ref"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"#/components/schemas/ErrorModel"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"parameters"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
<span class="hljs-punctuation">{</span>
<span class="hljs-attr">"name"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"id"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"in"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"path"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"description"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"ID of pet to use"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"required"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">true</span></span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"schema"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"array"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"items"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"type"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"string"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"style"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"simple"</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">]</span>
<span class="hljs-punctuation">}</span>
</code></pre>
<pre class="nohighlight"><code>
<span class="hljs-attr">get:</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">Returns</span> <span class="hljs-string">pets</span> <span class="hljs-string">based</span> <span class="hljs-string">on</span> <span class="hljs-string">ID</span>
<span class="hljs-attr">summary:</span> <span class="hljs-string">Find</span> <span class="hljs-string">pets</span> <span class="hljs-string">by</span> <span class="hljs-string">ID</span>
<span class="hljs-attr">operationId:</span> <span class="hljs-string">getPetsById</span>
<span class="hljs-attr">responses:</span>
<span class="hljs-attr">'200':</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">pet</span> <span class="hljs-string">response</span>
<span class="hljs-attr">content:</span>
<span class="hljs-string">'*/*'</span> <span class="hljs-string">:</span>
<span class="hljs-attr">schema:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">array</span>
<span class="hljs-attr">items:</span>
<span class="hljs-string">$ref:</span> <span class="hljs-string">'#/components/schemas/Pet'</span>
<span class="hljs-attr">default:</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">error</span> <span class="hljs-string">payload</span>
<span class="hljs-attr">content:</span>
<span class="hljs-attr">'text/html':</span>
<span class="hljs-attr">schema:</span>
<span class="hljs-string">$ref:</span> <span class="hljs-string">'#/components/schemas/ErrorModel'</span>
<span class="hljs-attr">parameters:</span>
<span class="hljs-bullet">-</span> <span class="hljs-attr">name:</span> <span class="hljs-string">id</span>
<span class="hljs-attr">in:</span> <span class="hljs-string">path</span>
<span class="hljs-attr">description:</span> <span class="hljs-string">ID</span> <span class="hljs-string">of</span> <span class="hljs-string">pet</span> <span class="hljs-string">to</span> <span class="hljs-string">use</span>
<span class="hljs-attr">required:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">schema:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">array</span>
<span class="hljs-attr">items:</span>
<span class="hljs-attr">type:</span> <span class="hljs-string">string</span>
<span class="hljs-attr">style:</span> <span class="hljs-string">simple</span>
</code></pre>
<p><a id="operationObject"></a></section></section><section><h3><span>Operation Object</span></h3></p>
<p>Describes a single API operation on a path.</p>
<section><h4>Fixed Fields</h4>
<table>
<thead>
<tr>
<th>Field Name</th>
<th style="text-align:center">Type</th>