You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versions/3.0.4.md
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# OpenAPI Specification
2
2
3
-
####Version 3.0.4
3
+
## Version 3.0.4
4
4
5
5
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 [BCP 14](https://tools.ietf.org/html/bcp14)[RFC2119](https://tools.ietf.org/html/rfc2119)[RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here.
6
6
@@ -71,30 +71,30 @@ For extension registries and other specifications published by the OpenAPI Initi
71
71
72
72
## Definitions
73
73
74
-
#####<aname="oasDocument"></a>OpenAPI Description
74
+
### <aname="oasDocument"></a>OpenAPI Description
75
75
76
76
An OpenAPI Description (OAD) formally describes the surface of an API and its semantics. It is composed of an [entry document](#documentStructure) and any/all of its referenced documents. An OAD uses and conforms to the OpenAPI Specification.
77
77
78
-
#####<aname="definitionsSchema"></a>Schema
78
+
### <aname="definitionsSchema"></a>Schema
79
79
80
80
A "schema" is a formal description of syntax and structure.
81
81
This document serves as the [schema](#schema) for the OpenAPI Specification format; a non-authoritative JSON Schema based on this document is also provided on [spec.openapis.org](https://spec.openapis.org) for informational purposes.
82
82
This specification also _uses_ schemas in the form of the [Schema Object](#schemaObject).
83
83
84
-
#####<aname="pathTemplating"></a>Path Templating
84
+
### <aname="pathTemplating"></a>Path Templating
85
85
86
86
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.
87
87
88
88
Each template expression in the path MUST correspond to a path parameter that is included in the [Path Item](#path-item-object) itself and/or in each of the Path Item's [Operations](#operation-object).
89
89
90
-
#####<aname="mediaTypes"></a>Media Types
90
+
### <aname="mediaTypes"></a>Media Types
91
91
92
92
Media type definitions are spread across several resources.
93
93
The media type definitions SHOULD be in compliance with [RFC6838](https://tools.ietf.org/html/rfc6838).
94
94
95
95
Some examples of possible media type definitions:
96
96
97
-
```
97
+
```text
98
98
text/plain; charset=utf-8
99
99
application/json
100
100
application/vnd.github+json
@@ -107,17 +107,17 @@ Some examples of possible media type definitions:
107
107
application/vnd.github.v3.patch
108
108
```
109
109
110
-
#####<aname="httpCodes"></a>HTTP Status Codes
110
+
### <aname="httpCodes"></a>HTTP Status Codes
111
111
112
112
The HTTP Status Codes are used to indicate the status of the executed operation.
113
113
Status codes SHOULD be selected from the available status codes registered in the [IANA Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).
114
114
115
-
#####<aname="httpAndCaseSensitivity"></a>HTTP and Case Sensitivity
115
+
### <aname="httpAndCaseSensitivity"></a>HTTP and Case Sensitivity
116
116
117
117
As most field names and values in the OpenAPI Specification are case-sensitive, this document endeavors to call out any case-insensitive names and values.
118
118
However, the case sensitivity of field names and values that map directly to HTTP concepts follow the case sensitivity rules of HTTP, even if this document does not make a note of every concept.
119
119
120
-
#####<aname="undefinedAndImplementationDefinedBehavior"></a>Undefined and Implementation-Defined Behavior
120
+
### <aname="undefinedAndImplementationDefinedBehavior"></a>Undefined and Implementation-Defined Behavior
121
121
122
122
This specification deems certain situations to have either _undefined_ or _implementation-defined_ behavior.
123
123
@@ -562,7 +562,7 @@ All the fixed fields declared above are objects that MUST use keys that match th
562
562
563
563
Field Name Examples:
564
564
565
-
```
565
+
```text
566
566
User
567
567
User_1
568
568
User_Name
@@ -761,21 +761,21 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
761
761
762
762
Assuming the following paths, the concrete definition, `/pets/mine`, will be matched first if used:
763
763
764
-
```
764
+
```text
765
765
/pets/{petId}
766
766
/pets/mine
767
767
```
768
768
769
769
The following paths are considered identical and invalid:
770
770
771
-
```
771
+
```text
772
772
/pets/{petId}
773
773
/pets/{name}
774
774
```
775
775
776
776
The following may lead to ambiguous resolution:
777
777
778
-
```
778
+
```text
779
779
/{entity}/me
780
780
/books/{id}
781
781
```
@@ -1175,7 +1175,7 @@ See [Appendix E](#percentEncodingAndFormMediaTypes) for a discussion of percent-
1175
1175
1176
1176
Assume a parameter named `color` has one of the following values:
1177
1177
1178
-
```
1178
+
```text
1179
1179
string -> "blue"
1180
1180
array -> ["blue","black","brown"]
1181
1181
object -> { "R": 100, "G": 200, "B": 150 }
@@ -2487,10 +2487,10 @@ The table below provides examples of runtime expressions and examples of their u
| HTTP Method |`$method`| The allowable values for the `$method` will be those for the HTTP operation. |
2490
-
| Requested media type |`$request.header.accept`|
2490
+
| Requested media type |`$request.header.accept`||
2491
2491
| Request parameter |`$request.path.id`| Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. |
2492
2492
| Request body property |`$request.body#/user/uuid`| In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. |
2493
-
| Request URL |`$url`|
2493
+
| Request URL |`$url`||
2494
2494
| Response value |`$response.body#/status`| In operations which return payloads, references may be made to portions of the response body or the entire body. |
2495
2495
| Response header |`$response.header.Server`| Single header values only are available |
0 commit comments