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-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -96,8 +96,8 @@ 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
+
The files describing the RESTful API in accordance with this specification consist of JSON objects and conform to the JSON standards. An OAS file written in
100
+
YAML, a superset of JSON, also complies with this specification.
101
101
102
102
For example, if a field has an array value, the JSON array representation will be used:
103
103
@@ -107,18 +107,18 @@ For example, if a field has an array value, the JSON array representation will b
107
107
}
108
108
```
109
109
110
-
While the API is described using JSON, it does not impose a JSON input/output to the API itself.
110
+
While the API is described using JSON, input to and output from the API is not required to be JSON.
111
111
112
112
All field names in the specification are **case sensitive**.
113
113
114
114
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
115
116
-
Patterned fields can have multiple occurrences as long as each has a unique name.
116
+
Multiple occurrences of patterned fields need to have unique names.
117
117
118
118
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
119
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)
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).
0 commit comments