@redocly/openapi-core 2.37.0 → 2.39.0

package/lib/types/asyncapi2.js

@@ -1,3 +1,4 @@
+import { AsyncApiBindings } from './asyncapi-bindings.js';
 import { listOf, mapOf } from './index.js';
 import { Dependencies, Discriminator, DiscriminatorMapping, Schema, SchemaProperties, } from './json-schema-draft7.shared.js';
 const Root = {
@@ -39,35 +40,6 @@ const ChannelMap = {
     properties: {},
     additionalProperties: 'Channel',
 };
-const ChannelBindings = {
-    properties: {},
-    allowed() {
-        // allow all supported values, not all have deep linting
-        return [
-            'http',
-            'ws',
-            'kafka',
-            'anypointmq',
-            'amqp',
-            'amqp1',
-            'mqtt',
-            'mqtt5',
-            'nats',
-            'jms',
-            'sns',
-            'solace',
-            'sqs',
-            'stomp',
-            'redis',
-            'mercure',
-            'ibmmq',
-            'googlepubsub',
-            'pulsar',
-        ];
-    },
-    additionalProperties: { type: 'object' },
-    description: 'Map describing protocol-specific definitions for a channel.',
-};
 export const Tag = {
     properties: {
         name: { type: 'string', description: 'REQUIRED. The name of the tag.' },
@@ -99,35 +71,6 @@ const SecurityRequirement = {
     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: {},
-    allowed() {
-        // allow all supported values, not all have deep linting
-        return [
-            'http',
-            'ws',
-            'kafka',
-            'anypointmq',
-            'amqp',
-            'amqp1',
-            'mqtt',
-            'mqtt5',
-            'nats',
-            'jms',
-            'sns',
-            'solace',
-            'sqs',
-            'stomp',
-            'redis',
-            'mercure',
-            'ibmmq',
-            'googlepubsub',
-            'pulsar',
-        ];
-    },
-    additionalProperties: { type: 'object' },
-    description: 'Map describing protocol-specific definitions for a server.',
-};
 const Server = {
     properties: {
         url: {
@@ -309,64 +252,6 @@ const Message = {
     additionalProperties: {},
     description: 'Describes a message received on a given channel and operation.',
 };
-const MessageBindings = {
-    properties: {},
-    allowed() {
-        // allow all supported values, not all have deep linting
-        return [
-            'http',
-            'ws',
-            'kafka',
-            'anypointmq',
-            'amqp',
-            'amqp1',
-            'mqtt',
-            'mqtt5',
-            'nats',
-            'jms',
-            'sns',
-            'solace',
-            'sqs',
-            'stomp',
-            'redis',
-            'mercure',
-            'ibmmq',
-            'googlepubsub',
-            'pulsar',
-        ];
-    },
-    additionalProperties: { type: 'object' },
-    description: 'Map describing protocol-specific definitions for a message.',
-};
-const OperationBindings = {
-    properties: {},
-    allowed() {
-        // allow all supported values, not all have deep linting
-        return [
-            'http',
-            'ws',
-            'kafka',
-            'anypointmq',
-            'amqp',
-            'amqp1',
-            'mqtt',
-            'mqtt5',
-            'nats',
-            'jms',
-            'sns',
-            'solace',
-            'sqs',
-            'stomp',
-            'redis',
-            'mercure',
-            'ibmmq',
-            'googlepubsub',
-            'pulsar',
-        ];
-    },
-    additionalProperties: { type: 'object' },
-    description: 'Map describing protocol-specific definitions for an operation.',
-};
 const OperationTrait = {
     properties: {
         tags: 'TagList',
@@ -618,494 +503,8 @@ 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 = {
-    properties: {
-        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 = {
-    properties: {
-        type: { type: 'string' },
-        method: {
-            type: 'string',
-            enum: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS', 'CONNECT', 'TRACE'],
-        },
-        headers: 'Schema',
-        bindingVersion: { type: 'string' },
-    },
-    description: 'Protocol-specific information for an HTTP operation.',
-};
-OperationBindings.properties.http = HttpOperationBinding;
-// ws
-const WsChannelBinding = {
-    properties: {
-        method: { type: 'string' },
-        query: 'Schema',
-        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
-const KafkaTopicConfiguration = {
-    properties: {
-        'cleanup.policy': { type: 'array', items: { enum: ['delete', 'compact'] } },
-        'retention.ms': { type: 'integer' },
-        'retention.bytes': { type: 'integer' },
-        'delete.retention.ms': { type: 'integer' },
-        'max.message.bytes': { type: 'integer' },
-    },
-};
-const KafkaChannelBinding = {
-    properties: {
-        topic: { type: 'string' },
-        partitions: { type: 'integer' },
-        replicas: { type: 'integer' },
-        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 = {
-    properties: {
-        key: 'Schema', // TODO: add avro support
-        schemaIdLocation: { type: 'string' },
-        schemaIdPayloadEncoding: { type: 'string' },
-        schemaLookupStrategy: { type: 'string' },
-        bindingVersion: { type: 'string' },
-    },
-    description: 'Protocol-specific information for a Kafka message.',
-};
-MessageBindings.properties.kafka = KafkaMessageBinding;
-const KafkaOperationBinding = {
-    properties: {
-        groupId: 'Schema',
-        clientId: 'Schema',
-        bindingVersion: { type: 'string' },
-    },
-    description: 'Protocol-specific information for a Kafka operation.',
-};
-OperationBindings.properties.kafka = KafkaOperationBinding;
-// anypointmq
-const AnypointmqChannelBinding = {
-    properties: {
-        destination: { type: 'string' },
-        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 = {
-    properties: {
-        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 = {
-    properties: {
-        contentEncoding: { type: 'string' },
-        messageType: { type: 'string' },
-        bindingVersion: { type: 'string' },
-    },
-    description: 'Protocol-specific information for an AMQP 0-9-1 message.',
-};
-MessageBindings.properties.amqp = AmqpMessageBinding;
-const AmqpOperationBinding = {
-    // TODO: some fields are subscribe only
-    properties: {
-        expiration: { type: 'integer' },
-        userId: { type: 'string' },
-        cc: { type: 'array', items: { type: 'string' } },
-        priority: { type: 'integer' },
-        deliveryMode: { type: 'integer' }, // TODO: enum: [1, 2]
-        mandatory: { type: 'boolean' },
-        bcc: { type: 'array', items: { type: 'string' } },
-        replyTo: { type: 'string' },
-        timestamp: { type: 'boolean' },
-        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,
-    description: 'Protocol-specific information for an AMQP 1.0 operation.',
-};
-OperationBindings.properties.amqp1 = Amqp1OperationBinding;
-// mqtt
-const MqttChannelBinding = {
-    properties: {
-        qos: { type: 'integer' },
-        retain: { type: 'boolean' },
-        bindingVersion: { type: 'string' },
-    },
-    description: 'Protocol-specific information for an MQTT channel.',
-};
-ChannelBindings.properties.mqtt = MqttChannelBinding;
-const MqttServerBindingLastWill = {
-    properties: {
-        topic: { type: 'string' },
-        qos: { type: 'integer' },
-        message: { type: 'string' },
-        retain: { type: 'boolean' },
-    },
-};
-const MqttServerBinding = {
-    properties: {
-        clientId: { type: 'string' },
-        cleanSession: { type: 'boolean' },
-        lastWill: 'MqttServerBindingLastWill',
-        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 = {
-    properties: {
-        qos: { type: 'integer' },
-        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 = {
-    properties: {
-        queue: { type: 'string' },
-        bindingVersion: { type: 'string' },
-    },
-    description: 'Protocol-specific information for a NATS operation.',
-};
-OperationBindings.properties.nats = NatsOperationBinding;
-// jms
-const JmsChannelBinding = {
-    properties: {
-        destination: { type: 'string' },
-        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 = {
-    properties: {
-        headers: 'Schema',
-        bindingVersion: { type: 'string' },
-    },
-    description: 'Protocol-specific information for a JMS message.',
-};
-MessageBindings.properties.jms = JmsMessageBinding;
-const JmsOperationBinding = {
-    properties: {
-        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 = {
-    properties: {
-        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 = {
-    properties: {
-        destinationType: { type: 'string', enum: ['queue', 'topic'] },
-        deliveryMode: { type: 'string', enum: ['direct', 'persistent'] },
-        'queue.name': { type: 'string' },
-        'queue.topicSubscriptions': { type: 'array', items: { type: 'string' } },
-        'queue.accessType': { type: 'string', enum: ['exclusive', 'nonexclusive'] },
-        'queue.maxMsgSpoolSize': { type: 'string' },
-        'queue.maxTtl': { type: 'string' },
-        'topic.topicSubscriptions': { type: 'array', items: { type: 'string' } },
-    },
-};
-const SolaceOperationBinding = {
-    properties: {
-        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
-// googlepubsub
-// pulsar
-// --- End per-protocol node types
-export const AsyncApi2Bindings = {
-    HttpServerBinding,
-    HttpChannelBinding,
-    HttpMessageBinding,
-    HttpOperationBinding,
-    WsServerBinding,
-    WsChannelBinding,
-    WsMessageBinding,
-    WsOperationBinding,
-    KafkaServerBinding,
-    KafkaTopicConfiguration,
-    KafkaChannelBinding,
-    KafkaMessageBinding,
-    KafkaOperationBinding,
-    AnypointmqServerBinding,
-    AnypointmqChannelBinding,
-    AnypointmqMessageBinding,
-    AnypointmqOperationBinding,
-    AmqpServerBinding,
-    AmqpChannelBinding,
-    AmqpMessageBinding,
-    AmqpOperationBinding,
-    Amqp1ServerBinding,
-    Amqp1ChannelBinding,
-    Amqp1MessageBinding,
-    Amqp1OperationBinding,
-    MqttServerBindingLastWill,
-    MqttServerBinding,
-    MqttChannelBinding,
-    MqttMessageBinding,
-    MqttOperationBinding,
-    Mqtt5ServerBinding,
-    Mqtt5ChannelBinding,
-    Mqtt5MessageBinding,
-    Mqtt5OperationBinding,
-    NatsServerBinding,
-    NatsChannelBinding,
-    NatsMessageBinding,
-    NatsOperationBinding,
-    JmsServerBinding,
-    JmsChannelBinding,
-    JmsMessageBinding,
-    JmsOperationBinding,
-    SolaceServerBinding,
-    SolaceChannelBinding,
-    SolaceMessageBinding,
-    SolaceDestination,
-    SolaceOperationBinding,
-    StompServerBinding,
-    StompChannelBinding,
-    StompMessageBinding,
-    StompOperationBinding,
-    RedisServerBinding,
-    RedisChannelBinding,
-    RedisMessageBinding,
-    RedisOperationBinding,
-    MercureServerBinding,
-    MercureChannelBinding,
-    MercureMessageBinding,
-    MercureOperationBinding,
-    ServerBindings,
-    ChannelBindings,
-    MessageBindings,
-    OperationBindings,
-};
 export const AsyncApi2Types = {
-    ...AsyncApi2Bindings,
+    ...AsyncApiBindings,
     Root,
     Tag,
     TagList: listOf('Tag'),
@@ -1144,8 +543,6 @@ export const AsyncApi2Types = {
     SecuritySchemeFlows,
     SecurityScheme,
     Message,
-    MessageBindings,
-    OperationBindings,
     OperationTrait,
     OperationTraitList: listOf('OperationTrait'),
     MessageTrait,