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

docs: initial NATS bindings #6

Merged
merged 13 commits into from
Aug 6, 2021
Merged

docs: initial NATS bindings #6

Changes from 7 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1b2e694
Initial commit for PR.
jonaslagoni Nov 5, 2019
27829f7
Added the channel bindings for which type of channel.
jonaslagoni Nov 5, 2019
8e3c60f
Changed wrong default payload type
jonaslagoni Nov 6, 2019
08113b0
Added binding versions and encoding for the server.
jonaslagoni Nov 10, 2019
9014537
Added requestReply type.
jonaslagoni Nov 12, 2019
20d0c35
Moved queue parameter to subscribe operations, since publish operatio…
jonaslagoni Nov 13, 2019
7c0263a
Added description for queue
jonaslagoni Nov 13, 2019
1d053d4
Removed custom server payload field since we have message payload and…
jonaslagoni Mar 28, 2020
9e48573
Updated bindings.
jonaslagoni Jul 27, 2020
bbc1169
Merge branch 'master' into feature/nats_binding
jonaslagoni Feb 26, 2021
93aff99
Merge branch 'master-upstream-master' into feature/nats_binding
jonaslagoni Jul 30, 2021
1d540f3
Removed unnecessary properties
jonaslagoni Jul 30, 2021
264a78a
Relocated operations
jonaslagoni Jul 30, 2021
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
29 changes: 23 additions & 6 deletions nats/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,49 @@ This document defines how to describe NATS-specific information on AsyncAPI.

Current version is `0.1.0`.


<a name="server"></a>

## Server Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.

##### Fixed Fields

| Field Name | Type | Description |
|------------------------------------------------------------------|:------:|-------------------------------------------------------------------------------------|
| <a name="serverBindingObjectPayload"></a>`payload` | string | Defines the payload data type. Can be either `binary`, `JSON` or `string` (default) |
| <a name="serverBindingObjectEncoding"></a>`encoding` | string | Defines the payloads encoding. Default to `utf8`. |
| <a name="serverBindingObjectBindingVersion"></a>`bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed. |

<a name="channel"></a>

## Channel Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.
<a name="operation"></a>

This object MUST NOT contain any properties. Its name is reserved for future use.

##### Fixed Fields

<a name="operation"></a>
| Field Name | Type | Description |
|------------------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------|
| <a name="channelBindingObjectIs"></a>`is` | string | Defines what type of channel it is. Can be either `requestReply` or `pubsub` (default). |
| <a name="channelBindingObjectRequestReply"></a>`requestReply` | Map[string, any] | If the channel is `requestReply`, define the request reply properties here. |
| <a name="channelBindingObjectRequestReplyTimeout"></a>`requestReply.timeout` | integer | The time you allow the subscriber to process the message and return a reply. |
| <a name="channelBindingObjectRequestReplyIs"></a>`requestReply.is` | string | Defines what type of request reply it is. Can be either `requester` or `replier`. |
| <a name="channelBindingObjectBindingVersion"></a>`bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed. |

## Operation Binding Object

<a name="message"></a>
This object MUST NOT contain any properties. Its name is reserved for future use.



<a name="message"></a>
| Field Name | Type | Applies To | Description |
|---------------------------------------------------------------------|:----------------:|:------------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| <a name="operationBindingObjectUnsubAfter"></a>`unsubAfter` | integer | Subscribe | Defines whether the client should unsubscribe after n messages. |
| <a name="operationBindingObjectQueue"></a>`queue` | Map[string, any] | Subscribe | If the subscription should use a queue, define the queue properties in this object. Cannot be used used if channel `is` of type `requestReply` and `requestReply.is` are of type requester. |
| <a name="operationBindingObjectQueueName"></a>`queue.name` | string | Subscribe | The name of the queue. It MUST NOT exceed 255 characters long. |
| <a name="operationBindingObjectBindingVersion"></a>`bindingVersion` | string | Publish, Subscribe | The version of this binding. If omitted, "latest" MUST be assumed. |

## Message Binding Object

Expand Down