8b1298ff58
Verified the API document with source for methods available and response codes used. Part of bp:api-ref-in-rst Change-Id: I52de3b6ac0e8a155a5a07458e1fb453824d3aad2
66 lines
1.3 KiB
ReStructuredText
66 lines
1.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
=====================================
|
|
Root certificates (os-certificates)
|
|
=====================================
|
|
|
|
Creates and shows details for a root certificate.
|
|
|
|
Create Certificate
|
|
==================
|
|
|
|
.. rest_method:: POST /v2.1/{tenant_id}/os-certificates
|
|
|
|
Creates a certificate.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Create Certificate: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-certificates/certificate-create-resp.json
|
|
:language: javascript
|
|
|
|
Show Certificate Details
|
|
========================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-certificates/{certificate_id}
|
|
|
|
Shows details for a certificate.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: notImplemented(501), unauthorized(401),
|
|
forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- certificate_id: certificate_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show Certificate Details: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-certificates/certificate-get-root-resp.json
|
|
:language: javascript
|
|
|