The keystone.common.controller Module

class keystone.common.controller.V2Controller(*args, **kwargs)

Bases: keystone.common.wsgi.Application

Base controller class for Identity API v2.

class keystone.common.controller.V3Controller(*args, **kwargs)

Bases: keystone.common.controller.V2Controller

Base controller class for Identity API v3.

Child classes should set the collection_name and member_name class attributes, representing the collection of entities they are exposing to the API. This is required for supporting self-referential links, pagination, etc.

classmethod base_url(path=None)
collection_name = 'entities'
classmethod filter_by_attribute(context, refs, attr)

Filters a list of references by query string value.

member_name = 'entity'
classmethod paginate(context, refs)

Paginates a list of references by page & per_page query strings.

classmethod wrap_collection(context, refs, filters=[])
classmethod wrap_member(context, ref)
keystone.common.controller.filterprotected(*filters)

Wraps filtered API calls with role based access controls (RBAC).

keystone.common.controller.flatten(d, parent_key='')

Flatten a nested dictionary

Converts a dictionary with nested values to a single level flat dictionary, with dotted notation for each key.

keystone.common.controller.protected(f)

Wraps API calls with role based access controls (RBAC).

Previous topic

The keystone.common.config Module

Next topic

The keystone.common.dependency Module

This Page