redis-smq-rest-api
Version:
REST API for RedisSMQ: OpenAPI 3 schema and Swagger UI for managing queues, messages, and consumers.
1,537 lines (1,536 loc) • 341 kB
JSON
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"BindQueueDirectXControllerRequestPathDTO": {
"properties": {
"direct": {
"type": "string"
},
"ns": {
"type": "string"
},
"queue": {
"type": "string"
}
},
"required": [
"direct",
"ns",
"queue"
],
"type": "object"
},
"BindQueueDirectXControllerRequestQueryDTO": {
"properties": {
"routingKey": {
"type": "string"
}
},
"required": [
"routingKey"
],
"type": "object"
},
"BindQueueDirectXControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidDirectExchangeParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 500,
"type": "number"
},
{
"const": "QueueDeliveryModelMismatchError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"BindQueueFanoutXControllerRequestPathDTO": {
"properties": {
"fanout": {
"type": "string"
},
"ns": {
"type": "string"
},
"queue": {
"type": "string"
}
},
"required": [
"fanout",
"ns",
"queue"
],
"type": "object"
},
"BindQueueFanoutXControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidFanoutExchangeParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 500,
"type": "number"
},
{
"const": "QueueDeliveryModelMismatchError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"BindQueueTopicXControllerRequestPathDTO": {
"properties": {
"ns": {
"type": "string"
},
"queue": {
"type": "string"
},
"topic": {
"type": "string"
}
},
"required": [
"ns",
"queue",
"topic"
],
"type": "object"
},
"BindQueueTopicXControllerRequestQueryDTO": {
"properties": {
"bindingPattern": {
"type": "string"
}
},
"required": [
"bindingPattern"
],
"type": "object"
},
"BindQueueTopicXControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidDirectExchangeParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 500,
"type": "number"
},
{
"const": "QueueDeliveryModelMismatchError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"ClearQueueRateLimitControllerRequestPathDTO": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"ClearQueueRateLimitControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"CountConsumerGroupPendingMessagesControllerRequestPathDTO": {
"properties": {
"consumerGroupId": {
"type": "string"
},
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"consumerGroupId",
"name",
"ns"
],
"type": "object"
},
"CountConsumerGroupPendingMessagesControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 501,
"type": "number"
},
{
"const": "ConsumerGroupsNotSupportedError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 200,
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"CountQueueAcknowledgedMessagesControllerRequestPathDTO": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"CountQueueAcknowledgedMessagesControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 500,
"type": "number"
},
{
"const": "QueueNotBoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 200,
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"CountQueueDeadLetteredMessagesControllerRequestPathDTO": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"CountQueueDeadLetteredMessagesControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 200,
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"CountQueueMessagesByStatusControllerRequestPathDTO": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"CountQueueMessagesByStatusControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 200,
"type": "number"
},
{
"properties": {
"acknowledged": {
"type": "number"
},
"deadLettered": {
"type": "number"
},
"pending": {
"anyOf": [
{
"additionalProperties": {
"type": "number"
},
"type": "object"
},
{
"type": "number"
}
]
},
"scheduled": {
"type": "number"
}
},
"required": [
"acknowledged",
"deadLettered",
"pending",
"scheduled"
],
"type": "object"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"CountQueueMessagesControllerRequestPathDTO": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"CountQueueMessagesControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 200,
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"CountQueuePendingMessagesControllerRequestPathDTO": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"CountQueuePendingMessagesControllerRequestQueryDTO": {
"properties": {
"consumerGroupId": {
"type": "string"
}
},
"type": "object"
},
"CountQueuePendingMessagesControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "ConsumerGroupRequiredError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 501,
"type": "number"
},
{
"const": "ConsumerGroupsNotSupportedError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 200,
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"CountQueueScheduledMessagesControllerRequestPathDTO": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"CountQueueScheduledMessagesControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 200,
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"CreateQueueControllerRequestBodyDTO": {
"properties": {
"queue": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"queueDeliveryModel": {
"enum": [
0,
1
],
"type": "number"
},
"queueType": {
"enum": [
0,
1,
2
],
"type": "number"
}
},
"required": [
"queue",
"queueDeliveryModel",
"queueType"
],
"type": "object"
},
"CreateQueueControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 409,
"type": "number"
},
{
"const": "QueueAlreadyExistsError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 201,
"type": "number"
},
{
"properties": {
"properties": {
"properties": {
"acknowledgedMessagesCount": {
"type": "number"
},
"deadLetteredMessagesCount": {
"type": "number"
},
"delayedMessagesCount": {
"type": "number"
},
"deliveryModel": {
"enum": [
0,
1
],
"type": "number"
},
"messagesCount": {
"type": "number"
},
"pendingMessagesCount": {
"type": "number"
},
"processingMessagesCount": {
"type": "number"
},
"queueType": {
"enum": [
0,
1,
2
],
"type": "number"
},
"rateLimit": {
"anyOf": [
{
"properties": {
"interval": {
"type": "number"
},
"limit": {
"type": "number"
}
},
"required": [
"interval",
"limit"
],
"type": "object"
},
{
"type": "null"
}
]
},
"requeuedMessagesCount": {
"type": "number"
},
"scheduledMessagesCount": {
"type": "number"
}
},
"required": [
"acknowledgedMessagesCount",
"deadLetteredMessagesCount",
"delayedMessagesCount",
"deliveryModel",
"messagesCount",
"pendingMessagesCount",
"processingMessagesCount",
"queueType",
"rateLimit",
"requeuedMessagesCount",
"scheduledMessagesCount"
],
"type": "object"
},
"queue": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
}
},
"required": [
"properties",
"queue"
],
"type": "object"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"DeleteConsumerGroupControllerRequestPathDTO": {
"properties": {
"consumerGroupId": {
"type": "string"
},
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"consumerGroupId",
"name",
"ns"
],
"type": "object"
},
"DeleteConsumerGroupControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 409,
"type": "number"
},
{
"const": "ConsumerGroupNotEmptyError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"DeleteExchangeDirectXControllerRequestPathDTO": {
"properties": {
"direct": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"direct",
"ns"
],
"type": "object"
},
"DeleteExchangeDirectXControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 500,
"type": "number"
},
{
"const": "ExchangeHasBoundQueuesError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidFanoutExchangeParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"DeleteExchangeFanoutXControllerRequestPathDTO": {
"properties": {
"fanout": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"fanout",
"ns"
],
"type": "object"
},
"DeleteExchangeFanoutXControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 500,
"type": "number"
},
{
"const": "ExchangeHasBoundQueuesError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidFanoutExchangeParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"DeleteExchangeTopicXControllerRequestPathDTO": {
"properties": {
"ns": {
"type": "string"
},
"topic": {
"type": "string"
}
},
"required": [
"ns",
"topic"
],
"type": "object"
},
"DeleteExchangeTopicXControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 500,
"type": "number"
},
{
"const": "ExchangeHasBoundQueuesError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidFanoutExchangeParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"DeleteMessageByIdControllerRequestPathDTO": {
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"DeleteMessageByIdControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "MessageNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"DeleteMessagesByIdsControllerRequestQueryDTO": {
"properties": {
"ids": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"ids"
],
"type": "object"
},
"DeleteMessagesByIdsControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "MessageNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"DeleteNamespaceControllerRequestPathDTO": {
"properties": {
"ns": {
"type": "string"
}
},
"required": [
"ns"
],
"type": "object"
},
"DeleteNamespaceControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidNamespaceError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "NamespaceNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 500,
"type": "number"
},
{
"const": "QueueManagerActiveConsumersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"DeleteQueueControllerRequestPathDTO": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"DeleteQueueControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "InvalidQueueParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{