@redocly/openapi-core 2.15.0 → 2.15.2

package/lib/types/asyncapi2.js

@@ -4,7 +4,10 @@ const Root = {
     properties: {
         asyncapi: null, // TODO: validate semver format and supported version
         info: 'Info',
-        id: { type: 'string' },
+        id: {
+            type: 'string',
+            description: 'Identifier of the application the AsyncAPI document is defining.',
+        },
         servers: 'ServerMap',
         channels: 'ChannelMap',
         components: 'Components',
@@ -16,13 +19,21 @@ const Root = {
 };
 const Channel = {
     properties: {
-        description: { type: 'string' },
+        description: {
+            type: 'string',
+            description: 'An optional description of this channel item. CommonMark syntax can be used for rich text representation.',
+        },
         subscribe: 'Operation',
         publish: 'Operation',
         parameters: 'ParametersMap',
         bindings: 'ChannelBindings',
-        servers: { type: 'array', items: { type: 'string' } },
+        servers: {
+            type: 'array',
+            items: { type: 'string' },
+            description: 'The servers on which this channel is available, specified as an optional unordered list of names (string keys) of Server Objects defined in the Servers Object (a map).',
+        },
     },
+    description: 'Describes the operations available on a single channel.',
 };
 const ChannelMap = {
     properties: {},
@@ -55,25 +66,38 @@ const ChannelBindings = {
         ];
     },
     additionalProperties: { type: 'object' },
+    description: 'Map describing protocol-specific definitions for a channel.',
 };
 export const Tag = {
     properties: {
-        name: { type: 'string' },
-        description: { type: 'string' },
+        name: { type: 'string', description: 'REQUIRED. The name of the tag.' },
+        description: {
+            type: 'string',
+            description: 'A short description for the tag. CommonMark syntax can be used for rich text representation.',
+        },
         externalDocs: 'ExternalDocs',
     },
     required: ['name'],
+    description: 'Allows adding meta data to a single tag.',
 };
 export const ExternalDocs = {
     properties: {
-        description: { type: 'string' },
-        url: { type: 'string' },
+        description: {
+            type: 'string',
+            description: 'A short description of the target documentation. CommonMark syntax can be used for rich text representation.',
+        },
+        url: {
+            type: 'string',
+            description: 'REQUIRED. The URL for the target documentation. This MUST be in the form of an absolute URL.',
+        },
     },
     required: ['url'],
+    description: 'Allows referencing an external resource for extended documentation.',
 };
 const SecurityRequirement = {
     properties: {},
     additionalProperties: { type: 'array', items: { type: 'string' } },
+    description: 'Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.',
 };
 const ServerBindings = {
     properties: {},
@@ -102,19 +126,33 @@ const ServerBindings = {
         ];
     },
     additionalProperties: { type: 'object' },
+    description: 'Map describing protocol-specific definitions for a server.',
 };
 const Server = {
     properties: {
-        url: { type: 'string' },
-        protocol: { type: 'string' },
-        protocolVersion: { type: 'string' },
-        description: { type: 'string' },
+        url: {
+            type: 'string',
+            description: 'REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the AsyncAPI document is being served. Variable substitutions will be made when a variable is named in {braces}.',
+        },
+        protocol: {
+            type: 'string',
+            description: 'REQUIRED. The protocol this URL supports for connection. Supported protocol include, but are not limited to: amqp, amqps, http, https, ibmmq, jms, kafka, kafka-secure, anypointmq, mqtt, secure-mqtt, solace, stomp, stomps, ws, wss, mercure, googlepubsub, pulsar.',
+        },
+        protocolVersion: {
+            type: 'string',
+            description: 'The version of the protocol used for connection. For instance: AMQP 0.9.1, HTTP 2.0, Kafka 1.0.0, etc.',
+        },
+        description: {
+            type: 'string',
+            description: 'An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.',
+        },
         variables: 'ServerVariablesMap',
         security: 'SecurityRequirementList',
         bindings: 'ServerBindings',
         tags: 'TagList',
     },
     required: ['url', 'protocol'],
+    description: 'An object representing a message broker, a server or any other kind of computer program capable of sending and/or receiving data. This object is used to capture details such as URIs, protocols and security configuration. Variable substitution can be used so that some details, for example usernames and passwords, can be injected by code generation tools.',
 };
 export const ServerMap = {
     properties: {},
@@ -127,67 +165,141 @@ export const ServerVariable = {
         enum: {
             type: 'array',
             items: { type: 'string' },
+            description: 'An enumeration of string values to be used if the substitution options are from a limited set.',
+        },
+        default: {
+            type: 'string',
+            description: 'The default value to use for substitution, and to send, if an alternate value is not supplied.',
+        },
+        description: {
+            type: 'string',
+            description: 'An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.',
         },
-        default: { type: 'string' },
-        description: { type: 'string' },
         examples: {
             type: 'array',
             items: { type: 'string' },
+            description: 'An array of examples of the server variable.',
         },
     },
     required: [],
+    description: 'An object representing a Server Variable for server URL template substitution.',
 };
 const Info = {
     properties: {
-        title: { type: 'string' },
-        version: { type: 'string' },
-        description: { type: 'string' },
-        termsOfService: { type: 'string' },
+        title: {
+            type: 'string',
+            description: 'REQUIRED. The title of the application.',
+        },
+        version: {
+            type: 'string',
+            description: 'REQUIRED Provides the version of the application API (not to be confused with the specification version).',
+        },
+        description: {
+            type: 'string',
+            description: 'A short description of the application. CommonMark syntax can be used for rich text representation.',
+        },
+        termsOfService: {
+            type: 'string',
+            description: 'A URL to the Terms of Service for the API. This MUST be in the form of an absolute URL.',
+        },
         contact: 'Contact',
         license: 'License',
     },
     required: ['title', 'version'],
+    description: 'The object provides metadata about the API. The metadata can be used by the clients if needed.',
 };
 export const Contact = {
     properties: {
-        name: { type: 'string' },
-        url: { type: 'string' },
-        email: { type: 'string' },
+        name: {
+            type: 'string',
+            description: 'The identifying name of the contact person/organization.',
+        },
+        url: {
+            type: 'string',
+            description: 'The URL pointing to the contact information. This MUST be in the form of an absolute URL.',
+        },
+        email: {
+            type: 'string',
+            description: 'The email address of the contact person/organization. MUST be in the format of an email address.',
+        },
     },
+    description: 'Contact information for the exposed API.',
 };
 export const License = {
     properties: {
-        name: { type: 'string' },
-        url: { type: 'string' },
+        name: {
+            type: 'string',
+            description: 'REQUIRED. The license name used for the API.',
+        },
+        url: {
+            type: 'string',
+            description: 'A URL to the license used for the API. This MUST be in the form of an absolute URL.',
+        },
     },
     required: ['name'],
+    description: 'License information for the exposed API.',
 };
 const Parameter = {
     properties: {
-        description: { type: 'string' },
+        description: {
+            type: 'string',
+            description: 'A verbose explanation of the parameter. CommonMark syntax can be used for rich text representation.',
+        },
         schema: 'Schema',
-        location: { type: 'string' },
+        location: {
+            type: 'string',
+            description: 'A runtime expression that specifies the location of the parameter value. Even when a definition for the target field exists, it MUST NOT be used to validate this parameter but, instead, the schema property MUST be used.',
+        },
     },
+    description: 'Describes a parameter included in a channel name.',
 };
 export const CorrelationId = {
     properties: {
-        description: { type: 'string' },
-        location: { type: 'string' },
+        description: {
+            type: 'string',
+            description: 'An optional description of the identifier. CommonMark syntax can be used for rich text representation.',
+        },
+        location: {
+            type: 'string',
+            description: 'REQUIRED. A runtime expression that specifies the location of the correlation ID.',
+        },
     },
     required: ['location'],
+    description: 'An object that specifies an identifier at design time that can used for message tracing and correlation.',
 };
 const Message = {
     properties: {
-        messageId: { type: 'string' },
+        messageId: {
+            type: 'string',
+            description: 'Unique string used to identify the message. The id MUST be unique among all messages described in the API. The messageId value is case-sensitive. Tools and libraries MAY use the messageId to uniquely identify a message, therefore, it is RECOMMENDED to follow common programming naming conventions.',
+        },
         headers: 'Schema',
         payload: 'Schema', // TODO: strictly this does not cover all cases
         correlationId: 'CorrelationId',
-        schemaFormat: { type: 'string' }, // TODO: support official list of schema formats and custom values
-        contentType: { type: 'string' },
-        name: { type: 'string' },
-        title: { type: 'string' },
-        summary: { type: 'string' },
-        description: { type: 'string' },
+        schemaFormat: {
+            type: 'string',
+            description: 'A string containing the name of the schema format used to define the message payload. If omitted, implementations should parse the payload as a Schema object. When the payload is defined using a $ref to a remote file, it is RECOMMENDED the schema format includes the file encoding type to allow implementations to parse the file correctly.',
+        }, // TODO: support official list of schema formats and custom values
+        contentType: {
+            type: 'string',
+            description: `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.`,
+        },
+        name: {
+            type: 'string',
+            description: 'A machine-friendly name for the message.',
+        },
+        title: {
+            type: 'string',
+            description: 'A human-friendly title for the message.',
+        },
+        summary: {
+            type: 'string',
+            description: 'A short summary of what the message is about.',
+        },
+        description: {
+            type: 'string',
+            description: 'A verbose explanation of the message. CommonMark syntax can be used for rich text representation.',
+        },
         tags: 'TagList',
         externalDocs: 'ExternalDocs',
         bindings: 'MessageBindings',
@@ -195,6 +307,7 @@ const Message = {
         traits: 'MessageTraitList',
     },
     additionalProperties: {},
+    description: 'Describes a message received on a given channel and operation.',
 };
 const MessageBindings = {
     properties: {},
@@ -223,6 +336,7 @@ const MessageBindings = {
         ];
     },
     additionalProperties: { type: 'object' },
+    description: 'Map describing protocol-specific definitions for a message.',
 };
 const OperationBindings = {
     properties: {},
@@ -251,58 +365,114 @@ const OperationBindings = {
         ];
     },
     additionalProperties: { type: 'object' },
+    description: 'Map describing protocol-specific definitions for an operation.',
 };
 const OperationTrait = {
     properties: {
         tags: 'TagList',
-        summary: { type: 'string' },
-        description: { type: 'string' },
+        summary: {
+            type: 'string',
+            description: 'A short summary of what the operation is about.',
+        },
+        description: {
+            type: 'string',
+            description: 'A verbose explanation of the operation. CommonMark syntax can be used for rich text representation.',
+        },
         externalDocs: 'ExternalDocs',
-        operationId: { type: 'string' },
+        operationId: {
+            type: 'string',
+            description: 'Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.',
+        },
         security: 'SecurityRequirementList',
         bindings: 'OperationBindings',
     },
     required: [],
+    description: 'Describes a trait that MAY be applied to an Operation Object. This object MAY contain any property from the Operation Object, except message and traits.',
 };
 const MessageTrait = {
     properties: {
-        messageId: { type: 'string' },
+        messageId: {
+            type: 'string',
+            description: 'Unique string used to identify the message. The id MUST be unique among all messages described in the API. The messageId value is case-sensitive. Tools and libraries MAY use the messageId to uniquely identify a message, therefore, it is RECOMMENDED to follow common programming naming conventions.',
+        },
         headers: 'Schema',
         correlationId: 'CorrelationId',
-        schemaFormat: { type: 'string' },
-        contentType: { type: 'string' },
-        name: { type: 'string' },
-        title: { type: 'string' },
-        summary: { type: 'string' },
-        description: { type: 'string' },
+        schemaFormat: {
+            type: 'string',
+            description: 'A string containing the name of the schema format/language used to define the message payload. If omitted, implementations should parse the payload as a Schema object.',
+        },
+        contentType: {
+            type: 'string',
+            description: `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.`,
+        },
+        name: {
+            type: 'string',
+            description: 'A verbose explanation of the message. CommonMark syntax can be used for rich text representation.',
+        },
+        title: {
+            type: 'string',
+            description: 'A human-friendly title for the message.',
+        },
+        summary: {
+            type: 'string',
+            description: 'A short summary of what the message is about.',
+        },
+        description: {
+            type: 'string',
+            description: 'A verbose explanation of the message. CommonMark syntax can be used for rich text representation.',
+        },
         tags: 'TagList',
         externalDocs: 'ExternalDocs',
         bindings: 'MessageBindings',
         examples: 'MessageExampleList',
     },
     additionalProperties: {},
+    description: '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.',
 };
 const Operation = {
     properties: {
         tags: 'TagList',
-        summary: { type: 'string' },
-        description: { type: 'string' },
+        summary: {
+            type: 'string',
+            description: 'A short summary of what the operation is about.',
+        },
+        description: {
+            type: 'string',
+            description: 'A verbose explanation of the operation. CommonMark syntax can be used for rich text representation.',
+        },
         externalDocs: 'ExternalDocs',
-        operationId: { type: 'string' },
+        operationId: {
+            type: 'string',
+            description: 'Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.',
+        },
         security: 'SecurityRequirementList',
         bindings: 'OperationBindings',
         traits: 'OperationTraitList',
         message: 'Message',
     },
     required: [],
+    description: 'Describes a publish or a subscribe operation. This provides a place to document how and why messages are sent and received.',
 };
 export const MessageExample = {
     properties: {
-        payload: { isExample: true },
-        summary: { type: 'string' },
-        name: { type: 'string' },
-        headers: { type: 'object' },
+        payload: {
+            isExample: true,
+            description: `The value of this field MUST validate against the Message Object's payload field.`,
+        },
+        summary: {
+            type: 'string',
+            description: 'A short summary of what the example is about.',
+        },
+        name: {
+            type: 'string',
+            description: 'A machine-friendly name.',
+        },
+        headers: {
+            type: 'object',
+            description: `The value of this field MUST validate against the Message Object's headers field.`,
+        },
     },
+    description: 'Message Example Object represents an example of a Message Object and MUST contain either headers and/or payload fields.',
 };
 const Components = {
     properties: {
@@ -329,6 +499,7 @@ const ImplicitFlow = {
         authorizationUrl: { type: 'string' },
     },
     required: ['authorizationUrl', 'scopes'],
+    description: 'Configuration for the OAuth Implicit flow.',
 };
 const PasswordFlow = {
     properties: {
@@ -337,6 +508,7 @@ const PasswordFlow = {
         tokenUrl: { type: 'string' },
     },
     required: ['tokenUrl', 'scopes'],
+    description: 'Configuration for the OAuth Password flow.',
 };
 const ClientCredentials = {
     properties: {
@@ -345,6 +517,7 @@ const ClientCredentials = {
         tokenUrl: { type: 'string' },
     },
     required: ['tokenUrl', 'scopes'],
+    description: 'Configuration for the OAuth Client Credentials flow.',
 };
 const AuthorizationCode = {
     properties: {
@@ -354,6 +527,7 @@ const AuthorizationCode = {
         tokenUrl: { type: 'string' },
     },
     required: ['authorizationUrl', 'tokenUrl', 'scopes'],
+    description: 'Configuration for the OAuth Authorization Code flow.',
 };
 export const SecuritySchemeFlows = {
     properties: {
@@ -382,13 +556,32 @@ const SecurityScheme = {
                 'gssapi',
             ],
         },
-        description: { type: 'string' },
-        name: { type: 'string' },
-        in: { type: 'string', enum: ['query', 'header', 'cookie', 'user', 'password'] },
-        scheme: { type: 'string' },
-        bearerFormat: { type: 'string' },
+        description: {
+            type: 'string',
+            description: 'A short description for security scheme. CommonMark syntax MAY be used for rich text representation.',
+        },
+        name: {
+            type: 'string',
+            description: 'REQUIRED. The name of the header, query or cookie parameter to be used.',
+        },
+        in: {
+            type: 'string',
+            enum: ['query', 'header', 'cookie', 'user', 'password'],
+            description: 'REQUIRED. The location of the API key. Valid values are "user" and "password" for apiKey and "query", "header" or "cookie" for httpApiKey.',
+        },
+        scheme: {
+            type: 'string',
+            description: 'REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.',
+        },
+        bearerFormat: {
+            type: 'string',
+            description: '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.',
+        },
         flows: 'SecuritySchemeFlows',
-        openIdConnectUrl: { type: 'string' },
+        openIdConnectUrl: {
+            type: 'string',
+            description: 'REQUIRED. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of an absolute URL.',
+        },
     },
     required(value) {
         switch (value?.type) {
@@ -423,15 +616,18 @@ const SecurityScheme = {
         }
     },
     extensionsPrefix: 'x-',
+    description: 'Defines a security scheme that can be used by the operations.',
 };
 // --- Per-protocol node types
 // http
 const HttpChannelBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an HTTP channel.',
 };
 ChannelBindings.properties.http = HttpChannelBinding;
 const HttpServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an HTTP server.',
 };
 ServerBindings.properties.http = HttpServerBinding;
 const HttpMessageBinding = {
@@ -439,6 +635,7 @@ const HttpMessageBinding = {
         headers: 'Schema',
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for an HTTP message, i.e., a request or a response.',
 };
 MessageBindings.properties.http = HttpMessageBinding;
 const HttpOperationBinding = {
@@ -451,6 +648,7 @@ const HttpOperationBinding = {
         headers: 'Schema',
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for an HTTP operation.',
 };
 OperationBindings.properties.http = HttpOperationBinding;
 // ws
@@ -461,18 +659,22 @@ const WsChannelBinding = {
         headers: 'Schema',
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for a WebSockets channel.',
 };
 ChannelBindings.properties.ws = WsChannelBinding;
 const WsServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a WebSockets server.',
 };
 ServerBindings.properties.ws = WsServerBinding;
 const WsMessageBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a WebSockets message.',
 };
 MessageBindings.properties.ws = WsMessageBinding;
 const WsOperationBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a WebSockets operation.',
 };
 OperationBindings.properties.ws = WsOperationBinding;
 // kafka
@@ -493,10 +695,12 @@ const KafkaChannelBinding = {
         topicConfiguration: 'KafkaTopicConfiguration',
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for a Kafka channel.',
 };
 ChannelBindings.properties.kafka = KafkaChannelBinding;
 const KafkaServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Kafka server.',
 };
 ServerBindings.properties.kafka = KafkaServerBinding;
 const KafkaMessageBinding = {
@@ -507,6 +711,7 @@ const KafkaMessageBinding = {
         schemaLookupStrategy: { type: 'string' },
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for a Kafka message.',
 };
 MessageBindings.properties.kafka = KafkaMessageBinding;
 const KafkaOperationBinding = {
@@ -515,6 +720,7 @@ const KafkaOperationBinding = {
         clientId: 'Schema',
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for a Kafka operation.',
 };
 OperationBindings.properties.kafka = KafkaOperationBinding;
 // anypointmq
@@ -524,10 +730,12 @@ const AnypointmqChannelBinding = {
         destinationType: { type: 'string' },
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for an Anypoint MQ channel.',
 };
 ChannelBindings.properties.anypointmq = AnypointmqChannelBinding;
 const AnypointmqServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an Anypoint MQ server.',
 };
 ServerBindings.properties.anypointmq = AnypointmqServerBinding;
 const AnypointmqMessageBinding = {
@@ -535,19 +743,23 @@ const AnypointmqMessageBinding = {
         headers: 'Schema',
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for an Anypoint MQ message.',
 };
 MessageBindings.properties.anypointmq = AnypointmqMessageBinding;
 const AnypointmqOperationBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an Anypoint MQ operation.',
 };
 OperationBindings.properties.anypointmq = AnypointmqOperationBinding;
 // amqp
 const AmqpChannelBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an AMQP 0-9-1 channel.',
 };
 ChannelBindings.properties.amqp = AmqpChannelBinding;
 const AmqpServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an AMQP 0-9-1 server.',
 };
 ServerBindings.properties.amqp = AmqpServerBinding;
 const AmqpMessageBinding = {
@@ -556,6 +768,7 @@ const AmqpMessageBinding = {
         messageType: { type: 'string' },
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for an AMQP 0-9-1 message.',
 };
 MessageBindings.properties.amqp = AmqpMessageBinding;
 const AmqpOperationBinding = {
@@ -573,23 +786,28 @@ const AmqpOperationBinding = {
         ack: { type: 'boolean' },
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for an AMQP 0-9-1 operation.',
 };
 OperationBindings.properties.amqp = AmqpOperationBinding;
 // amqp1
 const Amqp1ChannelBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an AMQP 1.0 channel.',
 };
 ChannelBindings.properties.amqp1 = Amqp1ChannelBinding;
 const Amqp1ServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an AMQP 1.0 server.',
 };
 ServerBindings.properties.amqp1 = Amqp1ServerBinding;
 const Amqp1MessageBinding = {
     properties: {}, // empty object
+    description: 'Binding	Protocol-specific information for an AMQP 1.0 message.',
 };
 MessageBindings.properties.amqp1 = Amqp1MessageBinding;
 const Amqp1OperationBinding = {
-    properties: {}, // empty object
+    properties: {}, // empty object,
+    description: 'Protocol-specific information for an AMQP 1.0 operation.',
 };
 OperationBindings.properties.amqp1 = Amqp1OperationBinding;
 // mqtt
@@ -599,6 +817,7 @@ const MqttChannelBinding = {
         retain: { type: 'boolean' },
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for an MQTT channel.',
 };
 ChannelBindings.properties.mqtt = MqttChannelBinding;
 const MqttServerBindingLastWill = {
@@ -617,12 +836,14 @@ const MqttServerBinding = {
         keepAlive: { type: 'integer' },
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for an MQTT server.',
 };
 ServerBindings.properties.mqtt = MqttServerBinding;
 const MqttMessageBinding = {
     properties: {
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for an MQTT message.',
 };
 MessageBindings.properties.mqtt = MqttMessageBinding;
 const MqttOperationBinding = {
@@ -631,36 +852,44 @@ const MqttOperationBinding = {
         retain: { type: 'boolean' },
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for an MQTT operation.',
 };
 OperationBindings.properties.mqtt = MqttOperationBinding;
 // mqtt5
 const Mqtt5ChannelBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an MQTT 5 channel.',
 };
 ChannelBindings.properties.mqtt5 = Mqtt5ChannelBinding;
 const Mqtt5ServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an MQTT 5 server.',
 };
 ServerBindings.properties.mqtt5 = Mqtt5ServerBinding;
 const Mqtt5MessageBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an MQTT 5 message.',
 };
 MessageBindings.properties.mqtt5 = Mqtt5MessageBinding;
 const Mqtt5OperationBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for an MQTT 5 operation.',
 };
 OperationBindings.properties.mqtt5 = Mqtt5OperationBinding;
 // nats
 const NatsChannelBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a NATS channel.',
 };
 ChannelBindings.properties.nats = NatsChannelBinding;
 const NatsServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a NATS server.',
 };
 ServerBindings.properties.nats = NatsServerBinding;
 const NatsMessageBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a NATS message.',
 };
 MessageBindings.properties.nats = NatsMessageBinding;
 const NatsOperationBinding = {
@@ -668,6 +897,7 @@ const NatsOperationBinding = {
         queue: { type: 'string' },
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for a NATS operation.',
 };
 OperationBindings.properties.nats = NatsOperationBinding;
 // jms
@@ -677,10 +907,12 @@ const JmsChannelBinding = {
         destinationType: { type: 'string' },
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for a JMS channel.',
 };
 ChannelBindings.properties.jms = JmsChannelBinding;
 const JmsServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a JMS server.',
 };
 ServerBindings.properties.jms = JmsServerBinding;
 const JmsMessageBinding = {
@@ -688,6 +920,7 @@ const JmsMessageBinding = {
         headers: 'Schema',
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for a JMS message.',
 };
 MessageBindings.properties.jms = JmsMessageBinding;
 const JmsOperationBinding = {
@@ -695,12 +928,14 @@ const JmsOperationBinding = {
         headers: 'Schema',
         bindingVersion: { type: 'string' },
     },
+    description: 'Protocol-specific information for a JMS operation.',
 };
 OperationBindings.properties.jms = JmsOperationBinding;
 // sns
 // solace
 const SolaceChannelBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Solace channel.',
 };
 ChannelBindings.properties.solace = SolaceChannelBinding;
 const SolaceServerBinding = {
@@ -708,10 +943,12 @@ const SolaceServerBinding = {
         bindingVersion: { type: 'string' },
         msgVpn: { type: 'string' },
     },
+    description: 'Protocol-specific information for a Solace message.',
 };
 ServerBindings.properties.solace = SolaceServerBinding;
 const SolaceMessageBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Solace message.',
 };
 MessageBindings.properties.solace = SolaceMessageBinding;
 const SolaceDestination = {
@@ -731,58 +968,71 @@ const SolaceOperationBinding = {
         bindingVersion: { type: 'string' },
         destinations: listOf('SolaceDestination'),
     },
+    description: 'Protocol-specific information for a Solace operation.',
 };
 OperationBindings.properties.solace = SolaceOperationBinding;
 // sqs
 // stomp
 const StompChannelBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a STOMP channel.',
 };
 ChannelBindings.properties.stomp = StompChannelBinding;
 const StompServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a STOMP server.',
 };
 ServerBindings.properties.stomp = StompServerBinding;
 const StompMessageBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a STOMP message.',
 };
 MessageBindings.properties.stomp = StompMessageBinding;
 const StompOperationBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a STOMP operation.',
 };
 OperationBindings.properties.stomp = StompOperationBinding;
 // redis
 const RedisChannelBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Redis channel.',
 };
 ChannelBindings.properties.redis = RedisChannelBinding;
 const RedisServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Redis server.',
 };
 ServerBindings.properties.redis = RedisServerBinding;
 const RedisMessageBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Redis message.',
 };
 MessageBindings.properties.redis = RedisMessageBinding;
 const RedisOperationBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Redis operation.',
 };
 OperationBindings.properties.redis = RedisOperationBinding;
 // mercure
 const MercureChannelBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Mercure channel.',
 };
 ChannelBindings.properties.mercure = MercureChannelBinding;
 const MercureServerBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Mercure server.',
 };
 ServerBindings.properties.mercure = MercureServerBinding;
 const MercureMessageBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Mercure message.',
 };
 MessageBindings.properties.mercure = MercureMessageBinding;
 const MercureOperationBinding = {
     properties: {}, // empty object
+    description: 'Protocol-specific information for a Mercure operation.',
 };
 OperationBindings.properties.mercure = MercureOperationBinding;
 // ibmmq