2.9 added locked param to view builder of servers
several actions are affected.
Rebuild action will be in another separated patch to
add whole response of rebuild action.
Change-Id: I366b5f43b971b4315f006d2b4a223de4fcaef78a
Implements: blueprint api-ref-in-rst-ocata
The sample of block_device_mapping_v2 contains uuid as a parameter
but there is not any explanation of the parameter.
This patch adds it to api-ref.
The following is for explaining the parameter from the code.
As the following code, source_type is "image" and api_dict["image_id"]
can be glance image-id on the sample case.
https://github.com/openstack/nova/blob/master/nova/block_device.py#L197
api_dict[source_type + '_id'] = device_uuid
The "image_id" is used for getting image metadata from Glance:
https://github.com/openstack/nova/blob/master/nova/compute/api.py#L1072
image_id = bdm['image_id']
image_meta = self.image_api.get(context, image_id)
Change-Id: I83badab07446c2b1e55cc3b29a3ba9476efc179d
- Cleaned up some wording, and formatted
two rst notes.
- Moved cloudpipe.inc in index.rst to be located
with other deprecated apis.
Change-Id: Ic3740540e8cc626110c77214acf87338e1abdd76
In the description of Update Server the parameter name is not optional,
while it is optional. This is fixed by this patch.
Change-Id: I2a659c07caeee1a10b096f58c2e10aa7e8a0bf7a
Signed-off-by: csatari <gergely.csatari@nokia.com>
The os-server-groups endpoint has supported paging using optional
'limit' & 'offset' query parameters for years now, but they aren't
documented in the api-ref. This patch adds those query parameters to the
nova api documentation.
Change-Id: Ifc234da617c31f1f22674b306fdd6e398041973a
This includes the parameter, example, and body
verification for os-floating-ips.
part of bp:api-ref-in-rst-ocata
Change-Id: I4beff34b41baf77827a2e4d916ad5319bdefbfa1
This completes the DELETE method body verification
for server migrations.
This was only supported in microversion >= 2.24 and only
on the libvirt driver so there are notes about it being
conditional.
Closes-Bug: #1641713
Part of blueprint api-ref-in-rst-ocata
Change-Id: I3bc2cb70f8ad12124098376ef01eb7df2f6b2f88
Currently we only publish the master branch of api-ref to:
http://developer.openstack.org/api-ref/compute
and we have microversion caps for different releases.
It will be better for user to understand if we add
also microversion caps information to the doc.
Change-Id: Ic6c042f68f5d340a68abad6701e65d44e46da3a7
Closes-bug: #1640995
This completes the body verification for the force_complete
action for server migrations.
This is only supported with microversion >= 2.22 and only for
in-progress live migrations, on unlocked servers that are in
active/migrating status.
There is also a note as not all compute drivers support this
action. See bug 1641753 for details.
Part of blueprint api-ref-in-rst-ocata
Change-Id: I9cd6cf35b4b5828f0f4acde168cda2beedd902f4
Completes the body verification for showing details of a
specific in-progress live migration for a given server.
Part of blueprint api-ref-in-rst-ocata
Change-Id: I5175fc8814cc5c62739273e02e52b81aa6b39b0b
This completes the body verification for listing server
migrations.
Note that the code currently filters such that only in-progress
live migration records are returned. This was also only available
with microversion >= 2.23.
Part of blueprint api-ref-in-rst-ocata
Change-Id: I3a785dad690eee80ec1fd50ebc9fd3f7484dc344
Completes the example verification for the server-migrations API.
Partial-Bug: #1641713
Part of blueprint api-ref-in-rst-ocata
Change-Id: I2234ac402d778553cbebb915943ce1fd0b8d6210
This completes the parameter verification for the server-migrations
API.
Partial-Bug: #1641713
Part of blueprint api-ref-in-rst-ocata
Change-Id: I94ac520b35f4e6a042456c67bc713202fd8c3c91
We don't have any api-ref for server-migrations. os-migrations
is frozen and server-migrations replaces it, but we don't
have any docs for it, so this is a start.
Partial-Bug: #1641713
Part of blueprint api-ref-in-rst-ocata
Change-Id: I3da6ff6a4a0abf2f9c8bae3fb28fe23fdc3b0959
The api-ref was saying that the server_id was in the body of the
server metadata requests but it's actually in the path for all
of the requests.
Change-Id: Icdecd980767f89ee5fcc5bdd4802b2c263268a26
Closes-Bug: #1641331
- Update server_id params to be of type path.
- Cleaned up os-getConsoleOutput action string.
- Made empty response body description more consistent.
Review and change as needed.
Implements: bp/api-ref-in-rst-ocata
Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
In the current api-ref, we have illustrated
about how to add extra specs for flavors,
but it was very simple and we have a large
number of built-in extra specs that can be
used to archive different purpose listed here:
http://docs.openstack.org/admin-guide/compute-flavors.html
The reader will still be confused about how
to correctly use extra specs only read the
api-ref. We could first simply add the above
link to the flavor extra spec section in
api-ref to let readers know where to find
information and come up with better solution
later.
Change-Id: Ie720973783f153d3954be9f4bd97e7f9bf788c6b
Closes-bug: #1640654
As described in the bug, the addFloatingIp parameter
in the request body is an object, not a string. And we
didn't actually have an example request, so one is added
here to further clarify the API.
Change-Id: I366ba880cf13558291da286e6524327cafcccf1f
Closes-Bug: #1636185
The user_id has always been returned for the keypair create and
show operations. The user_id has never been returned in the list
response. The docs were a bit confusing for create and show since
they said 'New in version 2.10' for the user_id description in the
response.
This change clarifies the response docs so that we don't make it
sound like user_id is only getting returned for create/show with
microversion 2.10 and removes user_id from the response docs for
the list operation.
Change-Id: I4bd06c8ed88e526f44bb0d6e927c09175bf103b1
Closes-Bug: #1638606
This makes two changes for the block_device_mapping_v2
delete_on_termination parameter reference:
1. Identifies that it's optional.
2. Identifies that if not specified, the default is False.
Change-Id: I21133052c67fcd995c3ba11d996b414defcf910a
The OS-EXT-STS:power_state attribute in a server GET response
is enum values which are meaningless unless you look at the
nova/compute/power_states.py code. This change adds a mapping
to the description on that field in the api-ref.
Note there are gaps in the sequence, those are for unused values
as seen in the nova.objects.fields.InstancePowerState class.
Change-Id: I2ef9f493e66ab04b13f439e73247dc306a1514b4
This was using the images details GET response which is
not the same as the specific image GET response format.
Change-Id: I7db1cf374701b7321d2d55e1454ea5a612e6b421
Closes-Bug: #1636418
In os-snapshots APIs, the display name is the snapshot name,
not the volume name.
The display description is the snapshot description,
not the volume description.
So fix them.
Change-Id: I33cd59b759c6f7c8eca8bd511ba43637e7b27c1c
Closes-Bug: #1611292
There are multiple errors in the API doc for os-console-auth-tokens
(name, description, params). This patch fixes them.
Closes-Bug: #1602293
Change-Id: Ia3d678b4d9fc5b768088224d0338c8e97c761b3c
As service delete will affect host aggregate, add more info
Change-Id: I57b17f60228df83a033735c33cc74589dad30553
Implements: blueprint api-ref-in-rst-ocata
This patch removes some parameters which are in parameters.yaml but
are not used in other *.inc files.
Change-Id: I53bfb618895a87305eeac6807f62ff1c2f2418cc
jichenjc