summaryrefslogtreecommitdiff
path: root/api-ref/source/os-aggregates.inc
Commit message (Collapse)AuthorAgeFilesLines
* Add image caching API for aggregatesDan Smith2019-10-151-0/+33
| | | | | | | | | This adds a new microversion and support for requesting image pre-caching on an aggregate. Related to blueprint image-precache-support Change-Id: I4ab96095106b38737ed355fcad07e758f8b5a9b0
* api-ref: mention policy defaults for aggregatesMatt Riedemann2019-02-061-2/+6
| | | | Change-Id: I8202e825a7c0870a71a60875a7f42125317ff82b
* api-ref: warn about changing/unsetting AZ name with instancesMatt Riedemann2019-02-061-9/+9
| | | | | | | | | | | | | | | It is currently possible to rename or unset the availability_zone metadata value on a host aggregate which can adversely impact instances that were created in that specific AZ since later attempts to migrate or unshelve those instances will fail if the AZ with the original name no longer exists. This adds a warning to the API reference for updating the AZ name and also fixes a grammar typo in the 'metadata' response parameter description. Change-Id: Ie9d4a1ff1a23827490fe51350c11292c6efc4eb2 Related-Bug: #1378904
* Merge "Clean up metadata param in doc"Jenkins2017-04-031-1/+1
|\
| * Clean up metadata param in docjichenjc2017-02-251-1/+1
| | | | | | | | | | | | | | | | | | 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 and examples in aggregate APITakashi NATSUME2017-03-131-14/+14
|/ | | | | | | | | | - The type of aggegate ID is changed to 'integer' instead of 'string'. - The uuid of aggegate is changed to 'required' because the uuid is always shown in the response after v2.41. - The response examples are replaced with v2.41 examples. Change-Id: Ib106898d32dc67e414f489468e91561ab0a5eb80 Closes-Bug: #1659475
* Return uuid attribute for aggregatesJay Pipes2017-01-051-0/+7
| | | | | | | | | | | | Adds a Compute API microversion that triggers returning an aggregate's UUID field. This field is necessary for scripts that must populate the placement API with resource provider to aggregate relationships, which rely on UUIDs for global identification. APIImpact blueprint: return-uuid-from-os-aggregates-api Change-Id: I4112ccd508eb85403933fec8b52efd468e866772 Closes-bug: #1652642
* Fix a few typos in API referenceHironori Shiina2016-09-281-1/+1
| | | | Change-Id: Ib90100f4ec6b4b03f27ed39166caeb9bdf5bc24c
* Body Verification of os-aggregates.incghanshyam2016-09-061-2/+1
| | | | | | | | | | | | | This patch verifies that the title and introductory description that precedes each rest method clearly reflects the context of the respective rest method. - Correct the Response text for delete API - 'body verification' tag is removed for this commit. part of bp:api-ref-in-rst Change-Id: If189c0f0246969527635879d96daa1ba8f77b7c3
* Verify os-aggregates.inc on sample filesjichenjc2016-07-261-3/+7
| | | | | | | | | verified all sample files is correct and adjust some format of the request Json file part of bp:api-ref-in-rst Change-Id: Ie9dd24858056337bcae9b03259d4f84de4fc1ab8
* api-ref: parameter verification for os-aggregatesKevin_Zheng2016-06-121-4/+102
| | | | | | | | checked parameters Part of bp:api-ref-in-rst Change-Id: I8fe3825243f8b94d5c3f382ebc30c342bffafcac
* remove /v2.1/{tenant_id} from all urlsSean Dague2016-06-031-23/+8
| | | | | | | | | | | | 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
* complete Method Verification of aggregatesjichenjc2016-04-251-55/+50
| | | | | | | | | | This complete the Method Verification of aggregates, adjust the sequence of GET/POST, also, clean and correct some error return code. Part of bp:api-ref-in-rst Change-Id: I1536b804fbbd887fa4da2c35282add7e3994727a
* 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 sample path for aggregate, certificate, consoleghanshyam2016-04-201-34/+24
| | | | | | | | | | | This fix all sample file path for -os-aggregates -os-certificates -os-consoles Part of bp:api-ref-in-rst Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd
* Merge "Fix json response example heading in api ref"Jenkins2016-04-191-7/+7
|\
| * Fix json response example heading in api refghanshyam2016-04-191-7/+7
| | | | | | | | | | | | | | | | | | 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
* | Fix "Creates an aggregate" parametersKen'ichi Ohmichi2016-04-181-0/+2
|/ | | | | | | | | | | | "Creates an aggregate" API supports multiple parameters on a request, but api-ref doesn.t contain them at all This patch adds them. The following JSON-Schema is for the API. https://github.com/openstack/nova/blob/master/nova/api/openstack/compute/schemas/aggregates.py#L32 Part of bp:api-ref-in-rst Change-Id: I3a58568662d21059bccdcf64cc30dbf3b706db58
* move sphinx h3 to '-' instead of '^'Sean Dague2016-04-151-16/+16
| | | | | | | | | | | | | | | 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/+268
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