Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change examples structure #436

Merged
merged 4 commits into from
Sep 9, 2020
Merged

Change examples structure #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2b4d742
Merge pull request #1 from asyncapi/master
BlockLucas Sep 4, 2020
e16bb2e
fixes bug #410, now examples facet for Message & Message Trait object…
BlockLucas Sep 4, 2020
547b114
Commit suggestion 1
BlockLucas Sep 7, 2020
3bb8f97
Commit suggestion 2
BlockLucas Sep 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions versions/2.0.0/asyncapi.md
View file
Open in desktop
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
View file
Open in desktop
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