13 Commits

Author SHA1 Message Date
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
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
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
45ded00b7c Merge "API change for verifying the scheduler when evacuating" 2016-06-03 17:16:28 +00: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
Sylvain Bauza
86706785ff API change for verifying the scheduler when evacuating
Adding a new microversion for changing the evacuate action behaviour
to call the scheduler anyway unless the admin user provides a force
flag that then keeps the previous behaviour by forcing the conductor
to call the destination without verifying it.

Implements: blueprint check-destination-on-migrations

APIImpact

Change-Id: I9ecbe3d481bf17b12072511da4bb106ff1b6404e
2016-06-02 15:03:39 +02:00
Karen Bradshaw
39fc07b9c5 api-ref: servers-action-evacuate.inc
-Verify evacuate action method, examples, params.
-Update parameters.yaml with request
 parameter, on_shared_storage. Added
 field max_version, required == true.
 Update adminPass_evacuate_rebuild
 with max_version field for response.
-Updated headers with action name.

Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0
2016-05-17 17:23:39 -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
Jenkins
9504797297 Merge "Change adminPass for several server actions" 2016-04-20 11:04:20 +00:00
ghanshyam
4d421c7151 Fix sample file path for 4 files
This fix sample file path and status code of evacuate

Part of bp:api-ref-in-rst

Change-Id: I3bec0fcf622c0a1c85bbfea53283bd73fd613c75
2016-04-20 15:34:02 +09: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