openstack/nova
Code Issues Proposed changes
7010aad4e1
nova/api-ref/source/os-certificates.inc

62 lines
1.2 KiB
PHP
Raw Normal View History

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. -*- rst -*-
=====================================
Root certificates (os-certificates)
=====================================
Creates and shows details for a root certificate.
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
2016-05-31 09:20:30 -04:00
Create Root Certificate
=======================
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: POST /os-certificates
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-05-31 09:20:30 -04:00
Creates a root certificate.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
api-ref: os-certificates.inc method verification Verified the API document with source for methods available and response codes used. Part of bp:api-ref-in-rst Change-Id: I52de3b6ac0e8a155a5a07458e1fb453824d3aad2
2016-05-10 22:34:38 +00:00
Error response codes: unauthorized(401), forbidden(403)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-05-31 09:20:30 -04:00
.. rest_parameters:: parameters.yaml
- certificate: certificate
- data: data
- private_key: private_key
|
**Example Create Root Certificate**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. literalinclude:: ../../doc/api_samples/os-certificates/certificate-create-resp.json
:language: javascript
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
2016-05-31 09:20:30 -04:00
Show Root Certificate Details
=============================
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-05-31 09:20:30 -04:00
.. rest_method:: GET /os-certificates/root
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-05-31 09:20:30 -04:00
Shows details for a root certificate.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
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
2016-05-31 09:20:30 -04:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-05-31 09:20:30 -04:00
Response
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
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
2016-05-31 09:20:30 -04:00
- certificate: certificate
- data: data
- private_key: private_key
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-05-31 09:20:30 -04:00
|
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
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
2016-05-31 09:20:30 -04:00
**Example Show Root Certificate Details**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix sample path for aggregate, certificate, console This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd
2016-04-20 10:35:37 +09:00
.. literalinclude:: ../../doc/api_samples/os-certificates/certificate-get-root-resp.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
Copy Permalink