Skip to content

Commit 92df7ca

Browse files
fix: typo spelling grammar (#2670)
* fix: typo spelling grammar * Update proposals/2019-07-17-Webhooks.md change ``request`` to ``requests`` Co-authored-by: Nate <[email protected]> Co-authored-by: Nate <[email protected]>
1 parent 4b1433d commit 92df7ca

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

proposals/2019-03-15-Alternative-Schema.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Values used to populate the Alternative Schema Object are required to come from
5757

5858
*** Note this is a placeholder registry. Don't take the values seriously. ***
5959

60-
Inital contents of the registry will include:
60+
Initial contents of the registry will include:
6161

6262
|Name |Link |Description |
6363
|--- | --- | --- |
@@ -69,5 +69,5 @@ This proposal makes use of the extensibility features of OpenAPI. All changes so
6969

7070
## Alternatives considered
7171

72-
Embedding non-JSON content in the OAS document would have imposed an unacceptable burden on tooling. Therefore, an extenal link was prefered. Considerable discussion was held over exactly how the links should be represented in the Schema Object. The selected option should support the greatest number of possible combinations of external schema that can be expressed with the OpenAPI schema language.
72+
Embedding non-JSON content in the OAS document would have imposed an unacceptable burden on tooling. Therefore, an external link was preferred. Considerable discussion was held over exactly how the links should be represented in the Schema Object. The selected option should support the greatest number of possible combinations of external schema that can be expressed with the OpenAPI schema language.
7373

proposals/2019-07-17-Webhooks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
## Introduction
2121

22-
Modern APIs often consist of two-way API traffic, but OpenAPI currently only supports some types of requests. Standard client-to-server API calls are well supported. Server-to-client callbacks are only supported if they are the result of an earlier API call and are documented by nesting under the path of that earlier call. Incoming HTTP reqests ("webhooks") cannot be described in the current version of OpenAPI if they are the result of subscription arranged outside of the scope of the API (e.g. by setting a callback URL in a web interface).
22+
Modern APIs often consist of two-way API traffic, but OpenAPI currently only supports some types of requests. Standard client-to-server API calls are well supported. Server-to-client callbacks are only supported if they are the result of an earlier API call and are documented by nesting under the path of that earlier call. Incoming HTTP requests ("webhooks") cannot be described in the current version of OpenAPI if they are the result of subscription arranged outside of the scope of the API (e.g. by setting a callback URL in a web interface).
2323

2424
## Motivation
2525

@@ -189,4 +189,4 @@ Adding a new top-level entry is not something to take lightly, however hopefully
189189

190190
## Alternatives considered
191191

192-
Another option is to add a special `path` that could contain the various webhooks using the exisiting `callback` syntax but existing tools which aren't expecting this special value may not handle it well, so this option was discounted.
192+
Another option is to add a special `path` that could contain the various webhooks using the existing `callback` syntax but existing tools which aren't expecting this special value may not handle it well, so this option was discounted.

proposals/2019-12-24-Overlays.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ This object contains identifying information about the [OpenAPI Overlay document
5252
Field Name | Type | Description
5353
---|:---:|---
5454
<a name="overlayTitle"></a>title | `string` | A human readable description of the purpose of the overlay.
55-
<a name="overlayVersion"></a>version | `string` | A version identifer for indicating changes to an overlay document.
55+
<a name="overlayVersion"></a>version | `string` | A version identifier for indicating changes to an overlay document.
5656

5757
#### <a name="updateObject"></a>Update Object
5858

0 commit comments

Comments
 (0)