From 3d35557851e66a621544dd87cbf83cf68dec68c2 Mon Sep 17 00:00:00 2001 From: Graham Hayes Date: Mon, 4 Dec 2017 18:47:08 +0000 Subject: [PATCH] Add zone 'attributes' to api-ref Change-Id: Ieb99d4944165e4db32bba3b6b6be627d5d3f4038 --- api-ref/source/dns-api-v2-zone.inc | 6 ++++++ api-ref/source/parameters.yaml | 9 +++++++++ api-ref/source/samples/zones/create-zone-request.json | 3 +++ api-ref/source/samples/zones/list-zones-response.json | 3 +++ api-ref/source/samples/zones/update-zone-response.json | 3 +++ api-ref/source/samples/zones/zone-response.json | 3 +++ 6 files changed, 27 insertions(+) diff --git a/api-ref/source/dns-api-v2-zone.inc b/api-ref/source/dns-api-v2-zone.inc index f1a48b96b..27b5d890c 100644 --- a/api-ref/source/dns-api-v2-zone.inc +++ b/api-ref/source/dns-api-v2-zone.inc @@ -43,6 +43,7 @@ Request - description: zone_description - masters: zone_masters - type: zone_type + - attributes: zone_attributes Request Example @@ -73,6 +74,7 @@ Response Parameters - version: version - created_at: created_at - updated_at: updated_at + - attributes: zone_attributes - links: links @@ -149,6 +151,7 @@ Response Parameters - version: version - created_at: created_at - updated_at: updated_at + - attributes: zone_attributes - links: links - metadata: metadata @@ -217,6 +220,7 @@ Response Parameters - version: version - created_at: created_at - updated_at: updated_at + - attributes: zone_attributes - links: links @@ -347,6 +351,7 @@ Response Parameters - version: version - created_at: created_at - updated_at: updated_at + - attributes: zone_attributes - links: links @@ -414,6 +419,7 @@ Response Parameters - version: version - created_at: created_at - updated_at: updated_at + - attributes: zone_attributes - links: links diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index f67849a9b..39dce4dfc 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -676,6 +676,15 @@ version: required: true type: integer +zone_attributes: + description: | + Key:Value pairs of information about this zone, and the pool the user + would like to place the zone in. This information can be used by the + scheduler to place zones on the correct pool. + in: body + required: false + type: dict + zone_description: description: | Description for this zone diff --git a/api-ref/source/samples/zones/create-zone-request.json b/api-ref/source/samples/zones/create-zone-request.json index f6586a62c..52b941b26 100644 --- a/api-ref/source/samples/zones/create-zone-request.json +++ b/api-ref/source/samples/zones/create-zone-request.json @@ -1,4 +1,7 @@ { + "attributes": { + "tier": "gold", "ha": "true" + }, "name": "example.org.", "email": "joe@example.org", "type": "PRIMARY", diff --git a/api-ref/source/samples/zones/list-zones-response.json b/api-ref/source/samples/zones/list-zones-response.json index c1d507822..c86f12e06 100644 --- a/api-ref/source/samples/zones/list-zones-response.json +++ b/api-ref/source/samples/zones/list-zones-response.json @@ -17,6 +17,9 @@ "version": 1, "created_at": "2014-07-07T18:25:31.275934", "updated_at": null, + "attributes": { + "tier": "gold", "ha": "true" + }, "links": { "self": "https://127.0.0.1:9001/v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3" } diff --git a/api-ref/source/samples/zones/update-zone-response.json b/api-ref/source/samples/zones/update-zone-response.json index 8bda19900..97e2ff43f 100644 --- a/api-ref/source/samples/zones/update-zone-response.json +++ b/api-ref/source/samples/zones/update-zone-response.json @@ -15,6 +15,9 @@ "version": 1, "created_at": "2014-07-07T18:25:31.275934", "updated_at": null, + "attributes": { + "tier": "gold", "ha": "true" + }, "links": { "self": "https://127.0.0.1:9001/v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3" } diff --git a/api-ref/source/samples/zones/zone-response.json b/api-ref/source/samples/zones/zone-response.json index b1170cf85..01d4be17a 100644 --- a/api-ref/source/samples/zones/zone-response.json +++ b/api-ref/source/samples/zones/zone-response.json @@ -15,6 +15,9 @@ "version": 1, "created_at": "2014-07-07T18:25:31.275934", "updated_at": null, + "attributes": { + "tier": "gold", "ha": "true" + }, "links": { "self": "https://127.0.0.1:9001/v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3" }