Skip to content

Commit ae658b1

Browse files
author
Ron
authored
Merge pull request #1176 from krishahn/responses-object
edit Responses Object
2 parents 1707d32 + c06f8b9 commit ae658b1

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

versions/3.0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1517,8 +1517,8 @@ requestBody:
15171517
A container for the expected responses of an operation.
15181518
The container maps a HTTP response code to the expected response.
15191519

1520-
It is not expected for the documentation to necessarily cover all possible HTTP response codes, since they may not be known in advance.
1521-
However, it is expected for the documentation to cover a successful operation response and any known errors.
1520+
The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance.
1521+
However, documentation is expected to cover a successful operation response and any known errors.
15221522

15231523
The `default` MAY be used as a default response object for all HTTP codes
15241524
that are not covered individually by the specification.
@@ -1529,7 +1529,7 @@ SHOULD be the response for a successful operation call.
15291529
##### Fixed Fields
15301530
Field Name | Type | Description
15311531
---|:---:|---
1532-
<a name="responsesDefault"></a>default | [Response Object](#responseObject) \| [Reference Object](#referenceObject) | The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses. [Reference Object](#referenceObject) can be used to link to a response that is defined at the [OpenAPI Object's components/responses](#componentsResponses) section.
1532+
<a name="responsesDefault"></a>default | [Response Object](#responseObject) \| [Reference Object](#referenceObject) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#referenceObject) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines.
15331533

15341534
##### Patterned Fields
15351535
Field Pattern | Type | Description

0 commit comments

Comments
 (0)