airship
/
shipyard
Code Issues Proposed changes
shipyard/src/bin/shipyard_airflow/shipyard_airflow/control/helpers
History
Bryan Strassner aae5662dce [fix] move functions into class 
Several funcitons were misplaced outside of the
configdocs helper class - this moves them into the
right scope.

Change-Id: I409d2974f7205a62a7286687aa21da540fd0242e
 		2018-05-11 12:02:23 -05: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 Add deployment group validation to shipyard 2018-05-09 09:18:16 -05:00
configdocs_helper.py [fix] move functions into class 2018-05-11 12:02:23 -05:00
deckhand_client.py Add deployment group validation to shipyard 2018-05-09 09:18:16 -05:00
design_reference_helper.py Add deployment group validation to shipyard 2018-05-09 09:18:16 -05: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.