The zaqar.api.v1.request module

class RequestSchema

Bases: zaqar.common.api.api.Api

headers = {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}

schema = {'queue_delete': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['queue_delete']}, 'body': {'properties': {'queue_name': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name']}}, 'required': ['action', 'headers', 'body']}, 'queue_get': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['queue_get']}, 'body': {'properties': {'queue_name': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name']}}, 'required': ['action', 'headers', 'body']}, 'flavor_delete': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['flavor_delete']}, 'body': {'properties': {'flavor_name': {'type': 'string'}}, 'type': 'object', 'required': ['flavor_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'queue_list': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['queue_list']}, 'body': {'properties': {'marker': {'type': 'string'}, 'detailed': {'type': 'boolean'}, 'limit': {'type': 'integer'}}, 'type': 'object'}}, 'required': ['action', 'headers']}, 'check_node_health': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object'}, 'action': {'enum': ['check_node_health']}}, 'admin': True, 'required': ['action', 'headers']}, 'queue_get_stats': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['queue_get_stats']}, 'body': {'properties': {'queue_name': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'message_post': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['message_post']}, 'body': {'properties': {'queue_name': {'type': 'string'}, 'messages': {'type': 'array'}}, 'type': 'object', 'required': ['queue_name', 'messages']}}, 'required': ['action', 'headers', 'body']}, 'pool_update': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['pool_update']}, 'body': {'properties': {'uri': {'type': 'string'}, 'options': {'type': 'object'}, 'pool_name': {'type': 'string'}, 'weight': {'type': 'integer'}}, 'type': 'object', 'required': ['pool_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'claim_create': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['claim_create']}, 'body': {'properties': {'limit': {'type': 'integer'}, 'queue_name': {'type': 'string'}, 'grace': {'type': 'integer'}, 'ttl': {'type': 'integer'}}, 'type': 'object', 'required': ['queue_name']}}, 'required': ['action', 'headers', 'body']}, 'authenticate': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['X-Project-ID', 'X-Auth-Token']}, 'action': {'enum': ['authenticate']}}, 'required': ['action', 'headers']}, 'subscription_create': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['subscription_create']}, 'body': {'properties': {'subscriber': {'type': 'string'}, 'queue_name': {'type': 'string'}, 'options': {'type': 'object'}, 'ttl': {'type': 'integer'}}, 'type': 'object', 'required': ['queue_name']}}, 'required': ['action', 'headers', 'body']}, 'subscription_get': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['subscription_get']}, 'body': {'properties': {'queue_name': {'type': 'string'}, 'subscription_id': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name', 'subscription_id']}}, 'required': ['action', 'headers', 'body']}, 'flavor_get': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['flavor_get']}, 'body': {'properties': {'detailed': {'type': 'boolean'}, 'flavor_name': {'type': 'string'}}, 'type': 'object', 'required': ['flavor_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'claim_delete': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['claim_delete']}, 'body': {'properties': {'queue_name': {'type': 'string'}, 'claim_id': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name', 'claim_id']}}, 'required': ['action', 'headers', 'body']}, 'subscription_list': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['subscription_list']}, 'body': {'properties': {'queue_name': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name']}}, 'required': ['action', 'headers', 'body']}, 'get_home_doc': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object'}, 'action': {'enum': ['get_home_doc']}}, 'admin': True, 'required': ['action', 'headers']}, 'claim_update': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['claim_update']}, 'body': {'properties': {'ttl': {'type': 'integer'}, 'queue_name': {'type': 'string'}, 'claim_id': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name', 'claim_id']}}, 'required': ['action', 'headers', 'body']}, 'pool_list': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['pool_list']}, 'body': {'properties': {'limit': {'type': 'integer'}, 'pool_name': {'type': 'string'}, 'marker': {'type': 'string'}}, 'type': 'object', 'required': ['pool_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'ping_node': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object'}, 'action': {'enum': ['ping_node']}}, 'admin': True, 'required': ['action', 'headers']}, 'subscription_delete': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['subscription_delete']}, 'body': {'properties': {'queue_name': {'type': 'string'}, 'subscription_id': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name', 'subscription_id']}}, 'required': ['action', 'headers', 'body']}, 'queue_create': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['queue_create']}, 'body': {'properties': {'queue_name': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name']}}, 'required': ['action', 'headers', 'body']}, 'pool_get': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['pool_get']}, 'body': {'properties': {'detailed': {'type': 'boolean'}, 'pool_name': {'type': 'string'}}, 'type': 'object', 'required': ['pool_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'flavor_create': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['flavor_create']}, 'body': {'properties': {'pool_name': {'type': 'string'}, 'flavor_name': {'type': 'string'}, 'capabilities': {'type': 'object'}}, 'type': 'object', 'required': ['flavor_name', 'pool_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'pool_create': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['pool_create']}, 'body': {'properties': {'uri': {'type': 'string'}, 'options': {'type': 'object'}, 'pool_name': {'type': 'string'}, 'weight': {'type': 'integer'}}, 'type': 'object', 'required': ['pool_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'message_delete_many': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['message_delete_many']}, 'body': {'properties': {'message_ids': {'type': 'array'}, 'queue_name': {'type': 'string'}, 'pop': {'type': 'integer'}}, 'type': 'object', 'required': ['queue_name']}}, 'required': ['action', 'headers', 'body']}, 'claim_get': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['claim_get']}, 'body': {'properties': {'queue_name': {'type': 'string'}, 'claim_id': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name', 'claim_id']}}, 'required': ['action', 'headers', 'body']}, 'flavor_list': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['flavor_list']}, 'body': {'properties': {'limit': {'type': 'integer'}, 'flavor_name': {'type': 'string'}, 'marker': {'type': 'string'}}, 'type': 'object', 'required': ['flavor_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'message_get_many': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['message_get_many']}, 'body': {'properties': {'message_ids': {'type': 'array'}, 'queue_name': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name', 'message_ids']}}, 'required': ['action', 'headers', 'body']}, 'message_delete': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['message_delete']}, 'body': {'properties': {'message_id': {'type': 'string'}, 'queue_name': {'type': 'string'}, 'claim_id': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name', 'message_id']}}, 'required': ['action', 'headers', 'body']}, 'message_list': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['message_list']}, 'body': {'properties': {'include_claimed': {'type': 'boolean'}, 'marker': {'type': 'string'}, 'queue_name': {'type': 'string'}, 'echo': {'type': 'boolean'}, 'limit': {'type': 'integer'}}, 'type': 'object', 'required': ['queue_name']}}, 'required': ['action', 'headers', 'body']}, 'pool_delete': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['pool_delete']}, 'body': {'properties': {'pool_name': {'type': 'string'}}, 'type': 'object', 'required': ['pool_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'flavor_update': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['flavor_update']}, 'body': {'properties': {'pool_name': {'type': 'string'}, 'flavor_name': {'type': 'string'}, 'capabilities': {'type': 'object'}}, 'type': 'object', 'required': ['flavor_name']}}, 'admin': True, 'required': ['action', 'headers', 'body']}, 'message_get': {'properties': {'headers': {'properties': {'Client-ID': {'type': 'string'}, 'X-Auth-Token': {'type': 'string'}, 'Accept': {'type': 'string'}, 'X-Project-ID': {'type': 'string'}, 'Date': {'type': 'string'}, 'User-Agent': {'type': 'string'}}, 'type': 'object', 'required': ['Client-ID', 'X-Project-ID']}, 'action': {'enum': ['message_get']}, 'body': {'properties': {'message_id': {'type': 'string'}, 'queue_name': {'type': 'string'}}, 'type': 'object', 'required': ['queue_name', 'message_id']}}, 'required': ['action', 'headers', 'body']}}