Skip to content

Commit

Permalink
fix: unify Message and MessageTrait examples description (#608)
Browse files Browse the repository at this point in the history
  • Loading branch information
char0n committed Sep 21, 2021
1 parent 88e2b08 commit 6887699
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion spec/asyncapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1220,7 +1220,7 @@ Field Name | Type | Description
<a name="messageTraitObjectTags"></a>tags | [Tags Object](#tagsObject) | A list of tags for API documentation control. Tags can be used for logical grouping of messages.
<a name="messageTraitObjectExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this message.
<a name="messageTraitObjectBindings"></a>bindings | [Message Bindings Object](#messageBindingsObject) \| [Reference Object](#referenceObject) | A map where the keys describe the name of the protocol and the values describe protocol-specific definitions for the message.
<a name="messageTraitObjectExamples"></a>examples | [Map[`string`, `any`]] | An array with examples of valid message objects.
<a name="messageTraitObjectExamples"></a>examples | [Map[`string`, `any`]] | An array of key/value pairs where keys MUST be either **headers** and/or **payload**. Values MUST contain examples that validate against the [headers](#messageObjectHeaders) or [payload](#messageObjectPayload) fields, respectively. Example MAY also have the **name** and **summary** additional keys to provide respectively a machine-friendly name and a short summary of what the example is about.

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

Expand Down

0 comments on commit 6887699

Please sign in to comment.