607 Commits

Author SHA1 Message Date
Jenkins
559eb958f5 Merge "Document and provide useful error message for volume-backed backup" 2017-04-20 12:47:22 +00:00
Takashi NATSUME
a369e30e08 api-ref: Fix response code and parameters in evacuate
* Unnecessary note is removed.

* The 'on_shared_storage' parameter
  The max version is 2.13.
  Improve the description.

* The 'evacuate' parameter
  Fix the type and the description.

* The 'adminPass' parameter
  Fix the description and remove max version.

* The 'host' parameter
  Improve the description.

* response code
  Remove unncessary response codes.
  Add a missing response code.

Change-Id: Ic857333ac25bee26e3ec22106b1b8fda2389b967
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1683264
2017-04-18 11:52:47 +09:00
Takashi NATSUME
962dae61dc api-ref: Parameter verification for servers-actions (1/4)
This patch fixes the parameters of the following actions.

* addSecurityGroup
* changePassword
* confirmResize
* createImage

Subsequent patches will fix the patameters of the other actions
in servers-actions.inc.

Change-Id: Ifaa1ed25c034e649ea4012f4998c571c38d404a1
Implements: blueprint api-ref-in-rst-pike
2017-04-17 01:20:57 +00:00
Jenkins
5a556a720f Merge "api-ref: networks is mandatory in Create Server" 2017-04-12 15:31:15 +00:00
Takashi NATSUME
0cbf7bb038 api-ref: Fix parameters in os-hosts.inc
* Show Host Details
  - The parameters in 'resource' object are prefixed
    with 'resource.' instead of 'host.'.
  - The types of 'cpu', 'memory_mb' and 'disk_gb' are
    changed to 'integer'.
  - The descriptions of 'cpu', 'memory_mb' and 'disk_gb'
    are changed (clearer).

* Update Host status
  - The 'status' and 'maintenance_mode' in request
    parameters are changed to 'body' parameters
    instead of 'path' parameters.
  - The 'status' and 'maintenance_mode' in request
    parameters are changed to either 'enable' or
    'disable'.
  - The 'status' and 'maintenance_mode' in response
    parameters are changed to 'optional'.

Change-Id: Ic6bffca8b1dfaa9284a72145f3e1f894acb306e3
Closes-Bug: #1653884
2017-04-12 00:02:01 +00:00
Jenkins
e5ffe02463 Merge "Fix api-ref for create servers response" 2017-04-11 12:06:44 +00:00
Jenkins
e78ff51bb4 Merge "api-ref: fix os-extended-volumes:volumes_attached in servers responses" 2017-04-11 12:04:39 +00:00
ghanshyam
435a898778 Fix api-ref for create servers response
create server API only return few elements in response
not all which are currently shown in api-ref.

This commit fix that.

Part of bp/api-ref-in-rst-pike

Change-Id: I782e97bc3ffb1e1c192b5a63736e524917739e4b
2017-04-11 03:20:19 +00:00
Matt Riedemann
b98d9e1d4f Document and provide useful error message for volume-backed backup
The createBackup API does not support backing up volume-backed
instances. The error message the user gets is not useful about
why the request was invalid, and the API reference docs do not
mention the limitation. This change addresses both of those issues.

Change-Id: I04fd8ab4f8818d9d0ccccb6f6fcb34965b15b8f3
Partial-Bug: #1679314
2017-04-10 16:24:28 -04:00
Jenkins
b5a9ebf4f2 Merge "Add server-action-removefloatingip.json file and update servers-actions.inc" 2017-04-07 18:34:30 +00:00
Jenkins
2669a89083 Merge "Add empty flavor object info in server api-ref" 2017-04-07 15:36:37 +00:00
Matt Riedemann
28831f3b3d api-ref: fix os-extended-volumes:volumes_attached in servers responses
There are two main changes here:

1. The contents of the os-extended-volumes:volumes_attached list are
   described, which are the id and delete_on_termination keys, the latter
   being introduced in the GET /servers response in 2.3.

2. The os-extended-volumes:volumes_attached parameters are removed from
   the PUT /servers and POST /servers responses, since we don't actually
   include those in the response for create and update operations, only
   GET /servers/{server_id} and GET /servers/detail operations.
   Note: create server is fixed in a follow up patch.

Change-Id: Ic92055e3095d220a3a11e35628f04e9e67c6b71a
Closes-Bug: #1675559
2017-04-07 13:40:08 +00:00
Matt Riedemann
74db119220 api-ref: make it clear that os-cells is for cells v1
With cells v2, we need to be clear about what is cells v1 and
what is cells v2 in our documentation. This makes a note in the
os-cells api-ref about that being for cells v1 and also adds a
line saying the entire API is admin-only by default.

Change-Id: I2a06e2c4921ce7172aab33818054dd37b5ef9a65
2017-04-05 17:56:57 +00:00
ghanshyam
af1734b0dd Add empty flavor object info in server api-ref
In case flavor information is not present in sysmeta then
GET/PUT server response can have flavor as empty object.

ref- http://git.openstack.org/cgit/openstack/nova/tree/nova/api/openstack/compute/views/servers.py#n252

Having that mentioned in api-ref will be nice to understand it clearly.
Closes-Bug: #1677999

Change-Id: I350dc33df0cb03eb86df1f142e58ae34b02a1334
2017-04-05 02:52:41 +00:00
Jenkins
2e4dbcf629 Merge "Make metadata doc more readable" 2017-04-03 13:43:15 +00:00
Jenkins
cb2fa07041 Merge "Clean up metadata param in doc" 2017-04-03 12:39:18 +00:00
Jenkins
88bc8dc5ce Merge "api-ref: fix description of volumeAttachment for attach/swap-volume" 2017-03-31 19:30:48 +00:00
Jenkins
9b1ec228df Merge "Fix api-ref for adminPass behavior" 2017-03-31 15:17:35 +00:00
libing
e0582bf174 Add server-action-removefloatingip.json file and update servers-actions.inc
Part of bp:api-ref-in-rst-pike

Change-Id: I6a7dbbd5d999fef557a110a6828a317e2e8da3c0
2017-03-31 14:12:38 +00:00
csatari
103c5a969f api-ref: networks is mandatory in Create Server
Since microversion 2.37 networks is mandatory in Create Server
request. This was not reflected in the api-ref. In the Description
field it is explained that the field become mandatory in 2.37 what
is correct, but the optionality should reflect the actual status.

Change-Id: I58ee75df3f1697b34db22469f1dafbe139e05a6b
Signed-off-by: csatari <gergely.csatari@nokia.com>
2017-03-31 09:11:38 +02:00
Kevin_Zheng
1be9b0e680 Make metadata doc more readable
Found that docs about server metadata is quite
hard to understand, made some modifications to
be more readable.

Change-Id: If74dc383149068f2c568482c78e6db1e19f7d3af
2017-03-31 06:19:01 +00:00
Takashi NATSUME
47bd7be882 api-ref: Fix wrong HTTP response codes
* POST /servers

  The 413 response code has not been expected
  since I470b53af45ff47c1dec98d09d7a426a29ca1efc6.
  So remove 413.

* POST /server/{server_id}/action

  In 'Rebuild' action, the 413 response code has not been expected
  since I470b53af45ff47c1dec98d09d7a426a29ca1efc6.
  So remove 413.

  In 'Rescue' action, the normal response code is actually 200
  instead of 202.
  So fix it.

Change-Id: I6e91d3ac751777f48ab084395a66cb3f83bfcca2
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1677452
2017-03-30 13:51:07 +09:00
Jenkins
7f5dd33a70 Merge "Complete verification of servers-action-fixed-ip.inc" 2017-03-28 10:58:37 +00:00
Jenkins
357951ca1e Merge "Fix 'server' and 'instance' occurrence in api-ref" 2017-03-28 09:48:08 +00:00
ghanshyam
78dee1de59 Fix api-ref for adminPass behavior
This commit fix the below doc issue for adminPass
 -'adminPass' attrbiure is only return in response if
  'enable_instance_password' configuration option is set to true
 - evacuate API stop returning adminPass from 2.14 microversion
   so max version for this field is 2.13.
 - if 'adminPass' is not present in request then, operation auto generate one.

Change-Id: I636657ed30b33da0a2df73b222c4ce5d8388a3d8
2017-03-28 06:51:01 +03:00
ghanshyam
49cade591f Fix 'server' and 'instance' occurrence in api-ref
some api-ref have sentence like '..for a server instance'
which is inconsistent and confusing as we use server for VM terminology.
I think here 'instance' word is being considered object of server which
is wrong.

We should always mention server only.

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

Change-Id: I32afe56cfc66b34b76d1f7e1b507d3d5e722e6a1
2017-03-28 02:54:11 +00:00
Jenkins
93aee8203a Merge "api-ref: Complete all the verifications of remote consoles" 2017-03-27 13:29:49 +00:00
Matt Riedemann
dbd1efd744 api-ref: fix description of volumeAttachment for attach/swap-volume
The description of the volumeAttachment request parameter was actually
the description of the response parameter, which included more fields
than we allow on the POST and PUT requests for os-volume_attachments.

This fixes the descriptions for both POST and PUT and also includes a
tiny fix for the wording on the existing volumeAttachment parameter.

Change-Id: I4ccd4ac12e24b232925875fdb5fb568c2bfaf417
Closes-Bug: #1675536
2017-03-23 16:00:46 -04:00
He Jie Xu
54af57f485 api-ref: Complete all the verifications of remote consoles
This patch includes all the verifications of remote consoles

part of blueprint api-ref-in-rst-pike

Co-Authored-By: Markus Zoeller <mzoeller@linux.vnet.ibm.com>
Change-Id: Ib169e4bd931b5a04f31cd0e7c43c161b49eafe5c
2017-03-23 10:51:13 +08:00
Jenkins
b672f35de6 Merge "Add description for Image location in snapshot" 2017-03-17 19:30:48 +00:00
Jenkins
b5e9198c99 Merge "api-ref: Fix parameters and examples in aggregate API" 2017-03-17 17:35:13 +00:00
Jenkins
2b3ce2a028 Merge "Improve descriptions for hostId, host, and hypervisor_hostname" 2017-03-17 16:52:39 +00:00
Jenkins
6dc60505f9 Merge "Add api-ref for filter/sort whitelist" 2017-03-17 16:13:44 +00:00
melanie witt
261e7e3c5e Improve descriptions for hostId, host, and hypervisor_hostname
The current descriptions for hostId, host, and hypervisor_hostname are
vague, so this adds more detail to make them more understandable.

Closes-Bug: #1673593

Change-Id: Id3ea9bbfe59a47b24e3584cf16b5a556007e58ea
2017-03-17 11:04:15 -04:00
Kevin_Zheng
e06cb39121 Add api-ref for filter/sort whitelist
Add api-ref doc for the filter/sort whitelist,
showing what can be used to filter and
sort results when calling list server API.

Co-Authored-By: ghanshyam <ghanshyammann@gmail.com>
Change-Id: I821085f885f207408e56f73ccbf0956dc017ba78
2017-03-17 06:56:47 +00:00
Matt Riedemann
3f2a5fc23a api-ref: fix description in os-services
The services data model and API is not per-tenant, it's
per-region, so this change updates the docs to reflect that.

Change-Id: I45bc0bd5afcd05626f61be84c012e00f723f80eb
2017-03-16 18:00:13 -04:00
Ken'ichi Ohmichi
095322657d Clarify os-stop API description
The original changed description tried to explain the instance
data still exists after the API operation, but that was not clear.
This patch makes it clear as possible for users.
In addition, this patch removes the related sentence of os-start
to avoid the same confusion.

Change-Id: I46c4d24a67717807f4c6650a739f7855108783e9
2017-03-16 11:16:49 -07:00
jichenjc
72081ded4d Add description for Image location in snapshot
snapshot action nova will return image URL in response header
better to provide this info to end user for their reference.

Also, the backup header description is changed as well.

Change-Id: I15cf228b4a5a2d0dbae5fa76ec6821487e7808ed
Closes-Bug: 1657998
2017-03-13 19:09:08 +08:00
Takashi NATSUME
48f6f0148d api-ref: Fix parameters and examples in aggregate API
- The type of aggegate ID is changed to 'integer' instead of 'string'.
- The uuid of aggegate is changed to 'required'
  because the uuid is always shown in the response after v2.41.
- The response examples are replaced with v2.41 examples.

Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80
Closes-Bug: #1659475
2017-03-13 04:04:39 +00:00
Jenkins
330590d0aa Merge "remove a TODO as all set for tags" 2017-03-10 22:51:34 +00:00
Jenkins
387e949625 Merge "api-ref: Fix keypair API parameters" 2017-03-10 19:31:08 +00:00
Takashi NATSUME
2800b53836 api-ref: Fix keypair API parameters
Fix parameter types and the order of parameters.
Add missing parameters.
Add a period at the end of a parameter description.
Replace sample files with v2.10 files.

Change-Id: I9d8d20b42c7d32e11af479e79c9c9e8475421302
Closes-Bug: #1656781
2017-03-10 15:58:06 +09:00
tengqm
9092207b9a Fix API doc about server attributes (2.3 API)
The attribute names added in version 2.3 API was incorrectly documented.

Change-Id: Ib2cdb5191fc23ba87b1528c95afc019ec57b4103
2017-03-09 03:50:48 -05:00
Andreas Jaeger
7ad3807500 Fix api-ref with Sphinx 1.5
Sphinx 1.5 is more picky about highlighting and currently building of
api-ref fails with:

Warning, treated as error:
/home/aj/Software/vcs/OpenStack/openstack/nova/api-ref/source/index.rst:4:
WARNING: Could not lex literal_block as "json". Highlighting skipped.

Fix problems found:
Remove duplicate "progress: 0" from
os-rescue/server-get-resp-unrescue.json,
os-server-tags/v2.26/servers-tags-details-resp.json,
os-server-tags/v2.26/server-tags-show-details-resp.json.

Change json to javascript for highlighting of delete_info.

Change-Id: I7cd969fb4c9d4bff995c34725cfb739cccaba12c
2017-03-03 11:58:50 +01:00
stewie925
5c574cf31c Complete verification of servers-action-fixed-ip.inc
This includes the parameter, body, and example verifications for
api-ref servers-action-fixed-ip.

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

Change-Id: I2b9971d7ff3716f330b55020bf37489dbc9e9b2c
2017-02-28 09:28:59 -08:00
jichenjc
70dd9660f5 remove a TODO as all set for tags
tags already documented in api-ref and we already had all
server queries there, so no additional steps for it

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

Change-Id: I726171f256a3404801a7f9b8109d46bf5b7c62cf
2017-02-25 22:06:56 +08:00
jichenjc
4aaa8bc0bf Clean up metadata param in doc
several params like metadata_xxx are used and actually they are
same, so just clean up them and use metadata_object instead

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

Change-Id: I455c02b5dcd77df43fc8c0113269f71a5207d3d5
2017-02-25 21:45:05 +08:00
Jenkins
918e80a7ee Merge "api-ref: fix delete server async postcondition docs" 2017-02-25 04:49:30 +00:00
Jenkins
4d33ec2954 Merge "api-ref: cleanup os-server-groups 'policies' parameter description" 2017-02-23 22:49:30 +00:00
Jenkins
92c03b45a5 Merge "api-ref: fix instance action 'message' description" 2017-02-23 12:43:13 +00:00