congress.api.rule_model module¶

class congress.api.rule_model.RuleModel(name, bus=None)¶

Model for handling API requests about policy Rules.

add_item(item, params, id_=None, context=None)¶

Add item to model.

Param: item: The item to add to the model
Param: params: A dict-like object containing parameters from the request query string and body.
Param: id_: The ID of the item, or None if an ID should be generated
Param: context: Key-values providing frame of reference of request
Returns: Tuple of (ID, newly_created_item)
Raises: KeyError – ID already exists.

delete_item(id_, params, context=None)¶

Remove item from model.

Param: id_: The ID of the item to be removed
Param: params: A dict-like object containing parameters from the request query string and body.
Param: context: Key-values providing frame of reference of request
Returns: The removed item.
Raises: KeyError – Item with specified id_ not present.

get_item(id_, params, context=None)¶

Retrieve item with id id_ from model.

Param: id_: The ID of the item to retrieve
Param: params: A dict-like object containing parameters from the request query string and body.
Param: context: Key-values providing frame of reference of request
Returns: The matching item or None if item with id_ does not exist.

get_items(params, context=None)¶

Get items in model.

Param: params: A dict-like object containing parameters from the request query string and body.
Param: context: Key-values providing frame of reference of request
Returns: A dict containing at least a ‘results’ key whose value is a list of items in the model. Additional keys set in the dict will also be rendered for the user.

congress.api.rule_model module