Merge lp:~sleepsonthefloor/nova/extdoc into lp:~annegentle/nova/extdoc

[Anthony Young]

Updates to the os-floating-ips docs.

[Anthony Young (sleepsonthefloor)]

Anne - take a look and let me know if you have any feedback. I wasn't sure of the best way to format the info.

[Anne Gentle (annegentle)]

Very useful, thanks. Yes I'm also finding that Sphinx doesn't want to format the XML examples like I thought they should be. So I'm working on that as well but this detailed info with examples is hugely helpful.

[Anne Gentle (annegentle)]

Merging it in with my branch, will figure out the formatting.

review: Approve

Unmerged revisions

1585. By Anthony Young on 2011-09-19

progress on floating-ip docs

=== modified file 'nova/api/openstack/contrib/doc/ext_floating_ips.rst'
--- nova/api/openstack/contrib/doc/ext_floating_ips.rst	2011-09-19 00:38:17 +0000
+++ nova/api/openstack/contrib/doc/ext_floating_ips.rst	2011-09-19 18:47:30 +0000
@@ -93,7 +93,60 @@
 
 New Resources
 -------------
-None
+This extension provides an os-floating-ips resource extension to do the following:
+
+List a tenant's floating ips::
+
+	GET /v1.1/tenant_id/os-floating-ips/
+
+    # Sample Response:
+    { "floating_ips" : [ { "fixed_ip" : "10.0.0.3",
+            "id" : 1,
+            "instance_id" : 1,
+            "ip" : "10.6.0.0"
+          },
+          { "fixed_ip" : null,
+            "id" : 2,
+            "instance_id" : null,
+            "ip" : "10.6.0.1"
+          }
+        ] }
+
+    Normal Response Code: 200
+
+Allocate a floating ip to a tenant::
+
+	POST /v1.1/tenant_id/os-floating-ips/
+
+    # Sample Response:
+    { "floating_ip" : { "fixed_ip" : "10.0.0.3",
+            "id" : 1,
+            "instance_id" : 1,
+            "ip" : "10.6.0.0"
+        }}
+
+    If there are no floating ips available, 400 will be returned, with a 
+    message indicating that no more floating ips are available
+
+
+De-allocate a floating ip from a tenant::
+
+	DELETE /v1.1/tenant_id/os-floating-ips/id
+
+    Normal Response Code: 202
+
+Show a floating ip::
+
+	GET /v1.1/tenant_id/os-floating-ips/id
+
+    # Sample Response:
+    { "floating_ip" : { "fixed_ip" : "10.0.0.3",
+            "id" : 1,
+            "instance_id" : 1,
+            "ip" : "10.6.0.0"
+        }}
+
+    Normal Response Code: 200
 
 New States
 ----------
@@ -106,4 +159,4 @@
 
 In the List Addresses section of the Cloud Servers Specification: Examples 4.21 and 4.22 should be replaced with examples below. 
 
-Provide examples in XML and JSON
 \ No newline at end of file
+Provide examples in XML and JSON