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 ^^^^^^