Merge pull request #67 from Dorthu/document-moved-ips

Documents moving networking/ipv4 to networking/ips

Author: jamesottinger

src/data/endpoints/networking.yaml

@@ -4,30 +4,32 @@ sort: 1
 description: >
   Networking endpoints provide a means of viewing networking objects.
 endpoints:
-  /networking/ipv4:
-    group: IPv4
+  /networking/ips:
+    group: IPs
     authenticated: true
     description: >
-      View and manage IPv4 Addresses you own.
+      View and manage IP Addresses you own.
     methods:
       GET:
         response: ipaddress
-        paginationKey: ipv4
+        paginationKey: data
         oauth: ips:view
         description: >
-          Returns a list of IPv4 Addresses.
+          Returns a list of IP Addresses, including v4 and slaac addresses.
         examples:
           curl: |
             curl -H "Authorization: Bearer $TOKEN" \
-              https://$api_root/$version/networking/ipv4
-          python: |
-            my_ipv4s = client.networking.get_ipv4()
+              https://$api_root/$version/networking/ips
       POST:
         money: true
         oauth: ips:create
         description: >
           Create a new Public IPv4 Address.
         params:
+          type:
+            type: String
+            description: >
+              The type of IP to allocate.  Currently only "ipv4" is supported.
           linode_id:
             description: >
               The Linode ID to assign this IP to.
@@ -36,38 +38,36 @@ endpoints:
           curl: |
             curl -H "Content-Type: application/json" \
                 -H "Authorization: Bearer $TOKEN" \
-                -X POST -d '{"linode":123}' \
-                https://$api_root/$version/networking/ipv4
-          python: |
-            # presently unsupported
-  /networking/ipv4/$address:
-    group: IPv4
+                -X POST -d '{"type":"ipv4","linode":123}' \
+                https://$api_root/$version/networking/ips
+  /networking/ips/$address:
+    group: IPs
     type: resource
     authenticated: true
     description: >
-      Manage a single IPv4 Address.
+      Manage a single IP Address.
     methods:
       GET:
         response: ipaddress
         oauth: ips:get
         description: >
-            Returns a single IPv4 Address.
+            Returns a single IP Address.
         examples:
             curl: |
               curl -H "Authorization: Bearer $TOKEN" \
-                https://$api_root/$version/networking/ipv4/97.107.143.37
+                https://$api_root/$version/networking/ips/97.107.143.37
             python: |
               my_ipv4 = linode.IPAddress(client, '97.107.143.37')
       PUT:
         oauth: ips:modify
         description: >
-            Update RDNS on one IPv4 Address.  Set RDNS to null to reset.
+            Update RDNS on one IP Address.  Set RDNS to null to reset.
         examples:
           curl: |
             curl -H "Content-Type: application/json" \
                 -H "Authorization: Bearer $TOKEN" \
                 -X PUT -d '{"rdns":"example.org"}' \
-                https://$api_root/$version/networking/ipv4/97.107.143.37
+                https://$api_root/$version/networking/ips/97.107.143.37
           python: |
             my_ipv4.rdns = 'example.org'
             my_ipv4.save()
@@ -79,7 +79,7 @@ endpoints:
           curl: |
             curl -H "Authorization: Bearer $TOKEN" \
                 -X DELETE \
-                https://$api_root/$version/networking/ipv4/97.107.143.37
+                https://$api_root/$version/networking/ips/97.107.143.37
   /networking/ipv6:
     group: IPv6
     authenticated: true

src/data/objects/ipaddress.yaml

@@ -1,6 +1,6 @@
-name: IPv4 Address
+name: IP Address
 description: >
-    An IPv4 Address
+    An IP Address
 schema:
   address:
     type: String
@@ -21,11 +21,11 @@ schema:
   rdns:
     editable: true
     type: String
-    value: null
+    value: "example.org"
     description: Reverse DNS address for this IP Address. Null to reset.
   region:
     type: String
-    value: us-east-1a
+    value: us-east
     description: The region this IP is in.
   subnet_mask:
     type: String
@@ -40,3 +40,6 @@ enums:
   IPAddressType:
     public: Public IP Address.
     private: Internal IP Addresses (192.168 range).
+    slaac: A Linode's slaac address.  These may not be transferred between Linodes.
+    link-local: A Linode's link local address.  These may not be transferred
+                between linodes.

src/data/objects/ipv6-address.yaml

@@ -19,10 +19,10 @@ schema:
   ipv6:
     description: The Linode's IPv6 networking data.
     addresses:
-      type: ipv6-address
+      type: ipaddress
       isArray: true
     slaac:
-      type: ipv6-address
+      type: ipaddress
       description: >
         This Linode's SLAAC range.
     link_local: