89a61d168a
This is a follow-up patch set for [0] to address the comments to break up the get_configdocs_status method into smaller methods. Also made a minor update to the check_reformat_versions method based on comments in [0] [0] https://review.gerrithub.io/#/c/att-comdev/shipyard/+/409839/ Change-Id: Id13fcaa25e48cc2f4267a08db1ccb4561b260197 |
||
|---|---|---|
| .. | ||
| README.rst | ||
| __init__.py | ||
| action_helper.py | ||
| configdocs_helper.py | ||
| deckhand_client.py | ||
| design_reference_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.