1d087af001
Implement the HEAD method for all get-one and list-all operations in the v3 API (non-extended). While this may never be used by python-openstackclient, it is useful to operators and application developers for quickly obtaining metainformation about API resources, and for "testing hypertext links for validity, accessibility, and recent modification"[1]. [1] https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.4 Closes-bug: #1370335 Change-Id: Iae26ebea1aa40d3b5c6c676dabe4f60a86a4f99f
83 lines
3.2 KiB
Python
83 lines
3.2 KiB
Python
# Copyright 2012 OpenStack Foundation
|
|
#
|
|
# 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 keystone.common import json_home
|
|
from keystone.common import wsgi
|
|
|
|
|
|
class Router(wsgi.ComposableRouter):
|
|
def __init__(self, controller, collection_key, key,
|
|
resource_descriptions=None,
|
|
is_entity_implemented=True,
|
|
method_template=None):
|
|
self.controller = controller
|
|
self.key = key
|
|
self.collection_key = collection_key
|
|
self._resource_descriptions = resource_descriptions
|
|
self._is_entity_implemented = is_entity_implemented
|
|
self.method_template = method_template or '%s'
|
|
|
|
def add_routes(self, mapper):
|
|
collection_path = '/%(collection_key)s' % {
|
|
'collection_key': self.collection_key}
|
|
entity_path = '/%(collection_key)s/{%(key)s_id}' % {
|
|
'collection_key': self.collection_key,
|
|
'key': self.key}
|
|
|
|
mapper.connect(
|
|
collection_path,
|
|
controller=self.controller,
|
|
action=self.method_template % 'create_%s' % self.key,
|
|
conditions=dict(method=['POST']))
|
|
mapper.connect(
|
|
collection_path,
|
|
controller=self.controller,
|
|
action=self.method_template % 'list_%s' % self.collection_key,
|
|
conditions=dict(method=['GET', 'HEAD']))
|
|
mapper.connect(
|
|
entity_path,
|
|
controller=self.controller,
|
|
action=self.method_template % 'get_%s' % self.key,
|
|
conditions=dict(method=['GET', 'HEAD']))
|
|
mapper.connect(
|
|
entity_path,
|
|
controller=self.controller,
|
|
action=self.method_template % 'update_%s' % self.key,
|
|
conditions=dict(method=['PATCH']))
|
|
mapper.connect(
|
|
entity_path,
|
|
controller=self.controller,
|
|
action=self.method_template % 'delete_%s' % self.key,
|
|
conditions=dict(method=['DELETE']))
|
|
|
|
# Add the collection resource and entity resource to the resource
|
|
# descriptions.
|
|
|
|
collection_rel = json_home.build_v3_resource_relation(
|
|
self.collection_key)
|
|
rel_data = {'href': collection_path, }
|
|
self._resource_descriptions.append((collection_rel, rel_data))
|
|
|
|
if self._is_entity_implemented:
|
|
entity_rel = json_home.build_v3_resource_relation(self.key)
|
|
id_str = '%s_id' % self.key
|
|
id_param_rel = json_home.build_v3_parameter_relation(id_str)
|
|
entity_rel_data = {
|
|
'href-template': entity_path,
|
|
'href-vars': {
|
|
id_str: id_param_rel,
|
|
},
|
|
}
|
|
self._resource_descriptions.append((entity_rel, entity_rel_data))
|