50 Commits

Author SHA1 Message Date
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
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
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
9b1ec228df Merge "Fix api-ref for adminPass behavior" 2017-03-31 15:17:35 +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
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
Jenkins
6dc60505f9 Merge "Add api-ref for filter/sort whitelist" 2017-03-17 16:13:44 +00: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
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
Jenkins
918e80a7ee Merge "api-ref: fix delete server async postcondition docs" 2017-02-25 04:49:30 +00:00
Jenkins
312efe4563 Merge "api-ref: document the 'tenant_id' query parameter" 2017-02-09 14:18:10 +00:00
Matt Riedemann
26a961b584 api-ref: fix delete server async postcondition docs
Apparently we thought it was useful to tell you that
while a server is being deleted you could watch it's
status, but not enough that we cared to tell you what
status.

Change-Id: Ibb175c448712cbc0ff80353b83dcab524b223e4d
Closes-Bug: #1663036
2017-02-08 16:41:31 -05:00
Jordan Pittier
acfad7cf6f api-ref: document the 'tenant_id' query parameter
When listing servers, it's possible to filter servers based on
the tenant_id. This patch documents this.

Change-Id: I8432aa922cb61ef052cd1f7436546e69d7b6aceb
2017-02-07 16:02:47 +01:00
Artom Lifshitz
e80e2511cf Fix tag attribute disappearing in 2.33 and 2.37
In the context of device tagging, bugs have caused the tag attribute
to disappear starting with version 2.33 for block_devices and starting
with version 2.37 for network interfaces. In other words, block
devices could only be tagged in 2.32 and network interfaces between
2.32 and 2.36 inclusively.

This patch documents this behaviour in api-ref and introduces
microversion 2.42, which re-adds the tag in all the right places.

Change-Id: Ia0869dc6f7f5bd347ccbd0930d1d668d37695a22
Closes-bug: 1658571
Implements: blueprint fix-tag-attribute-disappearing
2017-01-30 19:38:46 -05: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
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
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
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
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
Jenkins
62412ad454 Merge "[api-ref]: Update link reference" 2016-09-14 16:50:30 +00:00
Jenkins
0f9de41cba Merge "[api-ref] fix availability_zone for server create" 2016-09-14 12:46:57 +00:00
ghanshyam
d7948387b1 Correct sort_key and sort_dir parameter for flavor
This commits define new parameter sort_key_flavor
and sort_dir_flavor for flavor List API and define
the correct default values for those.

Partially implements blueprint api-ref-in-rst

Change-Id: I2915a5bccebfeddf66c825b0272af86e3fd7da19
2016-09-13 08:28:26 +00:00
tengqm
73c4c001d6 [api-ref] fix availability_zone for server create
The 'availability_zone' parameter was incorrectly documented as
'os-availability-zone:availability_zone'. This patch fixes it.

Change-Id: I9837a747b40c9ef933a89acbdab9360ade1012a8
2016-09-12 05:47:47 -04:00
Ha Van Tu
b5073eb735 [api-ref]: Update link reference
This patch updates link reference for "create keypair" in
Compute API create server [1].
Current reference link:
http://developer.openstack.org/api-ref-compute-v2.1.html#createKeypair
http://developer.openstack.org/api-ref-compute-v2.1.html#createFloatingIP
http://developer.openstack.org/api-ref-compute-v2.1.html#addFloatingIp
http://developer.openstack.org/api-ref-compute-v2.1.html#removeFloatingIp
Update reference link:
http://developer.openstack.org/api-ref/compute/#create-or-import-keypair
http://developer.openstack.org/api-ref/compute
/#create-allocate-floating-ip-address
http://developer.openstack.org/api-ref/compute
/#delete-deallocate-floating-ip-address
[1] http://developer.openstack.org/api-ref/compute/?expanded=
create-server-detail#create-server

Change-Id: I421b559a7c127abb8c8c97d08b579bedb080bbe4
Closes-Bug: #1615948
2016-08-24 09:42:53 +07:00
Matt Riedemann
d727795d66 Add REST API support for get me a network
This adds the 2.37 microversion to the REST API for automatically
allocating a network, i.e. get me a network.

The majority of the changes to the REST API concern request
validation. 'networks' is now required in the server POST body
after this microversion. The 'auto' or 'none' special network
uuid values are used, but if specified, can not be specified
with any other requested network values.

The other special case that is checked is when the minimum
compute service version is not new enough to support this change,
i.e. a Mitaka compute will not have the network API code that
knows how to deal with the special auto/none network IDs. Because
the REST API is checking the service version, the service caches
the service version after the first check. Once all computes are
updated to Newton then a restart of the nova-api service(s) will
be required to flush the cache. A release note is provided for
this situation.

The api-ref docs are also updated for this microversion including
an example API sample request.

The matching Tempest change to test this is here:

I89b18709e0cfbbcbf9be96a91a13a1356cdf85b0

The matching python-novaclient change is here:

I6636ddcd3be7bf393d2d69cc6c1ba5c7d65ff674

Implements blueprint get-me-a-network

Change-Id: I89b18709e0cfbbcbf9be96a91a13a1356cdf85b0
2016-08-15 14:10:42 -04:00
Jenkins
286046b537 Merge "Fixed typos in api-ref and releasenotes directory" 2016-07-29 20:25:36 +00:00
Alex Szarka
2a1aad9de7 Fixed typos in api-ref and releasenotes directory
This patchset fixes the typo errors in api-ref and
releasenotes directories.
TrivialFix

Change-Id: Ib72e5c4ac7539c1b08adc858b9b3a0071cb3c866
2016-07-20 09:08:50 +00:00
Jenkins
3f6ae25b27 Merge "api-ref: merge multiple create to servers.inc" 2016-07-19 01:50:38 +00:00
Sean Dague
039d0628a4 api-ref: merge multiple create to servers.inc
This creates a new way to describe multiple create as a dedicated
create call in the normal servers list. It only lists additional
parameters so that we're not copy / pasting between the 2 lists.

Part of bp:api-ref-in-rst

Change-Id: Ib15f224cf6a9432ae638c8b57a2156cd7b98215d
2016-07-04 13:57:18 +00:00
Artom Lifshitz
e83e114e1b Device tagging API support
This patch allows the user to specify a tag for a virtual network
interface and/or block device mapping when booting an instance.

Implements: blueprint bp/virt-device-role-tagging
Change-Id: I89247200f4cf1f644daf476727b4a6acb22b0cf6
2016-06-29 20:55:16 -07:00
Jenkins
68209e222f Merge "api-ref: add version 2.3 parameters to servers" 2016-06-14 13:26:38 +00:00
Sean Dague
036833d57c api-ref: add version 2.3 parameters to servers
This adds the microversion 2.3 parameters to servers display calls.

Part of bp:api-ref-in-rst

Change-Id: I71d45fbff2bfca553128b375e6494d003dbc3759
2016-06-14 12:44:13 +00:00
ghanshyam
f26f18e20c Enable all extension for server API tests part-1
As extensions options has been deprecated, API sample tests
should run against all extension enable.

This commit enables all extensions for server API tests and remove its specific
extensions tests and sample files.

Partially implements blueprint api-sample-tests-with-all-extensions

Change-Id: I7e12a4491738c2908c1dd134c05f38e0db497ee7
2016-06-09 08:53:30 -04:00
Sean Dague
c9f5ad3bcf remove /v2.1/{tenant_id} from all urls
As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.

This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.

Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-03 08:47:33 -04:00
Jenkins
25ac5a2756 Merge "Added fault response parameter to Show Server Details API." 2016-05-11 15:20:59 +00:00
sharat.sharma
54dfffb842 Added fault response parameter to Show Server Details API.
The Show Server Details returns fault field in the failed
responses. This patch adds the fault field to the response
parameter table.

Change-Id: I413a098061eb58ba70b3a18d646398dfdac590aa
Closes-Bug: #1545972
2016-05-11 11:44:03 +00:00
Jenkins
cb0740aa2d Merge "api-ref: update parameter validation on servers" 2016-05-10 15:36:48 +00:00
He Jie Xu
1fce522362 Remove 404 for list and details actions of servers
Just found when the marker can't be found, we won't return 404,
instead of we will return 400. This patch removes the 404 code from
list and details doc.

Part of bp:api-ref-in-rst

Change-Id: I03e76a3a45f2d59c8fb01610cbd751d5b91f5964
2016-05-10 02:37:45 +00:00
Sean Dague
e131317430 api-ref: update parameter validation on servers
This updates all the v2.1 parameters for servers, as well as some of
the microversions added parameters. It makes us more accurate than the
existing api-site.

This specificially *does not* include the additional response
parameters for microversions > 2.1 (tags, ext attrs for ec2, etc).

Part of bp:api-ref-in-rst

Change-Id: Ic03c0e6486a300c3cd724b798850dedeae014faf
2016-05-09 16:23:10 -04:00
Sean Dague
daad02b41d api-ref: method verification and fixes for servers.inc
Update the response codes for the methods based on what is in the
code. This follows the pattern of updating these error codes when
doing method verification that jichen has been doing.

Some notes are left for the body_verification phase later, as that is
going to take a while for this file.

Part of bp:api-ref-in-rst

Change-Id: I8d8bd09f72572caed1a45fa23f95a15d330c2f26
2016-05-09 12:37:22 -04:00
Sean Dague
d929b9fc76 add tags to files for the content verification phase
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef

Part of bp:api-ref-in-rst

Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016-04-20 16:21:58 -04:00
ghanshyam
6f8cda2f39 Fix json response example heading in api ref
Heading for json response example is wrong,
it is json request instead of json response.

Part of bp:api-ref-in-rst

Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:56:20 +09:00
Sean Dague
46a1fd17cc Update servers.inc to be as accurate as api-site
This updates servers.inc which had a rough path during conversion. The
GET servers/details was lost entirely.

It updates a number of parameters to distinguish ones that are only in
the queries, as well as fixes references to short names that collided.

It updates the UPDATE call to only specify request parameters which
you can actually update.

It introduces the notation object.field for parameters that are
embedded in other objects. This is a new concept, but one way we can
clear up that the uuid in the parameter list is really networks.uuid.

It also deletes the old hand rolled servers.rst, which drops the
warnings count by nearly 100.

Part of bp:api-ref-in-rst

Change-Id: Ie7693a5888efa913118244a0837e6c0177965d48
2016-04-18 06:40:23 -04:00
Sean Dague
9526462326 move sphinx h3 to '-' instead of '^'
In the sphinx document h3 is supposed to be '-' not '^':

=, for sections
-, for subsections
^, for subsubsections

We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.

Part of bp:api-ref-in-rst

Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-15 07:43:06 -04:00
Sean Dague
d4e2771440 Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.

Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-13 07:34:45 -04:00