Skip to content

Commit

Permalink
Fix typo in examples structure (#436)
Browse files Browse the repository at this point in the history
* fixes bug #410, now examples facet for Message & Message Trait objects are an array of any

* Commit suggestion 1

Co-authored-by: Fran Méndez <fmvilas@gmail.com>

* Commit suggestion 2

Co-authored-by: Fran Méndez <fmvilas@gmail.com>

Co-authored-by: Fran Méndez <fmvilas@gmail.com>
  • Loading branch information
BlockLucas and fmvilas authored Sep 9, 2020
1 parent e2921d5 commit 61fdd01
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
4 changes: 2 additions & 2 deletions versions/2.0.0/asyncapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1003,7 +1003,7 @@ Field Name | Type | Description
<a name="messageObjectTags"></a>tags | [Tags Object](#tagsObject) | A list of tags for API documentation control. Tags can be used for logical grouping of messages.
<a name="messageObjectExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this message.
<a name="messageObjectBindings"></a>bindings | [Message Bindings Object](#messageBindingsObject) | A map where the keys describe the name of the protocol and the values describe protocol-specific definitions for the message.
<a name="messageObjectExamples"></a>examples | [Map[`string`, `any`]] | An array with examples of valid message objects.
<a name="messageObjectExamples"></a>examples | [`any`] | An array with examples of valid message objects. Whatever "any" is, it MUST match the type defined on the payload.
<a name="messageObjectTraits"></a>traits | [[Message Trait Object](#messageTraitObject) &#124; [Reference Object](#referenceObject)] | A list of traits to apply to the message object. Traits MUST be merged into the message object using the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) algorithm in the same order they are defined here. The resulting object MUST be a valid [Message Object](#messageObject).

This object can be extended with [Specification Extensions](#specificationExtensions).
Expand Down Expand Up @@ -1168,7 +1168,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) | 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 | [`any`] | An array with examples of valid message objects. Whatever "any" is, it MUST match the type defined on the payload.

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

Expand Down
8 changes: 2 additions & 6 deletions versions/2.0.0/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -689,9 +689,7 @@
},
"examples": {
"type": "array",
"items": {
"type": "object"
}
"items": {}
},
"bindings": {
"$ref": "#/definitions/bindingsObject"
Expand Down Expand Up @@ -905,9 +903,7 @@
},
"examples": {
"type": "array",
"items": {
"type": "object"
}
"items": {}
},
"bindings": {
"$ref": "#/definitions/bindingsObject"
Expand Down

0 comments on commit 61fdd01

Please sign in to comment.