719 Commits

Author SHA1 Message Date
Jenkins
baf92969c0 Merge "make 2.31 microversion wording better" 2016-12-27 10:54:12 +00:00
Takashi NATSUME
e7f5f02f7d api-ref: Fix parameter type in servers-admin-action.inc
Fix parameter type and add a missing parameter
in servers-admin-action.inc.

Change-Id: I8ad9227b49ad8148098a8658647bb4a9216d15ba
Closes-Bug: #1651441
2016-12-26 05:30:47 +00:00
Jenkins
1d3bc61356 Merge "Remove v2.40 from URL string in usage API docs" 2016-12-22 21:27:54 +00:00
Cady_Chen
d0f3817bf0 Replace "Openstack" with "OpenStack"
According to the word choice convention in
http://docs.openstack.org/contributor-guide/writing-style/word-choice.html
We should use "OpenStack" instead of "Openstack".

Change-Id: Ie55354adb17fb3617995cf9463e670e4788723ca
2016-12-22 23:15:37 +08:00
Kevin_Zheng
19809429e8 Fix misleading port delete description
After the fix of: https://review.openstack.org/#/c/126309
the pre-existed Neutron port that are attached to the
instance will not be deleted, the current description
is misleading.

Change-Id: Ibfd4bc2278911844e4b1c05e94b4e3c947365b75
2016-12-22 09:24:34 +08:00
Jenkins
6f1a39d7dc Merge "Add document update for get console usage" 2016-12-22 00:17:20 +00:00
Kevin_Zheng
250799551b Trival fix typos in api-ref
Trival fix typos in api-ref

Change-Id: I98347db828a919dd9fa8f3c3ad51c7a048909176
2016-12-21 21:50:55 +08:00
jichenjc
271d9f6803 make 2.31 microversion wording better
use 'Now' is confusing, to make the wording more specific

Change-Id: Ifc4a9a192055af55d65fb48e6cb0d9968a986deb
Implements: blueprint api-ref-in-rst-ocata
2016-12-21 15:08:18 +08:00
int32bit
5eb8297f61 Add soft delete wrinkle to api-ref
The API reference for deleting a server is making the assumption that
the instance is going to be (hard) deleted from the system, but it
doesn't take into account the case that CONF.reclaim_instance_interval
is set, which if > 0 makes the API 'soft delete' the instance, so that
the instance's vm won't be deleted until the
CONF.reclaim_instance_interval has expired since the instance was soft
deleted. The instance marked as ``SOFT_DELETED`` can be recovered via
``restore`` action before it's really deleted from the system. We should
update the reference to talk about the soft deleted wrinkle so we can set
expectations.

Closes-Bug: #1650328

Change-Id: Ibbb1c225da11234aaac3634769db112a30dfef64
2016-12-21 02:39:02 +00:00
jichenjc
db7360b9af Add document update for get console usage
not set LC_ALL=en_US.UTF-8 might get some error like:
(UnicodeEncodeError): 'ascii' codec can't encode character u'\ufffd'
add document update to indicate this to user as this is user related.

Change-Id: I9c39da5411b3080c46f557ba27ffa06a37086b7d
Related-Bug: 1650051
2016-12-20 21:18:05 +08:00
Cao Xuan Hoang
d99fd590b0 Removes unnecessary utf-8 encoding
trivialfix

Change-Id: I1294ecb5e85c9bf70a23992e92eeccfd35362551
2016-12-20 10:27:01 +07:00
Monty Taylor
7049afd697
Remove v2.40 from URL string in usage API docs
It looks like this was just some copy-pasta.

Change-Id: Ic6549c55dc328f717ba84af40b919cbeba214798
2016-12-19 15:53:53 -06:00
Jenkins
f2e4b244e8 Merge "osapi_max_limit -> max_limit" 2016-12-19 15:25:50 +00:00
Diana Clarke
c8b631bc36 osapi_max_limit -> max_limit
This max limit config option was moved to the api group in
Ida4ee57d6e1822e35e3198f6d3a89410e211d57d. Update the api-ref to reflect
those changes.

Change-Id: I8ee5b07eecc49833987be499273f3eb7420197e4
2016-12-15 13:28:51 -05:00
Jenkins
bcc1768042 Merge "Simple tenant usage pagination" 2016-12-15 18:25:20 +00:00
Jenkins
ab8fca45e7 Merge "api-ref: Fix description of os-instance-usage-audit-log" 2016-12-15 13:11:51 +00:00
Jenkins
b27d091fb0 Merge "Stop allowing tags as empty string" 2016-12-15 04:34:17 +00:00
Jenkins
8a080d5ea1 Merge "Better wording for micorversion 2.36" 2016-12-14 18:57:44 +00:00
Matt Riedemann
be379e3733 api-ref: Fix description of os-instance-usage-audit-log
This API is not per-tenant, it's a global admin query of all
server usage audit data on all configured compute hosts, so
this change updates the description to reflect that and also
replaces the admin-only wording with the more useful boilerplate
admin default wording we have in other API references.

Change-Id: I8f48caa3505abbcfbe08e9218fc70eeeaf643b13
Closes-Bug: #1649944
2016-12-14 11:22:50 -05:00
ghanshyam
7cad745eba Stop allowing tags as empty string
Nova support tagging of instance or other resource like device etc.
But those tags are allowed to be as empty string which does not make
much sense or any real use case.

Updating single tag with empty string is not possible as it will
be 404 due to url itself has single tag as id.

But updating all tags with few or all of them as empty string
does not complain. In those cases, empty tags are being accepted and
stored as same.

Main issue with those is that empty tag cannot be deleted/show as single
tag as it will again 404 with url not found. Only way to delete/show
such tag is to delete all together.

Empty tag should not be allowed at first.
This commit makes empty string request to 400 which are
currently 200. Doing for server and device tags and same can
be adopted for other resource tagging also if any in future.

Fixing this as bug fix hoping no backward incompatibility
logically. If such tag could have been deleted alone then we could have
fix this with microversion.

Change-Id: I18a81f19205b2a40ca470067a9576f2f72ff0f13
Closes-Bug: #1648663
2016-12-14 12:23:24 +00:00
Diana Clarke
83404013cb Simple tenant usage pagination
Add optional parameters 'limit' and 'marker' to the
os-simple-tenant-usage endpoints for pagaination.

  /os-simple-tenant-usage?limit={limit}&marker={instance_uuid}
  /os-simple-tenant-usage/{tenant}?limit={limit}&marker={instance_uuid}

The aggregate usage totals may no longer reflect all instances for a
tenant, but rather just the instances for a given page. API consumers
will need to stitch the aggregate data back together (add the totals)
if a tenant's instances span several pages.

Implements blueprint paginate-simple-tenant-usage
Change-Id: Ic8e9f869f1b855f968967bedbf77542f287f26c0
2016-12-14 03:33:50 +00:00
Takashi NATSUME
6ab20bc523 api-ref: Fix 'id' (attachment_id) parameters
At first, the 'attachment_id_resp' in parameters.yaml was defined
as 'required' in I3789a4ad36e30728024f2aa122403b0e53b1e741
for os-volume_attachments.inc.
Then it was changed to 'optional' in
I0c1d183c5aaf6fb796be30fa5627bd5644ea689f
for os-volumes.inc.
So currently 'id' (attachment_id) parameters in
os-volume_attachments.inc are wrong.
They should be 'required'. So fix them.

Change-Id: I403a9eb1b08a840cbb2b82cb37f1b49c6edb87c9
Closes-Bug: #1608842
2016-12-13 06:18:05 +00:00
Jenkins
d9d9071af2 Merge "api-ref: note that os-virtual-interfaces is nova-network only" 2016-12-12 17:55:46 +00:00
Jenkins
e1a749ef43 Merge "api-ref: Body verification for os-simple-tenant-usage.inc" 2016-12-12 17:17:52 +00:00
Jenkins
2f678fe45d Merge "Add more description for rx and tx param" 2016-12-12 06:52:03 +00:00
jichenjc
5c5544203f Add more description for rx and tx param
Add more description for rx and tx in diagnostics command.

Change-Id: Ia4bc5a43a0a90392444dfbe710d6622986bf34b0
Closes-Bug: 1628368
2016-12-12 16:41:45 +11:00
jichenjc
deac17c4f9 Better wording for micorversion 2.36
make it follow other descriptions, use start from to make
it clear 2.36 is the first microversion deprecate those proxy

Implements: blueprint api-ref-in-rst-ocata

Change-Id: Iadf4bb6fa8e4a959a734f354206e2e1f4739e367
2016-12-10 18:49:13 +08:00
Jenkins
e75d5f9d53 Merge "[proxy-api] microversion 2.39 deprecates image-metadata proxy API" 2016-12-07 21:17:03 +00:00
Matt Riedemann
a35de0cd7b api-ref: note that os-virtual-interfaces is nova-network only
Let's avoid confusion over errors from the os-virtual-interfaces
exception when using Neutron and make a note that it's only
implemented for nova-network.

Change-Id: I7a136eecbeb5f89dfe98f51abf1188213bdca9fd
Closes-Bug: #1648047
2016-12-07 14:36:24 -05:00
Pavel Kholkin
df6e2d37f2 [proxy-api] microversion 2.39 deprecates image-metadata proxy API
Almost all proxy APIs were deprecated in microversion 2.36.
But the sub-resource image-metadata of image was forgotten to deprecate.
This patch deprecates the image-metdata API from 2.39.

Implements blueprint deprecate-image-meta-proxy-api
Closes-bug: #1614578

Change-Id: I5507337ab6fe4a377f66dec3fe275d75618cd7b4
2016-12-07 19:22:43 +03:00
Ken'ichi Ohmichi
9a5c20af7f Add block_device_mapping_v2.uuid to api-ref
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
2016-12-01 19:15:14 -08:00
Jenkins
224773def4 Merge "Optional name in Update Server description in api-ref" 2016-12-01 03:37:59 +00:00
Karen Bradshaw
dc1433be08 [api-ref] Minor text clean-up, formatting
- 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
2016-11-29 12:31:46 -05:00
Jenkins
8dafe05b42 Merge "api-ref: add missing os-server-groups parameters" 2016-11-29 11:30:54 +00:00
Jenkins
10740664f8 Merge "api-ref: body verification for abort live migration" 2016-11-29 11:30:19 +00:00
jichenjc
f853a5c4be Add description for 2.9 microversion
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
2016-11-28 22:26:08 +08:00
csatari
0c1e2fa28b Optional name in Update Server description in api-ref
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>
2016-11-28 12:41:21 +01:00
Diana Clarke
dba04d511c api-ref: add missing os-server-groups parameters
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
2016-11-22 11:27:46 -05:00
stewie925
2ecbbd8d43 Complete verification for os-floating-ips
This includes the parameter, example, and body
verification for os-floating-ips.

part of bp:api-ref-in-rst-ocata

Change-Id: I4beff34b41baf77827a2e4d916ad5319bdefbfa1
2016-11-21 14:49:35 -08:00
jichenjc
2fff8a0243 api-ref: Body verification for os-simple-tenant-usage.inc
Change-Id: I01035055352f828306bc15bc4bf140451bef2418
Co-Authored-By: Eli Qiao <liyong.qiao@intel.com>
Implements: blueprint api-ref-in-rst-ocata
2016-11-18 18:22:55 +08:00
Matt Riedemann
e975603b88 api-ref: body verification for abort live migration
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
2016-11-16 09:48:10 -05:00
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