667a538330
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 |
||
---|---|---|
.. | ||
README.rst | ||
__init__.py | ||
action_helper.py | ||
configdocs_helper.py | ||
deckhand_client.py | ||
design_reference_helper.py | ||
notes.py | ||
status_helper.py | ||
workflow_helper.py |
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.