latest--3.0.0-without-$id
shared| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/asyncapi/_shared/latest--3.0.0-without-$id.json |
| Parent schema | asyncapi |
!!Auto generated!! Do not manually edit.
Properties
The AsyncAPI specification version of this document.
The object provides metadata about the API. The metadata can be used by the clients if needed.
A unique id representing the application.
An object representing multiple servers.
Default content type to use when encoding/decoding a message's payload.
An object containing all the Channel Object definitions the Application MUST use during runtime.
Holds a dictionary with all the operations this application MUST implement.
An object to hold a set of reusable objects for different aspects of the AsyncAPI specification. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.
19 nested properties
An object to hold reusable Schema Object. If this is a Schema Object, then the schemaFormat will be assumed to be 'application/vnd.aai.asyncapi+json;version=asyncapi' where the version is equal to the AsyncAPI Version String.
An object to hold reusable Server Objects.
An object to hold reusable Channel Objects.
An object to hold reusable Server Variable Objects.
An object to hold reusable Message Objects.
An object to hold reusable Security Scheme Objects.
An object to hold reusable Parameter Objects.
An object to hold reusable Correlation ID Objects.
An object to hold reusable Operation Trait Objects.
An object to hold reusable Message Trait Objects.
An object to hold reusable Operation Reply Objects.
An object to hold reusable Operation Reply Address Objects.
An object to hold reusable Server Bindings Objects.
An object to hold reusable Channel Bindings Objects.
An object to hold reusable Operation Bindings Objects.
An object to hold reusable Message Bindings Objects.
An object to hold reusable Tag Objects.
An object to hold reusable External Documentation Objects.
Definitions
Any property starting with x- is valid.
The object provides metadata about the API. The metadata can be used by the clients if needed.
{ "title": "AsyncAPI Sample App", "version": "1.0.1", "description": "This is a sample app.", "termsOfService": "https://asyncapi.org/terms/", "contact": { "name": "API Support", "url": "https://www.asyncapi.org/support", "email": "[email protected]" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "externalDocs": { "description": "Find more info here", "url": "https://www.asyncapi.org" }, "tags": [ { "name": "e-commerce" } ] }
Contact information for the exposed API.
{ "name": "API Support", "url": "https://www.example.com/support", "email": "[email protected]" }
The identifying name of the contact person/organization.
The URL pointing to the contact information.
The email address of the contact person/organization.
{ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }
The name of the license type. It's encouraged to use an OSI compatible license.
The URL pointing to the license.
A simple object to allow referencing other components in the specification, internally and externally.
{ "$ref": "#/components/schemas/Pet" }
Allows adding metadata to a single tag.
{ "name": "user", "description": "User-related messages" }
The name of the tag.
A short description for the tag. CommonMark syntax can be used for rich text representation.
Allows referencing an external resource for extended documentation.
{ "description": "Find more info here", "url": "https://example.com" }
The URL for the target documentation. This MUST be in the form of an absolute URL.
A short description of the target documentation. CommonMark syntax can be used for rich text representation.
The object that lists all the extensions of Info
This extension allows you to provide the Twitter username of the account representing the team/company of the API.
This extension allows you to provide the Linkedin profile URL of the account representing the team/company of the API.
This extension allows you to provide the Twitter username of the account representing the team/company of the API.
This extension allows you to provide the Linkedin profile URL of the account representing the team/company of the API.
An object representing multiple servers.
{ "development": { "host": "localhost:5672", "description": "Development AMQP broker.", "protocol": "amqp", "protocolVersion": "0-9-1", "tags": [ { "name": "env:development", "description": "This environment is meant for developers to run their own tests." } ] }, "staging": { "host": "rabbitmq-staging.in.mycompany.com:5672", "description": "RabbitMQ broker for the staging environment.", "protocol": "amqp", "protocolVersion": "0-9-1", "tags": [ { "name": "env:staging", "description": "This environment is a replica of the production environment." } ] }, "production": { "host": "rabbitmq.in.mycompany.com:5672", "description": "RabbitMQ broker for the production environment.", "protocol": "amqp", "protocolVersion": "0-9-1", "tags": [ { "name": "env:production", "description": "This environment is the live environment available for final users." } ] } }
An object representing a message broker, a server or any other kind of computer program capable of sending and/or receiving data.
{ "host": "kafka.in.mycompany.com:9092", "description": "Production Kafka broker.", "protocol": "kafka", "protocolVersion": "3.2" }{ "host": "rabbitmq.in.mycompany.com:5672", "pathname": "/production", "protocol": "amqp", "description": "Production RabbitMQ broker (uses the `production` vhost)." }
The server host name. It MAY include the port. This field supports Server Variables. Variable substitutions will be made when a variable is named in {braces}.
The protocol this server supports for connection.
The path to a resource in the host. This field supports Server Variables. Variable substitutions will be made when a variable is named in {braces}.
A human-friendly title for the server.
A brief summary of the server.
A longer description of the server. CommonMark is allowed.
An optional string describing the server. CommonMark syntax MAY be used for rich text representation.
An array representing security requirements.
An object representing a Server Variable for server URL template substitution.
{ "host": "rabbitmq.in.mycompany.com:5672", "pathname": "/{env}", "protocol": "amqp", "description": "RabbitMQ broker. Use the `env` variable to point to either `production` or `staging`.", "variables": { "env": { "description": "Environment to connect to. It can be either `production` or `staging`.", "enum": [ "production", "staging" ] } } }
An enumeration of string values to be used if the substitution options are from a limited set.
The default value to use for substitution, and to send, if an alternate value is not supplied.
An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
An array of examples of the server variable.
An array representing security requirements.
Defines a security scheme that can be used by the operations.
{ "type": "userPassword" }
{ "type": "userPassword" }
{ "type": "apiKey", "in": "user" }
The type of the security scheme
The location of the API key.
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
{ "type": "X509" }
{ "type": "symmetricEncryption" }
The type of the security scheme.
A short description for security scheme.
The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
The type of the security scheme.
A short description for security scheme.
The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
The type of the security scheme.
A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
{ "type": "httpApiKey", "name": "api_key", "in": "header" }
The type of the security scheme.
The name of the header, query or cookie parameter to be used.
The location of the API key
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
Allows configuration of the supported OAuth Flows.
The type of the security scheme.
4 nested properties
Configuration for the OAuth Resource Owner Protected Credentials flow.
Configuration for the OAuth Client Credentials flow.
A short description for security scheme.
List of the needed scope names.
Configuration details for a supported OAuth Flow
{ "authorizationUrl": "https://example.com/api/oauth/dialog", "tokenUrl": "https://example.com/api/oauth/token", "availableScopes": { "write:pets": "modify pets in your account", "read:pets": "read your pets" } }
The authorization URL to be used for this flow. This MUST be in the form of an absolute URL.
The token URL to be used for this flow. This MUST be in the form of an absolute URL.
The URL to be used for obtaining refresh tokens. This MUST be in the form of an absolute URL.
The type of the security scheme.
OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of an absolute URL.
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
List of the needed scope names. An empty array means no scopes are needed.
{ "type": "scramSha512" }
The type of the security scheme. Valid values
A short description for security scheme.
{ "type": "scramSha512" }
The type of the security scheme.
A short description for security scheme.
{ "type": "scramSha512" }
The type of the security scheme.
A short description for security scheme.
Map describing protocol-specific definitions for a server.
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
This object contains information about the server representation in MQTT.
{ "clientId": "guest", "cleanSession": true, "lastWill": { "topic": "/last-wills", "qos": 2, "message": "Guest gone offline.", "retain": false }, "keepAlive": 60, "sessionExpiryInterval": 120, "maximumPacketSize": 1024, "bindingVersion": "0.2.0" }
The client identifier.
Whether to create a persistent connection or not. When 'false', the connection will be persistent. This is called clean start in MQTTv5.
Last Will and Testament configuration.
4 nested properties
The topic where the Last Will and Testament message will be sent.
Defines how hard the broker/client will try to ensure that the Last Will and Testament message is received. Its value MUST be either 0, 1 or 2.
Last Will message.
Whether the broker should retain the Last Will and Testament message or not.
Interval in seconds of the longest period of time the broker and the client can endure without sending a message.
Interval time in seconds or a Schema Object containing the definition of the interval. The broker maintains a session for a disconnected client until this interval expires.
Number of bytes or a Schema Object representing the Maximum Packet Size the Client is willing to accept.
The version of this binding. If omitted, 'latest' MUST be assumed.
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
46 nested properties
46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}{}{}{}46 nested properties
46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}46 nested properties
{}{}{}This object contains server connection information to a Kafka broker. This object contains additional information not possible to represent within the core AsyncAPI specification.
{ "schemaRegistryUrl": "https://my-schema-registry.com", "schemaRegistryVendor": "confluent", "bindingVersion": "0.5.0" }
API URL for the Schema Registry used when producing Kafka messages (if a Schema Registry was used).
The vendor of the Schema Registry and Kafka serdes library that should be used.
The version of this binding.
This object contains server connection information to a Kafka broker. This object contains additional information not possible to represent within the core AsyncAPI specification.
{ "schemaRegistryUrl": "https://my-schema-registry.com", "schemaRegistryVendor": "confluent", "bindingVersion": "0.4.0" }
API URL for the Schema Registry used when producing Kafka messages (if a Schema Registry was used).
The vendor of the Schema Registry and Kafka serdes library that should be used.
The version of this binding.
This object contains server connection information to a Kafka broker. This object contains additional information not possible to represent within the core AsyncAPI specification.
{ "schemaRegistryUrl": "https://my-schema-registry.com", "schemaRegistryVendor": "confluent", "bindingVersion": "0.3.0" }
API URL for the Schema Registry used when producing Kafka messages (if a Schema Registry was used).
The vendor of the Schema Registry and Kafka serdes library that should be used.
The version of this binding.
This object contains configuration for describing a JMS broker as an AsyncAPI server. This objects only contains configuration that can not be provided in the AsyncAPI standard server object.
{ "jmsConnectionFactory": "org.apache.activemq.ActiveMQConnectionFactory", "properties": [ { "name": "disableTimeStampsByDefault", "value": false } ], "clientID": "my-application-1", "bindingVersion": "0.0.1" }
The classname of the ConnectionFactory implementation for the JMS Provider.
Additional properties to set on the JMS ConnectionFactory implementation for the JMS Provider.
A client identifier for applications that use this JMS connection factory. If the Client ID Policy is set to 'Restricted' (the default), then configuring a Client ID on the ConnectionFactory prevents more than one JMS client from using a connection from this factory.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains server connection information about the IBM MQ server, referred to as an IBM MQ queue manager. This object contains additional connectivity information not possible to represent within the core AsyncAPI specification.
{ "groupId": "PRODCLSTR1", "cipherSpec": "ANY_TLS12_OR_HIGHER", "bindingVersion": "0.1.0" }{ "groupId": "PRODCLSTR1", "bindingVersion": "0.1.0" }
Defines a logical group of IBM MQ server objects. This is necessary to specify multi-endpoint configurations used in high availability deployments. If omitted, the server object is not part of a group.
The name of the IBM MQ queue manager to bind to in the CCDT file.
The recommended cipher specification used to establish a TLS connection between the client and the IBM MQ queue manager. More information on SSL/TLS cipher specifications supported by IBM MQ can be found on this page in the IBM MQ Knowledge Center.
If 'multiEndpointServer' is 'true' then multiple connections can be workload balanced and applications should not make assumptions as to where messages are processed. Where message ordering, or affinity to specific message resources is necessary, a single endpoint ('multiEndpointServer' = 'false') may be required.
The recommended value (in seconds) for the heartbeat sent to the queue manager during periods of inactivity. A value of zero means that no heart beats are sent. A value of 1 means that the client will use the value defined by the queue manager. More information on heart beat interval can be found on this page in the IBM MQ Knowledge Center.
The version of this binding.
This object contains server connection information about the Solace broker. This object contains additional connectivity information not possible to represent within the core AsyncAPI specification.
{ "msgVpn": "ProdVPN", "bindingVersion": "0.4.0" }
The name of the Virtual Private Network to connect to on the Solace broker.
A unique client name to use to register to the appliance. If specified, it must be a valid Topic name, and a maximum of 160 bytes in length when encoded as UTF-8.
The version of this binding.
This object contains server connection information about the Solace broker. This object contains additional connectivity information not possible to represent within the core AsyncAPI specification.
{ "msgVpn": "ProdVPN", "bindingVersion": "0.3.0" }
The name of the Virtual Private Network to connect to on the Solace broker.
The version of this binding.
This object contains server connection information about the Solace broker. This object contains additional connectivity information not possible to represent within the core AsyncAPI specification.
{ "msgVpn": "ProdVPN", "bindingVersion": "0.2.0" }
The name of the Virtual Private Network to connect to on the Solace broker.
The version of this binding.
This object contains server information of Pulsar broker, which covers cluster and tenant admin configuration. This object contains additional information not possible to represent within the core AsyncAPI specification.
{ "tenant": "contoso", "bindingVersion": "0.1.0" }
The pulsar tenant. If omitted, 'public' MUST be assumed.
The version of this binding. If omitted, 'latest' MUST be assumed.
An object containing all the Channel Object definitions the Application MUST use during runtime.
{ "userSignedUp": { "address": "user.signedup", "messages": { "userSignedUp": { "$ref": "#/components/messages/userSignedUp" } } } }
Describes a shared communication channel.
{ "address": "users.{userId}", "title": "Users channel", "description": "This channel is used to exchange messages about user events.", "messages": { "userSignedUp": { "$ref": "#/components/messages/userSignedUp" }, "userCompletedOrder": { "$ref": "#/components/messages/userCompletedOrder" } }, "parameters": { "userId": { "$ref": "#/components/parameters/userId" } }, "servers": [ { "$ref": "#/servers/rabbitmqInProd" }, { "$ref": "#/servers/rabbitmqInStaging" } ], "bindings": { "amqp": { "is": "queue", "queue": { "exclusive": true } } }, "tags": [ { "name": "user", "description": "User-related messages" } ], "externalDocs": { "description": "Find more info here", "url": "https://example.com" } }
An optional string representation of this channel's address. The address is typically the "topic name", "routing key", "event type", or "path". When null or absent, it MUST be interpreted as unknown. This is useful when the address is generated dynamically at runtime or can't be known upfront. It MAY contain Channel Address Expressions.
A map of the messages that will be sent to this channel by any application at any time. Every message sent to this channel MUST be valid against one, and only one, of the message objects defined in this map.
JSON objects describing re-usable channel parameters.
A human-friendly title for the channel.
A brief summary of the channel.
A longer description of the channel. CommonMark is allowed.
The references of the servers on which this channel is available. If absent or empty then this channel must be available on all servers.
A list of tags for logical grouping of channels.
A map of the messages that will be sent to this channel by any application at any time. Every message sent to this channel MUST be valid against one, and only one, of the message objects defined in this map.
Describes a message received on a given channel and operation.
{ "messageId": "userSignup", "name": "UserSignup", "title": "User signup", "summary": "Action to sign a user up.", "description": "A longer description", "contentType": "application/json", "tags": [ { "name": "user" }, { "name": "signup" }, { "name": "register" } ], "headers": { "type": "object", "properties": { "correlationId": { "description": "Correlation ID set by application", "type": "string" }, "applicationInstanceId": { "description": "Unique identifier for a given instance of the publishing application", "type": "string" } } }, "payload": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/userCreate" }, "signup": { "$ref": "#/components/schemas/signup" } } }, "correlationId": { "description": "Default Correlation ID", "location": "$message.header#/correlationId" }, "traits": [ { "$ref": "#/components/messageTraits/commonHeaders" } ], "examples": [ { "name": "SimpleSignup", "summary": "A simple UserSignup example message", "headers": { "correlationId": "my-correlation-id", "applicationInstanceId": "myInstanceId" }, "payload": { "user": { "someUserKey": "someUserValue" }, "signup": { "someSignupKey": "someSignupValue" } } } ] }
The content type to use when encoding/decoding a message's payload. The value MUST be a specific media type (e.g. application/json). When omitted, the value MUST be the one specified on the defaultContentType field.
An object representing either a schema or a multiFormatSchema based on the existence of the 'schema' property. If the property 'schema' is present, use the multi-format schema. Use the default AsyncAPI Schema otherwise.
An object representing either a schema or a multiFormatSchema based on the existence of the 'schema' property. If the property 'schema' is present, use the multi-format schema. Use the default AsyncAPI Schema otherwise.
A brief summary of the message.
Name of the message.
A human-friendly title for the message.
A longer description of the message. CommonMark is allowed.
List of examples.
A list of traits to apply to the message object. Traits MUST be merged using traits merge mechanism. The resulting object MUST be a valid Message Object.
An object representing either a schema or a multiFormatSchema based on the existence of the 'schema' property. If the property 'schema' is present, use the multi-format schema. Use the default AsyncAPI Schema otherwise.
The Multi Format Schema Object represents a schema definition. It differs from the Schema Object in that it supports multiple schema formats or languages (e.g., JSON Schema, Avro, etc.).
2 nested properties
2 nested properties
5 nested properties
Json-Schema definition for Avro AVSC files.
An object that specifies an identifier at design time that can used for message tracing and correlation.
{ "description": "Default Correlation ID", "location": "$message.header#/correlationId" }
A runtime expression that specifies the location of the correlation ID
A optional description of the correlation ID. GitHub Flavored Markdown is allowed.
Machine readable name of the message example.
A brief summary of the message example.
Example of the application headers. It MUST be a map of key-value pairs.
Example of the message payload. It can be of any type.
Map describing protocol-specific definitions for a message.
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
This object contains information about the message representation in HTTP.
{ "headers": { "type": "object", "properties": { "Content-Type": { "type": "string", "enum": [ "application/json" ] } } }, "bindingVersion": "0.3.0" }
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The HTTP response status code according to RFC 9110. statusCode is only relevant for messages referenced by the Operation Reply Object, as it defines the status code for the response. In all other cases, this value can be safely ignored.
The version of this binding. If omitted, "latest" MUST be assumed.
This object contains information about the message representation in HTTP.
{ "headers": { "type": "object", "properties": { "Content-Type": { "type": "string", "enum": [ "application/json" ] } } }, "bindingVersion": "0.2.0" }
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The version of this binding. If omitted, "latest" MUST be assumed.
This object contains information about the message representation in AMQP.
{ "contentEncoding": "gzip", "messageType": "user.signup", "bindingVersion": "0.3.0" }
A MIME encoding for the message content.
Application-specific message type.
The version of this binding. If omitted, "latest" MUST be assumed.
This object contains information about the message representation in MQTT.
{ "bindingVersion": "0.2.0" }{ "contentType": "application/json", "correlationData": { "type": "string", "format": "uuid" }, "responseTopic": "application/responses", "bindingVersion": "0.2.0" }
1 indicates that the payload is UTF-8 encoded character data. 0 indicates that the payload format is unspecified.
Correlation Data is used by the sender of the request message to identify which request the response message is for when it is received.
String describing the content type of the message payload. This should not conflict with the contentType field of the associated AsyncAPI Message object.
The topic (channel URI) to be used for a response message.
The version of this binding. If omitted, 'latest' MUST be assumed.
{ "key": { "type": "string", "enum": [ "myKey" ] }, "schemaIdLocation": "payload", "schemaIdPayloadEncoding": "apicurio-new", "schemaLookupStrategy": "TopicIdStrategy", "bindingVersion": "0.5.0" }{ "key": { "$ref": "path/to/user-create.avsc#/UserCreate" }, "schemaIdLocation": "payload", "schemaIdPayloadEncoding": "4", "bindingVersion": "0.5.0" }
If a Schema Registry is used when performing this operation, tells where the id of schema is stored.
Number of bytes or vendor specific values when schema id is encoded in payload.
Freeform string for any naming strategy class to use. Clients should default to the vendor default if not supplied.
The version of this binding. If omitted, 'latest' MUST be assumed.
{ "key": { "type": "string", "enum": [ "myKey" ] }, "schemaIdLocation": "payload", "schemaIdPayloadEncoding": "apicurio-new", "schemaLookupStrategy": "TopicIdStrategy", "bindingVersion": "0.4.0" }{ "key": { "$ref": "path/to/user-create.avsc#/UserCreate" }, "schemaIdLocation": "payload", "schemaIdPayloadEncoding": "4", "bindingVersion": "0.4.0" }
The message key.
If a Schema Registry is used when performing this operation, tells where the id of schema is stored.
Number of bytes or vendor specific values when schema id is encoded in payload.
Freeform string for any naming strategy class to use. Clients should default to the vendor default if not supplied.
The version of this binding. If omitted, 'latest' MUST be assumed.
{ "key": { "type": "string", "enum": [ "myKey" ] }, "schemaIdLocation": "payload", "schemaIdPayloadEncoding": "apicurio-new", "schemaLookupStrategy": "TopicIdStrategy", "bindingVersion": "0.3.0" }{ "key": { "$ref": "path/to/user-create.avsc#/UserCreate" }, "schemaIdLocation": "payload", "schemaIdPayloadEncoding": "4", "bindingVersion": "0.3.0" }
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
If a Schema Registry is used when performing this operation, tells where the id of schema is stored.
Number of bytes or vendor specific values when schema id is encoded in payload.
Freeform string for any naming strategy class to use. Clients should default to the vendor default if not supplied.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains configuration for describing an Anypoint MQ message as an AsyncAPI message. This objects only contains configuration that can not be provided in the AsyncAPI standard message object.
{ "headers": { "type": "object", "properties": { "messageId": { "type": "string" } } }, "bindingVersion": "0.0.1" }
A Schema object containing the definitions for Anypoint MQ-specific headers (protocol headers). This schema MUST be of type 'object' and have a 'properties' key. Examples of Anypoint MQ protocol headers are 'messageId' and 'messageGroupId'.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains configuration for describing a JMS message as an AsyncAPI message. This objects only contains configuration that can not be provided in the AsyncAPI standard message object.
{ "headers": { "type": "object", "required": [ "JMSMessageID" ], "properties": { "JMSMessageID": { "type": [ "string", "null" ], "description": "A unique message identifier. This may be set by your JMS Provider on your behalf." }, "JMSTimestamp": { "type": "integer", "description": "The time the message was sent. This may be set by your JMS Provider on your behalf. The time the message was sent. The value of the timestamp is the amount of time, measured in milliseconds, that has elapsed since midnight, January 1, 1970, UTC." }, "JMSDeliveryMode": { "type": "string", "enum": [ "PERSISTENT", "NON_PERSISTENT" ], "default": "PERSISTENT", "description": "Denotes the delivery mode for the message. This may be set by your JMS Provider on your behalf." }, "JMSPriority": { "type": "integer", "default": 4, "description": "The priority of the message. This may be set by your JMS Provider on your behalf." }, "JMSExpires": { "type": "integer", "description": "The time at which the message expires. This may be set by your JMS Provider on your behalf. A value of zero means that the message does not expire. Any non-zero value is the amount of time, measured in milliseconds, that has elapsed since midnight, January 1, 1970, UTC, at which the message will expire." }, "JMSType": { "type": [ "string", "null" ], "description": "The type of message. Some JMS providers use a message repository that contains the definitions of messages sent by applications. The 'JMSType' header field may reference a message's definition in the provider's repository. The JMS API does not define a standard message definition repository, nor does it define a naming policy for the definitions it contains. Some messaging systems require that a message type definition for each application message be created and that each message specify its type. In order to work with such JMS providers, JMS clients should assign a value to 'JMSType', whether the application makes use of it or not. This ensures that the field is properly set for those providers that require it." }, "JMSCorrelationID": { "type": [ "string", "null" ], "description": "The correlation identifier of the message. A client can use the 'JMSCorrelationID' header field to link one message with another. A typical use is to link a response message with its request message. Since each message sent by a JMS provider is assigned a message ID value, it is convenient to link messages via message ID, such message ID values must start with the 'ID:' prefix. Conversely, application-specified values must not start with the 'ID:' prefix; this is reserved for provider-generated message ID values." }, "JMSReplyTo": { "type": "string", "description": "The queue or topic that the message sender expects replies to." } } }, "bindingVersion": "0.0.1" }
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the message representation in IBM MQ.
{ "type": "string", "bindingVersion": "0.1.0" }{ "type": "jms", "description": "JMS stream message", "bindingVersion": "0.1.0" }
The type of the message.
Defines the IBM MQ message headers to include with this message. More than one header can be specified as a comma separated list. Supporting information on IBM MQ message formats can be found on this page in the IBM MQ Knowledge Center.
Provides additional information for application developers: describes the message type or format.
The recommended setting the client should use for the TTL (Time-To-Live) of the message. This is a period of time expressed in milliseconds and set by the application that puts the message. 'expiry' values are API dependant e.g., MQI and JMS use different units of time and default values for 'unlimited'. General information on IBM MQ message expiry can be found on this page in the IBM MQ Knowledge Center.
The version of this binding.
This object contains information about the message representation for Google Cloud Pub/Sub.
{ "schema": { "name": "projects/your-project-id/schemas/your-avro-schema-id" } }{ "schema": { "name": "projects/your-project-id/schemas/your-protobuf-schema-id" } }
The version of this binding.
1 nested properties
Describes a trait that MAY be applied to a Message Object. This object MAY contain any property from the Message Object, except payload and traits.
{ "contentType": "application/json" }
The content type to use when encoding/decoding a message's payload. The value MUST be a specific media type (e.g. application/json). When omitted, the value MUST be the one specified on the defaultContentType field.
An object representing either a schema or a multiFormatSchema based on the existence of the 'schema' property. If the property 'schema' is present, use the multi-format schema. Use the default AsyncAPI Schema otherwise.
A brief summary of the message.
Name of the message.
A human-friendly title for the message.
A longer description of the message. CommonMark is allowed.
List of examples.
JSON objects describing re-usable channel parameters.
{ "address": "user/{userId}/signedup", "parameters": { "userId": { "description": "Id of the user." } } }
Describes a parameter included in a channel address.
{ "address": "user/{userId}/signedup", "parameters": { "userId": { "description": "Id of the user.", "location": "$message.payload#/user/id" } } }
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
An enumeration of string values to be used if the substitution options are from a limited set.
The default value to use for substitution, and to send, if an alternate value is not supplied.
An array of examples of the parameter value.
A runtime expression that specifies the location of the parameter value
Map describing protocol-specific definitions for a channel.
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
When using WebSockets, the channel represents the connection. Unlike other protocols that support multiple virtual channels (topics, routing keys, etc.) per connection, WebSockets doesn't support virtual channels or, put it another way, there's only one channel and its characteristics are strongly related to the protocol used for the handshake, i.e., HTTP.
{ "method": "POST", "bindingVersion": "0.1.0" }
The HTTP method to use when establishing the connection. Its value MUST be either 'GET' or 'POST'.
A Schema object containing the definitions for each query parameter. This schema MUST be of type 'object' and have a 'properties' key.
A Schema object containing the definitions of the HTTP headers to use when establishing the connection. This schema MUST be of type 'object' and have a 'properties' key.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the channel representation in AMQP.
{ "is": "routingKey", "exchange": { "name": "myExchange", "type": "topic", "durable": true, "autoDelete": false, "vhost": "/" }, "bindingVersion": "0.3.0" }{ "is": "queue", "queue": { "name": "my-queue-name", "durable": true, "exclusive": true, "autoDelete": false, "vhost": "/" }, "bindingVersion": "0.3.0" }
Defines what type of channel is it. Can be either 'queue' or 'routingKey' (default).
When is=routingKey, this object defines the exchange properties.
5 nested properties
The name of the exchange. It MUST NOT exceed 255 characters long.
The type of the exchange. Can be either 'topic', 'direct', 'fanout', 'default' or 'headers'.
Whether the exchange should survive broker restarts or not.
Whether the exchange should be deleted when the last queue is unbound from it.
The virtual host of the exchange. Defaults to '/'.
When is=queue, this object defines the queue properties.
5 nested properties
The name of the queue. It MUST NOT exceed 255 characters long.
Whether the queue should survive broker restarts or not.
Whether the queue should be used only by one connection or not.
Whether the queue should be deleted when the last consumer unsubscribes.
The virtual host of the queue. Defaults to '/'.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the channel representation in Kafka.
{ "topic": "my-specific-topic", "partitions": 20, "replicas": 3, "bindingVersion": "0.5.0" }
Kafka topic name if different from channel name.
Number of partitions configured on this topic.
Number of replicas configured on this topic.
Topic configuration properties that are relevant for the API.
9 nested properties
The cleanup.policy configuration option.
It shows whether the schema validation for the message key is enabled. Vendor specific config. For more details: (https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-key-schema-validation)
The name of the schema lookup strategy for the message key. Vendor specific config. For more details: (https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-key-subject-name-strategy)
It shows whether the schema validation for the message value is enabled. Vendor specific config. For more details: (https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-value-schema-validation)
The name of the schema lookup strategy for the message value. Vendor specific config. For more details: (https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#confluent-value-subject-name-strategy)
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the channel representation in Kafka.
{ "topic": "my-specific-topic", "partitions": 20, "replicas": 3, "bindingVersion": "0.4.0" }
Kafka topic name if different from channel name.
Number of partitions configured on this topic.
Number of replicas configured on this topic.
Topic configuration properties that are relevant for the API.
5 nested properties
The cleanup.policy configuration option.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the channel representation in Kafka.
{ "topic": "my-specific-topic", "partitions": 20, "replicas": 3, "bindingVersion": "0.3.0" }
Kafka topic name if different from channel name.
Number of partitions configured on this topic.
Number of replicas configured on this topic.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains configuration for describing an Anypoint MQ exchange, queue, or FIFO queue as an AsyncAPI channel. This objects only contains configuration that can not be provided in the AsyncAPI standard channel object.
{ "destination": "user-signup-exchg", "destinationType": "exchange", "bindingVersion": "0.0.1" }
The destination (queue or exchange) name for this channel. SHOULD only be specified if the channel name differs from the actual destination name, such as when the channel name is not a valid destination name in Anypoint MQ. Defaults to the channel name.
The type of destination. SHOULD be specified to document the messaging model (publish/subscribe, point-to-point, strict message ordering) supported by this channel.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains configuration for describing a JMS queue, or FIFO queue as an AsyncAPI channel. This objects only contains configuration that can not be provided in the AsyncAPI standard channel object.
{ "destination": "user-signed-up", "destinationType": "fifo-queue", "bindingVersion": "0.0.1" }
The destination (queue) name for this channel. SHOULD only be specified if the channel name differs from the actual destination name, such as when the channel name is not a valid destination name according to the JMS Provider. Defaults to the channel name.
The type of destination. SHOULD be specified to document the messaging model (point-to-point, or strict message ordering) supported by this channel.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the channel representation in SNS.
{ "name": "my-sns-topic", "policy": { "statements": [ { "effect": "Allow", "principal": "*", "action": "SNS:Publish" } ] } }
The name of the topic. Can be different from the channel name to allow flexibility around AWS resource naming limitations.
By default, we assume an unordered SNS topic. This field allows configuration of a FIFO SNS Topic.
2 nested properties
Defines the type of SNS Topic.
True to turn on de-duplication of messages for a channel.
The security policy for the SNS Topic.
1 nested properties
An array of statement objects, each of which controls a permission for this topic
Key-value pairs that represent AWS tags on the topic.
The version of this binding.
This object contains information about the channel representation in SQS.
{ "queue": { "name": "myQueue", "fifoQueue": true, "deduplicationScope": "messageGroup", "fifoThroughputLimit": "perMessageGroupId", "deliveryDelay": 15, "visibilityTimeout": 60, "receiveMessageWaitTime": 0, "messageRetentionPeriod": 86400, "redrivePolicy": { "deadLetterQueue": { "arn": "arn:aws:SQS:eu-west-1:0000000:123456789" }, "maxReceiveCount": 15 }, "policy": { "statements": [ { "effect": "Deny", "principal": "arn:aws:iam::123456789012:user/dec.kolakowski", "action": [ "sqs:SendMessage", "sqs:ReceiveMessage" ] } ] }, "tags": { "owner": "AsyncAPI.NET", "platform": "AsyncAPIOrg" } }, "deadLetterQueue": { "name": "myQueue_error", "deliveryDelay": 0, "visibilityTimeout": 0, "receiveMessageWaitTime": 0, "messageRetentionPeriod": 604800 } }
A definition of a queue.
11 nested properties
The name of the queue. When an SNS Operation Binding Object references an SQS queue by name, the identifier should be the one in this field.
Is this a FIFO queue?
Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue (default).
Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue (default) and perMessageGroupId.
The number of seconds to delay before a message sent to the queue can be received. used to create a delay queue.
The length of time, in seconds, that a consumer locks a message - hiding it from reads - before it is unlocked and can be read again.
Determines if the queue uses short polling or long polling. Set to zero the queue reads available messages and returns immediately. Set to a non-zero integer, long polling waits the specified number of seconds for messages to arrive before returning.
How long to retain a message on the queue in seconds, unless deleted.
Prevent poison pill messages by moving un-processable messages to an SQS dead letter queue.
2 nested properties
The SQS queue to use as a dead letter queue (DLQ).
The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
The security policy for the SQS Queue
1 nested properties
An array of statement objects, each of which controls a permission for this queue.
Key-value pairs that represent AWS tags on the queue.
A definition of a queue.
11 nested properties
The name of the queue. When an SNS Operation Binding Object references an SQS queue by name, the identifier should be the one in this field.
Is this a FIFO queue?
Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue (default).
Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue (default) and perMessageGroupId.
The number of seconds to delay before a message sent to the queue can be received. used to create a delay queue.
The length of time, in seconds, that a consumer locks a message - hiding it from reads - before it is unlocked and can be read again.
Determines if the queue uses short polling or long polling. Set to zero the queue reads available messages and returns immediately. Set to a non-zero integer, long polling waits the specified number of seconds for messages to arrive before returning.
How long to retain a message on the queue in seconds, unless deleted.
Prevent poison pill messages by moving un-processable messages to an SQS dead letter queue.
2 nested properties
The SQS queue to use as a dead letter queue (DLQ).
The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
The security policy for the SQS Queue
1 nested properties
An array of statement objects, each of which controls a permission for this queue.
Key-value pairs that represent AWS tags on the queue.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the channel representation in IBM MQ. Each channel corresponds to a Queue or Topic within IBM MQ.
{ "destinationType": "topic", "topic": { "objectName": "myTopicName" }, "bindingVersion": "0.1.0" }{ "destinationType": "queue", "queue": { "objectName": "myQueueName", "exclusive": true }, "bindingVersion": "0.1.0" }
Defines the type of AsyncAPI channel.
Defines the properties of a queue.
3 nested properties
Defines the name of the IBM MQ queue associated with the channel.
Defines if the queue is a cluster queue and therefore partitioned. If 'true', a binding option MAY be specified when accessing the queue. More information on binding options can be found on this page in the IBM MQ Knowledge Center.
Specifies if it is recommended to open the queue exclusively.
Defines the properties of a topic.
4 nested properties
The value of the IBM MQ topic string to be used.
The name of the IBM MQ topic object.
Defines if the subscription may be durable.
Defines if the last message published will be made available to new subscriptions.
The maximum length of the physical message (in bytes) accepted by the Topic or Queue. Messages produced that are greater in size than this value may fail to be delivered. More information on the maximum message length can be found on this page in the IBM MQ Knowledge Center.
The version of this binding.
This object contains information about the channel representation for Google Cloud Pub/Sub.
{ "labels": { "label1": "value1", "label2": "value2" }, "messageRetentionDuration": "86400s", "messageStoragePolicy": { "allowedPersistenceRegions": [ "us-central1", "us-east1" ] }, "schemaSettings": { "encoding": "json", "name": "projects/your-project-id/schemas/your-schema" } }
4 nested properties
The version of this binding.
1 nested properties
This object contains information about the channel representation in Pulsar, which covers namespace and topic level admin configuration. This object contains additional information not possible to represent within the core AsyncAPI specification.
{ "namespace": "ns1", "persistence": "persistent", "compaction": 1000, "retention": { "time": 15, "size": 1000 }, "ttl": 360, "geo-replication": [ "us-west", "us-east" ], "deduplication": true, "bindingVersion": "0.1.0" }
The namespace, the channel is associated with.
persistence of the topic in Pulsar.
Topic compaction threshold given in MB
A list of clusters the topic is replicated to.
2 nested properties
Time given in Minutes. 0 = Disable message retention.
Size given in MegaBytes. 0 = Disable message retention.
TTL in seconds for the specified topic
Whether deduplication of events is enabled or not.
The version of this binding. If omitted, 'latest' MUST be assumed.
Holds a dictionary with all the operations this application MUST implement.
{ "onUserSignUp": { "title": "User sign up", "summary": "Action to sign a user up.", "description": "A longer description", "channel": { "$ref": "#/channels/userSignup" }, "action": "send", "tags": [ { "name": "user" }, { "name": "signup" }, { "name": "register" } ], "bindings": { "amqp": { "ack": false } }, "traits": [ { "$ref": "#/components/operationTraits/kafka" } ] } }
Describes a specific operation.
{ "title": "User sign up", "summary": "Action to sign a user up.", "description": "A longer description", "channel": { "$ref": "#/channels/userSignup" }, "action": "send", "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ], "tags": [ { "name": "user" }, { "name": "signup" }, { "name": "register" } ], "bindings": { "amqp": { "ack": false } }, "traits": [ { "$ref": "#/components/operationTraits/kafka" } ], "messages": [ { "$ref": "/components/messages/userSignedUp" } ], "reply": { "address": { "location": "$message.header#/replyTo" }, "channel": { "$ref": "#/channels/userSignupReply" }, "messages": [ { "$ref": "/components/messages/userSignedUpReply" } ] } }
Allowed values are send and receive. Use send when it's expected that the application will send a message to the given channel, and receive when the application should expect receiving messages from the given channel.
A simple object to allow referencing other components in the specification, internally and externally.
1 nested properties
A list of $ref pointers pointing to the supported Message Objects that can be processed by this operation. It MUST contain a subset of the messages defined in the channel referenced in this operation. Every message processed by this operation MUST be valid against one, and only one, of the message objects referenced in this list. Please note the messages property value MUST be a list of Reference Objects and, therefore, MUST NOT contain Message Objects. However, it is RECOMMENDED that parsers (or other software) dereference this property for a better development experience.
A list of traits to apply to the operation object. Traits MUST be merged using traits merge mechanism. The resulting object MUST be a valid Operation Object.
A human-friendly title for the operation.
A brief summary of the operation.
A longer description of the operation. CommonMark is allowed.
An array representing security requirements.
A list of tags for logical grouping and categorization of operations.
Describes the reply part that MAY be applied to an Operation Object. If an operation implements the request/reply pattern, the reply object represents the response message.
A simple object to allow referencing other components in the specification, internally and externally.
1 nested properties
A list of $ref pointers pointing to the supported Message Objects that can be processed by this operation as reply. It MUST contain a subset of the messages defined in the channel referenced in this operation reply. Every message processed by this operation MUST be valid against one, and only one, of the message objects referenced in this list. Please note the messages property value MUST be a list of Reference Objects and, therefore, MUST NOT contain Message Objects. However, it is RECOMMENDED that parsers (or other software) dereference this property for a better development experience.
An object that specifies where an operation has to send the reply
{ "description": "Consumer inbox", "location": "$message.header#/replyTo" }
A runtime expression that specifies the location of the reply address.
An optional description of the address. CommonMark is allowed.
Describes a trait that MAY be applied to an Operation Object. This object MAY contain any property from the Operation Object, except the action, channel and traits ones.
{ "bindings": { "amqp": { "ack": false } } }
A human-friendly title for the operation.
A brief summary of the operation.
A longer description of the operation. CommonMark is allowed.
A list of tags for logical grouping and categorization of operations.
A map where the keys describe the name of the protocol and the values describe protocol-specific definitions for the operation.
Map describing protocol-specific definitions for an operation.
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
1 nested properties
This object contains information about the operation representation in HTTP.
{ "query": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number", "minimum": 1, "description": "The Id of the company." } }, "additionalProperties": false }, "bindingVersion": "0.3.0" }{ "method": "GET", "query": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number", "minimum": 1, "description": "The Id of the company." } }, "additionalProperties": false }, "bindingVersion": "0.3.0" }
When 'type' is 'request', this is the HTTP method, otherwise it MUST be ignored. Its value MUST be one of 'GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS', 'CONNECT', and 'TRACE'.
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the operation representation in HTTP.
{ "query": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number", "minimum": 1, "description": "The Id of the company." } }, "additionalProperties": false }, "bindingVersion": "0.2.0" }{ "method": "GET", "query": { "type": "object", "required": [ "companyId" ], "properties": { "companyId": { "type": "number", "minimum": 1, "description": "The Id of the company." } }, "additionalProperties": false }, "bindingVersion": "0.2.0" }
When 'type' is 'request', this is the HTTP method, otherwise it MUST be ignored. Its value MUST be one of 'GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS', 'CONNECT', and 'TRACE'.
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the operation representation in AMQP.
{ "expiration": 100000, "userId": "guest", "cc": [ "user.logs" ], "priority": 10, "deliveryMode": 2, "mandatory": false, "bcc": [ "external.audit" ], "timestamp": true, "ack": false, "bindingVersion": "0.3.0" }
TTL (Time-To-Live) for the message. It MUST be greater than or equal to zero.
Identifies the user who has sent the message.
The routing keys the message should be routed to at the time of publishing.
A priority for the message.
Delivery mode of the message. Its value MUST be either 1 (transient) or 2 (persistent).
Whether the message is mandatory or not.
Like cc but consumers will not receive this information.
Whether the message should include a timestamp or not.
Whether the consumer should ack the message or not.
The version of this binding. If omitted, "latest" MUST be assumed.
This object contains information about the operation representation in MQTT.
{ "qos": 2, "retain": true, "messageExpiryInterval": 60, "bindingVersion": "0.2.0" }
Defines the Quality of Service (QoS) levels for the message flow between client and server. Its value MUST be either 0 (At most once delivery), 1 (At least once delivery), or 2 (Exactly once delivery).
Whether the broker should retain the message or not.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the operation representation in Kafka.
{ "groupId": { "type": "string", "enum": [ "myGroupId" ] }, "clientId": { "type": "string", "enum": [ "myClientId" ] }, "bindingVersion": "0.5.0" }
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the operation representation in Kafka.
{ "groupId": { "type": "string", "enum": [ "myGroupId" ] }, "clientId": { "type": "string", "enum": [ "myClientId" ] }, "bindingVersion": "0.4.0" }
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the operation representation in Kafka.
{ "groupId": { "type": "string", "enum": [ "myGroupId" ] }, "clientId": { "type": "string", "enum": [ "myClientId" ] }, "bindingVersion": "0.3.0" }
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 07. The empty schema (which allows any instance to validate) MAY be represented by the boolean value true and a schema which allows no instance to validate MAY be represented by the boolean value false.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the operation representation in NATS.
{ "queue": "MyCustomQueue", "bindingVersion": "0.1.0" }
Defines the name of the queue to use. It MUST NOT exceed 255 characters.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the operation representation in SNS.
{ "topic": { "name": "someTopic" }, "consumers": [ { "protocol": "sqs", "endpoint": { "name": "someQueue" }, "filterPolicy": { "store": [ "asyncapi_corp" ], "event": [ { "anything-but": "order_cancelled" } ], "customer_interests": [ "rugby", "football", "baseball" ] }, "filterPolicyScope": "MessageAttributes", "rawMessageDelivery": false, "redrivePolicy": { "deadLetterQueue": { "arn": "arn:aws:SQS:eu-west-1:0000000:123456789" }, "maxReceiveCount": 25 }, "deliveryPolicy": { "minDelayTarget": 10, "maxDelayTarget": 100, "numRetries": 5, "numNoDelayRetries": 2, "numMinDelayRetries": 3, "numMaxDelayRetries": 5, "backoffFunction": "linear", "maxReceivesPerSecond": 2 } } ] }
The protocols that listen to this topic and their endpoints.
5 nested properties
The endpoint is a URL.
The endpoint is an email address.
The endpoint is a phone number.
The target is an ARN. For example, for SQS, the identifier may be an ARN, which will be of the form: arn:aws:sqs:{region}:{account-id}:{queueName}
The endpoint is identified by a name, which corresponds to an identifying field called 'name' of a binding for that protocol on this publish Operation Object. For example, if the protocol is 'sqs' then the name refers to the name field sqs binding. We don't use $ref because we are referring, not including.
8 nested properties
The minimum delay for a retry in seconds.
The maximum delay for a retry in seconds.
The total number of retries, including immediate, pre-backoff, backoff, and post-backoff retries.
The number of immediate retries (with no delay).
The number of immediate retries (with delay).
The number of post-backoff phase retries, with the maximum delay between retries.
The algorithm for backoff between retries.
The maximum number of deliveries per second, per subscription.
The version of this binding.
This object contains information about the operation representation in SQS.
{ "queues": [ { "name": "myQueue", "fifoQueue": true, "deduplicationScope": "messageGroup", "fifoThroughputLimit": "perMessageGroupId", "deliveryDelay": 10, "redrivePolicy": { "deadLetterQueue": { "name": "myQueue_error" }, "maxReceiveCount": 15 }, "policy": { "statements": [ { "effect": "Deny", "principal": "arn:aws:iam::123456789012:user/dec.kolakowski", "action": [ "sqs:SendMessage", "sqs:ReceiveMessage" ] } ] } }, { "name": "myQueue_error", "deliveryDelay": 10 } ] }
Queue objects that are either the endpoint for an SNS Operation Binding Object, or the deadLetterQueue of the SQS Operation Binding Object.
The version of this binding. If omitted, 'latest' MUST be assumed.
This object contains information about the operation representation in Solace.
{ "bindingVersion": "0.4.0", "destinations": [ { "destinationType": "queue", "queue": { "name": "sampleQueue", "topicSubscriptions": [ "samples/*" ], "accessType": "nonexclusive" } }, { "destinationType": "topic", "topicSubscriptions": [ "samples/*" ] } ] }
The version of this binding. If omitted, "latest" MUST be assumed.
The list of Solace destinations referenced in the operation.
Interval in milliseconds or a Schema Object containing the definition of the lifetime of the message.
The valid priority value range is 0-255 with 0 as the lowest priority and 255 as the highest or a Schema Object containing the definition of the priority.
Set the message to be eligible to be moved to a Dead Message Queue. The default value is false.
This object contains information about the operation representation in Solace.
{ "bindingVersion": "0.3.0", "destinations": [ { "destinationType": "queue", "queue": { "name": "sampleQueue", "topicSubscriptions": [ "samples/*" ], "accessType": "nonexclusive" } }, { "destinationType": "topic", "topicSubscriptions": [ "samples/*" ] } ] }
The list of Solace destinations referenced in the operation.
The version of this binding. If omitted, "latest" MUST be assumed.
This object contains information about the operation representation in Solace.
{ "bindingVersion": "0.2.0", "destinations": [ { "destinationType": "queue", "queue": { "name": "sampleQueue", "topicSubscriptions": [ "samples/*" ], "accessType": "nonexclusive" } }, { "destinationType": "topic", "topicSubscriptions": [ "samples/*" ] } ] }
The list of Solace destinations referenced in the operation.
The version of this binding. If omitted, "latest" MUST be assumed.
An object to hold a set of reusable objects for different aspects of the AsyncAPI specification. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.
{ "components": { "schemas": { "Category": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Tag": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "AvroExample": { "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", "schema": { "$ref": "path/to/user-create.avsc#/UserCreate" } } }, "servers": { "development": { "host": "{stage}.in.mycompany.com:{port}", "description": "RabbitMQ broker", "protocol": "amqp", "protocolVersion": "0-9-1", "variables": { "stage": { "$ref": "#/components/serverVariables/stage" }, "port": { "$ref": "#/components/serverVariables/port" } } } }, "serverVariables": { "stage": { "default": "demo", "description": "This value is assigned by the service provider, in this example `mycompany.com`" }, "port": { "enum": [ "5671", "5672" ], "default": "5672" } }, "channels": { "user/signedup": { "subscribe": { "message": { "$ref": "#/components/messages/userSignUp" } } } }, "messages": { "userSignUp": { "summary": "Action to sign a user up.", "description": "Multiline description of what this action does.\nHere you have another line.\n", "tags": [ { "name": "user" }, { "name": "signup" } ], "headers": { "type": "object", "properties": { "applicationInstanceId": { "description": "Unique identifier for a given instance of the publishing application", "type": "string" } } }, "payload": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/userCreate" }, "signup": { "$ref": "#/components/schemas/signup" } } } } }, "parameters": { "userId": { "description": "Id of the user." } }, "correlationIds": { "default": { "description": "Default Correlation ID", "location": "$message.header#/correlationId" } }, "messageTraits": { "commonHeaders": { "headers": { "type": "object", "properties": { "my-app-header": { "type": "integer", "minimum": 0, "maximum": 100 } } } } } } }
An object to hold reusable Schema Object. If this is a Schema Object, then the schemaFormat will be assumed to be 'application/vnd.aai.asyncapi+json;version=asyncapi' where the version is equal to the AsyncAPI Version String.
An object to hold reusable Server Objects.
An object to hold reusable Channel Objects.
An object to hold reusable Server Variable Objects.
An object to hold reusable Message Objects.
An object to hold reusable Security Scheme Objects.
An object to hold reusable Parameter Objects.
An object to hold reusable Correlation ID Objects.
An object to hold reusable Operation Trait Objects.
An object to hold reusable Message Trait Objects.
An object to hold reusable Operation Reply Objects.
An object to hold reusable Operation Reply Address Objects.
An object to hold reusable Server Bindings Objects.
An object to hold reusable Channel Bindings Objects.
An object to hold reusable Operation Bindings Objects.
An object to hold reusable Message Bindings Objects.
An object to hold reusable Tag Objects.
An object to hold reusable External Documentation Objects.