summaryrefslogtreecommitdiff
path: root/api-ref/source/os-server-groups.inc
Commit message (Collapse)AuthorAgeFilesLines
* Add microversion info in the os-server-groups API samplesYikun Jiang2018-08-071-4/+4
| | | | | | | | | | | 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
* Microversion 2.64 - Use new format policy in server groupYikun Jiang2018-07-131-8/+16
| | | | | | | | | | | | | | | | | | | 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
* Clean up metadata param in docjichenjc2017-02-251-3/+3
| | | | | | | | | 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
* api-ref: Fix parameters in os-server-groups.incTakashi NATSUME2017-01-031-5/+6
| | | | | | | | | | | | 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
* api-ref: add missing os-server-groups parametersDiana Clarke2016-11-221-0/+2
| | | | | | | | | 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
* Fix server group name on api-refKen'ichi Ohmichi2016-09-121-1/+1
| | | | | | | | | 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
* api-ref: verify os-server-groups.incjichenjc2016-05-021-3/+2
| | | | | | | | | 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
* remove /v2.1/{tenant_id} from all urlsSean Dague2016-06-031-15/+5
| | | | | | | | | | | | 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
* api-ref: parameter verification for os-server-groupsKevin_Zheng2016-05-181-16/+15
| | | | | | | | checked parameters Part of bp:api-ref-in-rst Change-Id: I32e2da99c797903333447afacd6dbccc89c75603
* Complet Method Verification of server groupjichenjc2016-04-231-9/+4
| | | | | | | | | | | 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
* add tags to files for the content verification phaseSean Dague2016-04-201-0/+4
| | | | | | | | | | 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
* Fix os-server-groups.incjichenjc2016-03-241-6/+6
| | | | | | | | | | 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
* Merge "Fix json response example heading in api ref"Jenkins2016-04-191-3/+3
|\
| * Fix json response example heading in api refghanshyam2016-04-191-3/+3
| | | | | | | | | | | | | | | | | | 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
* | Remove 40X and 50X from Normal response codesKen'ichi Ohmichi2016-04-181-1/+1
|/ | | | | | | | | 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
* move sphinx h3 to '-' instead of '^'Sean Dague2016-04-151-8/+8
| | | | | | | | | | | | | | | 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
* Import RST files for documentationSean Dague2016-04-131-0/+162
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