openstack/nova
Code Issues Proposed changes
8449b7caef
nova/api-ref/source/os-keypairs.inc

179 lines
3.8 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 -*-
=====================
Keypairs (keypairs)
=====================
Generates, imports, and deletes SSH keys.
List Keypairs
=============
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:: GET /os-keypairs
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
Lists keypairs that are associated with the account.
Normal response codes: 200
Complet Method Verification of keypair verified the API doc for os-keypairs, Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495427 Part of bp:api-ref-in-rst Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
2016-04-23 02:26:11 +08: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
Add user_id request parameter in os-keypairs list Added user_id in request parameter section of the os-keypairs LIST method api-ref docs. Closes bug: #1599911 Change-Id: Ibb52663b2890f6d46b125903b438c0142aba92f5
2016-07-07 17:54:18 +00:00
Request
-------
.. rest_parameters:: parameters.yaml
- user_id: keypair_user
Microversion 2.35 adds keypairs pagination support After this microversion Nova API allows to get several keypairs with the help of new optional parameters 'limit' and 'marker' which were added to GET /os-keypairs request. Partial-Bug: #1599904 Implements blueprint: keypairs-pagination Change-Id: Idd3757f5be90ec4af1bd1a7ca3f9c20319dbfd33
2016-07-06 15:02:11 +03:00
- limit: keypair_limit
- marker: keypair_marker
Add user_id request parameter in os-keypairs list Added user_id in request parameter section of the os-keypairs LIST method api-ref docs. Closes bug: #1599911 Change-Id: Ibb52663b2890f6d46b125903b438c0142aba92f5
2016-07-07 17:54:18 +00: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
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: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
.. rest_parameters:: parameters.yaml
- keypairs: keypairs
api-ref: Fix keypair API parameters Fix parameter types and the order of parameters. Add missing parameters. Add a period at the end of a parameter description. Replace sample files with v2.10 files. Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302 Closes-Bug: #1656781
2017-01-16 18:42:21 +09:00
- keypair: keypair
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
- name: keypair_name
- public_key: keypair_public_key
- fingerprint: keypair_fingerprint
- type: keypair_type
Add keypairs_links into resp v2.35 added keypairs_links into resp param list, this patch added it to the api-ref Implements: blueprint api-ref-in-rst Change-Id: Id62dc61c169c772510b727b7666ae38a555e4247
2016-09-09 10:30:14 +08:00
- keypairs_links: keypair_links
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
api-ref: use the examples with paging links Use the microversion response samples that include the paging links in the example JSON responses. Change-Id: I99ef8e8e709b0262f3038bf19e8746782c9f302a
2017-01-03 11:58:53 -06:00
**Example List Keypairs (v2.35): JSON 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
trivial: Rename directory for os-keypairs samples We have a custom of naming the directory after the API. Reinforce that here. Change-Id: I5bf68aacc1d987400a91467835c4b55f03c18beb Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2020-03-06 16:56:51 +00:00
.. literalinclude:: ../../doc/api_samples/os-keypairs/v2.35/keypairs-list-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
api: Drop generating a keypair and add special chars to naming As agreed in the spec, we will both drop the generation support for a keypair but we'll also accept @ (at) and . (dot) chars in the keyname, all of them in the same API microversion. Rebased the work from I5de15935e83823afa545a250cf84f6a7a37036b4 APIImpact Implements: blueprint keypair-generation-removal Co-Authored-By: Nicolas Parquet <nicolas.parquet@gandi.net> Change-Id: I6a7c71fb4385348c87067543d0454f302907395e
2022-07-08 17:23:01 +02:00
Import (or create) Keypair
==========================
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-keypairs
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: Drop generating a keypair and add special chars to naming As agreed in the spec, we will both drop the generation support for a keypair but we'll also accept @ (at) and . (dot) chars in the keyname, all of them in the same API microversion. Rebased the work from I5de15935e83823afa545a250cf84f6a7a37036b4 APIImpact Implements: blueprint keypair-generation-removal Co-Authored-By: Nicolas Parquet <nicolas.parquet@gandi.net> Change-Id: I6a7c71fb4385348c87067543d0454f302907395e
2022-07-08 17:23:01 +02:00
Imports (or generates) a keypair.
.. warning::
Generating a keypair is no longer possible starting from version 2.92.
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: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
Normal response codes: 200, 201
.. note::
The success status code was changed from 200 to 201 in version 2.2
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
Complet Method Verification of keypair verified the API doc for os-keypairs, Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495427 Part of bp:api-ref-in-rst Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
2016-04-23 02:26:11 +08:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409)
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
Request
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
.. rest_parameters:: parameters.yaml
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
- keypair: keypair
api: Drop generating a keypair and add special chars to naming As agreed in the spec, we will both drop the generation support for a keypair but we'll also accept @ (at) and . (dot) chars in the keyname, all of them in the same API microversion. Rebased the work from I5de15935e83823afa545a250cf84f6a7a37036b4 APIImpact Implements: blueprint keypair-generation-removal Co-Authored-By: Nicolas Parquet <nicolas.parquet@gandi.net> Change-Id: I6a7c71fb4385348c87067543d0454f302907395e
2022-07-08 17:23:01 +02:00
- name: keypair_name_in
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
- public_key: keypair_public_key_in
- type: keypair_type_in
- user_id: keypair_userid_in
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: Fix keypair API parameters Fix parameter types and the order of parameters. Add missing parameters. Add a period at the end of a parameter description. Replace sample files with v2.10 files. Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302 Closes-Bug: #1656781
2017-01-16 18:42:21 +09:00
**Example Create Or Import Keypair (v2.10): JSON request**
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
trivial: Rename directory for os-keypairs samples We have a custom of naming the directory after the API. Reinforce that here. Change-Id: I5bf68aacc1d987400a91467835c4b55f03c18beb Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2020-03-06 16:56:51 +00:00
.. literalinclude:: ../../doc/api_samples/os-keypairs/v2.10/keypairs-import-post-req.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
api: Drop generating a keypair and add special chars to naming As agreed in the spec, we will both drop the generation support for a keypair but we'll also accept @ (at) and . (dot) chars in the keyname, all of them in the same API microversion. Rebased the work from I5de15935e83823afa545a250cf84f6a7a37036b4 APIImpact Implements: blueprint keypair-generation-removal Co-Authored-By: Nicolas Parquet <nicolas.parquet@gandi.net> Change-Id: I6a7c71fb4385348c87067543d0454f302907395e
2022-07-08 17:23:01 +02:00
**Example Import Keypair (v2.92): JSON request**
.. literalinclude:: ../../doc/api_samples/os-keypairs/v2.92/keypairs-import-post-req.json
:language: javascript
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: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
.. rest_parameters:: parameters.yaml
- keypair: keypair
- name: keypair_name
- public_key: keypair_public_key
- fingerprint: keypair_fingerprint
- user_id: keypair_userid
api-ref: Fix keypair API parameters Fix parameter types and the order of parameters. Add missing parameters. Add a period at the end of a parameter description. Replace sample files with v2.10 files. Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302 Closes-Bug: #1656781
2017-01-16 18:42:21 +09:00
- private_key: keypair_private_key
- type: keypair_type
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
api-ref: Fix keypair API parameters Fix parameter types and the order of parameters. Add missing parameters. Add a period at the end of a parameter description. Replace sample files with v2.10 files. Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302 Closes-Bug: #1656781
2017-01-16 18:42:21 +09:00
**Example Create Or Import Keypair (v2.10): JSON 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
trivial: Rename directory for os-keypairs samples We have a custom of naming the directory after the API. Reinforce that here. Change-Id: I5bf68aacc1d987400a91467835c4b55f03c18beb Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2020-03-06 16:56:51 +00:00
.. literalinclude:: ../../doc/api_samples/os-keypairs/v2.10/keypairs-import-post-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
api: Drop generating a keypair and add special chars to naming As agreed in the spec, we will both drop the generation support for a keypair but we'll also accept @ (at) and . (dot) chars in the keyname, all of them in the same API microversion. Rebased the work from I5de15935e83823afa545a250cf84f6a7a37036b4 APIImpact Implements: blueprint keypair-generation-removal Co-Authored-By: Nicolas Parquet <nicolas.parquet@gandi.net> Change-Id: I6a7c71fb4385348c87067543d0454f302907395e
2022-07-08 17:23:01 +02:00
**Example Import Keypair (v2.92): JSON response**
.. literalinclude:: ../../doc/api_samples/os-keypairs/v2.92/keypairs-import-post-resp.json
:language: javascript
Complet Method Verification of keypair verified the API doc for os-keypairs, Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495427 Part of bp:api-ref-in-rst Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
2016-04-23 02:26:11 +08:00
Show Keypair 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
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:: GET /os-keypairs/{keypair_name}
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
Complet Method Verification of keypair verified the API doc for os-keypairs, Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495427 Part of bp:api-ref-in-rst Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
2016-04-23 02:26:11 +08:00
Shows details for a keypair that is associated with the account.
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
Complet Method Verification of keypair verified the API doc for os-keypairs, Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495427 Part of bp:api-ref-in-rst Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
2016-04-23 02:26:11 +08:00
Normal response codes: 200
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
Complet Method Verification of keypair verified the API doc for os-keypairs, Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495427 Part of bp:api-ref-in-rst Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
2016-04-23 02:26:11 +08:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
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
Request
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
.. rest_parameters:: parameters.yaml
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
- keypair_name: keypair_name_path
api-ref: Fix keypair API parameters Fix parameter types and the order of parameters. Add missing parameters. Add a period at the end of a parameter description. Replace sample files with v2.10 files. Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302 Closes-Bug: #1656781
2017-01-16 18:42:21 +09:00
- user_id: keypair_user
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: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
.. rest_parameters:: parameters.yaml
- keypair: keypair
api-ref: Fix keypair API parameters Fix parameter types and the order of parameters. Add missing parameters. Add a period at the end of a parameter description. Replace sample files with v2.10 files. Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302 Closes-Bug: #1656781
2017-01-16 18:42:21 +09:00
- created_at: created
- deleted: keypair_deleted
- deleted_at: keypair_updated_deleted_at
- fingerprint: keypair_fingerprint
- id: keypair_id
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
- name: keypair_name
- public_key: keypair_public_key
api-ref: Fix keypair API parameters Fix parameter types and the order of parameters. Add missing parameters. Add a period at the end of a parameter description. Replace sample files with v2.10 files. Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302 Closes-Bug: #1656781
2017-01-16 18:42:21 +09:00
- updated_at: keypair_updated_deleted_at
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
- user_id: keypair_userid
api-ref: Fix keypair API parameters Fix parameter types and the order of parameters. Add missing parameters. Add a period at the end of a parameter description. Replace sample files with v2.10 files. Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302 Closes-Bug: #1656781
2017-01-16 18:42:21 +09:00
- type: keypair_type
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
api-ref: Fix keypair API parameters Fix parameter types and the order of parameters. Add missing parameters. Add a period at the end of a parameter description. Replace sample files with v2.10 files. Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302 Closes-Bug: #1656781
2017-01-16 18:42:21 +09:00
**Example Show Keypair Details (v2.10): JSON 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
trivial: Rename directory for os-keypairs samples We have a custom of naming the directory after the API. Reinforce that here. Change-Id: I5bf68aacc1d987400a91467835c4b55f03c18beb Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2020-03-06 16:56:51 +00:00
.. literalinclude:: ../../doc/api_samples/os-keypairs/v2.10/keypairs-get-resp.json
Complet Method Verification of keypair verified the API doc for os-keypairs, Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495427 Part of bp:api-ref-in-rst Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
2016-04-23 02:26:11 +08:00
:language: javascript
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
Complet Method Verification of keypair verified the API doc for os-keypairs, Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495427 Part of bp:api-ref-in-rst Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
2016-04-23 02:26:11 +08:00
Delete Keypair
==============
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:: DELETE /os-keypairs/{keypair_name}
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
Complet Method Verification of keypair verified the API doc for os-keypairs, Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495427 Part of bp:api-ref-in-rst Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
2016-04-23 02:26:11 +08:00
Deletes a keypair.
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
Normal response codes: 202, 204
.. note::
The normal return code is 204 in version 2.2 to match the fact that
no body content is returned.
Complet Method Verification of keypair verified the API doc for os-keypairs, Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495427 Part of bp:api-ref-in-rst Change-Id: Id74692af6e2ffde58a344d47968370ac54d5ce5e
2016-04-23 02:26:11 +08:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
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
Request
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
.. rest_parameters:: parameters.yaml
api-ref: Fix keypair API parameters Fix parameter types and the order of parameters. Add missing parameters. Add a period at the end of a parameter description. Replace sample files with v2.10 files. Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302 Closes-Bug: #1656781
2017-01-16 18:42:21 +09:00
- keypair_name: keypair_name_path
- user_id: keypair_user
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
--------
api-ref: verify keypairs This verifies all the parts of keypairs, including filling out all the details for microversion 2.2 and 2.10 which change it. Part of bp:api-ref-in-rst Change-Id: Iab88dc75cdb7b5f91e46afd29ee61e38b325e180
2016-06-03 09:50:43 -04:00
api-ref: unify the delete response infomation part of bp:api-ref-in-rst Change-Id: I924a632253b8b1c25f987c259d255cc6440f52f2
2016-07-07 10:23:34 +08:00
There is no body content for the response of a successful DELETE query
Copy Permalink