The apmec.api.v1.base Module¶

class apmec.api.v1.base.Controller(plugin, collection, resource, attr_info, allow_bulk=False, member_actions=None, parent=None, allow_pagination=False, allow_sorting=False)¶

Bases: object

CREATE = 'create'¶

DELETE = 'delete'¶

LIST = 'list'¶

SHOW = 'show'¶

UPDATE = 'update'¶

create(request, body=None, **kwargs)¶

Creates a new instance of the requested entity.

delete(request, id, **kwargs)¶

Deletes the specified entity.

index(request, **kwargs)¶

Returns a list of the requested entity.

static prepare_request_body(context, body, is_create, resource, attr_info, allow_bulk=False)¶

Verifies required attributes are in request body.

Also checking that an attribute is only specified if it is allowed for the given operation (create/update).

Attribute with default values are considered to be optional.

body argument must be the deserialized body.

show(request, id, **kwargs)¶

Returns detailed information about the requested entity.

update(request, id, body=None, **kwargs)¶

Updates the specified entity’s attributes.

apmec.api.v1.base.create_resource(collection, resource, plugin, params, allow_bulk=False, member_actions=None, parent=None, allow_pagination=False, allow_sorting=False)¶