openstack/barbican
Code Issues Proposed changes

Merge "Completing secret reference documentation"

Browse Source
This commit is contained in:
Jenkins
2015-03-26 19:06:35 +00:00
committed by Gerrit Code Review
parent 5ddbc3b8dc b502524698
commit 80421b7ddc
1 changed files with 45 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
doc/source/api/reference/secrets.rst
View File

@@ -149,7 +149,7 @@ Request:
Response:
*********
.. code-block:: javascript
.. code-block:: none
201 Created
@@ -192,7 +192,7 @@ Accept Header Options:
Metadata Request:
*****************
.. code-block:: javascript
.. code-block:: none
GET /v1/secrets/{uuid}
Headers:
@@ -226,7 +226,7 @@ Metadata Response:
Payload Request:
****************
.. code-block:: javascript
.. code-block:: none
GET /v1/secrets/{uuid}
Headers:
@@ -237,7 +237,7 @@ Payload Request:
Payload Response:
*****************
.. code-block:: javascript
.. code-block:: none
200 OK
@@ -287,7 +287,7 @@ Required Headers
Request:
********
.. code-block:: javascript
.. code-block:: none
PUT /v1/secrets/{uuid}
Headers:
@@ -301,7 +301,7 @@ Request:
Response:
*********
.. code-block:: javascript
.. code-block:: none
204 No Content
@@ -328,7 +328,7 @@ Delete a secret by uuid
Request:
****************
.. code-block:: javascript
.. code-block:: none
DELETE /v1/secrets/{uuid}
Headers:
@@ -337,7 +337,7 @@ Request:
Response:
****************
.. code-block:: javascript
.. code-block:: none
204 No Content
@@ -359,10 +359,42 @@ GET /v1/secrets/{uuid}/payload
##############################
Retrieve a secret's payload
TODO(jvrbanac): Finish this section
Accept Header Options:
**********************
PUT /v1/secrets/{uuid}/payload
##############################
Update a secret's payload
* application/octet-stream - Returns secret payload
* text/plain - Returns secret payload
TODO(jvrbanac): Finish this section
Request:
********
.. code-block:: none
GET /v1/secrets/{uuid}/payload
Headers:
Accept: text/plain
X-Project-Id: {project_id}
Response:
*********
.. code-block:: none
200 OK
beer
HTTP Status Codes
*****************
+------+-----------------------------------------------------------------------------+
| Code | Description |
+======+=============================================================================+
| 200 | Successful request |
+------+-----------------------------------------------------------------------------+
| 401 | Invalid X-Auth-Token or the token doesn't have permissions to this resource |
+------+-----------------------------------------------------------------------------+
| 404 | Not Found |
+------+-----------------------------------------------------------------------------+
| 406 | Not Acceptable |
+------+-----------------------------------------------------------------------------+