From 739d14033baf7367fa581dcf2d2419536400853f Mon Sep 17 00:00:00 2001
From: cpallares <cindy.pallaresq@gmail.com>
Date: Mon, 2 Dec 2013 12:05:51 -0600
Subject: [PATCH] Map HTTP request codes in jsonschema

Added schema.py to queues/api/v1/jsonschema. This file maps out the HTTP
request codes in jsonschema to be used by the API.

Partially-Implements: cross-transport-api-spec

Change-Id: I4da61c13a39c0bfe2873f65d14647315494b3554
---
 marconi/queues/api/v1/request.py | 197 +++++++++++++++++++++++++++++++
 1 file changed, 197 insertions(+)
 create mode 100644 marconi/queues/api/v1/request.py

diff --git a/marconi/queues/api/v1/request.py b/marconi/queues/api/v1/request.py
new file mode 100644
index 000000000..1852d59f4
--- /dev/null
+++ b/marconi/queues/api/v1/request.py
@@ -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',
+        },
+    }