cinder.api.openstack package

Submodules

• cinder.api.openstack.api_version_request module
  • APIVersionRequest
    • APIVersionRequest.get_string()
    • APIVersionRequest.matches()
    • APIVersionRequest.matches_versioned_method()
  • max_api_version()
  • min_api_version()
• cinder.api.openstack.versioned_method module
  • VersionedMethod
• cinder.api.openstack.wsgi module
  • ActionDispatcher
    • ActionDispatcher.default()
    • ActionDispatcher.dispatch()
  • Controller
    • Controller.api_version()
    • Controller.assert_valid_body()
    • Controller.validate_name_and_description()
    • Controller.validate_string_length()
    • Controller.wsgi_actions
    • Controller.wsgi_extensions
  • ControllerMetaclass
    • ControllerMetaclass.consolidate_vers()
  • DictSerializer
    • DictSerializer.default()
    • DictSerializer.serialize()
  • Fault
  • JSONDeserializer
    • JSONDeserializer.default()
  • JSONDictSerializer
    • JSONDictSerializer.default()
  • OverLimitFault
  • Request
    • Request.best_match_content_type()
    • Request.best_match_language()
    • Request.cache_db_backup()
    • Request.cache_db_backups()
    • Request.cache_db_items()
    • Request.cache_db_snapshot()
    • Request.cache_db_snapshots()
    • Request.cache_db_volume()
    • Request.cache_db_volume_type()
    • Request.cache_db_volume_types()
    • Request.cache_db_volumes()
    • Request.cache_resource()
    • Request.cached_resource()
    • Request.cached_resource_by_id()
    • Request.get_content_type()
    • Request.get_db_backup()
    • Request.get_db_backups()
    • Request.get_db_item()
    • Request.get_db_items()
    • Request.get_db_snapshot()
    • Request.get_db_snapshots()
    • Request.get_db_volume()
    • Request.get_db_volume_type()
    • Request.get_db_volume_types()
    • Request.get_db_volumes()
    • Request.set_api_version_request()
  • Resource
    • Resource.deserialize()
    • Resource.dispatch()
    • Resource.get_action_args()
    • Resource.get_body()
    • Resource.get_method()
    • Resource.post_process_extensions()
    • Resource.pre_process_extensions()
    • Resource.register_actions()
    • Resource.register_extensions()
    • Resource.support_api_request_version
  • ResourceExceptionHandler
  • ResponseObject
    • ResponseObject.attach()
    • ResponseObject.code
    • ResponseObject.get_serializer()
    • ResponseObject.headers
    • ResponseObject.preserialize()
    • ResponseObject.serialize()
  • TextDeserializer
    • TextDeserializer.default()
    • TextDeserializer.deserialize()
  • action()
  • action_peek_json()
  • deserializers()
  • extends()
  • response()
  • serializers()

Module contents

WSGI middleware for OpenStack API controllers.

class APIMapper(controller_scan=<function controller_scan>, directory=None, always_scan=False, register=True, explicit=True)

Bases: Mapper

connect(*args, **kwargs)

Create and connect a new Route to the Mapper.

Usage:

m = Mapper()
m.connect(':controller/:action/:id')
m.connect('date/:year/:month/:day', controller="blog",
          action="view")
m.connect('archives/:page', controller="blog", action="by_page",
requirements = { 'page':'\d{1,2}' })
m.connect('category_list', 'archives/category/:section',
          controller='blog', action='category',
          section='home', type='list')
m.connect('home', '', controller='blog', action='view',
          section='home')

routematch(url=None, environ=None)

Match a URL against against one of the routes contained.

Will return None if no valid match is found, otherwise a result dict and a route object is returned.

resultdict, route_obj = m.match('/joe/sixpack')

class APIRouter(ext_mgr=None)

Bases: Router

Routes requests on the API to the appropriate controller and method.

ExtensionManager = None

classmethod factory(global_config, **local_config)

Simple paste factory, cinder.wsgi.Router doesn’t have.

class ProjectMapper(controller_scan=<function controller_scan>, directory=None, always_scan=False, register=True, explicit=True)

Bases: APIMapper

resource(member_name, collection_name, **kwargs)

Base resource path handler

This method is compatible with resource paths that include a project_id and those that don’t. Including project_id in the URLs was a legacy API requirement; and making API requests against such endpoints won’t work for users that don’t belong to a particular project.