redis-smq-rest-api
Version:
A RESTful API for RedisSMQ
1,474 lines (1,473 loc) • 277 kB
JSON
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"BindQueueControllerRequestBodyDTO": {
"properties": {
"queue": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
}
},
"required": [
"queue"
],
"type": "object"
},
"BindQueueControllerRequestPathDTO": {
"properties": {
"fanOutName": {
"type": "string"
}
},
"required": [
"fanOutName"
],
"type": "object"
},
"BindQueueControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 403,
"type": "number"
},
{
"const": "ExchangeFanOutQueueTypeError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 422,
"type": "number"
},
{
"const": "ExchangeInvalidFanOutParamsError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueQueueNotFoundError",
"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": "QueueQueueNotFoundError",
"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": 400,
"type": "number"
},
{
"const": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "QueueMessagesConsumerGroupIdNotSupportedError",
"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": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueQueueNotFoundError",
"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": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueQueueNotFoundError",
"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": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueQueueNotFoundError",
"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": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueQueueNotFoundError",
"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"
},
"CountQueuePendingMessagesControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueQueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "QueueMessagesConsumerGroupIdRequiredError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "QueueMessagesConsumerGroupIdNotSupportedError",
"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": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueQueueNotFoundError",
"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": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "QueueQueueExistsError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 201,
"type": "number"
},
{
"properties": {
"properties": {
"properties": {
"deliveryModel": {
"enum": [
0,
1
],
"type": "number"
},
"exchange": {
"type": [
"null",
"string"
]
},
"messagesCount": {
"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"
}
]
}
},
"required": [
"deliveryModel",
"exchange",
"messagesCount",
"queueType",
"rateLimit"
],
"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": 404,
"type": "number"
},
{
"const": "ConsumerGroupsQueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 403,
"type": "number"
},
{
"const": "ConsumerGroupsConsumerGroupNotEmptyError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "QueueInvalidQueueParameterError",
"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": 500,
"type": "number"
},
{
"const": "MessageInvalidParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 403,
"type": "number"
},
{
"const": "MessageMessageInProcessError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "MessageMessageNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 500,
"type": "number"
},
{
"const": "MessageMessageNotDeletedError",
"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": 500,
"type": "number"
},
{
"const": "MessageInvalidParametersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 403,
"type": "number"
},
{
"const": "MessageMessageInProcessError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "MessageMessageNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 500,
"type": "number"
},
{
"const": "MessageMessageNotDeletedError",
"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": 404,
"type": "number"
},
{
"const": "NamespaceNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "NamespaceInvalidNamespaceError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 403,
"type": "number"
},
{
"const": "QueueQueueHasRunningConsumersError",
"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": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 403,
"type": "number"
},
{
"const": "QueueQueueHasRunningConsumersError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 403,
"type": "number"
},
{
"const": "QueueQueueNotEmptyError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 404,
"type": "number"
},
{
"const": "QueueQueueNotFoundError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 204,
"type": "number"
},
{
"type": "null"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
}
]
},
"GetAllExchangesControllerRequestQueryDTO": {
"anyOf": [
{
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
{
"type": "object"
}
]
},
"GetAllExchangesControllerResponseDTO": {
"items": [
{
"const": 200,
"type": "number"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"GetAllQueuesControllerResponseDTO": {
"items": [
{
"const": 200,
"type": "number"
},
{
"items": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"type": "array"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"GetConsumerGroupPendingMessagesControllerRequestPathDTO": {
"properties": {
"consumerGroupId": {
"type": "string"
},
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"consumerGroupId",
"name",
"ns"
],
"type": "object"
},
"GetConsumerGroupPendingMessagesControllerRequestQueryDTO": {
"properties": {
"cursor": {
"type": "number"
},
"pageSize": {
"type": "number"
}
},
"required": [
"cursor",
"pageSize"
],
"type": "object"
},
"GetConsumerGroupPendingMessagesControllerResponseDTO": {
"anyOf": [
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "QueueInvalidQueueParameterError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 400,
"type": "number"
},
{
"const": "QueueMessagesConsumerGroupIdNotSupportedError",
"type": "string"
}
],
"maxItems": 2,
"minItems": 2,
"type": "array"
},
{
"items": [
{
"const": 200,
"type": "number"
},
{
"properties": {
"cursor": {
"type": "number"
},
"items": {
"items": {
"properties": {
"body": {},
"consumeTimeout": {
"type": "number"
},
"consumerGroupId": {
"type": [
"null",
"string"
]
},
"createdAt": {
"type": "number"
},
"destinationQueue": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"exchange": {
"anyOf": [
{
"properties": {
"exchangeTag": {
"type": "string"
},
"params": {
"properties": {
"name": {
"type": "string"
},
"ns": {
"type": "string"
}
},
"required": [
"name",
"ns"
],
"type": "object"
},
"type": {
"const": 0,
"type": "number"
}
},
"required": [
"exchangeTag",
"params",
"type"
],