Merge "feat(wsgi): homedoc now ships relative URIs"

This commit is contained in:
Jenkins
2013-08-29 20:07:28 +00:00
committed by Gerrit Code Review

View File

@@ -16,32 +16,18 @@
import json import json
DOC_ROOT = 'http://docs.openstack-marconi.org'
"""Root URL for documents refered to in the home document."""
# NOTE(kgriffs): http://tools.ietf.org/html/draft-nottingham-json-home-03 # NOTE(kgriffs): http://tools.ietf.org/html/draft-nottingham-json-home-03
JSON_HOME = { JSON_HOME = {
'resources': { 'resources': {
#------------------------------------------------------------------
# Diagnostics
#------------------------------------------------------------------
DOC_ROOT + '/rel/health': {
'href': '/health',
'hints': {
'allow': ['GET', 'HEAD'],
},
},
#------------------------------------------------------------------ #------------------------------------------------------------------
# Queues # Queues
#------------------------------------------------------------------ #------------------------------------------------------------------
DOC_ROOT + '/rel/queues': { 'rel/queues': {
'href-template': '/queues{?marker,limit,detailed}', 'href-template': '/queues{?marker,limit,detailed}',
'href-vars': { 'href-vars': {
'marker': DOC_ROOT + '/param/marker', 'marker': 'param/marker',
'limit': DOC_ROOT + '/param/queue_limit', 'limit': 'param/queue_limit',
'detailed': DOC_ROOT + '/param/detailed', 'detailed': 'param/detailed',
}, },
'hints': { 'hints': {
'allow': ['GET'], 'allow': ['GET'],
@@ -50,10 +36,10 @@ JSON_HOME = {
}, },
}, },
}, },
DOC_ROOT + '/rel/queue': { 'rel/queue': {
'href-template': '/queues/{queue_name}', 'href-template': '/queues/{queue_name}',
'href-vars': { 'href-vars': {
'queue_name': DOC_ROOT + '/param/queue_name', 'queue_name': 'param/queue_name',
}, },
'hints': { 'hints': {
'allow': ['PUT', 'DELETE'], 'allow': ['PUT', 'DELETE'],
@@ -62,10 +48,10 @@ JSON_HOME = {
}, },
}, },
}, },
DOC_ROOT + '/rel/queue-metadata': { 'rel/queue-metadata': {
'href-template': '/queues/{queue_name}/metadata', 'href-template': '/queues/{queue_name}/metadata',
'href-vars': { 'href-vars': {
'queue_name': DOC_ROOT + '/param/queue_name', 'queue_name': 'param/queue_name',
}, },
'hints': { 'hints': {
'allow': ['GET', 'PUT'], 'allow': ['GET', 'PUT'],
@@ -74,10 +60,10 @@ JSON_HOME = {
}, },
}, },
}, },
DOC_ROOT + '/rel/queue-stats': { 'rel/queue-stats': {
'href-template': '/queues/{queue_name}/stats', 'href-template': '/queues/{queue_name}/stats',
'href-vars': { 'href-vars': {
'queue_name': DOC_ROOT + '/param/queue_name', 'queue_name': 'param/queue_name',
}, },
'hints': { 'hints': {
'allow': ['GET'], 'allow': ['GET'],
@@ -90,15 +76,15 @@ JSON_HOME = {
#------------------------------------------------------------------ #------------------------------------------------------------------
# Messages # Messages
#------------------------------------------------------------------ #------------------------------------------------------------------
DOC_ROOT + '/rel/messages': { 'rel/messages': {
'href-template': ('/queues/{queue_name}/messages' 'href-template': ('/queues/{queue_name}/messages'
'{?marker,limit,echo,include_claimed}'), '{?marker,limit,echo,include_claimed}'),
'href-vars': { 'href-vars': {
'queue_name': DOC_ROOT + '/param/queue_name', 'queue_name': 'param/queue_name',
'marker': DOC_ROOT + '/param/marker', 'marker': 'param/marker',
'limit': DOC_ROOT + '/param/messages_limit', 'limit': 'param/messages_limit',
'echo': DOC_ROOT + '/param/echo', 'echo': 'param/echo',
'include_claimed': DOC_ROOT + '/param/include_claimed', 'include_claimed': 'param/include_claimed',
}, },
'hints': { 'hints': {
'allow': ['GET'], 'allow': ['GET'],
@@ -107,10 +93,10 @@ JSON_HOME = {
}, },
}, },
}, },
DOC_ROOT + '/rel/post-messages': { 'rel/post-messages': {
'href-template': '/v1/queues/{queue_name}/messages', 'href-template': '/v1/queues/{queue_name}/messages',
'href-vars': { 'href-vars': {
'queue_name': DOC_ROOT + '/param/queue_name', 'queue_name': 'param/queue_name',
}, },
'hints': { 'hints': {
'allow': ['POST'], 'allow': ['POST'],
@@ -124,11 +110,11 @@ JSON_HOME = {
#------------------------------------------------------------------ #------------------------------------------------------------------
# Claims # Claims
#------------------------------------------------------------------ #------------------------------------------------------------------
DOC_ROOT + '/rel/claim': { 'rel/claim': {
'href-template': '/v1/queues/{queue_name}/claims{?limit}', 'href-template': '/v1/queues/{queue_name}/claims{?limit}',
'href-vars': { 'href-vars': {
'queue_name': DOC_ROOT + '/param/queue_name', 'queue_name': 'param/queue_name',
'limit': DOC_ROOT + '/param/claim_limit', 'limit': 'param/claim_limit',
}, },
'hints': { 'hints': {
'allow': ['POST'], 'allow': ['POST'],