222b074cb1
Currently, any document name or schema referenced in the Shipyard code base is a hard-coded string. Often times, these strings are repeated throughout the code. This patch set adds a new configuration section to shipyard.conf to define document names and schemas so they can then be referenced in the Shipyard code via the oslo configuration object. This functionality will be important for upcoming Shipyard features which will call for more documents to be validated as well as some new Shipyard-created docs. Change-Id: I34ae8cd578bab730d004c3d176e3817b5a45c89e |
||
---|---|---|
.. | ||
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.