44 Commits

Author SHA1 Message Date
Anne Gentle
d90a35ef65 API ref: associate floating IP requires Active status
- There is no available status.

Change-Id: If1a2696e63830ae38b4a0c4e2488fb16d33650d8
Closes-bug: 1618883
2017-07-25 16:11:00 +00:00
Chris Friesen
90636e0f33 show flavor info in server details
Add a new microversion to change the flavor field in the server
details to display a subset of the flavor information instead of
just a link to the original flavor.

This is more reliable since it shows the actual instance size, while
the flavor may have been deleted/recreated in the meantime or the
flavor extra-specs may have been modified.

Implements: blueprint instance-flavor-api
Change-Id: If646149efb7eec8c90bf7d07c39ff4c495349941
2017-06-02 12:09:24 -04:00
Takashi NATSUME
cbf83a01fb api-ref: Example verification for servers-actions.inc
* Example for the rebuild action

  The functional test is modified and
  the example is replaced with v2.26 examples.

* Example for the rescue action

  The example in API reference is replaced with
  the example with 'rescue_imgae_ref'.

Parameters for the rebuild action and the rescue action
are also fixed.

The patch completes the parameter verification and
the example verification of servers-actions.inc.

Change-Id: Iaf8808b13d1fdfead50da4cd447b3893578f76dd
Implements: blueprint api-ref-in-rst-pike
2017-05-22 00:19:19 +00:00
Takashi NATSUME
5532d6f404 Add a functional test for 'removeFloatingIp' action
Add a functional test for 'removeFloatingIp' action.
Rename the example file for 'addFloatingIp' action
to clarify that it is a request body example.

Change-Id: Ic865318fa640eb17d1317fb3d5f064788ebf44e7
2017-05-08 19:32:53 +00:00
Jenkins
eeb1bfcec8 Merge "2.45: Remove Location header from createImage and createBackup responses" 2017-04-25 22:28:38 +00:00
Jenkins
b57bb0431c Merge "api-ref: Parameter verification for servers-actions (3/4)" 2017-04-25 21:13:17 +00:00
Jenkins
729f5bea45 Merge "api-ref: Parameter verification for servers-actions (2/4)" 2017-04-25 21:09:54 +00:00
Matt Riedemann
66b0cf3337 2.45: Remove Location header from createImage and createBackup responses
This changes the response for the createImage and createBackup
server action APIs to no longer return a Location header and instead
returns a json dict body with the snapshot image ID. This is done
in a new microversion.

Implements blueprint remove-create-image-location-header-response

Closes-Bug: #1679285

Change-Id: Idc899ee76b8265b1c9e0871b6c7c277424cdd442
2017-04-25 15:52:14 -04:00
Matt Riedemann
0a03f0123c api-ref: move createBackup to server-actions
The createBackup API is by default an admin-or-owner API, so it
should live in server-actions rather than server-admin-actions.

Change-Id: Ifdc08a1df39f30944d45e2001d590b34a963d062
Closes-Bug: #1679314
2017-04-25 12:05:48 -04:00
He Jie Xu
03ce169884 Deprecate Multinic, floatingip action and os-virtual-interface API
The following APIs which are considered as proxies of Neutron networking
API, are deprecated and will result in a 404 error response in new
Microversion:

     POST /servers/{server_uuid}/action
     {
         "addFixedIp": {...}
     }
     POST /servers/{server_uuid}/action
     {
         "removeFixedIp": {...}
     }
     POST /servers/{server_uuid}/action
     {
         "addFloatingIp": {...}
     }
     POST /servers/{server_uuid}/action
     {
         "removeFloatingIp": {...}

And the nova-network specific API for query server's interfaces is
deprecated also:

     GET /servers/{server_uuid}/os-virtual-interfaces

Partial implement blueprint deprecate-multinic-proxy-api

Change-Id: I1848db384a825d3b166f113b30ebad92113af8e5
2017-04-25 12:04:05 -04:00
Takashi NATSUME
08a113fdaa api-ref: Parameter verification for servers-actions (3/4)
This patch fixes the parameters of the following actions.

* removeSecurityGroup
* resize
* resume
* revertResize

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

Change-Id: Ie470138ac53404369f4fc717bf979b94060c5652
Implements: blueprint api-ref-in-rst-pike
2017-04-25 11:37:28 +09:00
Takashi NATSUME
f38a234f9b api-ref: Parameter verification for servers-actions (2/4)
This patch fixes the parameters of the following actions.

* lock
* pause
* reboot
* removeFloatingIp

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

Change-Id: I33210b5d8cfb359e4cc9ef37fe74b71d30a9acc5
Implements: blueprint api-ref-in-rst-pike
2017-04-24 00:51:07 +00: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
b5a9ebf4f2 Merge "Add server-action-removefloatingip.json file and update servers-actions.inc" 2017-04-07 18:34:30 +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
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
b672f35de6 Merge "Add description for Image location in snapshot" 2017-03-17 19:30:48 +00: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
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
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
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
Jenkins
62412ad454 Merge "[api-ref]: Update link reference" 2016-09-14 16:50:30 +00:00
tengqm
fc9a540482 Fix api-ref doc for server-rebuild
This fixes the name parameter which should be referencing the optional
server name instead of the security group name. It also deletes an entry
in the parameters.yaml which is not referenced anywhere.

Change-Id: I38abe55aa46f54a22468e21188e0cd5ef2c63244
2016-09-08 23:04:43 -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
Tang Chen
43158382d9 api-ref: Parameter verification for servers-actions.inc Part 1
Since servers-actions.inc is too big, this job will be divided
into several patches.
Change Ia1409a4414248702718f64851b7dc892ea71d9c7 will be the
last one.

This patch fixes the following common problems in the file:
1. Parameter ``server_id`` is in the path, so it should be
   ``server_id_path``.
2. Add description for those responses without any content.
3. Remove useless words.

Change-Id: I81118d7890f37ee3124513136ef52af93d7c5dc0
Implements: blueprint api-ref-in-rst
2016-07-06 16:59:38 +08:00
Matthew Edmonds
ce01ef30e3 fix errors in revert resize api docs
The revert resize action's documentation appears to have been copied
from the documentation for confirm resize, and missed replacing the
word 'confirm' with 'revert' in one case. This fixes that.

It also gives incorrect information about the states involved through
the revert process. This also corrects that.

Change-Id: Ib2436da238a4a7b71454ecfee81ede4054b3018e
Closes-Bug: #1593295
2016-06-16 12:55:04 -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
Pushkar Umaranikar
1f4515d3c3 api-ref: Method verification for servers-actions
Verify and update the response codes for the methods
based on what is in the code.

part of blueprint: api-ref-in-rst

Change-Id: Ib60e82b320ac7db3c2b50005f420db0aa43de492
2016-05-12 15:05:47 +00:00
sharat.sharma
3300cdfcfb Corrected the typo.
Change-Id: Id542ba32d95f67820da112bfc994b9878c998aaa
Closes-Bug: #1580536
2016-05-11 16:02:28 +05:30
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
Sean Dague
1555736e3c Final warnings removals for api-ref
This removes the final warnings from the api-ref code base, and flips
the sphinx switch to enforce warnings as errors.

It also adds code to the rest_parameters extension to make it more
clear where a problem is when it comes to included parameters. This
puts us in a place where we can start doing the file per file look at
content.

Part of bp:api-ref-in-rst

Change-Id: Ic2c99d96d6addcafa00b9f16785c2fe59b1798d3
2016-04-20 11:25:30 -04:00
Jenkins
3ed55c2f80 Merge "Fix all remaining sample file path" 2016-04-20 11:05:51 +00:00
ghanshyam
24d380b4d0 Fix all remaining sample file path
This patch fix sample file path in all remaining api ref files.

Part of bp:api-ref-in-rst

Change-Id: I214b3a5bedea44cdfeba644ef3796938b709f4bf
2016-04-20 16:56:47 +09:00
Jenkins
16cea9cdc5 Merge "Fix json response example heading in api ref" 2016-04-19 18:01:14 +00:00
Jenkins
3d4f257aa9 Merge "Remove 40X and 50X from Normal response codes" 2016-04-19 15:02:15 +00: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
Ken'ichi Ohmichi
05e9f0a0e0 Remove 40X and 50X from Normal response codes
HTTP 40X-50X are not normal response codes at all.
This patch removes them from api-ref.

Part of bp:api-ref-in-rst

Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9
2016-04-18 16:56:11 -07:00
Sean Dague
afe8c1b3e8 fix samples references for 2 files
This fixes the samples references for ``servers-actions.inc`` and
``servers-multiple-create.inc`` and drops the warnings count to 195.

Change-Id: Id9a2ae98f5ded9ab57bfd3af5fb18357df6bc1d2
2016-04-18 07:15:10 -04:00
jichenjc
a248e6c60b Change adminPass for several server actions
adminPass has incorrect reference, thus every input param
are same ,but actually they are different. updated it with its
correct link reference.

Part of bp:api-ref-in-rst

Change-Id: Ie981a0912768effbe796bfc1d26d4972ba667b90
2016-03-23 22:49:44 +08: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