From 87f0b8f8cebcda117bdec4c51d99455ddf9684d8 Mon Sep 17 00:00:00 2001 From: Vladimir Gorej Date: Tue, 10 Aug 2021 11:14:18 +0200 Subject: [PATCH] docs(spec): unify Message and MessageTrait examples description Refs #604 --- spec/asyncapi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/asyncapi.md b/spec/asyncapi.md index b30244cdd..8339ae85b 100644 --- a/spec/asyncapi.md +++ b/spec/asyncapi.md @@ -1220,7 +1220,7 @@ Field Name | Type | Description tags | [Tags Object](#tagsObject) | A list of tags for API documentation control. Tags can be used for logical grouping of messages. externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this message. 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. -examples | [Map[`string`, `any`]] | An array with examples of valid message objects. +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).