17 Commits

Author SHA1 Message Date
Yikun Jiang
00b585a1b9 Add microversion info in the os-server-groups API samples
The os-server-groups samples are using 2.64 but don't explicitly say
that, so we need something like "(v2.64)" in the os-server-groups.inc.

In this patch, we add microversion info in the os-server-groups API
samples.

Change-Id: Ia7e25ceba532e6cfd0ed18cf3cc8113512d50323
Closes-bug: #1785415
2018-08-07 22:47:44 +00:00
Yikun Jiang
5cdb1ce26b Microversion 2.64 - Use new format policy in server group
Enable users to define the policy rules on server group policy
to meet more advanced policy requirement. This microversion
brings the following changes in server group APIs:

* Add  ``policy`` and ``rules`` fields in the request of POST
  ``/os-server-groups``.
* The ``policy`` and ``rules`` fields will be
  returned in response body of POST, GET ``/os-server-groups``
  API and GET ``/os-server-groups/{server_group_id}`` API.
* The ``policies`` and ``metadata`` fields have been removed
  from the response body of POST, GET ``/os-server-groups`` API
  and GET ``/os-server-groups/{server_group_id}`` API.

Part of blueprint: complex-anti-affinity-policies

Change-Id: I6911e97bd7f8df92511e90518dba21c127e106a5
2018-07-13 10:43:42 +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
Takashi NATSUME
1278b1fe44 api-ref: Fix parameters in os-server-groups.inc
Fix the following parameters.

- 'id'(server group id) defined as a path parameter in body
- 'server_group' object defined as 'server_groups' list
- missing 'server_group' object
- 'user_id' defined as a query parameter in body

Change-Id: I3dcf6aa317b428d6984b0dcb61496594a68bba6f
Closes-Bug: #1652897
2017-01-03 23:29:37 +00: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
Ken'ichi Ohmichi
99e012290b Fix server group name on api-ref
The parameter 'name' is for security group, not server group.
This patch fixes the description.

Partially implements blueprint api-ref-in-rst

Change-Id: I954b91c47bf4766be430ace2783089c7f59f9324
2016-09-12 14:37:57 -07:00
jichenjc
1e9d82ad20 api-ref: verify os-server-groups.inc
this verify the os-server-groups.inc for sample and body.
Added other minor update for better formatting.

Part of bp:api-ref-in-rst

Change-Id: I00e8c4025310d23244ef0f6a5ed276573ecaea7b
2016-05-02 11:13:20 +08: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
Kevin_Zheng
e7d2a1d1a5 api-ref: parameter verification for os-server-groups
checked parameters

Part of bp:api-ref-in-rst

Change-Id: I32e2da99c797903333447afacd6dbccc89c75603
2016-05-18 09:48:47 +08:00
jichenjc
5ead13913f Complet Method Verification of server group
verified the API doc for os-server-groups,
Also, remove some common error code like 500, 503 etc

detail log: http://paste.openstack.org/show/495341/

Part of bp:api-ref-in-rst

Change-Id: I0654ef2e1c937d1328b9ab4c434596035d53e0ee
2016-04-23 10:16:05 +08: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
jichenjc
356aa087bb Fix os-server-groups.inc
some json reponse/request reference not correct
fix incorrect return value.
Also, change id reference to server_group_id.

Part of bp:api-ref-in-rst

Change-Id: Ia1fc10301dfa35087658d311bec684d43c8e0929
2016-03-24 02:30:28 +08:00
Jenkins
16cea9cdc5 Merge "Fix json response example heading in api ref" 2016-04-19 18:01:14 +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
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