openstack/placement
Code Issues Proposed changes

Fix AZ related API docs

Browse Source 
While we have a big fat comment in the development docs explaining why it's so
terrible to use default AZ values for either booting an instance or setting
an aggregate AZ metadata, we still have confusing API docs that provide the
wrong name for the AZ...

Fixing that and trying to explain the problem within the docs, too.

Change-Id: I811d0f219142ca435b2b206e9b11ccd5ac611997
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Sylvain Bauza 2017-04-13 16:48:04 +02:00 committed by Stephen Finucane
parent e995bd5cea
commit bbb5d4e969
13 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api_samples/os-aggregates/aggregate-post-req.json
View File

@ -2,6 +2,6 @@
"aggregate":
{
"name": "name",
"availability_zone": "nova"
"availability_zone": "london"
}
}
}

2
doc/api_samples/os-aggregates/aggregate-post-resp.json
View File

@ -1,6 +1,6 @@
{
"aggregate": {
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2013-08-18T12:17:55.751757",
"deleted": false,
"deleted_at": null,

4
doc/api_samples/os-aggregates/aggregates-add-host-post-resp.json
View File

@ -1,6 +1,6 @@
{
"aggregate": {
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2013-08-18T12:17:56.297823",
"deleted": false,
"deleted_at": null,
@ -9,7 +9,7 @@
],
"id": 1,
"metadata": {
"availability_zone": "nova"
"availability_zone": "london"
},
"name": "name",
"updated_at": null

4
doc/api_samples/os-aggregates/aggregates-get-resp.json
View File

@ -1,13 +1,13 @@
{
"aggregate": {
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2013-08-18T12:17:56.380226",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova"
"availability_zone": "london"
},
"name": "name",
"updated_at": null

4
doc/api_samples/os-aggregates/aggregates-list-get-resp.json
View File

@ -1,14 +1,14 @@
{
"aggregates": [
{
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2013-08-18T12:17:56.856455",
"deleted": false,
"deleted_at": null,
"hosts": ["21549b2f665945baaa7101926a00143c"],
"id": 1,
"metadata": {
"availability_zone": "nova"
"availability_zone": "london"
},
"name": "name",
"updated_at": null

4
doc/api_samples/os-aggregates/aggregates-metadata-post-resp.json
View File

@ -1,13 +1,13 @@
{
"aggregate": {
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2013-08-18T12:17:55.959571",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova",
"availability_zone": "london",
"key": "value"
},
"name": "name",

4
doc/api_samples/os-aggregates/aggregates-remove-host-post-resp.json
View File

@ -1,13 +1,13 @@
{
"aggregate": {
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2013-08-18T12:17:56.990581",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova"
"availability_zone": "london"
},
"name": "name",
"updated_at": null

4
doc/api_samples/os-aggregates/v2.41/aggregate-post-resp.json
View File

@ -1,6 +1,6 @@
{
"aggregate": {
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2016-12-27T22:51:32.877711",
"deleted": false,
"deleted_at": null,
@ -9,4 +9,4 @@
"updated_at": null,
"uuid": "86a0da0e-9f0c-4f51-a1e0-3c25edab3783"
}
}
}

6
doc/api_samples/os-aggregates/v2.41/aggregates-add-host-post-resp.json
View File

@ -1,6 +1,6 @@
{
"aggregate": {
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2016-12-27T23:47:30.594805",
"deleted": false,
"deleted_at": null,
@ -9,10 +9,10 @@
],
"id": 1,
"metadata": {
"availability_zone": "nova"
"availability_zone": "london"
},
"name": "name",
"updated_at": null,
"uuid": "d1842372-89c5-4fbd-ad5a-5d2e16c85456"
}
}
}

6
doc/api_samples/os-aggregates/v2.41/aggregates-get-resp.json
View File

@ -1,16 +1,16 @@
{
"aggregate": {
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2016-12-27T23:47:30.563527",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova"
"availability_zone": "london"
},
"name": "name",
"updated_at": null,
"uuid": "fd0a5b12-7e8d-469d-bfd5-64a6823e7407"
}
}
}

6
doc/api_samples/os-aggregates/v2.41/aggregates-list-get-resp.json
View File

@ -1,7 +1,7 @@
{
"aggregates": [
{
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2016-12-27T23:47:32.911515",
"deleted": false,
"deleted_at": null,
@ -10,11 +10,11 @@
],
"id": 1,
"metadata": {
"availability_zone": "nova"
"availability_zone": "london"
},
"name": "name",
"updated_at": null,
"uuid": "6ba28ba7-f29b-45cc-a30b-6e3a40c2fb14"
}
]
}
}

6
doc/api_samples/os-aggregates/v2.41/aggregates-metadata-post-resp.json
View File

@ -1,17 +1,17 @@
{
"aggregate": {
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2016-12-27T23:59:18.623100",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova",
"availability_zone": "london",
"key": "value"
},
"name": "name",
"updated_at": "2016-12-27T23:59:18.723348",
"uuid": "26002bdb-62cc-41bd-813a-0ad22db32625"
}
}
}

6
doc/api_samples/os-aggregates/v2.41/aggregates-remove-host-post-resp.json
View File

@ -1,16 +1,16 @@
{
"aggregate": {
"availability_zone": "nova",
"availability_zone": "london",
"created_at": "2016-12-27T23:47:30.594805",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova"
"availability_zone": "london"
},
"name": "name",
"updated_at": null,
"uuid": "d1842372-89c5-4fbd-ad5a-5d2e16c85456"
}
}
}