History

Zuul 282c5699b9 Merge "Add notes common code for Shipyard"		2018-10-09 20:24:13 +00:00
..
README.rst	Add deployment group validation to shipyard	2018-05-09 09:18:16 -05:00
__init__.py	Add deployment group validation to shipyard	2018-05-09 09:18:16 -05:00
action_helper.py	Fix 404 on log retrieval for retries of a step	2018-09-10 21:22:18 -07:00
configdocs_helper.py	Rollback to revision 0 instead of clearing Deckhand DB	2018-09-25 16:04:32 -04:00
deckhand_client.py	Refactor validations retrieval for performance	2018-10-05 13:57:27 +00:00
design_reference_helper.py	[FIX] Correct design ref use with Drydock client	2018-08-22 09:51:34 -05:00
notes.py	Add notes common code for Shipyard	2018-10-05 15:40:48 -05:00
status_helper.py	A new Shipyard site statuses API and CLI	2018-07-31 09:16:36 +00:00
workflow_helper.py	Add deployment group validation to shipyard	2018-05-09 09:18:16 -05:00

README.rst

Helper Modules

A home for the helper modules used by the various apis. While mostly the helpers are used by the api that encompasses the function - e.g. configdocs uses the configdocs helper, there are multiple cases where there's a need to cross between functions. One such example is the need for the action api's to need to use functionality related to configdocs. Rather than having depenedencies between the functional sections, this package serves as a place for the common dependencies encompassed into helper modules.

One major difference between the helpers and the api controllers is that helpers should never raise API errors, but rather App Errors or other non-http focused errors.

Note: The deckhand client module found in this package is intended to be (largely) replaced by use of the Deckhand client, when that refactoring can be accomplished.