summaryrefslogtreecommitdiff
path: root/api-ref/source/os-certificates.inc
diff options
context:
space:
mode:
authorKaren Bradshaw <kbhawkey@gmail.com>2016-05-31 09:20:30 -0400
committerJohn Garbutt <john@johngarbutt.com>2016-06-29 13:14:12 +0000
commit7010aad4e157c2d81cfc626d85c6c63a83b991a8 (patch)
tree5e70fbb98648eebefb957ec0997fe3c18fc0ae8a /api-ref/source/os-certificates.inc
parent7ef3d299acfd55bb4157a979e8bd87c416bb2594 (diff)
downloadnova-7010aad4e157c2d81cfc626d85c6c63a83b991a8.tar.gz
api-ref: os-certificates.inc
Verified methods, parameters, body text. Updated parameters.yaml to include: certificate, data, private_key. Part of: bp/api-ref-in-rst Change-Id: I1003caa6bf52ce158e813481b383544fa550320b
Diffstat (limited to 'api-ref/source/os-certificates.inc')
-rw-r--r--api-ref/source/os-certificates.inc43
1 files changed, 24 insertions, 19 deletions
diff --git a/api-ref/source/os-certificates.inc b/api-ref/source/os-certificates.inc
index 6832f5e15f..d97298c7a3 100644
--- a/api-ref/source/os-certificates.inc
+++ b/api-ref/source/os-certificates.inc
@@ -1,7 +1,4 @@
.. -*- rst -*-
-.. needs:parameter_verification
-.. needs:example_verification
-.. needs:body_verification
=====================================
Root certificates (os-certificates)
@@ -9,12 +6,12 @@
Creates and shows details for a root certificate.
-Create Certificate
-==================
+Create Root Certificate
+=======================
.. rest_method:: POST /os-certificates
-Creates a certificate.
+Creates a root certificate.
Normal response codes: 200
@@ -23,34 +20,42 @@ Error response codes: unauthorized(401), forbidden(403)
Response
--------
-**Example Create Certificate: JSON response**
+.. rest_parameters:: parameters.yaml
+
+ - certificate: certificate
+ - data: data
+ - private_key: private_key
+
+|
+
+**Example Create Root Certificate**
.. literalinclude:: ../../doc/api_samples/os-certificates/certificate-create-resp.json
:language: javascript
-Show Certificate Details
-========================
+Show Root Certificate Details
+=============================
-.. rest_method:: GET /os-certificates/{certificate_id}
+.. rest_method:: GET /os-certificates/root
-Shows details for a certificate.
+Shows details for a root certificate.
Normal response codes: 200
-Error response codes: notImplemented(501), unauthorized(401),
-forbidden(403), itemNotFound(404)
+Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)
-Request
--------
+Response
+--------
.. rest_parameters:: parameters.yaml
- - certificate_id: certificate_id
+ - certificate: certificate
+ - data: data
+ - private_key: private_key
-Response
---------
+|
-**Example Show Certificate Details: JSON response**
+**Example Show Root Certificate Details**
.. literalinclude:: ../../doc/api_samples/os-certificates/certificate-get-root-resp.json
:language: javascript