deckhand.control.common module

class deckhand.control.common.ViewBuilder

Bases: object

Model API responses as dictionaries.

deckhand.control.common.get_rendered_docs(revision_id, cleartext_secrets=False, **filters)

Helper for retrieving rendered documents for revision_id.

Retrieves raw documents from DB, renders them, and returns rendered result set.

Parameters:

• revision_id (int) – Revision ID whose documents to render.
• cleartext_secrets (bool) – Whether to show unencrypted data as cleartext.
• filters – Filters used for retrieving raw documents from DB.

Returns:

List of rendered documents.

Return type:

list[dict]

deckhand.control.common.invalidate_cache_data()

Invalidate all data associated with document rendering.

deckhand.control.common.sanitize_params(allowed_params)

Sanitize query string parameters passed to an HTTP request.

Overrides the params attribute in the req object with the sanitized params. Invalid parameters are ignored.

Parameters:allowed_params – The request’s query string parameters.