diff --git a/api-ref/src/docbkx/ch_identity-v3.xml b/api-ref/src/docbkx/ch_identity-v3.xml index 61d208417..c21f4bdfb 100644 --- a/api-ref/src/docbkx/ch_identity-v3.xml +++ b/api-ref/src/docbkx/ch_identity-v3.xml @@ -124,7 +124,7 @@ href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#users_user_id_roles"> - - - + --> diff --git a/api-ref/src/docbkx/ch_images-v1.xml b/api-ref/src/docbkx/ch_images-v1.xml index ae302506e..98343c958 100644 --- a/api-ref/src/docbkx/ch_images-v1.xml +++ b/api-ref/src/docbkx/ch_images-v1.xml @@ -47,7 +47,7 @@ - + diff --git a/api-ref/src/wadls/compute-api/src/v2/common.ent b/api-ref/src/wadls/compute-api/src/v2/common.ent index bbc411902..e42a86d01 100644 --- a/api-ref/src/wadls/compute-api/src/v2/common.ent +++ b/api-ref/src/wadls/compute-api/src/v2/common.ent @@ -828,6 +828,34 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">Associated metadata key-and-value pairs. '> + + Specify the unshelve + action in the request + body. + ' > + + + Specify the shelve action + in the request body. + + ' > + + Specify the + shelveOffload action in + the request body. + ' > GET'> PUT'> diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-admin-actions.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-admin-actions.wadl index 7a2b6548b..2de7414b1 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-admin-actions.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-admin-actions.wadl @@ -4,7 +4,7 @@ xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wadl="http://wadl.dev.java.net/2009/02" - xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"> + xmlns:csapi="http://docs.openstack.org/compute/api/v2"> @@ -61,14 +61,6 @@ state. - - - Specify the pause action in the - request body. - - @@ -84,6 +76,14 @@ href="../api_samples/os-admin-actions/admin-actions-pause.xml" /> + + + Specify the pause action in + the request body. + + @@ -95,14 +95,6 @@ its status to ACTIVE. - - - Specify the unpause action in - the request body. - - @@ -118,6 +110,14 @@ href="../api_samples/os-admin-actions/admin-actions-unpause.xml" /> + + + Specify the unpause action + in the request body. + + @@ -137,14 +137,7 @@ become available to create other instances. - - - Specify the suspend action in - the request body. - - + @@ -160,6 +153,14 @@ href="../api_samples/os-admin-actions/admin-actions-suspend.xml" /> + + + Specify the suspend action + in the request body. + + @@ -171,14 +172,7 @@ its status to ACTIVE. - - - Specify the resume action in - the request body. - - + @@ -194,6 +188,14 @@ href="../api_samples/os-admin-actions/admin-actions-resume.xml" /> + + + Specify the resume action + in the request body. + + @@ -205,14 +207,7 @@ scheduler chooses the host. - - - Specify the migrate action in - the request body. - - + @@ -228,6 +223,14 @@ href="../api_samples/os-admin-actions/admin-actions-migrate.xml" /> + + + Specify the migrate action + in the request body. + + @@ -239,14 +242,6 @@ server. - - - Specify the resetNetwork action - in the request body. - - @@ -262,6 +257,14 @@ href="../api_samples/os-admin-actions/admin-actions-reset-network.xml" /> + + + Specify the resetNetwork + action in the request body. + + @@ -273,15 +276,7 @@ server. - - - Specify the injectNetworkInfo - action in the request body. - - + + + + Specify the + injectNetworkInfo action + in the request body. + + @@ -309,14 +314,7 @@ Locks a server. - - - Specify the lock action in the - request body. - - + @@ -332,6 +330,14 @@ href="../api_samples/os-admin-actions/admin-actions-lock-server.xml" /> + + + Specify the lock action in + the request body. + + @@ -342,14 +348,6 @@ Unlocks a server. - - - Specify the unlock action in - the request body. - - @@ -365,6 +363,14 @@ href="../api_samples/os-admin-actions/admin-actions-unlock-server.xml" /> + + + Specify the unlock action + in the request body. + + @@ -375,34 +381,7 @@ Backs up a server instance. - - - Specify the createBackup action - in the request body. - - - - Name of the - backup image. - - - The backup - type. Either 'daily' or - 'weekly.' - - - An integer - value that represents the number of backups to - maintain. - + + + + Specify the createBackup + action in the request body. + + + + Name of the + backup image. + + + The + backup type. Either 'daily' or + 'weekly.' + + + An + integer value that represents the number + of backups to maintain. + @@ -431,34 +439,7 @@ host without rebooting. - - - Specify the os-migrateLive - action in the request body. - - - - Name of the new - host. - - - If true, migration is - blocked. - - - If true, disk over commit is - allowed. - + + + + Specify the os-migrateLive + action in the request body. + + + + Name of the + new host. + + + If true, migration is + blocked. + + + If true, disk over commit is + allowed. + @@ -487,20 +497,7 @@ specified state. - - - Specify the resetState action - in the request body. - - - - The desired - state of a server. - + + + + Specify the resetState + action in the request body. + + + + The desired + state of a server. + @@ -529,36 +541,7 @@ host. - - - Specify the evacuate action in - the request body. - - - - The name or ID of - the host where the server is - evacuated. - - - Specifies a new admin password for the - evacuated instance. - - - If server is on shared storage, set to - True. Otherwise, set to - False. - + + + + Specify the evacuate action + in the request body. + + + + The name or + ID of the host where the server is + evacuated. + + + Specifies a new admin password for + the evacuated instance. + + + If server is on shared storage, set + to True. Otherwise, set to + False. + @@ -605,21 +618,7 @@ to a specified server. - - Specify the - addSecurityGroup action in - the request body. - - - The name of the - security group to assign to the - server. - + + + Specify the + addSecurityGroup action + in the request body. + + + The name of + the security group to assign to the + server. + @@ -648,21 +663,7 @@ from a specified server. - - Specify the - removeSecurityGroup action in - the request body. - - - The name of the - security group to remove from the - server. - + + + Specify the + removeSecurityGroup + action in the request + body. + + + The name of + the security group to remove from the + server. + @@ -693,27 +711,6 @@ the floating IP address. - - Specify the addFloatingIP - action in the request body. - - - A fixed - IP address that you want to associate with the - floating IP address. - - - A - floating IP address to associate with the - instance. - + + Specify the + addFloatingIP action in + the request body. + + + A + fixed IP address that you want to + associate with the floating IP + address. + + + A floating IP address to associate + with the instance. + - + + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xmlns:db="http://docbook.org/ns/docbook" + xmlns:common="http://docs.openstack.org/common/api/v1.0" + xmlns:csapi="http://docs.openstack.org/compute/api/v2"> diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-aggregates.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-aggregates.wadl index f67f087f6..85b5bfb2f 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-aggregates.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-aggregates.wadl @@ -1,10 +1,12 @@ - + + xmlns:db="http://docbook.org/ns/docbook" + xmlns:common="http://docs.openstack.org/common/api/v1.0" + xmlns:csapi="http://docs.openstack.org/compute/api/v2"> @@ -71,18 +73,6 @@ Creates an aggregate. - - Name of - aggregate - - - Availability zone of - aggregate - @@ -98,6 +88,18 @@ href="../api_samples/os-aggregates/aggregate-post-req.json" /> + + Name of + aggregate + + + Availability zone of + aggregate + @@ -159,18 +161,7 @@ aggregate. - - Name of - aggregate. - - - Availability zone of - aggregate. - + @@ -186,6 +177,18 @@ href="../api_samples/os-aggregates/aggregate-update-post-req.json" /> + + Name of + aggregate. + + + Availability zone of + aggregate. + @@ -224,12 +227,7 @@ aggregate. - - Metadata value to be - set. - + @@ -237,6 +235,12 @@ href="../api_samples/os-aggregates/aggregate-metadata-post-req.xml" /> + + Metadata value to be + set. + Adds a host to an aggregate. - - Host ID to add to an - aggregate, which is a collection of multiple - groups of hosts that share common resources - like storage and network. - + @@ -287,6 +284,15 @@ href="../api_samples/os-aggregates/aggregate-add-host-post-req.xml" /> + + Host ID to add to an + aggregate, which is a collection of + multiple groups of hosts that share common + resources like storage and + network. + - - Host ID to add to an - aggregate. - @@ -336,6 +336,12 @@ href="../api_samples/os-aggregates/aggregate-remove-host-post-req.xml" /> + + Host ID to add to an + aggregate. + - + @@ -12,8 +12,10 @@ + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xmlns:db="http://docbook.org/ns/docbook" + xmlns:common="http://docs.openstack.org/common/api/v1.0" + xmlns:csapi="http://docs.openstack.org/compute/api/v2"> @@ -68,75 +70,7 @@ Creates a server with a block device mapping. - &serverCreateParameters; - - block_device_mapping_v2. - - - - - A device name where the volume is attached - in the system at /dev/dev_name. This value is - typically vda. - - - - - Either snap or any other value, - including a blank string. snap - means that the volume was created from a - snapshot. - - - - - Either snap or any other value, - including a blank string. snap - means that the volume was created from a - snapshot. - - - - - Set to True (or 1) to delete the volume when - the instance is deleted. Set to False (or 0) - to retain the volume when the instance is - deleted. - - - - - Guest format. - - - - - The device ID. - - - - - The boot index. - - + @@ -152,11 +86,79 @@ - + &serverCreateParameters; + + block_device_mapping_v2. + + + + + A device name where the volume is + attached in the system at /dev/dev_name. + This value is typically vda. + + + + + Either snap or any other + value, including a blank string. + snap means that the + volume was created from a snapshot. + + + + + Either snap or any other + value, including a blank string. + snap means that the + volume was created from a snapshot. + + + + + Set to True (or 1) to delete the volume + when the instance is deleted. Set to False + (or 0) to retain the volume when the + instance is deleted. + + + + + Guest format. + + + + + The device ID. + + + + + The boot index. + + - &serverCreateParameters; + + - - + &serverCreateParameters; @@ -187,30 +188,11 @@ Lists IDs, names, and links for all servers. - &serverListQueryParameters; + + + &serverListQueryParameters; + - - List of servers. - - - - - Moves to the next item in the - list. - - - - Moves to the previous item in - the list. - - @@ -224,6 +206,28 @@ xml:lang="EN"> + + List of servers. + + + + + Moves to the next item in + the list. + + + + Moves to the previous item + in the list. + + &commonFaults; diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-certificates.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-certificates.wadl index a74d536c4..4b3643dc6 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-certificates.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-certificates.wadl @@ -1,9 +1,11 @@ - + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-cloudpipe.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-cloudpipe.wadl index 9116d7730..0b38fc9ca 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-cloudpipe.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-cloudpipe.wadl @@ -1,10 +1,12 @@ - + + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xmlns:db="http://docbook.org/ns/docbook" + xmlns:common="http://docs.openstack.org/common/api/v1.0" + xmlns:csapi="http://docs.openstack.org/compute/api/v2"> @@ -57,15 +59,6 @@ Creates a cloudpipe. - - Creates the cloudpipe for the - specified project ID. If omitted, the project - ID defaults to the calling - tenant. - @@ -81,6 +74,15 @@ href="../api_samples/os-cloudpipe/cloud-pipe-create-req.xml" /> + + Creates the cloudpipe for + the specified project ID. If omitted, the + project ID defaults to the calling + tenant. + @@ -110,20 +112,6 @@ instance. - - The VPN IP - address. - - - The VPN - port. - @@ -139,6 +127,20 @@ href="../api_samples/os-cloudpipe-update/cloud-pipe-update-req.xml" /> + + The VPN IP + address. + + + The VPN + port. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-console-output.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-console-output.wadl index 88359cbee..326fee6de 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-console-output.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-console-output.wadl @@ -1,10 +1,12 @@ - + + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xmlns:db="http://docbook.org/ns/docbook" + xmlns:common="http://docs.openstack.org/common/api/v1.0" + xmlns:csapi="http://docs.openstack.org/compute/api/v2"> @@ -43,22 +45,6 @@ instance. - - Specify the - os-getConsoleOutput action in - the request body. - - - - Number of lines to fetch from the end of - console log. - - + + Specify the + os-getConsoleOutput + action in the request + body. + + + + Number of lines to fetch from the end of + console log. + + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-consoles.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-consoles.wadl index 2341bfee9..d1f4e6789 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-consoles.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-consoles.wadl @@ -1,10 +1,12 @@ - + + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xmlns:db="http://docbook.org/ns/docbook" + xmlns:common="http://docs.openstack.org/common/api/v1.0" + xmlns:csapi="http://docs.openstack.org/compute/api/v2"> @@ -42,21 +44,6 @@ instance. - - Specify the getConsole - action in the request body. - - - Valid values are - novnc and - xvpvnc. - @@ -72,6 +59,21 @@ href="../api_samples/os-consoles/get-vnc-console-post-req.xml" /> + + Specify the getConsole + action in the request + body. + + + Valid values + are novnc and + xvpvnc. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-coverage.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-coverage.wadl index d33b6a269..0b913279d 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-coverage.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-coverage.wadl @@ -1,5 +1,5 @@ - + Generates a coverage report. - - - The file name for the report. - - - - - Set to true to generate the report in XML - format. - - - - - Set to true to generate the report in HTML - format. - - + + + The file name for the report. + + + + + Set to true to generate the report in + XML format. + + + + + Set to true to generate the report in + HTML format. + + - - - The path to the report file. - - + @@ -98,6 +92,13 @@ href="../api_samples/os-coverage/coverage-xml-report-post-resp.xml" /> + + + The path to the report file. + + @@ -108,14 +109,6 @@ reporting. - - - Specify start in the request - body. - - @@ -131,6 +124,14 @@ href="../api_samples/os-coverage/coverage-start-post-req.xml" /> + + + Specify start in the + request body. + + @@ -144,22 +145,6 @@ report. - - - Specify start in the request - body. - - - - - Set to true to generate a combined report - for all services. - - + + + Specify start in the + request body. + + + + + Set to true to generate a combined + report for all services. + + @@ -187,14 +188,6 @@ Stops coverage reporting. - - - Specify stop in the request - body. - - @@ -210,6 +203,14 @@ href="../api_samples/os-coverage/coverage-stop-post-req.xml" /> + + + Specify stop in the request + body. + + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-createserverext.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-createserverext.wadl index 30dce8e2c..864f4a2ec 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-createserverext.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-createserverext.wadl @@ -1,5 +1,5 @@ - + %common;]> Creates a server with the configuration drive extended attribute. - &serverCreateParameters; - ID of image to mount within - server as a configuration - drive. - + @@ -64,7 +58,14 @@ - + &serverCreateParameters; + ID of image to mount + within server as a configuration + drive. + &serverCreateParameters; @@ -93,14 +94,7 @@ server including the configuration drive extended attribute. - &serverCreateParameters; - The ID of the image to mount - on the server as a configuration - drive. - + @@ -115,7 +109,14 @@ - + &serverCreateParameters; + The ID of the image to + mount on the server as a configuration + drive. + @@ -126,14 +127,7 @@ including the configuration drive extended attribute. - &serverCreateParameters; - The ID of the image to mount - on the server as a configuration - drive. - + @@ -148,7 +142,14 @@ - + &serverCreateParameters; + The ID of the image to + mount on the server as a configuration + drive. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-deferred-delete.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-deferred-delete.wadl index 25a2b375a..af0348ada 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-deferred-delete.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-deferred-delete.wadl @@ -1,5 +1,5 @@ - + Force-deletes a server. - - Specify the forceDelete - action in the request body. - + + + Specify the + forceDelete action in the + request body. + @@ -77,14 +78,6 @@ Restores a deleted server. - - Specify - the restore action in the request - body. - @@ -100,6 +93,14 @@ href="../api_samples/os-deferred-delete/restore-post-req.xml" /> + + Specify the restore + action in the request + body. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-diagnostics.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-diagnostics.wadl index d08348ada..b5f26e7df 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-diagnostics.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-diagnostics.wadl @@ -1,5 +1,5 @@ - + - + %common;]> Creates a server. - &serverCreateParameters; - - A valid value is AUTO or MANUAL. - - + @@ -95,11 +89,17 @@ - + &serverCreateParameters; + + A valid value is AUTO or MANUAL. + + - - + + - - + &serverCreateParameters; @@ -233,13 +232,6 @@ server. - - Valid value is AUTO or - MANUAL. - - @@ -255,6 +247,13 @@ href="../api_samples/OS-DCF/server-get-resp.xml" /> + + Valid value is AUTO or + MANUAL. + + @@ -264,13 +263,6 @@ Lists servers. - - Valid value is AUTO or - MANUAL. - - @@ -286,6 +278,13 @@ href="../api_samples/OS-DCF/list-servers-detail-get.xml" /> + + Valid value is AUTO or + MANUAL. + + @@ -296,13 +295,6 @@ image. - - Valid value is AUTO or - MANUAL. - - @@ -318,6 +310,13 @@ href="../api_samples/OS-DCF/image-get-resp.xml" /> + + Valid value is AUTO or + MANUAL. + + @@ -327,13 +326,6 @@ Lists images. - - Valid value is AUTO or - MANUAL. - - @@ -349,6 +341,13 @@ href="../api_samples/OS-DCF/image-list-resp.xml" /> + + Valid value is AUTO or + MANUAL. + + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-ext-az.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-ext-az.wadl index 7316670a8..c6d90f3be 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-ext-az.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-ext-az.wadl @@ -1,5 +1,5 @@ - + The ID for the tenant or account in a multi-tenancy cloud. - + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-ext-img-size.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-ext-img-size.wadl index e20d4d0af..e56225e6a 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-ext-img-size.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-ext-img-size.wadl @@ -1,5 +1,5 @@ - + - - - + - - Lists all servers showing their IPs - by type, either fixed or floating. + Lists servers and shows their IPs + by type. Type is either fixed or floating. diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-extended-server-attributes.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-extended-server-attributes.wadl index d65dde041..b243fb2f0 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-extended-server-attributes.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-extended-server-attributes.wadl @@ -1,5 +1,5 @@ - + - + Lists the extended status - attributes in the detailed response for all servers. + attributes in the detailed response for all + servers. The extended status attributes are vm_state, power_state, and task_state. diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-fixed-ips.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-fixed-ips.wadl index 0cc732b1b..a4d65f31e 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-fixed-ips.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-fixed-ips.wadl @@ -1,7 +1,5 @@ - - - + - + %common;]> Lists flavors and includes the access type, which is public or private. - &flavorRespParameters; - Set to true if access is - public. - + @@ -74,7 +68,13 @@ - + &flavorRespParameters; + Set to true if access is + public. + @@ -83,14 +83,7 @@ title="Create private flavor"> Creates a private flavor. - &flavorReqParameters; - Set to true if access is - public. Set to false if access is - private. - + @@ -105,16 +98,17 @@ - + &flavorReqParameters; + Set to true if access is + public. Set to false if access is + private. + - &flavorRespParameters; - Set to true if access is - public. - + @@ -129,7 +123,13 @@ - + &flavorRespParameters; + Set to true if access is + public. + @@ -139,13 +139,7 @@ Gets the flavor access type, which is public or private. - &flavorRespParameters; - Set to true if access is - public. - + @@ -160,7 +154,13 @@ - + &flavorRespParameters; + Set to true if access is + public. + @@ -171,18 +171,7 @@ specified private flavor. - - The flavor - ID. - - - The tenant - ID. - + @@ -198,6 +187,18 @@ href="../api_samples/os-flavor-access/flavor-access-list-resp.xml" /> + + The flavor + ID. + + + The tenant + ID. + @@ -208,19 +209,6 @@ the specified private flavor. - - Specify the - addTenantAccess - action. - - - The name of the tenant to - which to give access. - @@ -236,21 +224,23 @@ href="../api_samples/os-flavor-access/flavor-access-add-tenant-req.xml" /> + + Specify the + addTenantAccess + action. + + + The name of the tenant to + which to give access. + - - The flavor - ID. - - - The tenant - ID. - + @@ -266,6 +256,18 @@ href="../api_samples/os-flavor-access/flavor-access-add-tenant-resp.xml" /> + + The flavor + ID. + + + The tenant + ID. + @@ -276,19 +278,6 @@ tenant for the specified private flavor. - - Specify the - removeTenantAccess - action. - - - The name of the tenant from - which to revoke access. - @@ -304,21 +293,23 @@ href="../api_samples/os-flavor-access/flavor-access-remove-tenant-req.xml" /> + + Specify the + removeTenantAccess + action. + + + The name of the tenant + from which to revoke + access. + - - The flavor - ID. - - - The tenant - ID. - @@ -334,6 +325,18 @@ href="../api_samples/os-flavor-access/flavor-access-remove-tenant-resp.xml" /> + + The flavor + ID. + + + The tenant + ID. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-extra-specs.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-extra-specs.wadl index 1aa9d5da3..f9bd744ac 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-extra-specs.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-extra-specs.wadl @@ -1,7 +1,5 @@ - - - + The ID of the flavor of interest to you. - + @@ -69,7 +67,6 @@ - @@ -113,7 +110,6 @@ - @@ -157,7 +153,6 @@ - @@ -183,7 +178,6 @@ - diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-rxtx.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-rxtx.wadl index 1cdb74142..ccd2e5a2b 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-rxtx.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-rxtx.wadl @@ -1,5 +1,5 @@ - + %common;]> - + - - - The name for the flavor. - - - The amount of RAM, in MBs, for - the flavor. - - - The virtual CPUs, in a whole - integer amount, for the - flavor. - - - The amount of disk space, in - GBs, for the flavor. - - - The ID, a unique integer - value, for the flavor. - - - Enables you to override the - bandwidth cap value, which defaults to the - bandwidth cap value for the network to which - the flavor is attached. The new bandwidth cap - is calculated by multiplying the rxtx_factor - valued that you specify by the rxtx_base - property for the network. - - - - The size of secondary drive, in GBs, to - attach to a server. - - - - - The amount of swap disk space, in GBs, to - allocate to a server. - - + @@ -109,6 +59,60 @@ href="../api_samples/OS-FLV-EXT-DATA/flavors-extra-data-post-req.xml" /> + + + The name for the + flavor. + + + The amount of RAM, in MBs, + for the flavor. + + + The virtual CPUs, in a + whole integer amount, for the + flavor. + + + The amount of disk space, + in GBs, for the flavor. + + + The ID, a unique integer + value, for the flavor. + + + Enables you to override + the bandwidth cap value, which defaults to + the bandwidth cap value for the network to + which the flavor is attached. The new + bandwidth cap is calculated by multiplying + the rxtx_factor valued that you specify by + the rxtx_base property for the + network. + + + + The size of secondary drive, in GBs, to + attach to a server. + + + + + The amount of swap disk space, in GBs, + to allocate to a server. + + @@ -147,8 +151,6 @@ /> - - @@ -175,8 +177,6 @@ /> - - diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-flavormanage.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-flavormanage.wadl index 01df6c5b0..a522534ca 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-flavormanage.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-flavormanage.wadl @@ -1,5 +1,5 @@ - + %common;]> - Creates a flavor. - - - - The name for the new flavor. - - - - - The amount of RAM, in MBs, for this - flavor. - - - - - The virtual CPUs, in a whole integer amount, - for the new flavor. - - - - - The amount of disk space, in GBs. - - - - - The ID for the new flavor, which is a unique - integer value. - - @@ -92,9 +57,41 @@ href="../api_samples/os-flavor-manage/flavor-create-post-req.xml" /> + + + The name for the new flavor. + + + + + The amount of RAM, in MBs, for this + flavor. + + + + + The virtual CPUs, in a whole integer + amount, for the new flavor. + + + + + The amount of disk space, in GBs. + + + + + The ID for the new flavor, which is a + unique integer value. + + - - @@ -122,7 +118,6 @@ - diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ip-dns.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ip-dns.wadl index 88a342cee..8900c775b 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ip-dns.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ip-dns.wadl @@ -1,5 +1,5 @@ - + - - - + - + + xml:id="os-floating-ips-bulk-v2"> Bulk-creates floating IPs. - - - The range of IP addresses to use for - creating floating IPs. - - @@ -117,6 +109,14 @@ href="../api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.xml" /> + + + The range of IP addresses to use for + creating floating IPs. + + @@ -144,14 +144,6 @@ Bulk-deletes floating IPs. - - - The range of IP addresses from which to - bulk-delete floating IPs. - - @@ -167,6 +159,14 @@ href="../api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.xml" /> + + + The range of IP addresses from which to + bulk-delete floating IPs. + + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ips.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ips.wadl index 23b19b6be..49f7ddbef 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ips.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ips.wadl @@ -1,12 +1,12 @@ - + + xml:id="os-floating-ips-v2"> The unique identifier associated with allocated floating IP address. - + @@ -85,13 +85,7 @@ to a tenant or account. - - - Pool to allocate IP address from. Will use - default pool if not specified. - - + @@ -107,6 +101,13 @@ href="../api_samples/os-floating-ips/floating-ips-create-req.xml" /> + + + Pool to allocate IP address from. Will + use default pool if not specified. + + @@ -176,12 +177,6 @@ instance. - - The pool to which to add the - floating IP address. - @@ -197,6 +192,12 @@ href="../api_samples/os-floating-ips/floating-ips-add-req.xml" /> + + The pool to which to add + the floating IP address. + @@ -208,19 +209,6 @@ instance. - - Specify the - removeFloatingIp action in - the request body. - - - The floating IP address that - you want to remove. - @@ -236,6 +224,19 @@ href="../api_samples/os-floating-ips/floating-ips-remove-req.xml" /> + + Specify the + removeFloatingIp action + in the request body. + + + The floating IP address + that you want to remove. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-flv-disabled.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-flv-disabled.wadl index 6582456d8..e0c5a1bf5 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-flv-disabled.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-flv-disabled.wadl @@ -1,5 +1,5 @@ - + - - @@ -80,8 +78,6 @@ /> - - diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-hosts.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-hosts.wadl index b1b3e7817..3090c3ddf 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-hosts.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-hosts.wadl @@ -1,5 +1,5 @@ - + Lists hosts. - - - The service name. To filter the returned - list by service name, specify - ?service={service} in the - URI. - - - - - The zone. To filter the returned list by - zone, specify ?zone={zone} in the - URI. - - + + + + The service name. To filter the returned + list by service name, specify + ?service={service} in the + URI. + + + + + The zone. To filter the returned list by + zone, specify ?zone={zone} in + the URI. + + + @@ -97,20 +99,7 @@ maintenance mode. - - - Valid values are enable or disable. - - - - - Valid values are enable or disable. - - + @@ -126,6 +115,22 @@ href="../api_samples/os-hosts/host-put-maintenance-req.xml" /> + + + Valid values are enable or + disable. + + + + + Valid values are enable or + disable. + + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-hypervisors.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-hypervisors.wadl index aa95f977e..7770894df 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-hypervisors.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-hypervisors.wadl @@ -52,19 +52,6 @@ API, such as libvirt or XenAPI. - - Hypervisor host name, - retrieved from the per-server - listing. - - - Hypervisor - ID. - @@ -80,6 +67,19 @@ href="../api_samples/os-hypervisors/hypervisors-list-resp.xml" /> + + Hypervisor host name, + retrieved from the per-server + listing. + + + Hypervisor + ID. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-instance-actions.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-instance-actions.wadl index 4a5e04ef8..8026d7b5f 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-instance-actions.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-instance-actions.wadl @@ -1,9 +1,7 @@ %common;]> - - - + The UUID of the action for which you want to get details. - + @@ -96,7 +94,7 @@ permissions for this request in the policy.json file. By default, only administrators can get details for an action. - + - + before date. - + - + The interface ID. - - + + @@ -61,22 +61,6 @@ to attach the port to a server instance. - - - Specify the interfaceAttachment - action in the request body. - - - - - The ID of the port for which you want to - create an interface. - - @@ -92,45 +76,26 @@ href="../api_samples/os-attach-interfaces/attach-interfaces-create-req.xml" /> + + + Specify the + interfaceAttachment + action in the request body. + + + + + The ID of the port for which you want to + create an interface. + + - - - Fixed IP addresses with subnet IDs. - - - - - The MAC address. - - - - - The network ID. - - - - - The port ID. - - - - - The port state. - - @@ -146,6 +111,43 @@ href="../api_samples/os-attach-interfaces/attach-interfaces-create-resp.xml" /> + + + Fixed IP addresses with subnet + IDs. + + + + + The MAC address. + + + + + The network ID. + + + + + The port ID. + + + + + The port state. + + @@ -155,41 +157,6 @@ Lists port interfaces. - - - The port state. - - - - - Fixed IP addresses with subnet IDs. - - - - - The MAC address. - - - - - The network ID. - - - - - The port ID. - - @@ -205,6 +172,42 @@ href="../api_samples/os-attach-interfaces/attach-interfaces-list-resp.xml" /> + + + The port state. + + + + + Fixed IP addresses with subnet + IDs. + + + + + The MAC address. + + + + + The network ID. + + + + + The port ID. + + @@ -236,7 +239,8 @@ - Detaches a specified port interface. + Detaches a specified port + interface. diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-keypairs.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-keypairs.wadl index b156c3678..17ecda173 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-keypairs.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-keypairs.wadl @@ -1,7 +1,5 @@ - - - + The name associated with a keypair. - + @@ -61,7 +59,6 @@ - @@ -79,7 +76,6 @@ - @@ -94,21 +90,6 @@ keypair. - - - The name to associate with the - keypair. - - - - The public ssh key to import. If not - provided, a key is generated. - - @@ -124,6 +105,21 @@ href="../api_samples/os-keypairs/keypairs-import-post-req.json" /> + + + The name to associate with the + keypair. + + + + The public ssh key to import. If not + provided, a key is generated. + + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-migrations.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-migrations.wadl index ab7351e64..8117a8397 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-migrations.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-migrations.wadl @@ -1,7 +1,5 @@ - - - + - - The - created at time stamp. - - - The - destination compute node. - - - The - destination host. - - - The - migration ID. - - - The ID - of the instance being - migrated. - - - The ID - of the new instance type. - - - The ID - of the old instance type. - - - The - source compute node. - - - The - source node. - - - The - migration status. - - - The - updated at time stamp. - @@ -143,6 +74,81 @@ href="../api_samples/os-migrations/migrations-get.xml" /> + + The created at time + stamp. + + + The destination compute + node. + + + The destination + host. + + + The migration ID. + + + The ID of the instance being + migrated. + + + The ID of the new instance + type. + + + The ID of the old instance + type. + + + The source compute + node. + + + The source node. + + + The migration + status. + + + The updated at time + stamp. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-multi-server-create.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-multi-server-create.wadl index 24b8cb840..f7a4d34b2 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-multi-server-create.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-multi-server-create.wadl @@ -1,5 +1,5 @@ - + %common;]> Creates one or more servers with an optional reservation ID. - &serverCreateParameters; - Set to Trueto - generate a reservation ID for each server. - Omit this attribute to create servers without - a reservation ID. This extended attribute is - enabled when the service provider enables - multiple server launch. - - - The minimum number of servers - to launch when the service provider enables - multiple server launch. - - - The maximum number of servers - to launch when the service provider enables - multiple server launch. - + @@ -79,7 +55,34 @@ - + &serverCreateParameters; + Set to Trueto + generate a reservation ID for each server. + Omit this attribute to create servers + without a reservation ID. This extended + attribute is enabled when the service + provider enables multiple server + launch. + + + The minimum number of + servers to launch when the service + provider enables multiple server + launch. + + + The maximum number of + servers to launch when the service + provider enables multiple server + launch. + - &serverCreateParameters; - + + - - + &serverCreateParameters; diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-networks.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-networks.wadl index 4cd006cf3..8c117f7ea 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-networks.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-networks.wadl @@ -1,5 +1,5 @@ - + - + - + - + - + @@ -86,18 +88,20 @@ - + - + - + - + @@ -221,18 +225,20 @@ - + - + - + - + @@ -243,96 +249,6 @@ Creates a network. - - - A dictionary representation - of a network. - - - - Network - label. - - - - VIFs on this network are - connected to this bridge. - - - - The bridge is connected to - this interface. - - - - IPv4 - subnet. - - - - Multi - host. - - - - Vlan id. - - - - IPv6 - subnet. - - - - First - DNS. - - - - Second - DNS. - - - - IPv4 - gateway. - - - - IPv6 - gateway. - - - - Project - id. - @@ -348,6 +264,99 @@ href="../api_samples/os-networks/network-create-req.xml" /> + + + A dictionary + representation of a + network. + + + + Network + label. + + + + VIFs on this network + are connected to this + bridge. + + + + The bridge is connected + to this interface. + + + + IPv4 + subnet. + + + + Multi + host. + + + + Vlan + id. + + + + IPv6 + subnet. + + + + First + DNS. + + + + Second + DNS. + + + + IPv4 + gateway. + + + + IPv6 + gateway. + + + + Project + id. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-quota-sets.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-quota-sets.wadl index 8497dd2db..69cf22d64 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-quota-sets.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-quota-sets.wadl @@ -96,8 +96,8 @@ Gets default quotas for a tenant. - "aSetsRespParameters; - + + @@ -113,8 +113,7 @@ - - + "aSetsRespParameters; @@ -122,8 +121,8 @@ title="Show quotas"> Shows quotas for a tenant. - "aSetsRespParameters; - + + - + "aSetsRespParameters; @@ -146,8 +145,8 @@ title="Update quotas"> Updates quotas for a tenant. - "aSetsReqParameters; + + - - + "aSetsReqParameters; - "aSetsRespParameters; - + + - + "aSetsRespParameters; - Deletes quotas for a tenant so the quotas - revert to default values. + Deletes quotas for a tenant so the + quotas revert to default values. @@ -197,8 +195,8 @@ >Enables an admin user to show quotas for a specified tenant and user. - "aSetsRespParameters; - + + @@ -214,7 +212,7 @@ - + "aSetsRespParameters; @@ -224,8 +222,8 @@ Updates quotas for a specified tenant/project and user. - "aSetsReqParameters; + + @@ -241,11 +239,10 @@ - - + "aSetsReqParameters; - "aSetsRespParameters; - + + @@ -261,15 +258,15 @@ - + "aSetsRespParameters; - Deletes quotas for a user so that the quotas - revert to default values. + Deletes quotas for a user so that + the quotas revert to default values. @@ -280,127 +277,6 @@ user. - - A quota_set - object. - - - A cores - object. - - - A fixed_ips - object. - - - A floating_ips - object. - - - The ID for the quota - set. - - - An - injected_file_content_bytes - object. - - - An - injected_file_path_bytes - object. - - - An injected_files - object. - - - An instances - object. - - - A key_pairs - object. - - - A metadata_items - object. - - - A ram object. - - - A - security_group_rules object. - - - A security_groups - object. - - - - The number of items in - use. - - - The number of items permitted - for this tenant. - - - - The number of reserved - items. - + + A quota_set + object. + + + A cores + object. + + + A fixed_ips + object. + + + A floating_ips + object. + + + The ID for the quota + set. + + + An + injected_file_content_bytes + object. + + + An + injected_file_path_bytes + object. + + + An injected_files + object. + + + An instances + object. + + + A key_pairs + object. + + + A metadata_items + object. + + + A ram + object. + + + A + security_group_rules + object. + + + A + security_groups object. + + + + The number of items in + use. + + + The number of items + permitted for this + tenant. + + + + The number of reserved + items. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-rescue.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-rescue.wadl index ae439b650..d0afb2854 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-rescue.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-rescue.wadl @@ -1,5 +1,5 @@ - + - - Specify - the rescue action in the request - body. - - - Use - this password for the rescued instance. - Generate a new password if none is - provided. - @@ -71,6 +57,22 @@ href="../api_samples/os-rescue/server-rescue-req.xml" /> + + Specify the rescue + action in the request + body. + + + Use + this password for the rescued instance. + Generate a new password if none is + provided. + @@ -98,13 +100,6 @@ Unrescues a server. - - Specify the unrescue - action in the request body. - + + Specify the unrescue + action in the request + body. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-scheduler-hints.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-scheduler-hints.wadl index 9c9d0518d..20c492292 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-scheduler-hints.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-scheduler-hints.wadl @@ -1,5 +1,5 @@ - + %common;]> Creates a server with scheduler hints that are passed directly to the scheduler. - &serverCreateParameters; - Dictionary of data to send to - the scheduler. - + @@ -51,11 +45,17 @@ - + &serverCreateParameters; + Dictionary of data to send + to the scheduler. + - &serverCreateParameters; + &serverCreateParameters; + - + - - - Port at start of range. - - - - - Security group ID. - - - - - The IP protocol: ICMP, TCP, or UDP. - - - - - An IP range object. - - - - - The CIDR for address range. - - - - - Port at end of range. - - + + + + Port at start of range. + + + + + Security group ID. + + + + + The IP protocol: ICMP, TCP, or + UDP. + + + + + An IP range object. + + + + + The CIDR for address range. + + + + + Port at end of range. + + @@ -116,48 +118,7 @@ security group rule. - - - Port at start of range. - - - - - Security group ID. - - - - - The IP protocol: ICMP, TCP, or UDP. - - - - - An IP range object. - - - - - The CIDR for address range. - - - - - Port at end of range. - - + + + + Port at start of range. + + + + + Security group ID. + + + + + The IP protocol: ICMP, TCP, or + UDP. + + + + + An IP range object. + + + + + The CIDR for address range. + + + + + Port at end of range. + + @@ -185,41 +189,6 @@ rule. - - - Security group name or ID. - - - - - The IP protocol: ICMP, TCP, or UDP. - - - - - Port at start of range. - - - - - Port at end of range. - - - - - The CIDR for address range. - - + + + Security group name or ID. + + + + + The IP protocol: ICMP, TCP, or + UDP. + + + + + Port at start of range. + + + + + Port at end of range. + + + + + The CIDR for address range. + + - - - Port at start of range. - - - - - Security group ID. - - - - - The IP protocol: ICMP, TCP, or UDP. - - - - - An IP range object. - - - - - The CIDR for address range. - - - - - Port at end of range. - - + + + + Port at start of range. + + + + + Security group ID. + + + + + The IP protocol: ICMP, TCP, or + UDP. + + + + + An IP range object. + + + + + The CIDR for address range. + + + + + Port at end of range. + + - Deletes a specified security - group rule. + Deletes a specified security group + rule. diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-security-groups.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-security-groups.wadl index 30f3411cb..6e701fec9 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-security-groups.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-security-groups.wadl @@ -1,5 +1,5 @@ - + - + %common;]> Creates a server with the OS-EXT-IPS-MAC:mac_addr extended attribute. - &serverCreateParameters; - Associated MAC - address. - + @@ -66,7 +60,13 @@ - + &serverCreateParameters; + Associated MAC + address. + &serverCreateParameters; @@ -95,7 +95,10 @@ server. Includes the OS-EXT-IPS-MAC:mac_addr extended attribute. - &serverListQueryParameters; + + + &serverListQueryParameters; + &serverCreateParameters; @@ -128,7 +131,10 @@ Includes the OS-EXT-IPS-MAC:mac_addr extended attribute. - &serverListQueryParameters; + + + &serverListQueryParameters; + &serverCreateParameters; diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-server-groups.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-server-groups.wadl index f0c5e25ff..b559694b1 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-server-groups.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-server-groups.wadl @@ -48,27 +48,6 @@ Creates a server group. - - - The server group name. A non-empty string - with no leading or trailing spaces. Maximum - length is 255 characters. - - - - A list of one or more policy names to - associate with the server group. The list must - contain at least one policy name. - Each policy name must be a non-empty string - with no leading or trailing spaces. Maximum - length is 255 characters. - @@ -84,10 +63,34 @@ href="../api_samples/os-server-groups/server-groups-post-req.xml" /> + + + The server group name. A non-empty + string with no leading or trailing spaces. + Maximum length is 255 + characters. + + + + A list of one or more policy names to + associate with the server group. The list + must contain at least one policy + name. + Each policy name must be a non-empty + string with no leading or trailing spaces. + Maximum length is 255 + characters. + - &serverGroupsParameters; - + + - - + &serverGroupsParameters; @@ -120,15 +122,14 @@ - &serverGroupsParameters; - + + - - + &serverGroupsParameters; @@ -147,15 +148,14 @@ - &serverGroupsParameters; - + + - - + &serverGroupsParameters; diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-server-password.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-server-password.wadl index 7207c4be9..ef0d44648 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-server-password.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-server-password.wadl @@ -1,6 +1,5 @@ - - + - diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-server-shelve.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-server-shelve.wadl index 22caa9d71..7d56a862c 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-server-shelve.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-server-shelve.wadl @@ -1,5 +1,7 @@ + +%common;]> shelveOffload action. - - Specify - the shelve action in the request - body. - @@ -69,8 +64,7 @@ - - + &shelveAction; @@ -85,14 +79,6 @@ usage. - - Specify the shelveOffload - action in the request body. - @@ -107,8 +93,7 @@ - - + &shelveOffloadAction; @@ -118,13 +103,6 @@ Restores a shelved server. - - Specify the unshelve - action in the request body. - - - + &unshelveAction; diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-server-start-stop.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-server-start-stop.wadl index e908ef75a..6ba8025c3 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-server-start-stop.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-server-start-stop.wadl @@ -1,5 +1,5 @@ - + The ID for the - tenant or account in a multi-tenancy - cloud. + xml:lang="EN" title="Tenant ID">The ID + for the tenant or account in a + multi-tenancy cloud. @@ -22,9 +22,9 @@ type="csapi:UUID"> The - UUID for the server of interest to - you. + xml:lang="EN" title="Server UUID" + >The UUID for the server of + interest to you. @@ -42,13 +42,6 @@ its status to ACTIVE. - - Specify - the os-start action in the - request body. - @@ -64,6 +57,15 @@ href="../api_samples/os-server-start-stop/server-stop-req.xml" /> + + Specify the + os-start action in the + request body. + @@ -75,13 +77,6 @@ its status to STOPPED. - - Specify - the os-stop action in the request - body. - @@ -97,6 +92,15 @@ href="../api_samples/os-server-start-stop/server-stop-req.xml" /> + + Specify the + os-stop action in the + request body. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-services.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-services.wadl index 415d5ee39..8d5f7f667 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-services.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-services.wadl @@ -1,7 +1,5 @@ - - - + - - The host - name. - - - The service - name. - - - The reason the service was - disabled. - @@ -147,6 +127,24 @@ href="../api_samples/os-services/service-disable-log-put-req.xml" /> + + The host + name. + + + The service + name. + + + The reason the service was + disabled. + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-simple-tenant-usage.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-simple-tenant-usage.wadl index 38e21ee40..d1f045217 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-simple-tenant-usage.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-simple-tenant-usage.wadl @@ -1,5 +1,5 @@ - + - - The start of a time range, in - date time format. - - - The end of the time range, in - date time format. - - - Whether to return detailed - usage information. Defaults to - false. - + + + The start of a time + range, in date time + format. + + + The end of the time + range, in date time + format. + + + Whether to return + detailed usage information. Defaults to + false. + + @@ -86,25 +90,29 @@ tenants. - - The start of a time range, in - date time format. - - - The end of the time range, in - date time format. - - - Whether to return detailed - usage information. Defaults to - false. - + + + The start of a time + range, in date time + format. + + + The end of the time + range, in date time + format. + + + Whether to return + detailed usage information. Defaults to + false. + + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-used-limits-for-admins.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-used-limits-for-admins.wadl index 760ef455b..0e14e6e85 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-used-limits-for-admins.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-used-limits-for-admins.wadl @@ -1,5 +1,5 @@ - + - - - + - + - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-volume.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-volume.wadl index d2259a2d6..287b37576 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-volume.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-volume.wadl @@ -1,5 +1,5 @@ - + Creates a volume. - - - A partial representation of a volume that is - used to create a volume. - - + @@ -109,6 +102,14 @@ href="../api_samples/os-volume/volume_create.xml" /> + + + A partial representation of a volume + that is used to create a volume. + + @@ -276,14 +277,7 @@ Creates a snapshot. - - - A partial representation of a snapshot that - is used to create a snapshot. - - + @@ -299,6 +293,14 @@ href="../api_samples/os-volume/snapshot_create.xml" /> + + + A partial representation of a snapshot + that is used to create a snapshot. + + diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-volume_attachments.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-volume_attachments.wadl index 359c8b31f..6bcbbf0a7 100644 --- a/api-ref/src/wadls/compute-api/src/v2/ext/os-volume_attachments.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-volume_attachments.wadl @@ -1,5 +1,5 @@ - + @@ -92,26 +92,7 @@ Attaches a volume to the specified server. - - - ID of the volume to attach. - - - - - Name of the device such as, /dev/vdb. Use - "auto" for auto-assign (if - supported). - - - - A dictionary representation of a volume - attachment. - + + + + ID of the volume to attach. + + + + + Name of the device such as, /dev/vdb. + Use "auto" for auto-assign (if + supported). + + + + A dictionary representation of a volume + attachment. + diff --git a/api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl b/api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl index 940c5bc4a..920b39d12 100644 --- a/api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl +++ b/api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl @@ -11,11 +11,11 @@ %common;]> + xmlns:csapi="http://docs.openstack.org/compute/api/v2"> @@ -33,8 +33,9 @@ The tenant ID in a - multi-tenancy cloud. + xml:lang="EN"> + The tenant ID in a multi-tenancy + cloud. An alias, which is - a name for a pointer to a resource. - For example, a named - extension. + xml:lang="EN"> + An alias, which is a name for a + pointer to a resource. For example, + a named extension. @@ -70,8 +71,8 @@ type="csapi:UUID"> The UUID for the - server. + xml:lang="EN"> + The UUID for the server. @@ -117,7 +118,6 @@ private. - @@ -131,60 +131,63 @@ - - - - - - The UUID for the image. - - - - - - - - + + + + + The UUID for the image. + + + + + + + + A string. Maximum length is 255 characters. - - - - - + + + + + + - - - - - - - UUID for the specific flavor - (combination of memory, disk size, and - CPUs). - - - + + + + + + UUID for the specific flavor + (combination of memory, disk size, + and CPUs). + + + + - @@ -376,20 +379,6 @@ Lists available extensions. - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - @@ -406,6 +395,21 @@ href="../api_samples/all_extensions/extensions-get-resp.xml" /> + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + &commonFaults; @@ -440,8 +444,9 @@ title="Create server"> Creates a server. - &serverCreateParameters; + + &serverCreateParameters; @@ -458,8 +463,8 @@ - &serverCreateParameters; + + - - + &serverCreateParameters; @@ -488,31 +492,11 @@ Lists IDs, names, and links for all servers. - &serverListQueryParameters; + + + &serverListQueryParameters; + - - - List of servers. - - - - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - @@ -526,6 +510,29 @@ xml:lang="EN"> + + + List of servers. + + + + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + &commonFaults; @@ -535,30 +542,35 @@ Lists details for all servers. - &serverListQueryParameters; + + + &serverListQueryParameters; + - - The following examples show the list server - responses: - - - + Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - + xml:lang="EN"> + + + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + + @@ -609,30 +621,6 @@ the specified server. - - - The name of the server. If you edit the - server name, the server host name does not - change. Also, server names are not guaranteed - to be unique. - - - - - The IP version 4 address. - - - - - The IP version 6 address. - - + + + The name of the server. If you edit the + server name, the server host name does not + change. Also, server names are not + guaranteed to be unique. + + + + + The IP version 4 address. + + + + + The IP version 6 address. + + &commonFaults; &getFaults; &inProgressFault; - - - - Specific URL of the server you want to - rebuild. - @@ -825,6 +831,13 @@ href="../api_samples/server-action-rebuild-resp.xml" /> + + + Specific URL of the server you want to + rebuild. + @@ -928,30 +941,6 @@ body. - - - Name of the snapshot. - - - - - A dictionary representation of a creation - for image. - - - - - Metadata key and value pairs. The maximum - size of the metadata key and value is 255 - bytes each. - - @@ -968,11 +957,38 @@ href="../api_samples/server-action-createimage.xml" /> + + + Name of the snapshot. + + + + + A dictionary representation of a + creation for image. + + + + + Metadata key and value pairs. The + maximum size of the metadata key and value + is 255 bytes each. + + - + + + @@ -988,8 +1004,8 @@ title="List addresses"> Lists networks and addresses for a specified tenant and server. - Specify the tenant ID and server ID in the URI. - + Specify the tenant ID and server ID in the + URI. @@ -1040,30 +1056,11 @@ Lists IDs, names, and links for available flavors. - &flavorListQueryParameters; + + + &flavorListQueryParameters; + - - Flavors are known combinations - of memory, disk space, and number of - CPUs. - - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - @@ -1078,6 +1075,28 @@ + + Flavors are known + combinations of memory, disk space, and + number of CPUs. + + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + &commonFaults; @@ -1087,23 +1106,11 @@ Lists all details for available flavors. - &flavorListQueryParameters; + + + &flavorListQueryParameters; + - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - @@ -1118,10 +1125,25 @@ + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + &commonFaults; - @@ -1153,23 +1175,11 @@ Lists all details for available images. - &imageListQueryParameters; + + + &imageListQueryParameters; + - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - @@ -1186,6 +1196,22 @@ href="../api_samples/images-details-get-resp.xml" /> + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + &commonFaults; @@ -1195,29 +1221,11 @@ Lists IDs, names, and links for available images. - &imageListQueryParameters; + + + &imageListQueryParameters; + - - Image - information. - - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - @@ -1234,6 +1242,27 @@ href="../api_samples/images-list-get-resp.xml" /> + + Image + information. + + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + &commonFaults; @@ -1276,22 +1305,6 @@ server. - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - @@ -1308,6 +1321,22 @@ href="../api_samples/server-metadata-all-resp.xml" /> + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + &commonFaults; @@ -1319,24 +1348,8 @@ Shows metadata for a specified image. - - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - - + + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + &commonFaults; @@ -1387,24 +1416,8 @@ - - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - - + + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + @@ -1456,24 +1485,8 @@ - - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - - + + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + @@ -1525,24 +1554,8 @@ - - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - - + + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + @@ -1595,22 +1624,6 @@ - - Moves to the next metadata - item. - - - - Moves to the previous metadata - item. - - @@ -1627,6 +1640,22 @@ href="../api_samples/image-metadata-put-resp.xml" /> + + Moves to the next metadata + item. + + + + Moves to the previous + metadata item. + + @@ -1735,7 +1764,6 @@ &commonFaults; &getFaults; &postPutFaults; &inProgressFault; - diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions-v3.wadl index 1ad58cfe1..2ccc0d41d 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions-v3.wadl @@ -1,8 +1,12 @@ -%common;]> + + +%common;]> + + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"> @@ -36,18 +40,20 @@ - + - + - + - + @@ -60,18 +66,20 @@ - + - + - + - + @@ -84,18 +92,20 @@ - + - + - + - + @@ -107,18 +117,20 @@ - + - + - + - + @@ -131,18 +143,20 @@ - + - + - + - + @@ -155,18 +169,20 @@ - + - + - + - + @@ -179,18 +195,20 @@ - + - + - + - + @@ -203,18 +221,20 @@ - + - + - + - + @@ -227,18 +247,20 @@ - + - + - + - + @@ -251,18 +273,20 @@ - + - + - + - + @@ -274,18 +298,20 @@ - + - + - + - + @@ -298,18 +324,20 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-agents-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-agents-v3.wadl index 781403280..cca543e51 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-agents-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-agents-v3.wadl @@ -1,11 +1,12 @@ - %common;]> + + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"> @@ -27,34 +28,38 @@ - + - + - + - + - + - + - + - + @@ -63,21 +68,22 @@ xmlns="http://docbook.org/ns/docbook"> Lists agent builds. - - + - + - + - + @@ -88,34 +94,38 @@ - + - + - + - + - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-aggregates-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-aggregates-v3.wadl index 7565ed037..c58377df8 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-aggregates-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-aggregates-v3.wadl @@ -1,11 +1,12 @@ - %common;]> + + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"> @@ -35,40 +36,41 @@ - + - + - + - + - + - + - + - + - - - @@ -77,34 +79,38 @@ - + - + - + - + - + - + - + - + @@ -117,34 +123,38 @@ - + - + - + - + - + - + - + - + @@ -157,34 +167,38 @@ - + - + - + - + - + - + - + - + @@ -198,34 +212,38 @@ - + - + - + - + - + - + - + - + @@ -238,34 +256,38 @@ - + - + - + - + - + - + - + - + @@ -278,34 +300,38 @@ - + - + - + - + - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-cells-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-cells-v3.wadl index 465c187fd..f3cd530fc 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-cells-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-cells-v3.wadl @@ -1,12 +1,12 @@ - %common;]> + + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"> diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-certificates-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-certificates-v3.wadl index 4449263bc..3f93372d2 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-certificates-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-certificates-v3.wadl @@ -26,34 +26,34 @@ - + - + - + - + @@ -64,18 +64,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-config-drive-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-config-drive-v3.wadl index 3a6632037..39e3f89b3 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-config-drive-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-config-drive-v3.wadl @@ -31,18 +31,18 @@ - + - + - + - + @@ -55,18 +55,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-deferred-delete-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-deferred-delete-v3.wadl index 06804e347..b3e87495f 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-deferred-delete-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-deferred-delete-v3.wadl @@ -30,18 +30,18 @@ - + - + - + - + @@ -54,18 +54,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-evacuate-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-evacuate-v3.wadl index 614071107..ae3587825 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-evacuate-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-evacuate-v3.wadl @@ -28,34 +28,34 @@ - + - + - + - + - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-availability-zone-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-availability-zone-v3.wadl index 9b0210603..d471e262c 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-availability-zone-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-availability-zone-v3.wadl @@ -31,18 +31,18 @@ - + - + - + - + @@ -55,18 +55,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-server-attributes-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-server-attributes-v3.wadl index de1d561aa..f0a43f7cf 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-server-attributes-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-server-attributes-v3.wadl @@ -30,18 +30,18 @@ - + - + - + - + @@ -54,18 +54,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-status-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-status-v3.wadl index efe75d2c9..98c78a9c3 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-status-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-status-v3.wadl @@ -29,18 +29,18 @@ - + - + - + - + @@ -52,18 +52,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-access-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-access-v3.wadl index 93de11d41..d013b9299 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-access-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-access-v3.wadl @@ -41,34 +41,34 @@ - + - + - + - + - + - + - + - + @@ -81,34 +81,34 @@ - + - + - + - + - + - + - + - + @@ -118,23 +118,23 @@ xmlns="http://docbook.org/ns/docbook"> Extends flavor detail to add access attribute to the response of flavor detail. - + - + - + - + - + @@ -146,34 +146,34 @@ - + - + - + - + - + - + - + - + @@ -181,38 +181,38 @@ Removes flavor access for tenant. - + - + - + - + - + - + - + - + - + @@ -226,18 +226,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-manage-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-manage-v3.wadl index d3a5866bf..4e4fde021 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-manage-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-manage-v3.wadl @@ -23,34 +23,34 @@ - + - + - + - + - + - + - + - + @@ -61,18 +61,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-rxtx-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-rxtx-v3.wadl index 3a4cc5624..8c87625dd 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-rxtx-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-rxtx-v3.wadl @@ -32,18 +32,18 @@ - + - + - + - + @@ -55,18 +55,18 @@ - + - + - + - + @@ -77,34 +77,34 @@ - + - + - + - + - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavors-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavors-v3.wadl index ad2a26d7b..0c5fbca46 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavors-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavors-v3.wadl @@ -32,18 +32,18 @@ - + - + - + - + @@ -55,18 +55,18 @@ - + - + - + - + @@ -78,18 +78,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavorspecs-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavorspecs-v3.wadl index 4e95e4287..c2b4cf7cc 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavorspecs-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavorspecs-v3.wadl @@ -36,34 +36,34 @@ - + - + - + - + - + - + - + - + @@ -75,34 +75,34 @@ - + - + - + - + - + - + - + - + @@ -114,34 +114,34 @@ - + - + - + - + - + - + - + - + @@ -153,34 +153,34 @@ - + - + - + - + - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-hosts-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-hosts-v3.wadl index 498c321e5..162c71104 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-hosts-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-hosts-v3.wadl @@ -38,18 +38,18 @@ - + - + - + - + @@ -62,18 +62,18 @@ - + - + - + - + @@ -85,18 +85,18 @@ - + - + - + - + @@ -108,18 +108,18 @@ - + - + - + - + @@ -131,34 +131,34 @@ - + - + - + - + - + - + - + - + @@ -170,18 +170,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-actions-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-actions-v3.wadl index b29f341e7..18b1172bb 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-actions-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-actions-v3.wadl @@ -34,18 +34,18 @@ - + - + - + - + @@ -58,18 +58,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-limits-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-limits-v3.wadl index c4e4dffbc..913c26253 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-limits-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-limits-v3.wadl @@ -22,18 +22,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-migrations-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-migrations-v3.wadl index 7a60d1031..df19190ab 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-migrations-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-migrations-v3.wadl @@ -26,18 +26,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-multinic-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-multinic-v3.wadl index fa3ed0dd5..89253cc68 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-multinic-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-multinic-v3.wadl @@ -26,18 +26,18 @@ - + - + - + - + @@ -50,18 +50,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-class-sets-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-class-sets-v3.wadl index ff8e4652f..78e292c09 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-class-sets-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-class-sets-v3.wadl @@ -30,18 +30,18 @@ - + - + - + - + @@ -53,34 +53,34 @@ - + - + - + - + - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-remote-consoles-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-remote-consoles-v3.wadl index 498d6fd2a..dba430c53 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-remote-consoles-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-remote-consoles-v3.wadl @@ -29,34 +29,34 @@ - + - + - + - + - + - + - + - + @@ -67,34 +67,34 @@ - + - + - + - + - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-server-usage-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-server-usage-v3.wadl index 83fa9202a..20cc2b817 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-server-usage-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-server-usage-v3.wadl @@ -30,18 +30,18 @@ - + - + - + - + @@ -54,18 +54,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-simple-tenant-usage-v3.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-simple-tenant-usage-v3.wadl index 9064cfe99..8e3ef71ef 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-simple-tenant-usage-v3.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-simple-tenant-usage-v3.wadl @@ -31,18 +31,18 @@ - + - + - + - + @@ -55,18 +55,18 @@ - + - + - + - + diff --git a/api-ref/src/wadls/databases-api/xsd/dbaas.wadl b/api-ref/src/wadls/databases-api/xsd/dbaas.wadl index 6bc0ee717..6393072a9 100644 --- a/api-ref/src/wadls/databases-api/xsd/dbaas.wadl +++ b/api-ref/src/wadls/databases-api/xsd/dbaas.wadl @@ -292,87 +292,6 @@ - - An instance - object. - - - Reference (href) to a flavor - as specified in the response from the list - Flavors API call. This is the actual URI as - specified by the href field in the - link. - Rather than the flavor URI, you can also - pass the flavor id (integer) as the value for - flavorRef. For example, the flavor id for the - flavor URI shown above is - "1". - - - The volume size in gigabytes - (GB). The value specified must be between 1 - and 50. - - - A databases - object. - - - Name of the instance to - create. The length of the name is limited to - 255 characters and any characters are - permitted. - - - Specifies database names for - creating databases on instance - creation. - - - Set of symbols and encodings. - The default character set is - utf8. - - - Set of rules for comparing - characters in a character set. The default - value for collate is - utf8_general_ci. - - - A users - object. - - - The user name for the database - on instance creation. - - - The password for those users - on instance creation. - @@ -382,6 +301,89 @@ href="samples/db-create-instance-request.json" /> + + An instance + object. + + + Reference (href) to a + flavor as specified in the response from + the list Flavors API call. This is the + actual URI as specified by the href field + in the link. + Rather than the flavor URI, you can also + pass the flavor id (integer) as the value + for flavorRef. For example, the flavor id + for the flavor URI shown above is + "1". + + + The volume size in + gigabytes (GB). The value specified must + be between 1 and 50. + + + A databases + object. + + + Name of the instance to + create. The length of the name is limited + to 255 characters and any characters are + permitted. + + + Specifies database names + for creating databases on instance + creation. + + + Set of symbols and + encodings. The default character set is + utf8. + + + Set of rules for comparing + characters in a character set. The default + value for collate is + utf8_general_ci. + + + A users + object. + + + The user name for the + database on instance + creation. + + + The password for those + users on instance + creation. + diff --git a/api-ref/src/wadls/identity-api/src/v2.0/samples/validatetoken.json b/api-ref/src/wadls/identity-api/src/v2.0/samples/validatetoken.json index 4a787c363..170db5d2d 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/samples/validatetoken.json +++ b/api-ref/src/wadls/identity-api/src/v2.0/samples/validatetoken.json @@ -1,28 +1,30 @@ { - "access": { - "token": { - "id": "ab48a9efdfedb23ty3494", - "expires": "2010-11-01T03:32:15-05:00", - "tenant": { - "id": "345", - "name": "My Project" + "access":{ + "token":{ + "id":"ab48a9efdfedb23ty3494", + "expires":"2010-11-01T03:32:15-05:00", + "tenant":{ + "id":"345", + "name":"My Project" + } + }, + "user":{ + "id":"123", + "name":"jqsmith", + "roles":[ + { + "id":"234", + "name":"compute:admin" + }, + { + "id":"234", + "name":"object-store:admin", + "tenantId":"1" } - }, - "user": { - "id": "123", - "name": "jqsmith", - "roles": [ - { - "id": "234", - "name": "compute:admin" - }, - { - "id": "234", - "name": "object-store:admin", - "tenantId": "1" - } - ], - "roles_links": [] - } - } + ], + "roles_links":[ + + ] + } + } } \ No newline at end of file diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/HP-IDM-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/HP-IDM-admin.wadl index 7da058890..7f75b6802 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/HP-IDM-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/HP-IDM-admin.wadl @@ -29,7 +29,8 @@ - + @@ -37,13 +38,15 @@ type="xsd:string" required="true"> A valid authentication token. + xml:lang="EN">A valid authentication + token. The token ID. + xml:lang="EN">The token + ID. @@ -62,11 +65,13 @@ type="xsd:string" required="false"> A comma-separated string of service IDs. - Checks the roles against the specified service - IDs. If a service ID is not valid or if no - roles are associated with a service ID, a - 401 fault is returned. + xml:lang="EN">A comma-separated + string of service IDs. Checks the + roles against the specified service + IDs. If a service ID is not valid or + if no roles are associated with a + service ID, a 401 fault is + returned. @@ -81,36 +86,32 @@ - - - Validates a token and that it belongs to a + + Validates that a token belongs to a specified tenant and services. Returns the permissions relevant to a particular client. - + - &commonFaults; &getFaults; - - - Validates a token and that it belongs to a - specified tenant and services, for performance. + + Validates that a token belongs to a + specified tenant and services. For performance. &commonFaults; &getFaults; diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl index f1429a275..5e37285f4 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl @@ -1,5 +1,5 @@ - + @@ -18,8 +18,7 @@ xmlns:capi="http://docs.openstack.org/common/api/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" - xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0" -> + xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"> @@ -27,7 +26,8 @@ - + @@ -118,10 +118,11 @@ The page size. - + - + @@ -203,7 +204,7 @@ The page size. - + @@ -575,15 +576,7 @@ Lists roles. - - Role object. - &roleResponse; - Role links. - + + + Role + object. + &roleResponse; + Role + links. + &commonFaults; &getFaults; @@ -621,10 +625,7 @@ - - The location. - + + + The location. + &commonFaults; &postPutFaults; &getFaults; @@ -644,11 +650,7 @@ title="Get role information by name"> Gets a role by name. - &roleResponse; - The location. - + - + &roleResponse; + The location. + &commonFaults; &postPutFaults; &getFaults; @@ -670,11 +676,7 @@ Gets information for a specified role. - &roleResponse; - The location. - + - + &roleResponse; + The location. + &commonFaults; &postPutFaults; &getFaults; @@ -789,10 +795,6 @@ - - The location. - + + The location. + &commonFaults; &postPutFaults; &getFaults; diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl index 6ebf5864b..df1518252 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl @@ -1,5 +1,5 @@ - + @@ -30,33 +30,77 @@ - + - A valid authentication token for an administrative user. + + A valid authentication + token for an administrative + user. + - The tenant ID. - + + The tenant + ID. + + - - The endpoint ID. + + + The endpoint + ID. + - + - - - A valid authentication token for an administrative user. - The service ID. + + + + A valid authentication + token for an administrative + user. + + + The service + ID. + + - - - The endpoint template ID. + + + + The endpoint + template ID. + @@ -73,205 +117,256 @@ - -

Lists endpoint templates.

- + + Lists endpoint templates. + - - - - - + + + + + - - - - - - &commonFaults; - &getFaults; - + + + + + &commonFaults; &getFaults; - -

Gets endpoint templates.

- + + Gets endpoint templates. + - - - - - + + + + + - - - - - - &commonFaults; - &getFaults; - + + + + + &commonFaults; &getFaults; - -

Adds endpoint template.

- + + Adds endpoint template. + - - - - - + + + + + - - - - + + + + - - - - - + + + + + - - - - + + + + - - &commonFaults; - &getFaults; - &postPutFaults; - + &commonFaults; &getFaults; &postPutFaults; - -

Updates endpoint template.

- + + Updates endpoint template. + - - - - + + + + - - - + + + - - - - + + + + - - - + + + - - &commonFaults; - &getFaults; - &postPutFaults; - + &commonFaults; &getFaults; &postPutFaults; - -

Deletes an endpoint template.

- - - &commonFaults; - &getFaults; - + + Deletes an endpoint + template. + + &commonFaults; &getFaults; - -

Adds endpoint to a tenant.

- + + Adds endpoint to a tenant. + - - - - - - + + + + + + - - - + + + - - - - - + + + + + - - - - + + + + - - &commonFaults; - &getFaults; - &postPutFaults; - + &commonFaults; &getFaults; &postPutFaults; - -

Lists endpoints for a tenant.

- + + Lists endpoints for a + tenant. + - - - - - + + + + + - - - - - - &commonFaults; - &getFaults; - + + + + + &commonFaults; &getFaults; - -

Gets endpoint for a tenant.

- + + Gets endpoint for a tenant. + - - - - - + + + + + - - - - - - &commonFaults; - &getFaults; - + + + + + &commonFaults; &getFaults; - -

Deletes an endpoint from a tenant.

- - - &commonFaults; - &getFaults; - + + Deletes an endpoint from a + tenant. + + &commonFaults; &getFaults; diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl index 1fa75ddf3..2facfddab 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl @@ -1,5 +1,5 @@ - + @@ -31,13 +31,14 @@ - + A valid authentication - token. + xml:lang="EN">A valid authentication + token. @@ -45,7 +46,8 @@ required="true" type="xsd:string"> The user ID. + xml:lang="EN">The user + ID. The ID of the last - item in the previous - list. + xmlns="http://docbook.org/ns/docbook" + xml:lang="EN">The ID of the + last item in the previous + list. The page size. + xmlns="http://docbook.org/ns/docbook" + xml:lang="EN">The page + size. - + - - - - - - The credential type. - - + + + + + + + The credential + type. + + - + diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl index 8f0472187..1ba307fc0 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl @@ -1,5 +1,5 @@ - + @@ -30,13 +30,14 @@ - + A valid authentication - token. + xml:lang="EN">A valid authentication + token. @@ -44,7 +45,8 @@ required="true" type="xsd:string"> The user ID. + xml:lang="EN">The user + ID. The ID of the last - item in the previous - list. + xml:lang="EN">The ID of the + last item in the previous + list. The page size. + xml:lang="EN">The page + size. @@ -71,13 +74,17 @@ - - The credential type. - - + + + The credential + type. + + + @@ -90,10 +97,10 @@ - + + title="Add user credential"> Adds a credential to a user. @@ -133,10 +140,9 @@ + title="List credentials"> Lists credentials. - @@ -159,7 +165,7 @@ + title="List credentials by type"> Lists credentials by type. @@ -185,7 +191,7 @@ + title="Update user credentials"> Updates credentials. @@ -226,7 +232,7 @@ + title="Delete user credentials"> Deletes user credentials. @@ -235,7 +241,7 @@ + title="Get user credentials"> Gets user credentials. diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl index 2db8a54df..a4c609cef 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl @@ -10,7 +10,6 @@ %common; ]> - - + @@ -38,14 +38,18 @@ type="xsd:string" required="true"> A valid authentication token for an - administrative user. + xml:lang="EN">A valid + authentication token for an + administrative + user. A valid authentication token. + xml:lang="EN">A valid + authentication + token. @@ -71,25 +75,30 @@ type="xsd:string" required="true"> A valid authentication token for an - administrative user. + xml:lang="EN">A valid + authentication token for an + administrative + user. A valid authentication token. + xml:lang="EN">A valid + authentication + token. A comma-separated string of service - IDs. Checks the roles against the - specified service IDs. If a service ID - is not valid or if no roles are - associated with a service ID, a 401 - fault is returned. + xml:lang="EN">A comma-separated + string of service IDs. Checks the + roles against the specified service + IDs. If a service ID is not valid + or if no roles are associated with + a service ID, a 401 fault is + returned. @@ -102,31 +111,30 @@ - + - - - Checks that a token is valid and that it belongs to a - specified tenant and service IDs. Returns the - permissions for a particular client. - Behavior is - similar to /tokens/{tokenId}. An - itemNotFound (404) fault is returned for - a token that is not valid. - This extension - might decrypt X-Subject-Token header and internally - call the normal validation for Identity, - passing in all headers and query parameters. It should - therefore support all existing calls on + + Checks that a token is valid and + that it belongs to a specified tenant and service IDs. + Returns the permissions for a particular + client. + Behavior is similar to + /tokens/{tokenId}. An itemNotFound + (404) fault is returned for a token + that is not valid. + This extension might decrypt + X-Subject-Token header and internally + call the normal validation for Identity, passing in + all headers and query parameters. It should therefore + support all existing calls on /tokens/{tokenId}, including extensions such as HP-IDM. - - &commonFaults; &getFaults; - - - Checks that a token is valid and that it belongs to a - specified tenant and service IDs, for performance. - Behavior is - similar to /tokens/{tokenId}. An - itemNotFound (404) fault is returned for - a token that is not valid. - This extension - might decrypt X-Subject-Token header and internally - call the normal validation for Identity, - passing in all headers and query parameters. It should - therefore support all existing calls on + + Checks that a token is valid and + that it belongs to a specified tenant and service IDs, + for performance. + Behavior is similar to + /tokens/{tokenId}. An itemNotFound + (404) fault is returned for a token + that is not valid. + This extension might decrypt + X-Subject-Token header and internally + call the normal validation for Identity, passing in + all headers and query parameters. It should therefore + support all existing calls on /tokens/{tokenId}, including extensions such as HP-IDM. &commonFaults; &getFaults; - - Lists endpoints - associated with a specific token. + + Lists endpoints associated with a + specific token. - - + xmlns:identity="http://docs.openstack.org/identity/api/v2.0" + xmlns:grp="http://docs.rackspace.com/identity/api/ext/RAX-KSGRP/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:db="http://docbook.org/ns/docbook" + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"> @@ -26,33 +27,38 @@ - - -

- A valid authentication token for an administrative user. -

- + + + A valid authentication token for an + administrative user. + - - -

- The group ID. -

- + + + The group ID. + - + - - -

- The user ID. -

- + + + The user ID. + @@ -65,233 +71,248 @@ - -

- A list of users. -

- + + A list of users. + - -

- A list of groups. -

- + + A list of groups. + - The ID of the last item in the previous - list. + The ID of the last item in the previous + list. - The page size. + The page size. + + + The group name. - The group name. - - -

- Lists groups. -

- + + + Lists groups. + - - - - + + + + + path="/grp:groups/atom:link[@rel='next']/@href"> + path="/grp:groups/atom:link[@rel='previous']/@href"> - - - + + + - - &commonFaults; - - - -

- Adds a group. -

- + &commonFaults; + + + Adds a group. + - - - - + + + + + type="grp:GroupForCreate" path="/grp:group"/> - - - + + + - - -

- The full URL to the new group is - returned in the Location - header. -

- - - - - - + + + + + + + The full URL to the new group is + returned in the Location + header. + + - - - + + + - - &commonFaults; - &getFaults; - &postPutFaults; - + &commonFaults; &getFaults; &postPutFaults; - -

- Gets information for a group by ID. -

- + + Gets information for a group by + ID. + - - - - + + + + - - - + + + - - &commonFaults; - &getFaults; - - - -

- Updates a group. -

- + &commonFaults; &getFaults; + + + Updates a group. + - - - - + + + + + type="grp:GroupForUpdate" path="/grp:group"/> - - - + + + - - - - + + + + - - - + + + - - &commonFaults; - &getFaults; - &postPutFaults; - + &commonFaults; &getFaults; &postPutFaults; - -

- Deletes a group. -

- + + Deletes a group. + - - &commonFaults; - &getFaults; - + &commonFaults; &getFaults; - -

- Lists users for a group. -

- + + Lists users for a group. + - - + + + + - - - - + + + + + path="/identity:users/atom:link[@rel='next']/@href"> + path="/identity:users/atom:link[@rel='previous']/@href"> - - - + + + - - &commonFaults; - + &commonFaults; - -

- Adds a user to a group. -

- + + Adds a user to a group. + - - &commonFaults; - &getFaults; - + &commonFaults; &getFaults; - -

- Removes a user from a group. -

- + + Removes a user from a group. + - - &commonFaults; - &getFaults; - + &commonFaults; &getFaults; diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSGRP-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSGRP-admin.wadl index 310bff942..6f7a118b1 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSGRP-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSGRP-admin.wadl @@ -1,5 +1,5 @@ - + @@ -29,15 +29,26 @@ - + - - A valid authentication token for an administrative user. + + A valid authentication token + for an administrative user. - The user ID. - + + The user + ID. + + @@ -45,22 +56,27 @@ - + Lists groups for a user. - - - + + + - - + + - - &commonFaults; - &getFaults; - - + &commonFaults; &getFaults; + diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSKEY-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSKEY-admin.wadl index 7b1de24e4..7f5a8438a 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSKEY-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSKEY-admin.wadl @@ -1,5 +1,5 @@ - + @@ -28,18 +28,23 @@ - + - A valid authentication token for an - administrative user. + A valid authentication token + for an administrative user. - The user ID. + The user + ID. @@ -50,17 +55,27 @@ - A valid authentication token - for an administrative user. + A valid + authentication token for an + administrative + user. - The ID of the last item in the - previous list. + The ID of the + last item in the previous + list. - The page size. + The page + size. @@ -81,138 +96,150 @@ - + - -

Adds a credential to a user.

- + + Adds a credential to a user. + - + - + - + - + - + - + - + - + &commonFaults; &postPutFaults; &getFaults; - -

Lists credentials.

- + + Lists credentials. + - + - + - + - + &commonFaults; &getFaults; - -

Updates credentials.

- + + Updates credentials. + - + - + - + - + - + - + - + - + &commonFaults; &postPutFaults; &getFaults; - -

Deletes user credentials.

- + + Deletes user credentials. + &commonFaults; &postPutFaults; &getFaults; - -

Gets user credentials.

- + + Gets user credentials. + - + - + - + - + &commonFaults; &getFaults; diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSQA-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSQA-admin.wadl index 36ec42020..c75337cf0 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSQA-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSQA-admin.wadl @@ -1,5 +1,5 @@ - + @@ -34,14 +34,18 @@ - A valid authentication token for an - administrative user. + A valid authentication token + for an administrative user. - The user ID. + The user + ID. @@ -54,67 +58,72 @@ - -

Gets a secret question and answer for a specified - user.

- + + Gets a secret question and answer + for a specified user. + - + - + - + - + &commonFaults; &getFaults; - -

Updates a secret question and answer for a specified - user.

- + + Updates a secret question and + answer for a specified user. + - + - + - + - + - + - + - + - + &commonFaults; &postPutFaults; diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl index 30096ea43..131d58ca6 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl @@ -199,11 +199,7 @@ of the Identity API. - + + + + &commonFaults; &getFaults; @@ -229,20 +230,7 @@ Lists available extensions. - - Moves to the next item in the - list. - - - - Moves to the previous item in the - list. - - + @@ -252,6 +240,21 @@ /> + + Moves to the next item in the + list. + + + + Moves to the previous item in + the list. + + + @@ -146,27 +146,7 @@ Lists available extensions. - - - Moves to the next item in the list. - - - - - - Moves to the previous item in the - list. - - - + @@ -185,6 +165,29 @@ + + + Moves to the next item in the + list. + + + + + + Moves to the previous item in the + list. + + + &commonFaults; &getFaults; @@ -241,67 +244,6 @@ are stored. - - The tenant name. Both the - tenantId and - tenantName attributes are - optional, but should not be specified - together. If both attributes are specified, - the server responds with a 400 - Bad Request. - - - The tenant ID. Both the - tenantId and - tenantName attributes are - optional, but should not be specified - together. If both attributes are specified, - the server responds with a 400 - Bad Request. - - - A passwordCredentials - object. To authenticate, you must provide - either a user ID and password or a - token. - - - The user name. Required if you include - the passwordCredentials object. - If you do not provide a password credentials, - you must provide a token. - - - The password of the user. Required if - you include the - passwordCredentials object. - If you do not provide a password credentials, - you must provide a token. - - - A token object. Required - if you do not provide password - credentials. - - - The token ID. This is a required field - in the token - object. - @@ -321,6 +263,74 @@ href="../samples/auth_credentials.xml"/> + + The tenant name. Both the + tenantId and + tenantName attributes are + optional, but should not be specified + together. If both attributes are + specified, the server responds with a + 400 + Bad + Request. + + + The tenant ID. Both the + tenantId and + tenantName attributes are + optional, but should not be specified + together. If both attributes are + specified, the server responds with a + 400 + Bad + Request. + + + A passwordCredentials + object. To authenticate, you must provide + either a user ID and password or a + token. + + + The user name. Required if you + include the + passwordCredentials + object. If you do not provide a password + credentials, you must provide a + token. + + + The password of the user. Required + if you include the + passwordCredentials + object. If you do not provide a password + credentials, you must provide a + token. + + + A token object. + Required if you do not provide password + credentials. + + + The token ID. This is a required + field in the token + object. + @@ -345,114 +355,7 @@ - - An access - object. - - - A token - object. - - - A timestamp that indicates when the - token was issued. - - - A timestamp that indicates when the - token expires. - - - The authentication token. In the - example, the token is - my_id. - - - A tenant - object. - - - The description of the tenant. If not - set, this value is - null. - - - Indicates whether the tenant is enabled - or disabled. - - - The tenant ID. - - - The tenant name. - - - A serviceCatalog - object. - - - One or more endpoints - objects. Each object shows the - adminURL, - region, internalURL, - id, and - publicURL for the - endpoint. - - - Links for the - endpoint. - - - Endpoint type. - - - Endpoint name. - - - A user object, which shows - the username, - roles_links, id, - roles, and - name. - - - A metadata - object. - + @@ -470,6 +373,115 @@ + + An access + object. + + + A token + object. + + + A timestamp that indicates when the + token was issued. + + + A timestamp that indicates when the + token expires. + + + The authentication token. In the + example, the token is + my_id. + + + A tenant + object. + + + The description of the tenant. If + not set, this value is + null. + + + Indicates whether the tenant is + enabled or disabled. + + + The tenant ID. + + + The tenant name. + + + A serviceCatalog + object. + + + One or more endpoints + objects. Each object shows the + adminURL, + region, + internalURL, + id, and + publicURL for the + endpoint. + + + Links for the + endpoint. + + + Endpoint type. + + + Endpoint name. + + + A user object, which + shows the username, + roles_links, + id, roles, + and name. + + + A metadata + object. + diff --git a/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl b/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl index 5caf6cf15..97c3643c8 100644 --- a/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl +++ b/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl @@ -1,5 +1,5 @@ - + diff --git a/api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl b/api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl index 6654dd93e..6221bd622 100644 --- a/api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl +++ b/api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl @@ -172,8 +172,9 @@ &descriptionQueryParam; &domain_idQueryParam; &emailQueryParam; &enabledQueryParam; - &nameQueryParam; + &nameQueryParam; + The user - ID. + xml:lang="EN">The user + ID. The role - ID. + xml:lang="EN">The role + ID. @@ -461,7 +462,6 @@ Shows details for the Identity API v3. &commonFaults; &getFaults; &versionParam; &statusParam; &updatedParam; - &media-typesParam; &version-idParam; &version-linksParam; - + status="200"> + - - + &versionParam; &statusParam; &updatedParam; + &media-typesParam; &version-idParam; + &version-linksParam; @@ -599,12 +596,8 @@ Conflict are also possible. - &authRequestParam; &identityRequestParam; - &methodsRequestParam; &passwordObjectRequestParam; - &scopeRequestParam; &tokenRequestParam; &userRequestParam; - &idRequestParam; &user-nameRequestParamOpt; - &passwordRequestParam; + + @@ -668,7 +661,11 @@ href="../samples/TokenAuthPasswordIDScopeProjDomainNameRequest.json" /> - + &authRequestParam; &identityRequestParam; + &methodsRequestParam; &passwordObjectRequestParam; + &scopeRequestParam; &tokenRequestParam; + &userRequestParam; &idRequestParam; + &user-nameRequestParamOpt; &passwordRequestParam; @@ -739,37 +736,34 @@ token was issued by POST /auth/tokens. - &authTokenHeader; &subjectTokenHeader; - + + - + &authTokenHeader; &subjectTokenHeader; - &tokenResponseParam; - &expires-atResponseParam; &issued-atResponseParam; - &methodsRequestParam; &userRequestParam; - &domainRequestParam; &domain-idResponseParam; - &domain-linksResponseParam; &domain-nameResponseParam; - &user-idResponseParam; &user-linksResponseParam; - &user-nameResponseParam; + + - - + &tokenResponseParam; + &expires-atResponseParam; &issued-atResponseParam; + &methodsRequestParam; &userRequestParam; + &domainRequestParam; &domain-idResponseParam; + &domain-linksResponseParam; &domain-nameResponseParam; + &user-idResponseParam; &user-linksResponseParam; + &user-nameResponseParam; &commonFaults; &getFaults; - &authTokenHeader; &subjectTokenHeader; - + + - + &authTokenHeader; &subjectTokenHeader; - &commonFaults; &getFaults; + &commonFaults; &getFaults; X-Auth-Token is not required. - &authTokenHeader; &subjectTokenHeader; - + + - + &authTokenHeader; &subjectTokenHeader; &commonFaults; &getFaults; @@ -837,20 +829,22 @@ Lists services. - &typeQueryParam; &pageQueryParam; - &per_pageQueryParam; - &serviceResponseParam; - &service_idResponseParam; &service_typeResponseParam; - + + + &typeQueryParam; &pageQueryParam; + &per_pageQueryParam; + + + - + &serviceResponseParam; + &service_idResponseParam; &service_typeResponseParam; &commonFaults; &getFaults; @@ -859,34 +853,31 @@ xml:lang="EN" title="Add service"> Adds a service. - &typeRequestParam; + + - - + &typeRequestParam; - &linksResponseParam; - &servicesResponseParam; &descriptionResponseParam; - &service_idResponseParam; &service_linksResponseParam; - &service_nameResponseParam; &service_typeResponseParam; - + + - - + &linksResponseParam; + &servicesResponseParam; &descriptionResponseParam; + &service_idResponseParam; &service_linksResponseParam; + &service_nameResponseParam; + &service_typeResponseParam; &commonFaults; &getFaults; @@ -897,21 +888,20 @@ service. - &serviceResponseParam; - &descriptionResponseParam; &service_idResponseParam; - &service_linksResponseParam; &service_nameResponseParam; - &service_typeResponseParam; + + - - + &serviceResponseParam; + &descriptionResponseParam; &service_idResponseParam; + &service_linksResponseParam; + &service_nameResponseParam; + &service_typeResponseParam; &commonFaults; &getFaults; Updates a specified service. - &typeRequestParam; + + - - + &typeRequestParam; - &servicesResponseParam; - &service_idResponseParam; &service_typeResponseParam; - + + - + &servicesResponseParam; + &service_idResponseParam; &service_typeResponseParam; &commonFaults; &getFaults; @@ -958,7 +945,7 @@ - &commonFaults; &getFaults; + &commonFaults; &getFaults; Lists available endpoints. - &interfaceQueryParam; &service_idQueryParam; - &pageQueryParam; &per_pageQueryParam; - &endpointRequestParam; - &interfaceRequestParam; &nameResponseParam; - ®ionRequestParam; &urlRequestParam; - &service_idRequestParam; + + + &interfaceQueryParam; &service_idQueryParam; + &pageQueryParam; &per_pageQueryParam; + + + + - - + &endpointRequestParam; + &interfaceRequestParam; &nameResponseParam; + ®ionRequestParam; &urlRequestParam; + &service_idRequestParam; &commonFaults; &getFaults; Adds an endpoint. - &endpointRequestParam; &interfaceRequestParam; - &nameRequestParam; ®ionRequestParam; &urlRequestParam; - &service_idRequestParam; + + - - + &endpointRequestParam; + &interfaceRequestParam; &nameRequestParam; + ®ionRequestParam; &urlRequestParam; + &service_idRequestParam; - &endpointRequestParam; - &interfaceRequestParam; &linksResponseParam; - &nameRequestParam; ®ionRequestParam; &urlRequestParam; - &service_idRequestParam; + + - + &endpointRequestParam; + &interfaceRequestParam; &linksResponseParam; + &nameRequestParam; ®ionRequestParam; + &urlRequestParam; &service_idRequestParam; &commonFaults; &getFaults; @@ -1029,35 +1016,33 @@ Updates a specified endpoint. - &endpointRequestParam; &interfaceRequestParamOpt; - &nameRequestParam; ®ionRequestParamOpt; - &urlRequestParamOpt; &service_idRequestParamOpt; - + + - - + &endpointRequestParam; + &interfaceRequestParamOpt; &nameRequestParam; + ®ionRequestParamOpt; &urlRequestParamOpt; + &service_idRequestParamOpt; - &endpointRequestParam; - &interfaceRequestParam; &linksResponseParam; - &nameRequestParam; ®ionRequestParam; &urlRequestParam; - &service_idRequestParam; + + - + &endpointRequestParam; + &interfaceRequestParam; &linksResponseParam; + &nameRequestParam; ®ionRequestParam; + &urlRequestParam; &service_idRequestParam; &commonFaults; &getFaults; @@ -1068,7 +1053,7 @@ endpoint. - &commonFaults; &getFaults; + &commonFaults; &getFaults; Lists domains. - &nameQueryParam; &enabledQueryParam; - &pageQueryParam; &per_pageQueryParam; - &descriptionResponseParam; - &enabledResponseParam; &idResponseParam; - &linksResponseParam; &nameResponseParam; + + + &nameQueryParam; &enabledQueryParam; &pageQueryParam; + &per_pageQueryParam; + + + @@ -1090,7 +1076,9 @@ href="../samples/DomainsListResponse.json" /> - + &descriptionResponseParam; + &enabledResponseParam; &idResponseParam; + &linksResponseParam; &nameResponseParam; &commonFaults; &getFaults; @@ -1099,35 +1087,33 @@ xml:lang="EN" title="Add domain"> Adds a domain. - &authTokenHeader; &domain_descriptionRequestParam; - &domain_enabledRequestParam; &domain_nameRequestParam; - + + - + &authTokenHeader; + &domain_descriptionRequestParam; + &domain_enabledRequestParam; &domain_nameRequestParam; - &domainRequestParam; - &descriptionResponseParam; &enabledResponseParam; - &domain-idResponseParam; &linksResponseParam; - &nameResponseParam; + + - - + &domainRequestParam; + &descriptionResponseParam; &enabledResponseParam; + &domain-idResponseParam; &linksResponseParam; + &nameResponseParam; &commonFaults; &getFaults; - &domainsResponseParam; - &descriptionResponseParam; &enabledResponseParam; - &domain-idResponseParam; &linksResponseParam; - &nameResponseParam; + + - - + &domainsResponseParam; + &descriptionResponseParam; &enabledResponseParam; + &domain-idResponseParam; &linksResponseParam; + &nameResponseParam; &commonFaults; &getFaults; Updates a specified domain. - &authTokenHeader; &domain_descriptionRequestParam; - &domain_enabledRequestParam; &domain_nameRequestParam; - + + - + &authTokenHeader; + &domain_descriptionRequestParam; + &domain_enabledRequestParam; &domain_nameRequestParam; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; Lists projects. - &domain_idQueryParam; &nameQueryParam; - &enabledQueryParam; &pageQueryParam; &per_pageQueryParam; + + + &domain_idQueryParam; &nameQueryParam; + &enabledQueryParam; &pageQueryParam; + &per_pageQueryParam; + Deletes a specified project. - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; Lists users. - &domain_idQueryParam; &emailQueryParam; - &nameQueryParam; &enabledQueryParam; &pageQueryParam; - &per_pageQueryParam; + + + &domain_idQueryParam; &emailQueryParam; + &nameQueryParam; &enabledQueryParam; &pageQueryParam; + &per_pageQueryParam; + Deletes a specified user. - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &descriptionResponseParam; - &domain-idResponseParam; &idResponseParam; - &linksResponseParam; &nameResponseParam; + + - + &descriptionResponseParam; + &domain-idResponseParam; &idResponseParam; + &linksResponseParam; &nameResponseParam; &commonFaults; &getFaults; @@ -1732,7 +1702,6 @@ - &descriptionResponseParam; - &domain-idResponseParam; &idResponseParam; - &linksResponseParam; &nameResponseParam; + + - + &descriptionResponseParam; + &domain-idResponseParam; &idResponseParam; + &linksResponseParam; &nameResponseParam; &commonFaults; &getFaults; @@ -1791,7 +1758,6 @@ Deletes a specified group. - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; Removes a user from a group. - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &commonFaults; &getFaults; + &commonFaults; &getFaults; - &domain_idQueryParam; &descriptionQueryParam; - &emailQueryParam; &nameQueryParam; &enabledQueryParam; - &pageQueryParam; &per_pageQueryParam; + + + &domain_idQueryParam; &descriptionQueryParam; + &emailQueryParam; &nameQueryParam; &enabledQueryParam; + &pageQueryParam; &per_pageQueryParam; + + Lists credentials. - &authTokenHeader; &pageQueryParam; - &per_pageQueryParam; - &blobResponseParam; &idResponseParam; - &linksResponseParam; &project_idResponseParam; - &typeResponseParam; &user_idResponseParam; + + + &authTokenHeader; &pageQueryParam; + &per_pageQueryParam; + + + - + &blobResponseParam; &idResponseParam; + &linksResponseParam; &project_idResponseParam; + &typeResponseParam; &user_idResponseParam; &commonFaults; &getFaults; @@ -1914,7 +1884,6 @@ - &commonFaults; &getFaults; + &commonFaults; &getFaults; Lists roles. - &nameQueryParam; &pageQueryParam; - &per_pageQueryParam; + + + &nameQueryParam; &pageQueryParam; &per_pageQueryParam; + + Deletes a specified role. - &commonFaults; &getFaults; + &commonFaults; &getFaults; Lists policies. - &typeQueryParam; &pageQueryParam; - &per_pageQueryParam; - &blobResponseParam; &idResponseParam; - &linksResponseParam; &project_idResponseParam; - &typeResponseParam; &user_idResponseParam; + + + &typeQueryParam; &pageQueryParam; &per_pageQueryParam; + + + + - + &blobResponseParam; &idResponseParam; + &linksResponseParam; &project_idResponseParam; + &typeResponseParam; &user_idResponseParam; &commonFaults; &getFaults; @@ -2214,33 +2178,31 @@ xml:lang="EN" title="Add policy"> Adds a policy. - &blobRequestParam; &project_idRequestParam; - &typeRequestParam; &user_idRequestParam; + + - + &blobRequestParam; &project_idRequestParam; + &typeRequestParam; &user_idRequestParam; - &blobResponseParam; &idResponseParam; - &linksResponseParam; &project_idResponseParam; - &typeResponseParam; &user_idResponseParam; + + - + &blobResponseParam; &idResponseParam; + &linksResponseParam; &project_idResponseParam; + &typeResponseParam; &user_idResponseParam; &commonFaults; &getFaults; @@ -2251,18 +2213,17 @@ policy. - &blobResponseParam; &idResponseParam; - &linksResponseParam; &project_idResponseParam; - &typeResponseParam; &user_idResponseParam; + + - + &blobResponseParam; &idResponseParam; + &linksResponseParam; &project_idResponseParam; + &typeResponseParam; &user_idResponseParam; &commonFaults; &getFaults; @@ -2274,7 +2235,6 @@ - &blobResponseParam; &idResponseParam; - &linksResponseParam; &project_idResponseParam; - &typeResponseParam; &user_idResponseParam; + + - + &blobResponseParam; &idResponseParam; + &linksResponseParam; &project_idResponseParam; + &typeResponseParam; &user_idResponseParam; &commonFaults; &getFaults; @@ -2306,6 +2265,5 @@ Deletes a specified policy. - &commonFaults; &getFaults; - + &commonFaults; &getFaults; diff --git a/api-ref/src/wadls/image-api/src/v1/os-image-1.0.wadl b/api-ref/src/wadls/image-api/src/v1/os-image-1.0.wadl index e8b473dbf..cfd50177c 100644 --- a/api-ref/src/wadls/image-api/src/v1/os-image-1.0.wadl +++ b/api-ref/src/wadls/image-api/src/v1/os-image-1.0.wadl @@ -33,31 +33,37 @@ - The ID for the tenant or - account in a multi-tenancy - cloud. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN"> + The ID for the tenant or account in a + multi-tenancy cloud. - Image - ID stored through the image API. - Typically a UUID. + xmlns:wadl="http://wadl.dev.java.net/2009/02" + xml:lang="EN" title="Image ID" + >Image ID stored through the + image API. Typically a + UUID. @@ -66,13 +72,16 @@ - + Owner ID, which is the tenant - ID. + >Owner ID, which is the + tenant ID. @@ -82,10 +91,13 @@ - + Owner ID. The owner ID is the tenant ID. @@ -107,14 +119,17 @@ - + Details for a version. - Lists information about all Image Service API versions. @@ -139,55 +156,60 @@ - - + Shows details for Image Service API v1. - - - + - + --> - + Registers a virtual machine (VM) image. - - - Name for the image. Note that the name of an - image is not unique to a Glance node. The API - cannot expect users to know the names of - images owned by others. - - - - - Valid values are: aki, ari, ami, raw, iso, - vhd, vdi, qcow2, or vmdk. - The disk format of a VM image is the format - of the underlying disk image. Virtual - appliance vendors have different formats for - laying out the information contained in a VM - disk image. - You can set the container format for your - image to one of the following values: - - - - raw - - Unstructured disk image - format. - - - - vhd - - VHD disk format, a common disk - format used by VM monitors from - VMWare, Xen, Microsoft, VirtualBox, - and others. - - - - vmdk - - A common disk format that supported - by many VM monitors. - - - - vdi - - Supported by VirtualBox VM monitor - and the QEMU emulator. - - - - iso - - An archive format for the data - contents of an optical disc, such as - CDROM. - - - - qcow2 - - Supported by the QEMU emulator that - can expand dynamically and supports - Copy on Write. - - - - aki - - An Amazon kernel image. - - - - ari - - An Amazon ramdisk image. - - - - ami - - An Amazon machine image. - - - - - - - The container format refers to whether the - VM image is in a file format that also - contains metadata about the actual VM. - Container formats include: OVF and Amazon’s - AMI. In addition, a VM image might not have a - container format – instead, the image is just - a blob of unstructured data. - You can set the container format to one of - the following: - - - - ovf - OVF container format. - - - - bare - No container or metadata envelope - for the image. - - - - aki - Amazon kernel image. - - - - ari - Amazon ramdisk image. - - - - ami - Amazon machine image. - - - - - + element="image"> + + + Name for the image. Note that the name + of an image is not unique to a Glance + node. The API cannot expect users to know + the names of images owned by + others. + + + + + Valid values are: aki, ari, ami, raw, + iso, vhd, vdi, qcow2, or vmdk. + The disk format of a VM image is the + format of the underlying disk image. + Virtual appliance vendors have different + formats for laying out the information + contained in a VM disk image. + You can set the container format for + your image to one of the following + values: + + + + raw + Unstructured disk image + format. + + + + vhd + VHD disk format, a common disk + format used by VM monitors from + VMWare, Xen, Microsoft, VirtualBox, + and others. + + + + vmdk + A common disk format that + supported by many VM + monitors. + + + + vdi + Supported by VirtualBox VM + monitor and the QEMU + emulator. + + + + iso + An archive format for the data + contents of an optical disc, such + as CDROM. + + + + qcow2 + Supported by the QEMU emulator + that can expand dynamically and + supports Copy on Write. + + + + aki + An Amazon kernel image. + + + + ari + An Amazon ramdisk image. + + + + ami + An Amazon machine image. + + + + + + + The container format refers to whether + the VM image is in a file format that also + contains metadata about the actual + VM. + Container formats include OVF and Amazon + AMI. In addition, a VM image might not + have a container format – instead, the + image is just a blob of unstructured + data. + You can set the container format to one + of the following formats: + + + + ovf + OVF container format. + + + + bare + No container or metadata + envelope for the image. + + + + aki + Amazon kernel image. + + + + ari + Amazon ramdisk image. + + + + ami + Amazon machine image. + + + + + + - - - A location for the image identified by a - URI. - - - + + element="common:version"> + + + A location for the image identified by a + URI. + + + + - + Updates an image, uploads an image file, or updates metadata for an image. - @@ -419,10 +455,11 @@ - - Returns the image details as - headers and the image binary in the body of the + + Shows the image details as headers + and the image binary in the body of the response. @@ -430,64 +467,78 @@ element="imageapi:image"/> - - - Returns the image details as + - + Deletes the specified image. - + Lists the VM images shared with a specified owner. The owner ID is the tenant ID. - - - The ID of the image that is shared with the - specified owner. The owner ID is the tenant - ID. - - - - - - If the owner is authorized to further share - the image, the can_share field is set to true. - The owner ID is the tenant ID. - - - + element="imageapi:images"> + + + The ID of the image that is shared with + the specified owner. The owner ID is the + tenant ID. + + + + + + If the owner is authorized to further + share the image, the can_share field is + set to true. The owner ID is the tenant + ID. + + + + @@ -495,71 +546,81 @@ - + Lists public VM images. - - - Name of the image as a string. - - - - - Value of the container format, such as ovf, - bare, aki, ari, or ami. - - - - - Value of the disk format. - - - - - Filters the list of images to those with - this status. Valid values are queued, saving, - active, killed, deleted, and - pending_delete. - - - - - Value of the minimum size of the image in - bytes. - - - - - Value of the maximum size of the image in - bytes. - - + + + + Name of the image as a string. + + + + + Value of the container format, such as + ovf, bare, aki, ari, or ami. + + + + + Value of the disk format. + + + + + Filters the list of images to those with + this status. Valid values are queued, + saving, active, killed, deleted, and + pending_delete. + + + + + Value of the minimum size of the image + in bytes. + + + + + Value of the maximum size of the image + in bytes. + + + @@ -568,92 +629,106 @@ - + Lists details for available images. - - - Name of the image as a string. - - - - - Value of the container format, such as ovf, - bare, aki, ari, or ami. - - - - - Value of the disk format. - - - - - Filters the list of images to those with - this status. Valid values are queued, saving, - active, killed, deleted, and - pending_delete. - - - - - The minimum size of the image, in - bytes. - - - - - Value of the maximum size of the image in - bytes. - - - - - Filters the list of images to those that - have changed since this time stamp - value. - - + + + + Name of the image as a string. + + + + + Value of the container format, such as + ovf, bare, aki, ari, or ami. + + + + + Value of the disk format. + + + + + Filters the list of images to those with + this status. Valid values are queued, + saving, active, killed, deleted, and + pending_delete. + + + + + The minimum size of the image, in + bytes. + + + + + Value of the maximum size of the image + in bytes. + + + + + Filters the list of images to those that + have changed since this time stamp + value. + + + - Show the next item in the list. - Show the previous item in the list. @@ -666,43 +741,53 @@ - + Adds a member to an image. If you omit the request body from this call, this request adds the membership to the image, leaves the - existing memberships unmodified, and defaults new - memberships to have can_share set to false. + existing memberships unmodified, and sets the + can_share attribute to false for new + memberships. - - - To give an owner access to a private image, - set to true. The owner ID is the tenant - ID. - - - + + + + + + To give an owner access to a private + image, set to true. The owner ID is the + tenant ID. + + - + Replaces a membership list for an image. - - + @@ -710,17 +795,20 @@ - + Removes a member from an image. - ID of member with which an image is shared. diff --git a/api-ref/src/wadls/image-api/src/v2.0/os-image-2.0.wadl b/api-ref/src/wadls/image-api/src/v2.0/os-image-2.0.wadl index 38c3b6f37..1a6d78ddd 100644 --- a/api-ref/src/wadls/image-api/src/v2.0/os-image-2.0.wadl +++ b/api-ref/src/wadls/image-api/src/v2.0/os-image-2.0.wadl @@ -1,6 +1,5 @@ - - + @@ -77,64 +76,48 @@ image. - - - Name for the image. The name of an image is - not unique to an Image Service node. The API - cannot expect users to know the names of - images owned by others. - - - - - The image ID. - - - - - Image visibility. Public or private. Default - is public. - - - - - Image tags. - - + + + + Name for the image. The name of an image + is not unique to an Image Service node. + The API cannot expect users to know the + names of images owned by others. + + + + + The image ID. + + + + + Image visibility. Public or private. + Default is public. + + + + + Image tags. + + - Successful HTTP - response is 201. Created with a Location header that - contains the newly-created URI for the image. Response - body represents the created image entity. - - - - The location for the image identified by a - URI. - - - + Successful + HTTP response is 201. Created with a Location + header that contains the newly-created URI for the + image. Response body represents the created image + entity. + + + + The location for the image identified by + a URI. + + + @@ -160,38 +162,7 @@ >Appendix B: HTTP PATCH media types. - - - Name for the image. The name of an image is - not unique to a Glance node. The API cannot - expect users to know the names of images owned - by others. - - - - - The image ID. - - - - - Image visibility. Public or private. Default - is public. - - - - - Image tags. - - + + + + Name for the image. The name of an image + is not unique to a Glance node. The API + cannot expect users to know the names of + images owned by others. + + + + + The image ID. + + + + + Image visibility. Public or private. + Default is public. + + + + + Image tags. + + @@ -259,119 +262,124 @@ json-schema, such as self, file, or schema. - - - Use to request a specific page size. Expect - a response to a limited request to return - between zero and limit items. The typical - pattern of limit and marker is to make an - initial limited request and then to use the ID - of the last image from the response as the - marker parameter in a subsequent limited - request. - - - - - Specifies the ID of the last-seen image. The - typical pattern of limit and marker is to make - an initial limited request and then to use the - ID of the last image from the response as the - marker parameter in a subsequent limited - request. - - - - - Filter parameter. Name of the image as a - string. - - - - - Filter parameter. Image visibility. Either - public or private. - - - - - Filter parameter. The image status, such as - queued, saving, active, killed, deleted, and - pending_delete. - - - - - Filter parameter. The minimum size of the - image in bytes. Use the size_min and size_max - parameters to perform greater-than and - less-than filtering of images based on their - size attribute. The size is measured in bytes - and is the size of an image when it is stored - on disk. For example, sending a size_min - filter of 1048576 and size_max of 4194304 - filters the container to include only images - that are between 1 and 4 MBs in size. - - - - - Filter parameter. The maximum size of the - image in bytes. Use the size_min and size_max - parameters to perform greater-than and - less-than filtering of images based on their - size attribute. The size is measured in bytes - and is the size of an image when it is stored - on disk. - - - - - Sort key. You can sort the results by using - the 'sort_key' and 'sort_dir' parameters. All - image attributes can be used as the sort_key - except tags and link attributes. Default is - 'created_at.' The API uses the natural sorting - of whatever image attribute is provided as the - 'sort_key.' - - - - - Sort direction. You can sort the results by - using the 'sort_key' and 'sort_dir' - parameters. Valid values are 'asc' (ascending) - and 'desc' (descending). Default is - 'desc.' - - + + + + Use to request a specific page size. + Expect a response to a limited request to + return between zero and limit items. The + typical pattern of limit and marker is to + make an initial limited request and then + to use the ID of the last image from the + response as the marker parameter in a + subsequent limited request. + + + + + Specifies the ID of the last-seen image. + The typical pattern of limit and marker is + to make an initial limited request and + then to use the ID of the last image from + the response as the marker parameter in a + subsequent limited request. + + + + + Filter parameter. Name of the image as a + string. + + + + + Filter parameter. Image visibility. + Either public or private. + + + + + Filter parameter. The image status, such + as queued, saving, active, killed, + deleted, and pending_delete. + + + + + Filter parameter. The minimum size of + the image in bytes. Use the size_min and + size_max parameters to perform + greater-than and less-than filtering of + images based on their size attribute. The + size is measured in bytes and is the size + of an image when it is stored on disk. For + example, sending a size_min filter of + 1048576 and size_max of 4194304 filters + the container to include only images that + are between 1 and 4 MBs in size. + + + + + Filter parameter. The maximum size of + the image in bytes. Use the size_min and + size_max parameters to perform + greater-than and less-than filtering of + images based on their size attribute. The + size is measured in bytes and is the size + of an image when it is stored on + disk. + + + + + Sort key. You can sort the results by + using the 'sort_key' and 'sort_dir' + parameters. All image attributes can be + used as the sort_key except tags and link + attributes. Default is 'created_at.' The + API uses the natural sorting of whatever + image attribute is provided as the + 'sort_key.' + + + + + Sort direction. You can sort the results + by using the 'sort_key' and 'sort_dir' + parameters. Valid values are 'asc' + (ascending) and 'desc' (descending). + Default is 'desc.' + + + diff --git a/api-ref/src/wadls/image-api/src/v2.0/os-image-schemas-2.0.wadl b/api-ref/src/wadls/image-api/src/v2.0/os-image-schemas-2.0.wadl index 014c04262..066ad05e2 100644 --- a/api-ref/src/wadls/image-api/src/v2.0/os-image-schemas-2.0.wadl +++ b/api-ref/src/wadls/image-api/src/v2.0/os-image-schemas-2.0.wadl @@ -1,5 +1,5 @@ - + diff --git a/api-ref/src/wadls/image-api/src/v2/os-image-schemas-v2.wadl b/api-ref/src/wadls/image-api/src/v2/os-image-schemas-v2.wadl index b2e7c35dd..51712f565 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-image-schemas-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/os-image-schemas-v2.wadl @@ -1,5 +1,5 @@ - + diff --git a/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl b/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl index 4d26fe3c3..cfe33889e 100644 --- a/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl +++ b/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl @@ -32,9 +32,10 @@ - The ID for the tenant or account in a multi-tenancy cloud. @@ -143,22 +144,25 @@ whatever image attribute is provided as the sort_key. - &imageListReqParameters; - &imagesParameter; &statusParameter; - &deleted_atParameter; &nameParameter; &deletedParameter; - &container_formatParameter; &created_atParameter; - &disk_formatParameter; &updated_atParameter; - &min_diskParameter; &protectedParameter; &idParameter; - &min_ramParameter; &check_sumParameter; &ownerParameter; - &is_publicParameter; &virtual_sizeParameter; - &propertiesParameter; + + + &imageListReqParameters; + + + - - + &imagesParameter; &statusParameter; + &deleted_atParameter; &nameParameter; + &deletedParameter; &container_formatParameter; + &created_atParameter; &disk_formatParameter; + &updated_atParameter; &min_diskParameter; + &protectedParameter; &idParameter; &min_ramParameter; + &check_sumParameter; &ownerParameter; + &is_publicParameter; &virtual_sizeParameter; + &propertiesParameter; @@ -166,78 +170,84 @@ title="Create image"> Creates a virtual machine (VM) image. (Since Image API v2.0.) - Created with a Location header that contains the - newly-created URI for the image. Response body - represents the created image entity. + Created with a Location header that + contains the newly-created URI for the image. Response + body represents the created image entity. - - Name for - the image. The name of an image is not unique - to a Image Service node. The API cannot expect - users to know the names of images owned by - others. - - - The image - ID. - - - - Image visibility. Public or private. Default - is public. - - - - - Image tags. - - + + Name for the image. The + name of an image is not unique to a Image + Service node. The API cannot expect users + to know the names of images owned by + others. + + + The image + ID. + + + + Image visibility. Public or private. + Default is public. + + + + + Image tags. + + - &imageParameter; &statusParameter; - &deletedParameter; &container_formatParameter; - &min_ramParameter; &updated_atParameter; &ownerParameter; - &min_diskParameter; &is_publicParameter; - &deleted_atParameter; &idParameter; &sizeParameter; - &virtual_sizeParameter; &nameParameter; - &check_sumParameter; &created_atParameter; - &disk_formatParameter; &propertiesParameter; - &protectedParameter; - - The location for the image identified by a - URI. - - - + - + &imageParameter; &statusParameter; + &deletedParameter; &container_formatParameter; + &min_ramParameter; &updated_atParameter; + &ownerParameter; &min_diskParameter; + &is_publicParameter; &deleted_atParameter; + &idParameter; &sizeParameter; &virtual_sizeParameter; + &nameParameter; &check_sumParameter; + &created_atParameter; &disk_formatParameter; + &propertiesParameter; &protectedParameter; @@ -267,13 +277,12 @@ OpenStack Image Service API v2 Reference. - &image_idParameter; + + - - + &image_idParameter; @@ -292,7 +301,10 @@ (Since Image API v2.0.) Response body is a single image entity. - &image_idParameter; + + + &image_idParameter; + - &image_idParameter; + + + &image_idParameter; + @@ -336,7 +351,10 @@ @/home/glance/ubuntu-12.10.qcow2 $image_url/v2/images/{image_id}/file - &image_idParameter; + + + &image_idParameter; + @@ -358,7 +376,10 @@ If no image data exists, returns the HTTP 204 status code. - &image_idParameter; + + &image_idParameter; + @@ -368,7 +389,10 @@ Adds a specified tag to a specified image. (Since Image API v2.0.) - &image_idParameter; &tagParameter; + + &image_idParameter; &tagParameter; + @@ -377,7 +401,10 @@ Deletes a specified tag from a specified image. (Since Image API v2.0.) - &image_idParameter; &tagParameter; + + + &image_idParameter; &tagParameter; + @@ -388,7 +415,11 @@ Response body is a single image member entity. (Since Image API 2.2.) - &image_idParameter; &member_idParameter; + + + &image_idParameter; &member_idParameter; + + - &image_idParameter; + + &image_idParameter; + Adds a specified tenant ID as an image member. (Since Image API v2.1.) - &image_idParameter; + + - - + &image_idParameter; @@ -459,14 +492,14 @@ specified member of the specified image. (Since Image API v2.1.) - &image_idParameter; &member_idParameter; - + + - + &image_idParameter; &member_idParameter; @@ -487,7 +520,11 @@ the member list of the specified image. (Since Image API v2.1.) - &image_idParameter; &member_idParameter; + + + &image_idParameter; + &member_idParameter; + diff --git a/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl b/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl index 901ed3bdb..e0fefca17 100644 --- a/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl +++ b/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl @@ -215,70 +215,73 @@ Lists active stacks. - - - Filters the stack list by the specified - status. You can use this filter multiple times - to filter by multiple statuses. - - - - - Filters the stack list by the specified - name. - - - - - Limits the number of stacks that appear on a - page to this value. The typical pattern of - limit and marker is to make an initial limited - request and then to use the ID of the last - stack from the response as the marker - parameter in a subsequent limited - request. - - - - - Specifies the ID of the last-seen stack. The - typical pattern of limit and marker is to make - an initial limited request and then to use the - ID of the last stack from the response as the - marker parameter in a subsequent limited - request. - - - - - Sorts the stack list by one of these - attributes: name, - status, - created_at, or - updated_at. - - - - - The sort direction of the stack list. Either - asc (ascending) or - desc (descending). - - + + + + Filters the stack list by the specified + status. You can use this filter multiple + times to filter by multiple + statuses. + + + + + Filters the stack list by the specified + name. + + + + + Limits the number of stacks that appear + on a page to this value. The typical + pattern of limit and marker is to make an + initial limited request and then to use + the ID of the last stack from the response + as the marker parameter in a subsequent + limited request. + + + + + Specifies the ID of the last-seen stack. + The typical pattern of limit and marker is + to make an initial limited request and + then to use the ID of the last stack from + the response as the marker parameter in a + subsequent limited request. + + + + + Sorts the stack list by one of these + attributes: name, + status, + created_at, or + updated_at. + + + + + The sort direction of the stack list. + Either asc (ascending) or + desc (descending). + + + - - - - - + + + + + @@ -287,61 +290,6 @@ Creates a stack. - - - The name of the stack to create. - - - - The URL of the template to - instantiate. This value is ignored if the - template is supplied inline. - - - A JSON template to - instantiate. This value takes precedence over - the template URL if both are - supplied. - - - A JSON environment for the - stack. - - - A map of file names (Provider - resource templates, as referenced in the - environment) to JSON template - bodies. - - - User-defined parameter names - to pass to the template. - - - User-defined parameter values - to pass to the template. - - - The timeout for stack creation - in minutes. - - - Controls whether a failure - during stack creation causes deletion of all - previously-created resources in that stack. - The default is True; a failure does not cause - deletions. - @@ -350,12 +298,76 @@ - - - - - + + + + + + + The name of the stack to create. + + + + The URL of the template to + instantiate. This value is ignored if the + template is supplied + inline. + + + A JSON template to + instantiate. This value takes precedence + over the template URL if both are + supplied. + + + A JSON environment for the + stack. + + + A map of file names + (Provider resource templates, as + referenced in the environment) to JSON + template bodies. + + + User-defined parameter + names to pass to the + template. + + + User-defined parameter + values to pass to the + template. + + + The timeout for stack + creation in minutes. + + + Controls whether a failure + during stack creation causes deletion of + all previously-created resources in that + stack. The default is True; a failure does + not cause deletions. + + @@ -364,82 +376,89 @@ Previews a stack. - - - The name of the stack to preview. - - - - - The URL of the template to instantiate. This - value is ignored if the template is supplied - inline. - - - - - A JSON template to instantiate. This value - takes precedence over the template URL if both - are supplied. - - - - - A JSON environment for the stack. - - - - - A map of file names (Provider resource - templates, as referenced in the environment) - to JSON template bodies. - - - - - User-defined parameter names to pass to the - template. - - - - - User-defined parameter values to pass to the - template. - - - - - The timeout for stack creation in minutes. - During a stack preview, this value is only - used as part of stack validation. - - - - - Controls whether a failure during stack - creation causes deletion of all - previously-created resources in that stack. - The default is True; a failure does not cause - deletions. During a stack preview, this value - is only used as part of stack validation. - - - + + + The name of the stack to preview. + + + + + The URL of the template to instantiate. + This value is ignored if the template is + supplied inline. + + + + + A JSON template to instantiate. This + value takes precedence over the template + URL if both are supplied. + + + + + A JSON environment for the stack. + + + + + A map of file names (Provider resource + templates, as referenced in the + environment) to JSON template + bodies. + + + + + User-defined parameter names to pass to + the template. + + + + + User-defined parameter values to pass to + the template. + + + + + The timeout for stack creation in + minutes. During a stack preview, this + value is only used as part of stack + validation. + + + + + Controls whether a failure during stack + creation causes deletion of all + previously-created resources in that + stack. The default is True; a failure does + not cause deletions. During a stack + preview, this value is only used as part + of stack validation. + + @@ -458,83 +477,91 @@ resources. - - - A name for the new stack. - - - - URL of the template to - instantiate. This value is ignored if the - template is supplied inline. - - - A JSON template to - instantiate. This value takes precedence over - the template URL if both are - supplied. - - - A JSON environment for the - stack. - - - A map of file names (Provider - resource templates, as referenced in the - environment) for JSON template - bodies. - - - User-defined parameter names - to pass to the template. - - - User-defined parameter values - to pass to the template. - - - The timeout for stack creation - in minutes. - - - Existing resources data to - adopt a stack. Data returned by abandon stack - could be provided as - adopt_stack_data. - - - Enables or disables deletion - of all stack resources when a stack creation - fails. Default is True; all resources are not - deleted when stack creation - fails. - + + + A name for the new stack. + + + + URL of the template to + instantiate. This value is ignored if the + template is supplied + inline. + + + A JSON template to + instantiate. This value takes precedence + over the template URL if both are + supplied. + + + A JSON environment for the + stack. + + + A map of file names + (Provider resource templates, as + referenced in the environment) for JSON + template bodies. + + + User-defined parameter + names to pass to the + template. + + + User-defined parameter + values to pass to the + template. + + + The timeout for stack + creation in minutes. + + + Existing resources data to + adopt a stack. Data returned by abandon + stack could be provided as + adopt_stack_data. + + + Enables or disables + deletion of all stack resources when a + stack creation fails. Default is True; all + resources are not deleted when stack + creation fails. + - - - - - + + + + + @@ -543,18 +570,18 @@ Suspends a stack. - - Specify the - suspend action in the request - body. - + + Specify the + suspend action in the + request body. + @@ -565,18 +592,18 @@ Resumes a suspended stack. - - Specify the - resume action in the request - body. - + + Specify the + resume action in the + request body. + @@ -599,8 +626,7 @@ - + @@ -615,8 +641,7 @@ - + @@ -635,51 +660,59 @@ Updates a specified stack. - - The URL of the template to - instantiate. This value is ignored if the - template is supplied inline. - - - A JSON template to - instantiate. This value takes precedence over - the template URL if both are - supplied. - - - A JSON environment for the - stack. - - - A map of file names (Provider - resource templates, as referenced in the - environment) to JSON template - bodies. - - - User-defined parameter names - to pass to the template. - - - User-defined parameter values - to pass to the template. - - - The timeout for stack creation - in minutes. - + + The URL of the template to + instantiate. This value is ignored if the + template is supplied + inline. + + + A JSON template to + instantiate. This value takes precedence + over the template URL if both are + supplied. + + + A JSON environment for the + stack. + + + A map of file names + (Provider resource templates, as + referenced in the environment) to JSON + template bodies. + + + User-defined parameter + names to pass to the + template. + + + User-defined parameter + values to pass to the + template. + + + The timeout for stack + creation in minutes. + @@ -723,7 +756,6 @@ - @@ -731,25 +763,27 @@ template. - - The URL of the template to - instantiate. This value is ignored if the - template is supplied inline. - - - A JSON template to - instantiate. This value takes precedence over - the template URL if both are - supplied. - + + The URL of the template to + instantiate. This value is ignored if the + template is supplied + inline. + + + A JSON template to + instantiate. This value takes precedence + over the template URL if both are + supplied. + @@ -762,7 +796,6 @@ - @@ -778,7 +811,6 @@ - @@ -787,7 +819,6 @@ - @@ -873,59 +904,61 @@ configuration. - - - Configuration script or manifest that - defines which configuration is - performed. - - - - - Namespace that groups this software - configuration by when it is delivered to a - server. This setting might imply which - configuration tool performs the - configuration. - - - - - The name of the configuration to - create. - - - - - Schema that represents the inputs that this - software configuration expects. - - - - - Schema that represents the outputs that this - software configuration produces. - - - - - Map containing options specific to the - configuration management tool used by this - resource. - - + + + Configuration script or manifest that + defines which configuration is + performed. + + + + + Namespace that groups this software + configuration by when it is delivered to a + server. This setting might imply which + configuration tool performs the + configuration. + + + + + The name of the configuration to + create. + + + + + Schema that represents the inputs that + this software configuration + expects. + + + + + Schema that represents the outputs that + this software configuration + produces. + + + + + Map containing options specific to the + configuration management tool used by this + resource. + + @@ -1002,58 +1035,60 @@ deployment. - - - The ID of the software configuration - resource that runs when applying to the - server. - - - - - The ID of the compute server to which the - configuration applies. - - - - - The current stack action that triggers this - deployment resource. - - - - - Authentication project ID which can also - perform operations on this deployment. - - - - - Current status of the deployment, expected - to be one of IN_PROGRESS, COMPLETE or - FAILED. - - - - - Reason for the last status change, which - will be an error description for status - FAILED. - - + + + The ID of the software configuration + resource that runs when applying to the + server. + + + + + The ID of the compute server to which + the configuration applies. + + + + + The current stack action that triggers + this deployment resource. + + + + + Authentication project ID which can also + perform operations on this + deployment. + + + + + Current status of the deployment, + expected to be one of IN_PROGRESS, + COMPLETE or FAILED. + + + + + Reason for the last status change, which + will be an error description for status + FAILED. + + @@ -1088,53 +1123,56 @@ deployment. - - - ID of the software configuration resource to - run when applying to the server. This ID might - not be the same configuration ID with which - the deployment was created because ephemeral - configurations are created throughout the life - cycle of the deployment. - - - - - Current stack action this deployment - resource is being triggered in. - - - - - Current status of the deployment, expected - to be one of IN_PROGRESS, COMPLETE or - FAILED. - - - - - Reason for the last status change, which - will be an error description for status - FAILED. - - - - - Map of output values for the deployment, as - signalled from the server. - - + + + ID of the software configuration + resource to run when applying to the + server. This ID might not be the same + configuration ID with which the deployment + was created because ephemeral + configurations are created throughout the + life cycle of the deployment. + + + + + Current stack action this deployment + resource is being triggered in. + + + + + Current status of the deployment, + expected to be one of IN_PROGRESS, + COMPLETE or FAILED. + + + + + Reason for the last status change, which + will be an error description for status + FAILED. + + + + + Map of output values for the deployment, + as signalled from the server. + + diff --git a/api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl b/api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl index 308633730..562e992d3 100644 --- a/api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl +++ b/api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl @@ -64,14 +64,16 @@ resources. - - - Filter rules for the resources to be - returned. - - + + + + Filter rules for the resources to be + returned. + + + @@ -95,13 +97,15 @@ resource. - - - The UUID of the resource. - - + + + + The UUID of the resource. + + + @@ -125,14 +129,16 @@ recorded so far. - - - Filter rules for the meters to be - returned. - - + + + + Filter rules for the meters to be + returned. + + + @@ -156,21 +162,24 @@ meter. - - - Filter rules for the data to be - returned. - - - - - Maximum number of samples to return. - - + + + + Filter rules for the data to be + returned. + + + + + Maximum number of samples to + return. + + + @@ -194,14 +203,16 @@ Telemetry. - - - A list of samples within the request - body. - - + + + + A list of samples within the request + body. + + + @@ -225,30 +236,32 @@ samples in a specified time range. - - - Filter rules for the data to be - returned. - - - - - Fields for group by aggregation - - - - - Returned result will be an array of - statistics for a period long of that number of - seconds. - - + + + + Filter rules for the data to be + returned. + + + + + Fields for group by aggregation + + + + + Returned result will be an array of + statistics for a period long of that + number of seconds. + + + @@ -273,14 +286,16 @@ specified query. - - - Filter rules for the alarms to be - returned. - - + + + + Filter rules for the alarms to be + returned. + + + @@ -303,13 +318,16 @@ Creates an alarm. - - - a alarm within the request body. - - + + + + a alarm within the request body. + + + @@ -332,7 +350,6 @@ Shows information for a specified alarm. - Updates a specified alarm. - - - a alarm within the request body. - - + + + + a alarm within the request body. + + + @@ -384,14 +404,16 @@ specified alarm. - - - Filter rules for the changes to be - described. - - + + + + Filter rules for the changes to be + described. + + + @@ -402,16 +424,18 @@ alarm. - - - An alarm state within the request body. - Valid values are ok, - alarm, or insufficient - data. - - + + + + An alarm state within the request body. + Valid values are ok, + alarm, or + insufficient data. + + + @@ -429,7 +453,6 @@ xmlns="http://docbook.org/ns/docbook"> Deletes a specified alarm. - diff --git a/api-ref/src/wadls/volume-api/src/v1/os-quota-sets.wadl b/api-ref/src/wadls/volume-api/src/v1/os-quota-sets.wadl index 230d676b4..7dfe898c8 100644 --- a/api-ref/src/wadls/volume-api/src/v1/os-quota-sets.wadl +++ b/api-ref/src/wadls/volume-api/src/v1/os-quota-sets.wadl @@ -4,11 +4,13 @@ %common;]> - - + + @@ -17,8 +19,10 @@ The ID for the tenant or project in a multi-tenancy cloud. - - + + - + - + Gets default quotas for a tenant. - "aSetsRespParameters; - + + @@ -112,8 +118,7 @@ - - + "aSetsRespParameters; @@ -121,8 +126,8 @@ title="Show quotas"> Shows quotas for a tenant. - "aSetsRespParameters; - + + - - + "aSetsRespParameters; @@ -145,8 +149,8 @@ title="Update quotas"> Updates quotas for a tenant. - "aSetsReqParameters; + + - - + "aSetsReqParameters; - "aSetsRespParameters; - + + - + "aSetsRespParameters; - Deletes quotas for a tenant so the quotas - revert to default values. + Deletes quotas for a tenant so the + quotas revert to default values. @@ -196,8 +199,8 @@ >Enables an admin user to show quotas for a specified tenant and user. - "aSetsRespParameters; - + + @@ -213,7 +216,7 @@ - + "aSetsRespParameters; @@ -223,8 +226,8 @@ Updates quotas for a specified tenant/project and user. - "aSetsReqParameters; + + @@ -240,11 +243,10 @@ - - + "aSetsReqParameters; - "aSetsRespParameters; - + + @@ -260,15 +262,14 @@ - - + "aSetsRespParameters; - Deletes quotas for a user so that the quotas - revert to default values. + Deletes quotas for a user so that + the quotas revert to default values. @@ -279,127 +280,6 @@ user. - - A quota_set - object. - - - A cores - object. - - - A fixed_ips - object. - - - A floating_ips - object. - - - The ID for the quota - set. - - - An - injected_file_content_bytes - object. - - - An - injected_file_path_bytes - object. - - - An injected_files - object. - - - An instances - object. - - - A key_pairs - object. - - - A metadata_items - object. - - - A ram object. - - - A - security_group_rules object. - - - A security_groups - object. - - - - The number of items in - use. - - - The number of items permitted - for this tenant. - - - - The number of reserved - items. - + + A quota_set + object. + + + A cores + object. + + + A fixed_ips + object. + + + A floating_ips + object. + + + The ID for the quota + set. + + + An + injected_file_content_bytes + object. + + + An + injected_file_path_bytes + object. + + + An injected_files + object. + + + An instances + object. + + + A key_pairs + object. + + + A metadata_items + object. + + + A ram + object. + + + A + security_group_rules + object. + + + A + security_groups object. + + + + The number of items in + use. + + + The number of items + permitted for this + tenant. + + + + The number of reserved + items. + diff --git a/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl b/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl index 3a976b03e..c7abbe3ec 100644 --- a/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl +++ b/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl @@ -4,7 +4,7 @@ %common;]> @@ -157,14 +157,7 @@ Creates a volume. - - - A partial representation of a volume used in - the creation process. - - + @@ -177,6 +170,14 @@ + + + A partial representation of a volume + used in the creation process. + + @@ -320,14 +321,7 @@ Creates a snapshot. - - - A partial representation of a snapshot used - in the creation process. - - + @@ -341,6 +335,14 @@ + + + A partial representation of a snapshot + used in the creation process. + + @@ -363,7 +365,7 @@ Lists simple snapshot entities. - + @@ -467,24 +469,7 @@ specified snapshot. - - - One or more metadata key and value pairs to - set or unset for the snapshot. - To unset a metadata key value, specify only - the key name. - To set a metadata key value, specify the key - and value pair. - The Block Storage server does not respect - case-sensitive key names. For example, if you - specify both "key": "v1" and - "KEY": "V1", the server sets - and returns only the KEY key and - value pair. - - + @@ -500,6 +485,25 @@ href="api_samples/snapshot_update_metadata_request.json" /> + + + One or more metadata key and value pairs + to set or unset for the snapshot. + To unset a metadata key value, specify + only the key name. + To set a metadata key value, specify the + key and value pair. + The Block Storage server does not + respect case-sensitive key names. For + example, if you specify both "key": + "v1" and "KEY": + "V1", the server sets and + returns only the KEY key and + value pair. + + diff --git a/api-ref/src/wadls/volume-api/src/v2/os-attach.wadl b/api-ref/src/wadls/volume-api/src/v2/os-attach.wadl index 634c14f39..e4a65eb90 100644 --- a/api-ref/src/wadls/volume-api/src/v2/os-attach.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/os-attach.wadl @@ -4,7 +4,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:db="http://docbook.org/ns/docbook" - xmlns:csapi="http://docs.openstack.org/compute/api/v2" + xmlns:csapi="http://docs.openstack.org/api/openstack-block-storage/v1" xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0" xmlns:common="http://docs.openstack.org/common/api/v1.0" xmlns:wadl="http://wadl.dev.java.net/2009/02" @@ -28,7 +28,7 @@ The UUID for the server of - interest to you. + interest to you. - - The interface ID. - + style="template" type="csapi:UUID"> + + The interface ID. + @@ -60,22 +60,6 @@ to attach the port to a server instance. - - - Specify the interfaceAttachment - action in the request body. - - - - - The ID of the port for which you want to - create an interface. - - @@ -91,45 +75,26 @@ href="../api_samples/os-attach-interfaces/attach-interfaces-create-req.xml" /> + + + Specify the + interfaceAttachment + action in the request body. + + + + + The ID of the port for which you want to + create an interface. + + - - - Fixed IP addresses with subnet IDs. - - - - - The MAC address. - - - - - The network ID. - - - - - The port ID. - - - - - The port state. - - @@ -145,6 +110,43 @@ href="../api_samples/os-attach-interfaces/attach-interfaces-create-resp.xml" /> + + + Fixed IP addresses with subnet + IDs. + + + + + The MAC address. + + + + + The network ID. + + + + + The port ID. + + + + + The port state. + + @@ -154,41 +156,6 @@ Lists port interfaces. - - - The port state. - - - - - Fixed IP addresses with subnet IDs. - - - - - The MAC address. - - - - - The network ID. - - - - - The port ID. - - @@ -204,6 +171,42 @@ href="../api_samples/os-attach-interfaces/attach-interfaces-list-resp.xml" /> + + + The port state. + + + + + Fixed IP addresses with subnet + IDs. + + + + + The MAC address. + + + + + The network ID. + + + + + The port ID. + + @@ -233,4 +236,3 @@ - diff --git a/api-ref/src/wadls/volume-api/src/v2/os-limits.wadl b/api-ref/src/wadls/volume-api/src/v2/os-limits.wadl index 5da986961..86dee6835 100644 --- a/api-ref/src/wadls/volume-api/src/v2/os-limits.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/os-limits.wadl @@ -4,7 +4,7 @@ %common;]> Creates a QoS specification. - - - A qos_specs - object. - - - - The name of the QoS - specification. - - - - Specification key and value pairs. - - @@ -113,50 +92,31 @@ + + + A qos_specs + object. + + + + The name of the QoS + specification. + + + + Specification key and value + pairs. + + - - - A qos_specs - object. - - - - A specs - object. - - - - The consumer type. - - - - The name of the QoS - specification. - - - - The generated ID for the QoS - specification. - - - - The QoS specification - links. - @@ -170,6 +130,47 @@ + + + A qos_specs + object. + + + + A specs + object. + + + + The consumer type. + + + + The name of the QoS + specification. + + + + The generated ID for the QoS + specification. + + + + The QoS specification + links. + @@ -181,40 +182,6 @@ specifications. - - - A qos_specs - object. - - - - Specification key and value pairs. - - - - - The consumer type. - - - - The name of the QoS - specification. - - - - The generated ID for the QoS - specification. - @@ -227,6 +194,41 @@ xml:lang="EN"> + + + A qos_specs + object. + + + + Specification key and value + pairs. + + + + + The consumer type. + + + + The name of the QoS + specification. + + + + The generated ID for the QoS + specification. + @@ -238,47 +240,6 @@ specification. - - - A qos_specs - object. - - - - Specification key and value pairs. - - - - - The consumer type. - - - - The name of the QoS - specification. - - - - The generated ID for the QoS - specification. - - - - The QoS specification - links. - @@ -294,6 +255,48 @@ href="api_samples/qos_details_show_response.xml" /> + + + A qos_specs + object. + + + + Specification key and value + pairs. + + + + + The consumer type. + + + + The name of the QoS + specification. + + + + The generated ID for the QoS + specification. + + + + The QoS specification + links. + &commonFaults; @@ -356,20 +359,7 @@ QoS specification. - - - A qos_specs - object. - - - - Specification key and value pairs. - - + @@ -383,6 +373,21 @@ + + + A qos_specs + object. + + + + Specification key and value + pairs. + + @@ -410,19 +415,22 @@ specification. - - - The unique ID of the QoS - specification. - - - - Optional flag that indicates whether to - delete the specified QoS specification even if - it is in-use. - + + + + The unique ID of the QoS + specification. + + + + Optional flag that indicates whether to + delete the specified QoS specification + even if it is in-use. + + diff --git a/api-ref/src/wadls/volume-api/src/v2/os-quota-sets.wadl b/api-ref/src/wadls/volume-api/src/v2/os-quota-sets.wadl index 5779d18ac..4acee8fce 100644 --- a/api-ref/src/wadls/volume-api/src/v2/os-quota-sets.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/os-quota-sets.wadl @@ -4,11 +4,13 @@ %common;]> - - + + @@ -17,8 +19,10 @@ The ID for the tenant or project in a multi-tenancy cloud. - - + + - + - + Gets default quotas for a tenant. - "aSetsRespParameters; - + + @@ -112,8 +118,7 @@ - - + "aSetsRespParameters; @@ -121,8 +126,8 @@ title="Show quotas"> Shows quotas for a tenant. - "aSetsRespParameters; - + + - - + "aSetsRespParameters; @@ -145,8 +149,8 @@ title="Update quotas"> Updates quotas for a tenant. - "aSetsReqParameters; + + - - + "aSetsReqParameters; - "aSetsRespParameters; - + + - - + "aSetsRespParameters; - Deletes quotas for a tenant so the quotas - revert to default values. + Deletes quotas for a tenant so the + quotas revert to default values. @@ -196,8 +198,8 @@ >Enables an admin user to show quotas for a specified tenant and user. - "aSetsRespParameters; - + + @@ -213,8 +215,7 @@ - - + "aSetsRespParameters; @@ -223,8 +224,8 @@ Updates quotas for a specified tenant/project and user. - "aSetsReqParameters; + + @@ -240,11 +241,10 @@ - - + "aSetsReqParameters; - "aSetsRespParameters; - + + @@ -260,15 +260,14 @@ - - + "aSetsRespParameters; - Deletes quotas for a user so that the quotas - revert to default values. + Deletes quotas for a user so that + the quotas revert to default values. @@ -279,127 +278,6 @@ user. - - A quota_set - object. - - - A cores - object. - - - A fixed_ips - object. - - - A floating_ips - object. - - - The ID for the quota - set. - - - An - injected_file_content_bytes - object. - - - An - injected_file_path_bytes - object. - - - An injected_files - object. - - - An instances - object. - - - A key_pairs - object. - - - A metadata_items - object. - - - A ram object. - - - A - security_group_rules object. - - - A security_groups - object. - - - - The number of items in - use. - - - The number of items permitted - for this tenant. - - - - The number of reserved - items. - + + A quota_set + object. + + + A cores + object. + + + A fixed_ips + object. + + + A floating_ips + object. + + + The ID for the quota + set. + + + An + injected_file_content_bytes + object. + + + An + injected_file_path_bytes + object. + + + An injected_files + object. + + + An instances + object. + + + A key_pairs + object. + + + A metadata_items + object. + + + A ram + object. + + + A + security_group_rules + object. + + + A + security_groups object. + + + + The number of items in + use. + + + The number of items + permitted for this + tenant. + + + + The number of reserved + items. + diff --git a/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl index 41abcd308..22cb4b276 100644 --- a/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl @@ -4,7 +4,7 @@ %common;]> @@ -209,77 +209,7 @@ true in the request body. - - - The availability zone. - - - - To create a volume from an existing volume, - specify the ID of the existing - volume. - - - - The volume description. - - - - To create a volume from an existing - snapshot, specify the ID of the existing - volume snapshot. - - - - The size of the volume, in - GBs. - - - - The volume name. - - - - The ID of the image from which you want to - create the volume. Required to create a - bootable volume. - - - - The associated volume - type. - - - - Enables or disables the bootable attribute. - You can boot an instance from a bootable - volume. - - - - One or more metadata key and value pairs to - associate with the volume. - + @@ -295,98 +225,83 @@ + + + The availability zone. + + + + To create a volume from an existing + volume, specify the ID of the existing + volume. + + + + The volume + description. + + + + To create a volume from an existing + snapshot, specify the ID of the existing + volume snapshot. + + + + The size of the volume, in + GBs. + + + + The volume name. + + + + The ID of the image from which you want + to create the volume. Required to create a + bootable volume. + + + + The associated volume + type. + + + + Enables or disables the bootable + attribute. You can boot an instance from a + bootable volume. + + + + One or more metadata key and value pairs + to associate with the + volume. + - - - The volume status. - - - - The volume name. - - - - One or more instance - attachments. - - - - The availability zone. - - - - Enables or disables the bootable attribute. - You can boot an instance from a bootable - volume. - - - - Date and time when the volume was - created. - - - - The volume description. - - - - The associated volume - type. - - - - To create a volume from an existing volume - snapshot, specify the ID of the existing - volume snapshot. - - - - To create a volume from an existing volume, - specify the ID of the existing - volume. - - - - One or more metadata key and value pairs to - associate with the volume. - - - - The volume ID. - - - - The size of the volume, in - GBs. - + @@ -402,6 +317,98 @@ href="api_samples/volume_create_response.xml" /> + + + The volume status. + + + + The volume name. + + + + One or more instance + attachments. + + + + The availability zone. + + + + Enables or disables the bootable + attribute. You can boot an instance from a + bootable volume. + + + + Date and time when the volume was + created. + + + + The volume + description. + + + + The associated volume + type. + + + + To create a volume from an existing + volume snapshot, specify the ID of the + existing volume + snapshot. + + + + To create a volume from an existing + volume, specify the ID of the existing + volume. + + + + One or more metadata key and value pairs + to associate with the + volume. + + + + The volume ID. + + + + The size of the volume, in + GBs. + @@ -486,18 +493,7 @@ Updates a volume. - - A description of the - volume. - - - The name of the - volume. - + @@ -512,6 +508,18 @@ href="api_samples/volume_update_request.json" /> + + A description of the + volume. + + + The name of the + volume. + @@ -597,44 +605,7 @@ volume from the snapshot. - - A partial representation of a - snapshot used in the creation process. - - - - To create a snapshot from an - existing volume, specify the ID of the - existing volume. - - - - [True/False] Indicate whether - to snapshot, even if the volume is attached. - Default==False. - - - - Name of the snapshot. - Default==None. - - - - Description of snapshot. - Default==None. - - @@ -642,6 +613,45 @@ href="api_samples/snapshot_create_request.xml" /> + + A partial representation + of a snapshot used in the creation + process. + + + + To create a snapshot from + an existing volume, specify the ID of the + existing volume. + + + + [True/False] Indicate + whether to snapshot, even if the volume is + attached. Default==False. + + + + + Name of the snapshot. + Default==None. + + + + Description of snapshot. + Default==None. + + - - - Describes the - snapshot. - - - The name of the - snapshot. - + @@ -783,6 +781,18 @@ href="api_samples/snapshot_update_request.json" /> + + Describes the + snapshot. + + + The name of the + snapshot. + @@ -844,23 +854,7 @@ specified snapshot. - - - One or more metadata key and value pairs to - set or unset for the snapshot. - To unset a metadata key value, specify only - the key name. - To set a metadata key value, specify the key - and value pair. - The Block Storage server does not respect - case-sensitive key names. For example, if you - specify both "key": "v1" and - "KEY": "V1", the server sets - and returns only the KEY key and - value pair. - + @@ -876,6 +870,24 @@ href="api_samples/snapshot_update_metadata_request.json" /> + + + One or more metadata key and value pairs + to set or unset for the snapshot. + To unset a metadata key value, specify + only the key name. + To set a metadata key value, specify the + key and value pair. + The Block Storage server does not + respect case-sensitive key names. For + example, if you specify both "key": + "v1" and "KEY": + "V1", the server sets and + returns only the KEY key and + value pair. + diff --git a/api-ref/src/wadls/volume-api/src/v2/volume-backups-api-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/volume-backups-api-v2.wadl index 5f51c7574..66aba0746 100644 --- a/api-ref/src/wadls/volume-api/src/v2/volume-backups-api-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/volume-backups-api-v2.wadl @@ -2,7 +2,7 @@ - - - A backup - object. - - - - The container name or - null. - - - - The backup name. - - - - The backup description or - null. - - - - The ID of the volume that you want to back - up. - @@ -89,34 +55,43 @@ href="api_samples/backup/backup_create_request.json" /> + + + A backup + object. + + + + The container name or + null. + + + + The backup name. + + + + The backup description or + null. + + + + The ID of the volume that you want to + back up. + - - - A backup - object. - - - - The ID of the backup. - - - - Links for the backup. - - - - The backup name. - @@ -124,6 +99,31 @@ href="api_samples/backup/backup_create_response.json" /> + + + A backup + object. + + + + The ID of the backup. + + + + Links for the backup. + + + + The backup name. + @@ -135,31 +135,7 @@ has access. - - - A backups - object. - - - - The ID of the backup. - - - - Links for the backup. - - - - The backup name. - + @@ -167,6 +143,31 @@ href="api_samples/backup/backup_list_simple_response.json" /> + + + A backups + object. + + + + The ID of the backup. + + + + Links for the backup. + + + + The backup name. + @@ -178,93 +179,6 @@ who submits the request has access. - - - A backups - object. - - - - The availability zone. - - - - The container name or - null. - - - - The date and time when the backup was - created. - - - - The backup description or - null. - - - - If the backup failed, the reason for the - failure. Otherwise, null. - - - - The ID of the backup. - - - - Links for the backup. - - - - The backup name. - - - - The number of objects in the - backup. - - - - The size of the backup, in - GB. - - - - The backup status, such as - available. - - - - The ID of the volume from which the backup - was created. - @@ -272,6 +186,94 @@ href="api_samples/backup/backup_list_detail_response.json" /> + + + A backups + object. + + + + The availability zone. + + + + The container name or + null. + + + + The date and time when the backup was + created. + + + + The backup description or + null. + + + + If the backup failed, the reason for the + failure. Otherwise, + null. + + + + The ID of the backup. + + + + Links for the backup. + + + + The backup name. + + + + The number of objects in the + backup. + + + + The size of the backup, in + GB. + + + + The backup status, such as + available. + + + + The ID of the volume from which the + backup was created. + @@ -282,93 +284,6 @@ backup. - - - A backup - object. - - - - The availability zone. - - - - The container name or - null. - - - - The date and time when the backup was - created. - - - - The backup description or - null. - - - - If the backup failed, the reason for the - failure. Otherwise, null. - - - - The ID of the backup. - - - - Links for the backup. - - - - The backup name. - - - - The number of objects in the - backup. - - - - The size of the backup, in - GB. - - - - The backup status, such as - available. - - - - The ID of the volume from which the backup - was created. - @@ -376,6 +291,94 @@ href="api_samples/backup/backup_show_response.json" /> + + + A backup + object. + + + + The availability zone. + + + + The container name or + null. + + + + The date and time when the backup was + created. + + + + The backup description or + null. + + + + If the backup failed, the reason for the + failure. Otherwise, + null. + + + + The ID of the backup. + + + + Links for the backup. + + + + The backup name. + + + + The number of objects in the + backup. + + + + The size of the backup, in + GB. + + + + The backup status, such as + available. + + + + The ID of the volume from which the + backup was created. + @@ -393,20 +396,6 @@ an existing or new Block Storage volume. - - The restore - action. - - - - The ID of the volume to which - you want to restore a backup. - - @@ -414,29 +403,23 @@ href="api_samples/backup/backup_restore_request.json" /> + + The restore + action. + + + + The ID of the volume to + which you want to restore a backup. + + - - The restore - action. - - - - The ID of the backup. - - - - The ID of the volume to which - the backup was restored. - - @@ -444,6 +427,27 @@ href="api_samples/backup/backup_restore_response.json" /> + + The restore + action. + + + + The ID of the + backup. + + + + The ID of the volume to + which the backup was restored. + +