Merge pull request #2661 from SzySteve/docs/nodebalancer

NodeBalancer Docs updates
linode · Oct 31, 2017 · 51f17a9 · 51f17a9
2 parents 788ae66 + 0e0e8f1
commit 51f17a9
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/docs/src/data/endpoints/nodebalancers.yaml b/docs/src/data/endpoints/nodebalancers.yaml
@@ -306,7 +306,8 @@ endpoints:
         response: nodebalancer_config_node
         oauth: nodebalancers:view
         description: >
-          Returns information about this node..
+          Returns information about this node. A node is a single server backend for this
+          nodebalancer, accessed as the given address.
         examples:
           curl: |
             curl -H "Authorization: Bearer $TOKEN" \

diff --git a/docs/src/data/objects/nodebalancer.yaml b/docs/src/data/objects/nodebalancer.yaml
@@ -7,7 +7,7 @@ schema:
   id:
     type: Integer
     value: 123456
-    description: An integer.
+    description: The ID of this NodeBalancer.
   label:
     editable: true
     type: String
@@ -26,4 +26,24 @@ schema:
   region:
     type: String
     value: us-east-1a
-    description: The region this Nodebalancer is in
+    description: The region this Nodebalancer is in.
+  ipv4:
+    editable: false
+    type: String
+    value: "123.45.67.89"
+    description: This NodeBalancer's IPv4 address.
+  ipv6:
+    editable: false
+    type: String
+    value: "2a01:7e00::f03c:91ff:fe96:46f5/64"
+    description: This NodeBalancer's IPv6 SLAAC address.
+  created:
+    editable: false
+    type: Datetime
+    value: "2017-09-29T11:21:01"
+    description: When this NodeBalancer was initially created.
+  updated:
+    editable: false
+    type: Datetime
+    value: "2017-09-30T11:21:01"
+    description: When this NodeBalancer was last updated.