Merge "Map HTTP request codes in jsonschema"
This commit is contained in:
commit
13d9fa29e8
197
marconi/queues/api/v1/request.py
Normal file
197
marconi/queues/api/v1/request.py
Normal file
@ -0,0 +1,197 @@
|
|||||||
|
# Copyright (c) 2013 Red Hat, Inc.
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
# implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
|
||||||
|
from marconi.common import api
|
||||||
|
|
||||||
|
|
||||||
|
class RequestSchema(api.Api):
|
||||||
|
|
||||||
|
schema = {
|
||||||
|
'queue_list': {
|
||||||
|
'ref': 'queues',
|
||||||
|
'method': 'GET',
|
||||||
|
'properties': {
|
||||||
|
'marker': {'type': 'string'},
|
||||||
|
'limit': {'type': 'integer'},
|
||||||
|
'detailed': {'type': 'boolean'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'queue_create': {
|
||||||
|
'ref': 'queues/{queue_name}',
|
||||||
|
'method': 'PUT',
|
||||||
|
'required': ['queue_name'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
'queue_exists': {
|
||||||
|
'ref': 'queues/{queue_name}',
|
||||||
|
'method': 'HEAD',
|
||||||
|
'required': ['queue_name'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'queue_delete': {
|
||||||
|
'ref': 'queues/{queue_name}',
|
||||||
|
'method': 'DELETE',
|
||||||
|
'required': ['queue_name'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'queue_set_metadata': {
|
||||||
|
'ref': 'queues/{queue_name}/metadata',
|
||||||
|
'method': 'PUT',
|
||||||
|
'required': ['queue_name'],
|
||||||
|
'properties': {
|
||||||
|
# NOTE(flaper87): Metadata is part
|
||||||
|
# of the request content. No need to
|
||||||
|
# add it here.
|
||||||
|
'queue_name': {'type': 'string'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'queue_get_metadata': {
|
||||||
|
'ref': 'queues/{queue_name}/metadata',
|
||||||
|
'method': 'GET',
|
||||||
|
'required': ['queue_name'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'queue_get_stats': {
|
||||||
|
'ref': 'queues/{queue_name}/stats',
|
||||||
|
'method': 'GET',
|
||||||
|
'required': ['queue_name'],
|
||||||
|
'admin': True,
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'},
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'message_list': {
|
||||||
|
'ref': 'queues/{queue_name}/messages',
|
||||||
|
'method': 'GET',
|
||||||
|
'required': ['queue_name'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'},
|
||||||
|
'marker': {'type': 'string'},
|
||||||
|
'limit': {'type': 'integer'},
|
||||||
|
'echo': {'type': 'boolean'},
|
||||||
|
'include_claimed': {'type': 'boolean'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'message_post': {
|
||||||
|
'ref': 'queues/{queue_name}/messages',
|
||||||
|
'method': 'POST',
|
||||||
|
'required': ['queue_name'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'message_get': {
|
||||||
|
'ref': 'queues/{queue_name}/messages/{message_id}',
|
||||||
|
'method': 'GET',
|
||||||
|
'required': ['queue_name', 'message_id'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'},
|
||||||
|
'message_id': {'type': 'string'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'message_get_many': {
|
||||||
|
'ref': 'queues/{queue_name}/messages',
|
||||||
|
'method': 'GET',
|
||||||
|
'required': ['queue_name', 'ids'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'},
|
||||||
|
'ids': {'type': 'array'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'message_delete': {
|
||||||
|
'ref': 'queues/{queue_name}/messages/{message_id}',
|
||||||
|
'method': 'DELETE',
|
||||||
|
'required': ['queue_name', 'message_id'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'},
|
||||||
|
'message_id': {'type': 'string'},
|
||||||
|
'claim_id': {'type': 'string'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'message_delete_many': {
|
||||||
|
'ref': 'queues/{queue_name}/messages',
|
||||||
|
'method': 'DELETE',
|
||||||
|
'required': ['queue_name', 'ids'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'},
|
||||||
|
'ids': {'type': 'array'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'claim_create': {
|
||||||
|
'ref': 'queues/{queue_name}/claims',
|
||||||
|
'method': 'POST',
|
||||||
|
'required': ['queue_name'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'},
|
||||||
|
'limit': {'type': 'integer'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'claim_get': {
|
||||||
|
'ref': 'queues/{queue_name}/claims/{claim_id}',
|
||||||
|
'method': 'GET',
|
||||||
|
'required': ['queue_name', 'claim_id'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'},
|
||||||
|
'claim_id': {'type': 'string'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'claim_update': {
|
||||||
|
'ref': 'queues/{queue_name}/claims/{claim_id}',
|
||||||
|
'method': 'PATCH',
|
||||||
|
'required': ['queue_name', 'claim_id'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'},
|
||||||
|
'claim_id': {'type': 'string'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'claim_delete': {
|
||||||
|
'ref': 'queues/{queue_name}/claims/{claim_id}',
|
||||||
|
'method': 'DELETE',
|
||||||
|
'required': ['queue_name', 'claim_id'],
|
||||||
|
'properties': {
|
||||||
|
'queue_name': {'type': 'string'},
|
||||||
|
'claim_id': {'type': 'string'}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
'check_node_health': {
|
||||||
|
'ref': '/v1/health',
|
||||||
|
'method': 'GET',
|
||||||
|
},
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user