openstack/nova
Code Issues Proposed changes
174f5a0a21
nova/api-ref/source/os-migrations.inc

48 lines
1.1 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 -*-
verify api-ref os-migrations.inc verify the parameters of os-migrations.inc including response and request. And, add warning for deprecation and incorrect wording of policy default rule. looks like the new migration is missing in doc, follow up patch will add it. Part of bp:api-ref-in-rst Change-Id: I8fed7374c34c5c857c8c55f56f86ad4c744844e9
2016-04-27 22:52:42 +08:00
=========================================
Migrations (os-migrations) (frozen)
=========================================
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
Shows data on migrations.
verify api-ref os-migrations.inc verify the parameters of os-migrations.inc including response and request. And, add warning for deprecation and incorrect wording of policy default rule. looks like the new migration is missing in doc, follow up patch will add it. Part of bp:api-ref-in-rst Change-Id: I8fed7374c34c5c857c8c55f56f86ad4c744844e9
2016-04-27 22:52:42 +08:00
.. warning:: The old top-level resource `/os-migrations` is frozen,
it won't be extended anymore. Use /servers/{uuid}/migrations instead.
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
List Migrations
===============
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-migrations
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 in-progress migrations.
verify api-ref os-migrations.inc verify the parameters of os-migrations.inc including response and request. And, add warning for deprecation and incorrect wording of policy default rule. looks like the new migration is missing in doc, follow up patch will add it. Part of bp:api-ref-in-rst Change-Id: I8fed7374c34c5c857c8c55f56f86ad4c744844e9
2016-04-27 22:52:42 +08:00
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
``policy.json`` file.
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
Complete method verification of os-migrations Corrects the error status responses for os-migrations Part of bp:api-ref-in-rst Change-Id: Ia4aa0e6378e1b327fb75b2f630279b35835ba095
2016-05-09 22:10:24 +00: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
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
verify api-ref os-migrations.inc verify the parameters of os-migrations.inc including response and request. And, add warning for deprecation and incorrect wording of policy default rule. looks like the new migration is missing in doc, follow up patch will add it. Part of bp:api-ref-in-rst Change-Id: I8fed7374c34c5c857c8c55f56f86ad4c744844e9
2016-04-27 22:52:42 +08:00
- status: migration_status
- host: migration_host
- source_compute: migration_source_compute
- migration_type: migration_type
- hidden: migration_hidden
- instance_uuid: migration_instance_uuid
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
Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:52:18 +09:00
**Example List Migrations: 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
Fix content and sample file for keypair, migration, networks This fix some content and sample file path for: -os-keypairs -os-migrations -os-networks Part of bp:api-ref-in-rst Change-Id: I6ae6d38207c5a9552bab9a42b2800449e4ad040a
2016-04-20 12:03:04 +09:00
.. literalinclude:: ../../doc/api_samples/os-migrations/migrations-get.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