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
I did run aspell over this (ignoring a lot of words ... it looks like there isn't a markdown filter yet for it).
(Omitted some fixes which were noted as unnecessary by @webron.)
Copy file name to clipboardExpand all lines: versions/3.0.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -116,7 +116,7 @@ While the API is described using JSON it does not impose a JSON input/output to
116
116
All field names in the specification are **case sensitive**.
117
117
118
118
The schema exposes two types of fields.
119
-
Fixed fields, which have a declared name, and Patterned fields, which declare a regex pattern for the field name.
119
+
Fixed fields, which have a declared name, and Patterned fields, which declare a regular expression pattern for the field name.
120
120
Patterned fields can have multiple occurrences as long as each has a unique name.
121
121
122
122
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:
@@ -1138,7 +1138,7 @@ schema:
1138
1138
type: string
1139
1139
format: base64
1140
1140
1141
-
# content transfered in binary (octet-stream):
1141
+
# content transferred in binary (octet-stream):
1142
1142
schema:
1143
1143
type: string
1144
1144
format: binary
@@ -1188,16 +1188,16 @@ requestBody:
1188
1188
type: string
1189
1189
format: uuid
1190
1190
address:
1191
-
# complex types are stringified to support rfc1866
1191
+
# complex types are stringified to support RFC1866
1192
1192
type: object
1193
1193
properties: {}
1194
1194
```
1195
1195
1196
-
Note that in the above example, the contents in the `requestBody` MUST be stringified per RFC1866 when being passed to the server. In addition, the `address` field complex object will be strigified as well.
1196
+
Note that in the above example, the contents in the `requestBody` MUST be stringified per RFC1866 when being passed to the server. In addition, the `address` field complex object will be stringified as well.
1197
1197
1198
1198
When passing complex objects in the `x-www-form-urlencoded` content type, the default serialization strategy of such properties is described in the `parameterContent` section as `form`.
1199
1199
1200
-
##### Special Considerations for `mutlipart` content
1200
+
##### Special Considerations for `multipart` content
1201
1201
1202
1202
It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is required to define the input parameters to the operation when using `multipart` content. This allows complex structures as well as supports mechanisms for multiple file uploads.
1203
1203
@@ -1240,7 +1240,7 @@ requestBody:
1240
1240
type: '#/definitions/Address'
1241
1241
```
1242
1242
1243
-
In scenarios where more control is needed over the Content-Type for `multipart` request bodies, an `encoding` attribute is introduced. This attribute is _only_ applicable to `mulitpart/*` and `x-www-form-urlencoded` request bodies.
1243
+
In scenarios where more control is needed over the Content-Type for `multipart` request bodies, an `encoding` attribute is introduced. This attribute is _only_ applicable to `multipart/*` and `x-www-form-urlencoded` request bodies.
1244
1244
1245
1245
#### <a name="encodingObject"></a>Encoding Object
1246
1246
@@ -1528,7 +1528,7 @@ This object can be extended with [Specification Extensions](#specificationExtens
1528
1528
1529
1529
The key used to identify the callback object is a variable expression that can be evaluated in the context of a runtime HTTP request/response to identify the URL to be used for the callback request.
1530
1530
A simple example might be `$request.body#/url`.
1531
-
However, using [variable substition](#variableSubstition) syntax the complete HTTP message can be accessed.
1531
+
However, using [variable substitution](#variableSubstitution) syntax the complete HTTP message can be accessed.
1532
1532
This includes accessing any part of a body that can be accessed using a JSON Pointer [RFC6901](https://tools.ietf.org/html/rfc6901).
1533
1533
1534
1534
@@ -1704,7 +1704,7 @@ Because of the potential for name clashes, consider the `href` syntax as the pre
Payload values are only available in parseable response payloads which match the advertised media-type and for media-types that can be referenced using a JSON Pointer fragment Id.
1707
+
Payload values are only available in parsable response payloads which match the advertised media-type and for media-types that can be referenced using a JSON Pointer fragment Id.
1708
1708
In all cases, if a value does _not_ exist, the parameter will be considered a `null` value (as opposed to an empty value) and _not_ passed as a parameter to the linked resource.
1709
1709
In cases where a value is required, and a parameter is not supplied, the client MAY choose to not follow the link definition.
In all cases, _variables_ from request and responses may be substituted for link generation.
1752
1752
The table below provides examples of variable expressions and examples of their use in a value:
1753
1753
@@ -3385,8 +3385,8 @@ Field Name | Type | Description
3385
3385
---|:---:|---|---
3386
3386
<a name="oauthFlowImplicit"></a>implicit| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Implicit flow
3387
3387
<a name="oauthFlowPassword"></a>password| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Resource Owner Password flow
3388
-
<a name="oauthFlowClientCredentials"></a>clientCredentials| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenApi 2.0.
3389
-
<a name="oauthFlowAuthorizationCode"></a>authorizationCode| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenApi 2.0.
3388
+
<a name="oauthFlowClientCredentials"></a>clientCredentials| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0.
3389
+
<a name="oauthFlowAuthorizationCode"></a>authorizationCode| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0.
3390
3390
3391
3391
This object can be extended with [Specification Extensions](#specificationExtensions).
0 commit comments