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.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,8 +96,7 @@ The available status codes are defined by [RFC7231](http://tools.ietf.org/html/r
96
96
97
97
### Format
98
98
99
-
The files describing the RESTful API in accordance with this specification are represented as JSON objects and conform to the JSON standards.
100
-
YAML, being a superset of JSON, can be used as well to represent an OAS file.
99
+
An API description that conforms to the OpenAPI Specification is itself a JSON object, which may be represented either in JSON or YAML format.
101
100
102
101
For example, if a field has an array value, the JSON array representation will be used:
103
102
@@ -106,19 +105,18 @@ For example, if a field has an array value, the JSON array representation will b
106
105
"field": [...]
107
106
}
108
107
```
109
-
110
-
While the API is described using JSON, it does not impose a JSON input/output to the API itself.
111
-
112
108
All field names in the specification are **case sensitive**.
113
109
114
110
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.
115
111
116
-
Patterned fields can have multiple occurrences as long as each has a unique name.
112
+
Patterned fields MUST have unique names within the containing object.
117
113
118
114
In order to preserve the ability to round-trip between YAML and JSON formats, YAML version [1.2](http://www.yaml.org/spec/1.2/spec.html) is RECOMMENDED along with some additional constraints:
119
115
120
-
- Tags MUST be limited to those allowed by the [JSON Schema ruleset](http://www.yaml.org/spec/1.2/spec.html#id2803231)
121
-
- Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](http://yaml.org/spec/1.2/spec.html#id2802346)
116
+
- Tags MUST be limited to those allowed by the [JSON Schema ruleset](http://www.yaml.org/spec/1.2/spec.html#id2803231).
117
+
- Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](http://yaml.org/spec/1.2/spec.html#id2802346).
118
+
119
+
**Note:** While APIs are described by OpenAPI documents in YAML or JSON format, the API request and response bodies and other content are not required to be JSON or YAML.
0 commit comments