478 Commits

Author SHA1 Message Date
Jenkins
5d6a84b851 Merge "API Ref: update server_id params" 2016-11-16 11:42:44 +00:00
Jenkins
22306bb8f5 Merge "Remove unused parameters" 2016-11-16 10:24:02 +00:00
Jenkins
516569136c Merge "api-ref: body verification for force_complete server migration" 2016-11-16 10:23:26 +00:00
Jenkins
de91c803c4 Merge "api-ref: body verification for show server migration" 2016-11-16 10:22:44 +00:00
Jenkins
e1f6ee4639 Merge "api-ref: body verification for list server migrations" 2016-11-16 10:22:07 +00:00
Jenkins
cf8d55ab3f Merge "api-ref: example verification for server-migrations" 2016-11-16 10:21:19 +00:00
Jenkins
e48ab81469 Merge "api-ref: parameter verification for server-migrations" 2016-11-16 10:20:03 +00:00
Kevin_Zheng
a4a7853781 Add microversion cap information
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
2016-11-16 06:50:09 +00:00
Matt Riedemann
3e210b443d api-ref: body verification for force_complete server migration
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
2016-11-14 18:09:54 -05:00
Matt Riedemann
c0774e6776 api-ref: body verification for show server migration
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
2016-11-14 17:41:33 -05:00
Matt Riedemann
ca09cbd0a6 api-ref: body verification for list server migrations
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
2016-11-14 17:41:28 -05:00
Matt Riedemann
6c6df6aa13 api-ref: example verification for server-migrations
Completes the example verification for the server-migrations API.

Partial-Bug: #1641713

Part of blueprint api-ref-in-rst-ocata

Change-Id: I2234ac402d778553cbebb915943ce1fd0b8d6210
2016-11-14 17:27:04 -05:00
Matt Riedemann
7d33dc85f5 api-ref: parameter verification for server-migrations
This completes the parameter verification for the server-migrations
API.

Partial-Bug: #1641713

Part of blueprint api-ref-in-rst-ocata

Change-Id: I94ac520b35f4e6a042456c67bc713202fd8c3c91
2016-11-14 17:26:54 -05:00
Matt Riedemann
925dc7aa12 api-ref: method verification for server-migrations
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
2016-11-14 16:25:37 -05:00
Matt Riedemann
633c817de5 api-ref: fix server_id in metadata docs
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
2016-11-12 12:15:04 -05:00
Jenkins
c4b1cdfc36 Merge "Add flavor extra_spec info link to api_ref" 2016-11-11 21:03:46 +00:00
Karen Bradshaw
168a500570 API Ref: update server_id params
- 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
2016-11-11 14:01:51 -05:00
Jenkins
f21ba22fa9 Merge "api-ref: fix addFloatingIp action docs" 2016-11-11 17:28:56 +00:00
Jenkins
e7fa14e5b3 Merge "api-ref: Fix a 'port' parameter in os-consoles.inc" 2016-11-10 16:55:42 +00:00
Jenkins
ad2cb626be Merge "[api-ref] Fix path parameter console_id" 2016-11-10 16:29:01 +00:00
Jenkins
d7d20497dc Merge "api-ref: fix image GET response example" 2016-11-10 16:28:09 +00:00
Kevin_Zheng
da1148a7a7 Add flavor extra_spec info link to api_ref
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
2016-11-10 06:10:14 +00:00
Takashi NATSUME
cc84595c23 api-ref: Fix a 'port' parameter in os-consoles.inc
In 'Show Console Details' API,
'port' is not a port ID but a port number.

Change-Id: Iefdd9e9a68fc197a99b8c5e2e36a82c062caa35f
Closes-Bug: #1632153
2016-11-09 00:28:36 +00:00
Matt Riedemann
0f26e6872e api-ref: fix addFloatingIp action docs
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
2016-11-07 11:32:31 -05:00
Matt Riedemann
be11fab555 api-ref: remove user_id from keypair list response and fix 2.10
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
2016-11-04 10:31:29 -04:00
Matt Riedemann
1d5442808e api-ref: cleanup bdm.delete_on_termination field
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
2016-11-01 18:12:29 -04:00
Matt Riedemann
c175c8d579 api-ref: document the power_state enum values
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
2016-11-01 17:39:17 -04:00
Karen Bradshaw
414afadec3 [api-ref] Fix path parameter console_id
Replace path parameter id with console_id in DELETE method.

Change-Id: Id008784fd91b5f5b4974564643cb0086799f9a8a
2016-10-31 15:45:05 -04:00
Matt Riedemann
07e65071b2 api-ref: fix image GET response example
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
2016-10-25 05:31:53 -04:00
Takashi NATSUME
5e9add3d10 api-ref: Fix wrong parameters in os-volumes.inc
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
2016-10-17 09:35:23 +00:00
Jenkins
26fd2eabb0 Merge "Fix API doc for os-console-auth-tokens" 2016-10-10 12:38:49 +00:00
Jenkins
bf3035506f Merge "Fix typo on api-ref parameters" 2016-10-06 19:53:06 +00:00
Radoslav Gerganov
d04e41e72b Fix API doc for os-console-auth-tokens
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
2016-10-06 18:09:52 +03:00
Hironori Shiina
935bea2045 Fix a few typos in API reference
Change-Id: Ib90100f4ec6b4b03f27ed39166caeb9bdf5bc24c
2016-09-28 14:34:23 +09:00
Atsushi SAKAI
4a6bf432b0 Fix typo on api-ref parameters
The => the

Change-Id: I08fedb0d24b0cb79369b0341e9fc92d960b7e76a
2016-09-28 14:28:51 +09:00
jichenjc
f81e32c9d1 Add more description when service delete
As service delete will affect host aggregate, add more info

Change-Id: I57b17f60228df83a033735c33cc74589dad30553
Implements: blueprint api-ref-in-rst-ocata
2016-09-21 20:18:18 +08:00
Ha Van Tu
a68cd911d1 [api-ref] Correct parameter type
`OS-EXT-SERV-ATTR:launch_index` parameter should be `integer`
instead of `int`.

Change-Id: I598ac4f310008933d1ddf2eff9f2e68fa2c76edc
2016-09-20 17:20:37 +07:00
Ha Van Tu
5e8f66d152 Remove unused parameters
This patch removes some parameters which are in parameters.yaml but
are not used in other *.inc files.

Change-Id: I53bfb618895a87305eeac6807f62ff1c2f2418cc
2016-09-20 12:02:00 +07:00
Jenkins
2468784fcb Merge "[api-ref] Update configuration file" 2016-09-19 16:39:09 +00:00
Jenkins
451db85c78 Merge "doc: fix disk=0 use case in flavor doc" 2016-09-19 16:38:06 +00:00
Jenkins
f6a3fccfe2 Merge "Updates URL and removes trailing characters" 2016-09-19 14:35:51 +00:00
Jenkins
983cc7c75e Merge "Add link ref to nova api concept doc" 2016-09-19 14:16:49 +00:00
Jenkins
c2341b5112 Merge "Add description for v2.20 changes in api-ref" 2016-09-19 14:16:22 +00:00
Jenkins
3a4c03dbe0 Merge "Add hypervisor_links into hypervisor v2.33" 2016-09-19 10:47:56 +00:00
Jenkins
2fb995a8ab Merge "Add keypairs_links into resp" 2016-09-19 09:15:22 +00:00
Jenkins
27a4b1744c Merge "Body Verification of api-ref os-volume-attachments.inc" 2016-09-19 08:57:03 +00:00
Jenkins
b624bec672 Merge "Complete verification for os-virtual-interfaces" 2016-09-19 08:45:38 +00:00
He Jie Xu
b2ee12ce19 Add link ref to nova api concept doc
This patch adds link to the api concept doc.

Change-Id: I3c9f7ebce7f4241a41492511b39f8649190b53eb
Partial-implements: blueprint api-ref-in-rst-ocata
2016-09-19 10:35:14 +08:00
Jenkins
29e2c41092 Merge "Add reserved param for v2.4" 2016-09-19 02:27:15 +00:00
Jenkins
8230aedb80 Merge "Trivial fix remove not used var in parameters" 2016-09-18 13:11:42 +00:00