airship/shipyard
Code Issues Proposed changes

Shipyard Documentation for Dryrun Option/Query

Browse Source 
Shipyard API to retrieve validation status of a collection of configdocs

4 of 4 Commits (API, API Client, CLI are in separate commits)

Documentation
-Read the Docs documentation has been updated to include the CLI command,
 commit configdocs, option dryrun in docs/source/CLI.rst
-Read the Docs documentation has been updated to include the API,
 commitconfigdocs, query dryrun in docs/source/API.rst

Change-Id: I1dfea75cb2886aa57052c30362c2992051ef56a8
This commit is contained in:
One-Fine-Day 2018-01-11 10:55:06 -06:00 committed by vd789v
parent 4b571a9ad9
commit 5335622671
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/source/API.rst
View File

@ -266,6 +266,11 @@ force=true | **false**
will still be moved from the Shipyard Buffer to the Committed will still be moved from the Shipyard Buffer to the Committed
Documents. Documents.
dryrun=true | **false**
By default, false. With dryrun=true, the response will contain the
validation status for the contents of the buffer. The Shipyard Buffer will
not be committed.
Responses Responses
''''''''' '''''''''
200 OK 200 OK

3
docs/source/CLI.rst
View File

@ -114,6 +114,9 @@ downstream components.
\--force \--force
Force the commit to occur, even if validations fail. Force the commit to occur, even if validations fail.
\--dryrun
Retrieve validation status for the contents of the buffer without committing.
Sample Sample
^^^^^^ ^^^^^^