Skip to content

Commit 34d1aec

Browse files
committed
plain language edits
1 parent 9036a04 commit 34d1aec

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

versions/3.0.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ The available status codes are defined by [RFC7231](http://tools.ietf.org/html/r
9696

9797
### Format
9898

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.
101101

102102
For example, if a field has an array value, the JSON array representation will be used:
103103

@@ -107,18 +107,18 @@ For example, if a field has an array value, the JSON array representation will b
107107
}
108108
```
109109

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.
111111

112112
All field names in the specification are **case sensitive**.
113113

114114
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.
115115

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.
117117

118118
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:
119119

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).
122122

123123
### <a name="fileStructure"></a>File Structure
124124

0 commit comments

Comments
 (0)