From 6c1d792b82bd817f8a229292bedc394461654c7b Mon Sep 17 00:00:00 2001 From: Matatjahu Date: Tue, 10 May 2022 16:23:22 +0200 Subject: [PATCH] fix external docs types --- spec/asyncapi.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/asyncapi.md b/spec/asyncapi.md index fe619662f..d11cef4c8 100644 --- a/spec/asyncapi.md +++ b/spec/asyncapi.md @@ -176,7 +176,7 @@ Field Name | Type | Description operations | [Operations Object](#operationsObject) | The operations this [application](#definitionsApplication) MUST implement. components | [Components Object](#componentsObject) | An element to hold various reusable objects for the specification. Everything that is defined inside this object represents a resource that MAY or MAY NOT be used in the rest of the document and MAY or MAY NOT be used by the implemented [Application](#definitionsApplication). tags | [[Tags Object](#tagsObject) \| [Reference Object](#referenceObject)] | A list of tags used by the specification with additional metadata. Each tag name in the list MUST be unique. -externalDocs | [[External Documentation Object](#externalDocumentationObject) \| [Reference Object](#referenceObject)] | Additional external documentation. +externalDocs | [External Documentation Object](#externalDocumentationObject) \| [Reference Object](#referenceObject) | Additional external documentation. This object MAY be extended with [Specification Extensions](#specificationExtensions). @@ -1450,7 +1450,7 @@ Field Name | Type | Description ---|:---:|--- name | `string` | **REQUIRED.** The name of the tag. description | `string` | A short description for the tag. [CommonMark syntax](https://spec.commonmark.org/) can be used for rich text representation. -externalDocs | [[External Documentation Object](#externalDocumentationObject) \| [Reference Object](#referenceObject)] | Additional external documentation for this tag. +externalDocs | [External Documentation Object](#externalDocumentationObject) \| [Reference Object](#referenceObject) | Additional external documentation for this tag. This object MAY be extended with [Specification Extensions](#specificationExtensions). @@ -1846,7 +1846,7 @@ In addition to the JSON Schema fields, the following AsyncAPI vocabulary fields Field Name | Type | Description ---|:---:|--- discriminator | `string` | Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the `required` property list. When used, the value MUST be the name of this schema or any schema that inherits it. See [Composition and Inheritance](#schemaComposition) for more details. -externalDocs | [[External Documentation Object](#externalDocumentationObject) \| [Reference Object](#referenceObject)] | Additional external documentation for this schema. +externalDocs | [External Documentation Object](#externalDocumentationObject) \| [Reference Object](#referenceObject) | Additional external documentation for this schema. deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. This object MAY be extended with [Specification Extensions](#specificationExtensions).