airship
/
shipyard
Code Issues Proposed changes
shipyard/src/bin/shipyard_airflow/shipyard_airflow/control/helpers
History
Bryan Strassner 667a538330 Support clearing collections of configdocs 
Adds an option to create configdocs as an empty colleciton. This is done
as an explicit flag (--empty-collection) on the command as opposed to
using empty files to prevent accidental emtpy file loads leading to
frustration.

Since this introduced a new flag value for the CLI, the CLIs using flag
values were updated to use the standard is_flag=True instead of the
flag_value=True or some other value when a boolean flag is expected.

Minor updates to CLI tests due to moving to responses 0.10.2

Depends-On: https://review.openstack.org/#/c/614421/

Change-Id: I489b0e1183335cbfbaa2014c1458a84dadf6bb0b
 		2018-11-30 13:36:14 -06: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 notes processing to the Shipyard API+CLI 2018-10-11 15:36:22 -05:00
configdocs_helper.py Support clearing collections of configdocs 2018-11-30 13:36:14 -06:00
deckhand_client.py Ensure SY gets redacted rendered documents 2018-11-14 18:32:37 +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.