Adds v3 API samples for ips and server_metadata extensions

DocImpact

Change-Id: I3774db2ab59335e0f8543c4563028b0c35234dc9

20 files changed, 180 insertions, 0 deletions

diff --git a/doc/v3/api_samples/server-ips/server-ips-network-resp.json b/doc/v3/api_samples/server-ips/server-ips-network-resp.json
new file mode 100644
index 0000000000..0c13588eb0
--- /dev/null
+++ b/doc/v3/api_samples/server-ips/server-ips-network-resp.json
@@ -0,0 +1,10 @@
+{
+    "private": [
+        {
+            "addr": "192.168.0.3",
+            "mac_addr": "aa:bb:cc:dd:ee:ff",
+            "type": "fixed",
+            "version": 4
+        }
+    ]
+}
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-ips/server-ips-network-resp.xml b/doc/v3/api_samples/server-ips/server-ips-network-resp.xml
new file mode 100644
index 0000000000..1577ec4825
--- /dev/null
+++ b/doc/v3/api_samples/server-ips/server-ips-network-resp.xml
@@ -0,0 +1,4 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<network xmlns="http://docs.openstack.org/compute/api/v1.1" id="private">
+  <ip version="4" type="fixed" addr="192.168.0.3" mac_addr="aa:bb:cc:dd:ee:ff"/>
+</network>
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-ips/server-ips-resp.json b/doc/v3/api_samples/server-ips/server-ips-resp.json
new file mode 100644
index 0000000000..bb2ae0ab47
--- /dev/null
+++ b/doc/v3/api_samples/server-ips/server-ips-resp.json
@@ -0,0 +1,12 @@
+{
+    "addresses": {
+        "private": [
+            {
+                "addr": "192.168.0.3",
+                "mac_addr": "aa:bb:cc:dd:ee:ff",
+                "type": "fixed",
+                "version": 4
+            }
+        ]
+    }
+}
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-ips/server-ips-resp.xml b/doc/v3/api_samples/server-ips/server-ips-resp.xml
new file mode 100644
index 0000000000..5184898e73
--- /dev/null
+++ b/doc/v3/api_samples/server-ips/server-ips-resp.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<addresses xmlns="http://docs.openstack.org/compute/api/v1.1">
+  <network id="private">
+    <ip version="4" type="fixed" addr="192.168.0.3" mac_addr="aa:bb:cc:dd:ee:ff"/>
+  </network>
+</addresses>
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-ips/server-post-req.json b/doc/v3/api_samples/server-ips/server-post-req.json
new file mode 100644
index 0000000000..d41985a1bc
--- /dev/null
+++ b/doc/v3/api_samples/server-ips/server-post-req.json
@@ -0,0 +1,16 @@
+{
+    "server" : {
+        "name" : "new-server-test",
+        "image_ref" : "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
+        "flavor_ref" : "http://openstack.example.com/openstack/flavors/1",
+        "metadata" : {
+            "My Server Name" : "Apache1"
+        },
+        "personality" : [
+            {
+                "path" : "/etc/banner.txt",
+                "contents" : "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
+            }
+        ]
+    }
+}
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-ips/server-post-req.xml b/doc/v3/api_samples/server-ips/server-post-req.xml
new file mode 100644
index 0000000000..598839cf6a
--- /dev/null
+++ b/doc/v3/api_samples/server-ips/server-post-req.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<server xmlns="http://docs.openstack.org/compute/api/v1.1" image_ref="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" flavor_ref="http://openstack.example.com/openstack/flavors/1" name="new-server-test">
+  <metadata>
+    <meta key="My Server Name">Apache1</meta>
+  </metadata>
+  <personality>
+    <file path="/etc/banner.txt">
+        ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
+        dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
+        IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
+        c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
+        QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
+        ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
+        dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
+        c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
+        b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
+    </file>
+  </personality>
+</server>
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-ips/server-post-resp.json b/doc/v3/api_samples/server-ips/server-post-resp.json
new file mode 100644
index 0000000000..4edce34c63
--- /dev/null
+++ b/doc/v3/api_samples/server-ips/server-post-resp.json
@@ -0,0 +1,16 @@
+{
+    "server": {
+        "admin_pass": "Ag463BYwnXEf",
+        "id": "0813a7dc-8e97-42df-9634-957109499bf0",
+        "links": [
+            {
+                "href": "http://openstack.example.com/v3/servers/0813a7dc-8e97-42df-9634-957109499bf0",
+                "rel": "self"
+            },
+            {
+                "href": "http://openstack.example.com/servers/0813a7dc-8e97-42df-9634-957109499bf0",
+                "rel": "bookmark"
+            }
+        ]
+    }
+}
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-ips/server-post-resp.xml b/doc/v3/api_samples/server-ips/server-post-resp.xml
new file mode 100644
index 0000000000..fca0e9c025
--- /dev/null
+++ b/doc/v3/api_samples/server-ips/server-post-resp.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="8fee36b1-43ce-4380-a360-0b03c9571319" admin_pass="t7CaoxDhmBm8">
+  <metadata/>
+  <atom:link href="http://openstack.example.com/v3/servers/8fee36b1-43ce-4380-a360-0b03c9571319" rel="self"/>
+  <atom:link href="http://openstack.example.com/servers/8fee36b1-43ce-4380-a360-0b03c9571319" rel="bookmark"/>
+</server>
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-metadata-all-req.json b/doc/v3/api_samples/server-metadata/server-metadata-all-req.json
new file mode 100644
index 0000000000..03925e4a4a
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-metadata-all-req.json
@@ -0,0 +1,5 @@
+{
+  "metadata" : {
+    "foo" : "Foo Value"
+  }
+}
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-metadata-all-req.xml b/doc/v3/api_samples/server-metadata/server-metadata-all-req.xml
new file mode 100644
index 0000000000..72811e3025
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-metadata-all-req.xml
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<metadata xmlns="http://docs.openstack.org/compute/api/v1.1">
+    <meta key="foo">Foo Value</meta>
+</metadata>
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-metadata-all-resp.json b/doc/v3/api_samples/server-metadata/server-metadata-all-resp.json
new file mode 100644
index 0000000000..81cd4eb94a
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-metadata-all-resp.json
@@ -0,0 +1,5 @@
+{
+    "metadata": {
+        "foo": "Foo Value"
+    }
+}
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-metadata-all-resp.xml b/doc/v3/api_samples/server-metadata/server-metadata-all-resp.xml
new file mode 100644
index 0000000000..55c949c577
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-metadata-all-resp.xml
@@ -0,0 +1,4 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<metadata xmlns="http://docs.openstack.org/compute/api/v1.1">
+  <meta key="foo">Foo Value</meta>
+</metadata>
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-metadata-req.json b/doc/v3/api_samples/server-metadata/server-metadata-req.json
new file mode 100644
index 0000000000..b9a8ac2086
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-metadata-req.json
@@ -0,0 +1,5 @@
+{
+  "metadata" : {
+    "foo" : "Bar Value"
+  }
+}
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-metadata-req.xml b/doc/v3/api_samples/server-metadata/server-metadata-req.xml
new file mode 100644
index 0000000000..3f23eeb495
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-metadata-req.xml
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<metadata xmlns="http://docs.openstack.org/compute/api/v1.1" key="foo">Bar Value</metadata>
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-metadata-resp.json b/doc/v3/api_samples/server-metadata/server-metadata-resp.json
new file mode 100644
index 0000000000..81cd4eb94a
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-metadata-resp.json
@@ -0,0 +1,5 @@
+{
+    "metadata": {
+        "foo": "Foo Value"
+    }
+}
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-metadata-resp.xml b/doc/v3/api_samples/server-metadata/server-metadata-resp.xml
new file mode 100644
index 0000000000..90436729ab
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-metadata-resp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<metadata xmlns="http://docs.openstack.org/compute/api/v1.1" key="foo">Foo Value</metadata>
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-post-req.json b/doc/v3/api_samples/server-metadata/server-post-req.json
new file mode 100644
index 0000000000..d41985a1bc
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-post-req.json
@@ -0,0 +1,16 @@
+{
+    "server" : {
+        "name" : "new-server-test",
+        "image_ref" : "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
+        "flavor_ref" : "http://openstack.example.com/openstack/flavors/1",
+        "metadata" : {
+            "My Server Name" : "Apache1"
+        },
+        "personality" : [
+            {
+                "path" : "/etc/banner.txt",
+                "contents" : "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
+            }
+        ]
+    }
+}
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-post-req.xml b/doc/v3/api_samples/server-metadata/server-post-req.xml
new file mode 100644
index 0000000000..598839cf6a
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-post-req.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<server xmlns="http://docs.openstack.org/compute/api/v1.1" image_ref="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" flavor_ref="http://openstack.example.com/openstack/flavors/1" name="new-server-test">
+  <metadata>
+    <meta key="My Server Name">Apache1</meta>
+  </metadata>
+  <personality>
+    <file path="/etc/banner.txt">
+        ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
+        dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
+        IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
+        c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
+        QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
+        ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
+        dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
+        c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
+        b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
+    </file>
+  </personality>
+</server>
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-post-resp.json b/doc/v3/api_samples/server-metadata/server-post-resp.json
new file mode 100644
index 0000000000..8d9d896219
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-post-resp.json
@@ -0,0 +1,16 @@
+{
+    "server": {
+        "admin_pass": "ys9M8HQXvwEJ",
+        "id": "a6ebe5b4-b68b-420b-9c1e-620c4d3e0389",
+        "links": [
+            {
+                "href": "http://openstack.example.com/v3/servers/a6ebe5b4-b68b-420b-9c1e-620c4d3e0389",
+                "rel": "self"
+            },
+            {
+                "href": "http://openstack.example.com/servers/a6ebe5b4-b68b-420b-9c1e-620c4d3e0389",
+                "rel": "bookmark"
+            }
+        ]
+    }
+}
\ No newline at end of file
diff --git a/doc/v3/api_samples/server-metadata/server-post-resp.xml b/doc/v3/api_samples/server-metadata/server-post-resp.xml
new file mode 100644
index 0000000000..026abd6940
--- /dev/null
+++ b/doc/v3/api_samples/server-metadata/server-post-resp.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="80cd3928-5ce9-44a1-9257-88847c37f9e4" admin_pass="6GXmk5m4AXpy">
+  <metadata/>
+  <atom:link href="http://openstack.example.com/v3/servers/80cd3928-5ce9-44a1-9257-88847c37f9e4" rel="self"/>
+  <atom:link href="http://openstack.example.com/servers/80cd3928-5ce9-44a1-9257-88847c37f9e4" rel="bookmark"/>
+</server>
\ No newline at end of file