diff options
| author | Chris Yeoh <cyeoh@au1.ibm.com> | 2013-08-13 22:20:57 +0930 |
|---|---|---|
| committer | Chris Yeoh <cyeoh@au1.ibm.com> | 2013-09-12 11:06:54 +0930 |
| commit | c4b8dd6a3939491f9bf6a63f14138dccb95187ed (patch) | |
| tree | 43f2f6ff0d986fb2fc3613a0e7fdc3d8d6e73c32 /doc/v3 | |
| parent | 4e842e38a2d5cc9a02a42f8c3d9947a19595a67f (diff) | |
| download | nova-c4b8dd6a3939491f9bf6a63f14138dccb95187ed.tar.gz | |
Adds V3 API samples for remote consoles, deferred delete
Adds V3 API samples for remote consoles, deferred delete
extensions. Bundling them together to save on review load
Partially implements blueprint v3-api-unittests
Partially implements blueprint v3-api-specification
Change-Id: I595532d9e1b8eed80336c0258be3e9d07ec7461e
Diffstat (limited to 'doc/v3')
20 files changed, 164 insertions, 0 deletions
diff --git a/doc/v3/api_samples/os-deferred-delete/force-delete-post-req.json b/doc/v3/api_samples/os-deferred-delete/force-delete-post-req.json new file mode 100644 index 0000000000..e1a585a698 --- /dev/null +++ b/doc/v3/api_samples/os-deferred-delete/force-delete-post-req.json @@ -0,0 +1,3 @@ +{ + "force_delete": null +}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-deferred-delete/force-delete-post-req.xml b/doc/v3/api_samples/os-deferred-delete/force-delete-post-req.xml new file mode 100644 index 0000000000..5ebae912bb --- /dev/null +++ b/doc/v3/api_samples/os-deferred-delete/force-delete-post-req.xml @@ -0,0 +1,2 @@ +<?xml version="1.0" encoding="UTF-8"?> +<force_delete />
\ No newline at end of file diff --git a/doc/v3/api_samples/os-deferred-delete/restore-post-req.json b/doc/v3/api_samples/os-deferred-delete/restore-post-req.json new file mode 100644 index 0000000000..0e526ff641 --- /dev/null +++ b/doc/v3/api_samples/os-deferred-delete/restore-post-req.json @@ -0,0 +1,3 @@ +{ + "restore": null +}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-deferred-delete/restore-post-req.xml b/doc/v3/api_samples/os-deferred-delete/restore-post-req.xml new file mode 100644 index 0000000000..a43bef2f54 --- /dev/null +++ b/doc/v3/api_samples/os-deferred-delete/restore-post-req.xml @@ -0,0 +1,2 @@ +<?xml version="1.0" encoding="UTF-8"?> +<restore />
\ No newline at end of file diff --git a/doc/v3/api_samples/os-deferred-delete/server-post-req.json b/doc/v3/api_samples/os-deferred-delete/server-post-req.json new file mode 100644 index 0000000000..d41985a1bc --- /dev/null +++ b/doc/v3/api_samples/os-deferred-delete/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/os-deferred-delete/server-post-req.xml b/doc/v3/api_samples/os-deferred-delete/server-post-req.xml new file mode 100644 index 0000000000..598839cf6a --- /dev/null +++ b/doc/v3/api_samples/os-deferred-delete/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/os-deferred-delete/server-post-resp.json b/doc/v3/api_samples/os-deferred-delete/server-post-resp.json new file mode 100644 index 0000000000..ef30f2c09a --- /dev/null +++ b/doc/v3/api_samples/os-deferred-delete/server-post-resp.json @@ -0,0 +1,16 @@ +{ + "server": { + "admin_pass": "hqgU8QzT54wF", + "id": "4a3bde9b-fa37-408d-b167-68e1724c923e", + "links": [ + { + "href": "http://openstack.example.com/v3/servers/4a3bde9b-fa37-408d-b167-68e1724c923e", + "rel": "self" + }, + { + "href": "http://openstack.example.com/servers/4a3bde9b-fa37-408d-b167-68e1724c923e", + "rel": "bookmark" + } + ] + } +}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-deferred-delete/server-post-resp.xml b/doc/v3/api_samples/os-deferred-delete/server-post-resp.xml new file mode 100644 index 0000000000..72073fce53 --- /dev/null +++ b/doc/v3/api_samples/os-deferred-delete/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="1259ad4e-7541-4079-9794-bf7cb8ec3579" admin_pass="JBxtVyh6ggbm"> + <metadata/> + <atom:link href="http://openstack.example.com/v3/servers/1259ad4e-7541-4079-9794-bf7cb8ec3579" rel="self"/> + <atom:link href="http://openstack.example.com/servers/1259ad4e-7541-4079-9794-bf7cb8ec3579" rel="bookmark"/> +</server>
\ No newline at end of file diff --git a/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-req.json b/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-req.json new file mode 100644 index 0000000000..2ce7ff6258 --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-req.json @@ -0,0 +1,5 @@ +{ + "get_spice_console": { + "type": "spice-html5" + } +}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-req.xml b/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-req.xml new file mode 100644 index 0000000000..1362442f16 --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-req.xml @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<get_spice_console> + <type>spice-html5</type> +</get_spice_console>
\ No newline at end of file diff --git a/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-resp.json b/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-resp.json new file mode 100644 index 0000000000..f0e09f47db --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-resp.json @@ -0,0 +1,6 @@ +{ + "console": { + "type": "spice-html5", + "url": "http://127.0.0.1:6082/spice_auto.html?token=a30e5d08-6a20-4043-958f-0852440c6af4" + } +}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-resp.xml b/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-resp.xml new file mode 100644 index 0000000000..c8f04b6341 --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/get-spice-console-post-resp.xml @@ -0,0 +1,5 @@ +<?xml version='1.0' encoding='UTF-8'?> +<console> + <url>http://127.0.0.1:6082/spice_auto.html?token=45eb7f39-5157-4864-a443-41ac2d498748</url> + <type>spice-html5</type> +</console>
\ No newline at end of file diff --git a/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-req.json b/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-req.json new file mode 100644 index 0000000000..390e8d5890 --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-req.json @@ -0,0 +1,5 @@ +{ + "get_vnc_console": { + "type": "novnc" + } +}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-req.xml b/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-req.xml new file mode 100644 index 0000000000..9a7adc916f --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-req.xml @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<get_vnc_console> + <type>novnc</type> +</get_vnc_console>
\ No newline at end of file diff --git a/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-resp.json b/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-resp.json new file mode 100644 index 0000000000..fe15b77933 --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-resp.json @@ -0,0 +1,6 @@ +{ + "console": { + "type": "novnc", + "url": "http://127.0.0.1:6080/vnc_auto.html?token=191996c3-7b0f-42f3-95a7-f1839f2da6ed" + } +}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-resp.xml b/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-resp.xml new file mode 100644 index 0000000000..6c47bcc8be --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/get-vnc-console-post-resp.xml @@ -0,0 +1,5 @@ +<?xml version='1.0' encoding='UTF-8'?> +<console> + <url>http://127.0.0.1:6080/vnc_auto.html?token=ba493af2-559b-4893-951c-a835bdd3f823</url> + <type>novnc</type> +</console>
\ No newline at end of file diff --git a/doc/v3/api_samples/os-remote-consoles/server-post-req.json b/doc/v3/api_samples/os-remote-consoles/server-post-req.json new file mode 100644 index 0000000000..d41985a1bc --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/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/os-remote-consoles/server-post-req.xml b/doc/v3/api_samples/os-remote-consoles/server-post-req.xml new file mode 100644 index 0000000000..598839cf6a --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/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/os-remote-consoles/server-post-resp.json b/doc/v3/api_samples/os-remote-consoles/server-post-resp.json new file mode 100644 index 0000000000..d53218f005 --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/server-post-resp.json @@ -0,0 +1,16 @@ +{ + "server": { + "admin_pass": "Kwg5tff6KiUU", + "id": "8619225c-67c8-424f-9b46-cec5bad137a2", + "links": [ + { + "href": "http://openstack.example.com/v3/servers/8619225c-67c8-424f-9b46-cec5bad137a2", + "rel": "self" + }, + { + "href": "http://openstack.example.com/servers/8619225c-67c8-424f-9b46-cec5bad137a2", + "rel": "bookmark" + } + ] + } +}
\ No newline at end of file diff --git a/doc/v3/api_samples/os-remote-consoles/server-post-resp.xml b/doc/v3/api_samples/os-remote-consoles/server-post-resp.xml new file mode 100644 index 0000000000..48b3c7aec1 --- /dev/null +++ b/doc/v3/api_samples/os-remote-consoles/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="7cfaf61c-9b84-40b1-95f3-4ecd07b7b4db" admin_pass="cAKiM6sT5LaU"> + <metadata/> + <atom:link href="http://openstack.example.com/v3/servers/7cfaf61c-9b84-40b1-95f3-4ecd07b7b4db" rel="self"/> + <atom:link href="http://openstack.example.com/servers/7cfaf61c-9b84-40b1-95f3-4ecd07b7b4db" rel="bookmark"/> +</server>
\ No newline at end of file |