Merge "Add zone 'attributes' to api-ref"

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
 
 

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

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",

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"
             }

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"
     }

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"
     }