Shipyard Documentation for Configdocs Status
Shipyard API to discover buffered and committed collections of configdocs 4 of 4 Commits (API Client, CLI, Documentation are in separate commits) Documentation -Read the Docs documentation has been updated to include the CLI command in docs/source/CLI.rst -Read the Docs documentation has been updated to include the API in docs/source/API.rst Change-Id: Ia5404867796b283c65bc8f73cdaa100301e116ce
This commit is contained in:
parent
f3188fcf10
commit
ab0cd0468d
|
@ -97,6 +97,23 @@ All versions of documents rely upon Deckhand for storage. Shipyard uses the
|
|||
tagging features of Deckhand of to find the appropriate Committed Documents
|
||||
and Shipyard Buffer version.
|
||||
|
||||
/v1.0/configdocs
|
||||
~~~~~~~~~~~~~~~~
|
||||
Represents the site configuration documents' current statuses
|
||||
|
||||
GET /v1.0/configdocs
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
Returns a list of collections including their committed and buffer status.
|
||||
|
||||
.. note::
|
||||
|
||||
The output type for this request is 'Content-Type: application/json'
|
||||
|
||||
Responses
|
||||
'''''''''
|
||||
200 OK
|
||||
If documents can be retrieved
|
||||
|
||||
/v1.0/configdocs/{collection_id}
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Represents the site configuration documents
|
||||
|
@ -822,7 +839,7 @@ Example
|
|||
'''''''
|
||||
.. note::
|
||||
|
||||
Sub_dags can be queried to restrict to only that sub-dag’s steps. e.g. using
|
||||
Sub_dags can be queried to restrict to only that sub-dag’s steps. e.g. using
|
||||
this as {workflow_id}:
|
||||
deploy_site.preflight.armada_preflight_check__2017-10-09T21:19:03.000000
|
||||
|
||||
|
|
|
@ -532,14 +532,16 @@ Shipyard Buffer.
|
|||
::
|
||||
|
||||
shipyard get configdocs
|
||||
<collection>
|
||||
[<collection>]
|
||||
[--committed | --buffer]
|
||||
|
||||
Example:
|
||||
shipyard get configdocs design
|
||||
|
||||
<collection>
|
||||
The collection to retrieve for viewing.
|
||||
[<collection>]
|
||||
The collection to retrieve for viewing. If no collection is entered, the
|
||||
status of the collections in the buffer and those that are committed will be
|
||||
displayed.
|
||||
|
||||
\--committed
|
||||
Retrieve the documents that have last been committed for this collection
|
||||
|
@ -549,8 +551,16 @@ Shipyard Buffer.
|
|||
prior commit. If no documents have been loaded into the buffer for this
|
||||
collection, this will return an empty response (default)
|
||||
|
||||
Sample
|
||||
^^^^^^
|
||||
Samples
|
||||
^^^^^^^
|
||||
|
||||
::
|
||||
|
||||
$ shipyard get configdocs
|
||||
Collection Committed Buffer
|
||||
coll1 present unmodified
|
||||
coll2 not present created
|
||||
|
||||
|
||||
::
|
||||
|
||||
|
@ -643,7 +653,7 @@ help
|
|||
~~~~
|
||||
Provides topical help for shipyard.
|
||||
|
||||
.. note::
|
||||
.. note::
|
||||
|
||||
--help will provide more specific command help.
|
||||
|
||||
|
|
Loading…
Reference in New Issue