The zaqar.api.v1.request module

class RequestSchema

Bases: zaqar.common.api.api.Api

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

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