Merge "api-ref: os-certificates.inc"

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),
+Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)
-forbidden(403), itemNotFound(404)
-
-Request
--------
-
-.. rest_parameters:: parameters.yaml
-
-  - certificate_id: certificate_id
 
 Response
 --------
 
-**Example Show Certificate Details: JSON response**
+.. rest_parameters:: parameters.yaml
+
+  - certificate: certificate
+  - data: data
+  - private_key: private_key
+
+|
+
+**Example Show Root Certificate Details**
 
 .. literalinclude:: ../../doc/api_samples/os-certificates/certificate-get-root-resp.json
    :language: javascript

api-ref/source/parameters.yaml

@@ -1032,6 +1032,12 @@ boot_index:
   in: body
   required: true
   type: string
+certificate:
+  description: |
+    The certificate object.
+  in: body
+  required: true
+  type: object
 changePassword:
   description: |
     The action.
@@ -1198,6 +1204,12 @@ current_workload:
   in: body
   required: true
   type: integer
+data:
+  description: |
+    The certificate.
+  in: body
+  required: true
+  type: string
 delete_on_termination:
   description: |
     To delete the boot volume when the server is destroyed, specify ``true``.
@@ -3005,6 +3017,12 @@ previous:
   in: body
   required: false
   type: string
+private_key:
+  description: |
+    The secret key.
+  in: body
+  required: true
+  type: string
 progress:
   description: |
     A percentage value of the build progress.