From 5335622671bc0c9ddd94d88cb231c738c48fffa7 Mon Sep 17 00:00:00 2001 From: One-Fine-Day Date: Thu, 11 Jan 2018 10:55:06 -0600 Subject: [PATCH] Shipyard Documentation for Dryrun Option/Query 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 --- docs/source/API.rst | 5 +++++ docs/source/CLI.rst | 3 +++ 2 files changed, 8 insertions(+) diff --git a/docs/source/API.rst b/docs/source/API.rst index 33c1c0d6..4e0123a2 100644 --- a/docs/source/API.rst +++ b/docs/source/API.rst @@ -266,6 +266,11 @@ force=true | **false** will still be moved from the Shipyard Buffer to the Committed 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 ''''''''' 200 OK diff --git a/docs/source/CLI.rst b/docs/source/CLI.rst index 49dba3c3..8be2d3fe 100644 --- a/docs/source/CLI.rst +++ b/docs/source/CLI.rst @@ -114,6 +114,9 @@ downstream components. \--force Force the commit to occur, even if validations fail. +\--dryrun + Retrieve validation status for the contents of the buffer without committing. + Sample ^^^^^^