Skip to content

Commit c517e29

Browse files
author
Ron
authored
Merge pull request #1173 from krishahn/considerations-for-file-uploads-and-support-for-x-www-form-urlencoded-request-bodies
edit 'Considerations for file uploads' and 'Support for x-www-form-ur…
2 parents f31c83b + 5f97fc5 commit c517e29

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

versions/3.0.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1343,9 +1343,9 @@ application/json:
13431343
$ref: "#/components/examples/frog-example"
13441344
```
13451345

1346-
##### Considerations for file uploads
1346+
##### Considerations for File Uploads
13471347

1348-
In contrast with the 2.0 specification, describing `file` input/output content in OpenAPI is
1348+
In contrast with the 2.0 specification, `file` input/output content in OpenAPI is
13491349
described with the same semantics as any other schema type. Specifically:
13501350

13511351
```yaml
@@ -1360,9 +1360,9 @@ schema:
13601360
format: binary
13611361
```
13621362

1363-
Note that the above examples apply to either input payloads (i.e. file uploads) or response payloads.
1363+
These examples apply to either input payloads of file uploads or response payloads.
13641364

1365-
A `requestBody` example for submitting a file in a `POST` operation therefore may look like the following:
1365+
A `requestBody` for submitting a file in a `POST` operation may look like the following example:
13661366

13671367
```yaml
13681368
requestBody:
@@ -1388,7 +1388,7 @@ requestBody:
13881388
format: binary
13891389
```
13901390
1391-
##### Support for x-www-form-urlencoded request bodies
1391+
##### Support for x-www-form-urlencoded Request Bodies
13921392
13931393
To submit content using form url encoding via [RFC1866](https://tools.ietf.org/html/rfc1866), the following
13941394
definition may be used:
@@ -1409,7 +1409,7 @@ requestBody:
14091409
properties: {}
14101410
```
14111411
1412-
Note that in the above example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when being passed to the server. In addition, the `address` field complex object will be stringified as well.
1412+
In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified.
14131413

14141414
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`.
14151415

0 commit comments

Comments
 (0)