x/mogan
Code Issues Proposed changes

API-REF: Fix the typo in docs and ensure the consistency of instance_uuid

Browse Source 
There is some typo in api-ref, it`s better to fix it.
And in [1], we use instance_ident, while in [2], we use instance_uuid,
in [3], we use instances_uuid. For consistency, it`s better to use
instance_uuid only.

[1]: https://github.com/openstack/nimble/blob/master/api-ref/source/v1/instances.inc#L163
[2]: https://github.com/openstack/nimble/blob/master/api-ref/source/v1/instances.inc#L213
[3]: https://github.com/openstack/nimble/blob/master/api-ref/source/v1/instances.inc#L267
Close-Bug: #1655205

Change-Id: I8489301467713f8391804c6f392e83283fb30a9a
This commit is contained in:
zhangjl 2017-01-10 03:03:53 +00:00
parent ed9c19d02c
commit 3ddadc49e0
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
api-ref/source/v1/instances.inc
View File

@ -11,7 +11,7 @@ Create Instance
.. rest_method:: POST /instances
Creates a instance.
Creates an instance.
The progress of this operation depends on the location of the
requested image, network I/O, selected type, and other factors.
@ -160,9 +160,9 @@ Response
Show Instance Details
=====================
.. rest_method:: GET /instances/{instance_ident}
.. rest_method:: GET /instances/{instance_uuid}
Shows details for a instance. By default, this will return the full
Shows details of an instance. By default, this will return the full
representation of the resource; an optional fields parameter can be supplied to
return only the specified set.
@ -176,7 +176,7 @@ Request
.. rest_parameters:: parameters.yaml
- instance_ident: instance_ident
- instance_uuid: instance_ident
- fields: fields
Response
@ -210,7 +210,7 @@ Response
Update Instance
===============
.. rest_method:: PATCH /instances/{instances_uuid}
.. rest_method:: PATCH /instances/{instance_uuid}
Updates the infromation stored about an instance.
@ -227,7 +227,7 @@ The BODY of the PATCH request must be a JSON PATCH document, adhering to
.. rest_parameters:: parameters.yaml
- instance_ident: instance_ident
- instance_uuid: instance_ident
**Example Update Instance: JSON request**
@ -264,7 +264,7 @@ Response
Delete Instance
===============
.. rest_method:: DELETE /instances/{instances_uuid}
.. rest_method:: DELETE /instances/{instance_uuid}
Deletes an instance.
@ -281,7 +281,7 @@ Request
.. rest_parameters:: parameters.yaml
- instance_ident: instance_ident
- instance_uuid: instance_ident
Response
--------
@ -302,7 +302,7 @@ its power state. This is handled asynchronously.
Instance State Summary
======================
.. rest_method:: GET /v1/instances/{instance_ident}/states
.. rest_method:: GET /v1/instances/{instance_uuid}/states
Get a summary of the Instance's current power status.
@ -313,7 +313,7 @@ Request
.. rest_parameters:: parameters.yaml
- instance_ident: instance_ident
- instance_uuid: instance_ident
Response
--------
@ -330,7 +330,7 @@ Response
Change Instance Power State
===========================
.. rest_method:: PUT /v1/instances/{instance_ident}/states/power
.. rest_method:: PUT /v1/instances/{instance_uuid}/states/power
Request a change to the Instance's power state.
@ -346,7 +346,7 @@ Request
.. rest_parameters:: parameters.yaml
- instance_ident: instance_ident
- instance_uuid: instance_ident
- target: power_state
**Example request to power off a Instance:**