Skip to content

Commit

Permalink
Add webhooks as a top level element to the spec
Browse files Browse the repository at this point in the history
  • Loading branch information
lornajane committed Jan 14, 2020
1 parent e3c236a commit 168b0ec
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion versions/3.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ An OpenAPI definition can then be used by documentation generation tools to disp
- [Path Templating](#pathTemplating)
- [Media Types](#mediaTypes)
- [HTTP Status Codes](#httpCodes)
- [Specification](#specification)
- [Specification](#specification)
- [Versions](#versions)
- [Format](#format)
- [Document Structure](#documentStructure)
Expand Down Expand Up @@ -197,6 +197,7 @@ Field Name | Type | Description
<a name="oasSecurity"></a>security | [[Security Requirement Object](#securityRequirementObject)] | A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition.
<a name="oasTags"></a>tags | [[Tag Object](#tagObject)] | A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the [Operation Object](#operationObject) must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.
<a name="oasExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation.
<a name="oasWebhooks"></a>webhooks | Map[`string`, [Path Item Object](#pathItemObject)] | The incoming webhooks that may be received as part of this API. The key name is a unique string to refer to each webhook, while the Path Item Object describes a request that may be initiated by the API provider and the expected responses.

This object MAY be extended with [Specification Extensions](#specificationExtensions).

Expand Down

0 comments on commit 168b0ec

Please sign in to comment.