diff --git a/api-ref/pom.xml b/api-ref/pom.xml index fe585e661..8d698f3ea 100644 --- a/api-ref/pom.xml +++ b/api-ref/pom.xml @@ -32,22 +32,144 @@ generate-sources + api-ref.xml, api-ref-identity.xml, + api-ref-compute.xml, api-ref-compute-ext.xml, api-ref-image.xml, + api-ref-networking.xml, api-ref-objectstorage.xml, + api-ref-blockstorage.xml, api-ref-orchestration.xml, + api-ref-telemetry.xml + reviewer false 1 UA-17511903-1 + + + + os-api-ref-blockstorage + + generate-webhelp + + generate-sources + + bk-api-ref-blockstorage.xml + api-ref-blockstorage + + + + os-api-ref-compute + + generate-webhelp + + generate-sources + + bk-api-ref-compute.xml + api-ref-compute + + + + os-api-ref-compute-ext + + generate-webhelp + + generate-sources + + bk-api-ref-compute-ext.xml + api-ref-compute-ext + + + + os-api-ref-identity + + generate-webhelp + + generate-sources + + bk-api-ref-identity.xml + api-ref-identity + + + + os-api-ref-image + + generate-webhelp + + generate-sources + + bk-api-ref-image.xml + api-ref-image + + + + os-api-ref-objectstorage + + generate-webhelp + + generate-sources + + bk-api-ref-objectstorage.xml + api-ref-objectstorage + + + + os-api-ref-networking + + generate-webhelp + + generate-sources + + bk-api-ref-networking.xml + api-ref-networking + + + + os-api-ref-orchestration + + generate-webhelp + + generate-sources + + bk-api-ref-orchestration.xml + api-ref-orchestration + + + + os-api-ref-telemetry + + generate-webhelp + + generate-sources + + bk-api-ref-telemetry.xml + api-ref-telemetry + + + appendix toc,title + article/appendix nop + article toc,title + book toc,title + chapter toc,title + section toc, title + part toc,title + qandadiv toc + qandaset toc + reference toc,title + set toc,title true src/docbkx - api-ref.xml, api-ref-identity.xml, - api-ref-compute.xml, api-ref-image.xml, - api-ref-networking.xml, api-ref-objectstorage.xml, - api-ref-blockstorage.xml, api-ref-orchestration.xml, - api-ref-telemetry.xml - reviewer openstack 1 true diff --git a/api-ref/src/docbkx/api-ref-blockstorage.xml b/api-ref/src/docbkx/api-ref-blockstorage.xml index 543f9263b..38fe7e661 100644 --- a/api-ref/src/docbkx/api-ref-blockstorage.xml +++ b/api-ref/src/docbkx/api-ref-blockstorage.xml @@ -18,9 +18,10 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="api.openstack.org"> + version="5.0-extension RackBook-2.0" + xml:id="api.openstack.org-blockstorage"> - OpenStack Block Storage Service APIs + OpenStack Block Storage APIs 2010-2013 @@ -28,28 +29,5 @@ - - - Block Storage Service API v2.0 - Manages volumes and snapshots for use with the Block Storage - Service API (cinder services). - - + diff --git a/api-ref/src/docbkx/api-ref-compute-ext.xml b/api-ref/src/docbkx/api-ref-compute-ext.xml index 99e320bdf..60fe0e3bd 100644 --- a/api-ref/src/docbkx/api-ref-compute-ext.xml +++ b/api-ref/src/docbkx/api-ref-compute-ext.xml @@ -1,442 +1,20 @@ -GET'>PUT'>POST'>DELETE'>]> - - Compute API v2 Extensions - Adds capabilities to the core Compute API. Use extensions to - add features, MIME types, actions, states, headers, - parameters, and resources to the core API. Query the Compute - API to list available extensions with a &GET; request to - v2/extensions. -
- Server admin actions (action) - Permits administrators to perform actions on a server. - Specify the action in the request body. - - - - - - -
-
- Server diagnostics (diagnostics) - Gets the usage data for a server. - -
-
- Flavor access (flavors) - Creates and gets details for private flavors. Also, - lists, adds and removes tenants' access to private - flavors. - -
-
- Flavors with FlavorDisabled attribute (flavors) - Gets details for a flavor, and lists - details for available flavors. Includes the - OS-FLV-DISABLED:disabled extended attribute. - -
-
- Flavor extra-specs (os-extra-specs) - Lists, creates, and updates the extra-specs or keys for - a flavor. - -
-
- Flavors with rxtx_factor extended attribute - (flavors) - Creates a flavor, gets details for a specified flavor, - and lists details for available flavors. Includes the - rxtx_factor extended attribute, - related to configured bandwidth cap values. - -
-
- Flavors with extended attributes (flavors) - Creates a flavor, gets details for a flavor, and lists - details for available flavors. Includes the - rxtx_factor, - OS-FLV-EXT-DATA:ephemeral, and - swap extended attributes. - -
-
- Flavors create or delete (flavors) - Creates or deletes flavors. - -
-
- Images with size attribute (images) - Lists details for available images or gets details for a - specified image. Includes the - OS-EXT-IMG-SIZE:size extended attribute, - which shows the image size. - -
-
- Images with disk config (images) - Extends images with a diskConfig attribute. - - - -
-
- Limits with project usage (limits) - Extends limits to show the project usage. Shows - information such as RAM or instance quotas usage. - -
-
- Limits with project usage for administrators - (limits) - Extends limits to enable administrators to show the - project usage for a specified customer project ID. Shows - information such as RAM or instance quotas usage. - -
-
- Guest agents (os-agents) - Creates, updates, and deletes guest agents. Use guest - agents to access files on the disk, configure networking, - or run other applications or scripts in the guest while it - runs. This hypervisor-specific extension is not currently - enabled for KVM. Use of guest agents is possible only if - the underlying service provider uses the Xen - driver. - -
-
- Host aggregates (os-aggregates) - Creates and manages host aggregates. An aggregate - assigns metadata to groups of compute nodes. Aggregates - are only visible to the cloud provider. - -
-
- Attach interfaces (os-attach-interfaces) - Creates, lists, and gets details for port - interfaces. - -
-
- Root certificates (os-certificates) - Creates and shows details for a root certificate. - -
-
- Cloudpipe (os-cloudpipe) - Manages virtual VPNs for projects. - -
-
- Coverage reports (os-coverage) - -
-
- Fixed IPs (os-fixed-ips) - Shows data for a specified fixed IP, such as host name, - CIDR, and address. Also, reserves or frees a fixed - IP. - -
-
- Floating IP DNS records (os-floating-ip-dns) - Manages DNS records associated with IP addresses - allocated by the Floating IPs extension. Requests are - dispatched to a DNS driver selected at startup. - -
-
- Floating IP pools (os-floating-ip-pools) - Manages groups of floating IPs. - -
-
- Floating IPs (os-floating-ips) - Assigns and allocates floating IP addresses to instances - that run in an OpenStack cloud. - -
-
- Floating IPs bulk (os-floating-ips-bulk) - Bulk creates, deletes, and lists floating IPs. By - default, the pool is named nova. Use the - os-floating-ip-pools extension to - view available pools. - -
-
- Hosts (os-hosts) - Manages physical hosts. - -
-
- Hypervisors (os-hypervisors) - Displays extra statistical information from the machine - that hosts the hypervisor through the API for the - hypervisor (XenAPI or KVM/libvirt). - -
-
- Server actions (os-instance-actions) - Permits all users to list available actions for a - specified server. Permits administrators to get details - for a specified action for a specified server. - -
-
- Keypairs (os-keypairs) - Generates, imports, and deletes SSH keys. - -
-
- Migrations (os-migrations) - Enables administrative users to fetch in-progress - migrations for a region or a specified cell in a - region. - -
-
- Networks (os-networks) - Shows network information for or deletes networks. Also, - disassociates a network from a project if you use vlan - mode. - -
-
- Quota sets (os-quota-sets) - Permits administrators, depending on policy settings, to - view quotas for a tenant and view and update default - quotas. - -
-
- Security groups (os-security-groups) - Lists, shows information for, creates, and deletes - security groups. - -
-
- Default security group rules - (os-security-group-default-rules) - Lists, shows information for, and creates default - security group rules. - -
-
- Server password (os-server-password) - Retrieves and resets the encrypted admin password set - through metadata service. - -
-
- Manage services (os-services) - Lists, enables, and disables Compute services in all - hosts. - -
-
- Usage reports (os-simple-tenant-usage) - Reports usage statistics on compute and storage - resources. - -
-
- Virtual interfaces (os-virtual-interfaces) - Lists the virtual interfaces for a specified server - instance. - -
-
- Volume extension to Compute (os-volumes, - os-snapshots) - Manages volumes and snapshots for use with the Compute - API. - -
-
- Volume attachments (os-volume_attachments) - Attaches volumes created through the volume API to - server instances. Also, lists volume attachments for a - server instance, gets volume details for a volume - attachment, and deletes a volume attachment. - -
-
- Servers with block device mapping format - (servers) - Creates a server with a block device mapping. - -
-
- Server OS-EXT-IPS-MAC:mac_addr extended attribute - (servers) - Adds OS-EXT-IPS-MAC:mac_addr extended attribute when you - create, show information for, or list servers. - -
-
- Disk Config (servers, images) - Extends servers and images with a diskConfig - attribute. - -
-
- Servers with extended availability zones - (servers) - Shows the instance availability zone for compute nodes - (nova-compute). Internal services appear in their own - internal - availability zone. - -
-
- Servers with disk config (servers) - Extends servers with the diskConfig attribute. - - - -
-
- Server IP type (servers) - Shows the type of the IP addresses assigned to an - instance. Type is either fixed or floating. - -
-
- Server extended attributes (servers) - Shows metadata for servers. - -
-
- Server extended status (servers) - Shows extended status information, vm_state, task_state, - and power_state, in detailed server responses. - -
-
- Servers with scheduler hints (servers) - Creates a server with scheduler hints. - -
-
- Servers multiple create (servers) - Creates one or more servers with an optional reservation - ID. The request and response examples show how to create - multiple servers with or without a reservation ID. - -
- + version="5.0-extension RackBook-2.0" + xml:id="api.openstack.org-compute-ext"> + + OpenStack Compute API extensions + + 2010-2014 + + + + + + + diff --git a/api-ref/src/docbkx/api-ref-compute.xml b/api-ref/src/docbkx/api-ref-compute.xml index d996aec5f..ce862c858 100644 --- a/api-ref/src/docbkx/api-ref-compute.xml +++ b/api-ref/src/docbkx/api-ref-compute.xml @@ -1,21 +1,20 @@ -GET'>PUT'>POST'>DELETE'>]> + + version="5.0-extension RackBook-2.0" + xml:id="api.openstack.org-compute"> - OpenStack Compute APIs and Extensions + OpenStack Compute API - 2010-2013 + 2010-2014 - - + diff --git a/api-ref/src/docbkx/api-ref-identity.xml b/api-ref/src/docbkx/api-ref-identity.xml index 269d3b462..38b56d82f 100644 --- a/api-ref/src/docbkx/api-ref-identity.xml +++ b/api-ref/src/docbkx/api-ref-identity.xml @@ -18,9 +18,10 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="api.openstack.org"> + version="5.0-extension RackBook-2.0" + xml:id="api.openstack.org-identity"> - OpenStack Identity Service APIs + OpenStack Identity Service APIs and extensions 2010-2013 @@ -28,405 +29,9 @@ - - Identity Service API v3 - Gets an authentication token that permits access to the - Compute API for 24 hours. -
- Versions - - - - -
- -
- Tokens - Enables service developers to manage tokens. - - - - - -
- -
- Service catalog - Enables service developers to manage the catalog of - services. - - - - - - -
- -
- Endpoints - Enables service developers to manage endpoints. - - - - - - - -
- -
- Domains - Enables service developers to manage domains. - Domains represent collections of users, groups, and - projects. Each is owned by exactly one domain. Users, however, - can be associated with multiple projects by granting roles to - the user on a project, including projects owned by other - domains. - Each domain defines a namespace where certain API-visible - name attributes exist, which affects whether those names must - be globally unique or unique within that domain. In the - Identity API, the uniqueness of the following attributes is as - follows: - - - Domain Name: - Globally unique across all domains. - - - Role Name: Globally - unique across all domains. - - - User Name: Unique - within the owning domain. - - - Project Name: - Unique within the owning domain. - - - Group Name: Unique - within the owning domain. - - - - - - - - - - - - - - - -
- - -
- Projects - Enables service developers to manage projects. - - - - - - - - - - - - - - - - - - - - - - -
- - -
- Users - Enables service developers to manage users. - - - - - - - - - - -
- - -
- Groups - Enables service developers to manage groups. - - - - - - - - - - - - - - - -
- - -
- Credentials - Enables service developers to manage credentials. - - - - - - - - -
- - -
- Roles - Enables service developers to manage roles. - - - - - - - - - - -
- -
- Policies - Enables service developers to manage policies. - - - - - - - -
- - - Identity Service API v3 extensions - Adds capabilities to the core Identity Service Admin API - v3. - Query the Identity Service API to list available extensions - with a &GET; request to v3/extensions. -
- OS-OAUTH1 extension - Enables users to delegate roles to third-party consumers - through the OAuth 1.0a specification. - A user is an Identity Service API user who delegates its - roles and who authorizes request tokens. A consumer is a - third-party application that uses OAuth to access a protected - resource. An OAuth-derived token enables admin users to act on - behalf of the authorizing user. A request token is a token - that the consumer uses to get authorization from the user and - exchanges with an OAuth verifier for an access token. The - OAuth verifier is a required string that is provided with the - corresponding request token in exchange for an access token. - An access token is a token that the consumer uses to request - Identity Service API tokens on behalf of the authorizing user - instead of using the credentials for the user. - Request and access tokens use token keys to identify - themselves. For OpenStack purposes, the token key is the token - ID. The consumer uses a token secret to establish ownership of - a specified token. Both request and access tokens have token - secrets. - Delegated authentication through OAuth occurs as - follows: - - - A user creates a consumer. - - - The consumer gets an unauthorized request token. Then, - the consumer uses the request token to initiate user - authorization. - - - The user authorizes the request token. - - - The consumer exchanges the authorized request token - and the OAuth verifier for an access token. - The authorizing user receives the request token key - from the consumer out-of-band. - - - The consumer uses the access token to request a - Identity Service API token. - - - -
- - - Identity Service API v2.0 - Gets an authentication token that permits access to the - Compute API for 24 hours. - - - - Identity Service admin API v2.0 - Gets an authentication token that permits access to the - Compute API for 24 hours. - - - - - - - - Identity Service API v2.0 extensions - Adds capabilities to the core Identity Service Admin API - v2.0. - Query the Identity Service API to list available extensions - with a &GET; request to v2.0/extensions. -
- HP-IDM-serviceId extended parameter - -
-
- OS-KSADM admin extension - -
-
- OS-KSCATALOG admin extension - -
-
- OS-KSEC2 admin extension - -
-
- OS-KSS3 admin extension - -
-
- OS-KSVALIDATE admin extension - -
-
- RAX-GRPADM admin extension - -
-
- RAX-KSGRP admin extension - -
-
- RAX-KSKEY admin extension - -
-
- RAX-KSQA admin extension - -
- + + + + + diff --git a/api-ref/src/docbkx/api-ref-image.xml b/api-ref/src/docbkx/api-ref-image.xml index 65e1a3bc0..cb371377c 100644 --- a/api-ref/src/docbkx/api-ref-image.xml +++ b/api-ref/src/docbkx/api-ref-image.xml @@ -18,7 +18,8 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="api.openstack.org"> + version="5.0-extension RackBook-2.0" + xml:id="api.openstack.org-image"> OpenStack Image Service APIs @@ -28,34 +29,6 @@ - - Image Service API v2 - Image Service API v2.0, API v2.1, and API v2.2. -
- Images - Creates, updates, and deletes image metadata records. - Enables users to share images with each other. - Also, uploads and downloads raw image data. - - -
-
- Image Schemas - Gets a JSON-schema document that represents an images or - image entity. - -
- - - Image Service API v1 - Loads images for use at launch time by the Compute API. - Also, assigns metadata to images. Some cloud implementations do - not expose this API and offer pretested images only. - - + + diff --git a/api-ref/src/docbkx/api-ref-networking.xml b/api-ref/src/docbkx/api-ref-networking.xml index b185e3286..674453204 100644 --- a/api-ref/src/docbkx/api-ref-networking.xml +++ b/api-ref/src/docbkx/api-ref-networking.xml @@ -1,26 +1,14 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> + version="5.0-extension RackBook-2.0" + xml:id="api.openstack.org-networking"> - OpenStack Networking APIs and Extensions + OpenStack Networking APIs and extensions 2010-2014 @@ -28,67 +16,6 @@ - - Networking API v2.0 - Provides virtual networking services among devices that are - managed by the OpenStack Compute service. The Networking API - v2.0 combines the API v1.1 functionality with some essential - Internet Protocol Address Management (IPAM) functionality. - Enables users to associate IP address blocks and other network - configuration settings with a neutron network. You can choose a - specific IP address from the block or let neutron choose the - first available IP address. -
- Networks - Lists, shows information for, creates, updates, and - deletes networks. - -
-
- Subnets - Lists, shows information for, creates, updates, and - deletes subnet resources. - -
-
- Ports - Lists, shows information for, creates, updates, and - deletes ports. - -
- - - Networking API v2.0 Extensions -
- Quotas Extension - Lists, shows information for, updates, and resets - quotas. - -
-
- Networks provider extended attributes - -
-
- Ports binding extended attributes - -
-
- Security groups and rules - Creates, modifies, and deletes OpenStack Networking - security groups and rules. - -
- + + diff --git a/api-ref/src/docbkx/api-ref-objectstorage.xml b/api-ref/src/docbkx/api-ref-objectstorage.xml index 88f151f2e..df3c6b1d7 100644 --- a/api-ref/src/docbkx/api-ref-objectstorage.xml +++ b/api-ref/src/docbkx/api-ref-objectstorage.xml @@ -18,7 +18,8 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="api.openstack.org"> + version="5.0-extension RackBook-2.0" + xml:id="api.openstack.org-objectstorage"> OpenStack Object Storage API @@ -28,12 +29,5 @@ - - Object Storage API v1 - Manages the accounts, containers, and objects in the object - storage system. - - + diff --git a/api-ref/src/docbkx/api-ref-orchestration.xml b/api-ref/src/docbkx/api-ref-orchestration.xml index 16d98ee24..d8ea0aa96 100644 --- a/api-ref/src/docbkx/api-ref-orchestration.xml +++ b/api-ref/src/docbkx/api-ref-orchestration.xml @@ -18,7 +18,8 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="api.openstack.org"> + version="5.0-extension RackBook-2.0" + xml:id="api.openstack.org-orchestration"> OpenStack Orchestration API @@ -28,12 +29,5 @@ - - Orchestration API v1.0 - Orchestrates OpenStack services by using a template - language. - - + diff --git a/api-ref/src/docbkx/api-ref-telemetry.xml b/api-ref/src/docbkx/api-ref-telemetry.xml index 9a46bd567..543a1ea15 100644 --- a/api-ref/src/docbkx/api-ref-telemetry.xml +++ b/api-ref/src/docbkx/api-ref-telemetry.xml @@ -5,21 +5,16 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="api.openstack.org"> + version="5.0-extension RackBook-2.0" + xml:id="api.openstack.org-telemetry"> OpenStack Telemetry API - 2013-2013 + 2010-2013 - - Telemetry API v2.0 - Manages all telemetry operations. - - + diff --git a/api-ref/src/docbkx/api-ref.xml b/api-ref/src/docbkx/api-ref.xml index b7302b38f..b6a8ed508 100644 --- a/api-ref/src/docbkx/api-ref.xml +++ b/api-ref/src/docbkx/api-ref.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> - OpenStack APIs + OpenStack API Reference + API Reference + + + + + + + OpenStack Foundation + + 2010-2013 + OpenStack Foundation + OpenStack - + Copyright details are filled in by the template. - - OpenStack API Reference - Use the following OpenStack APIs in your OpenStack - cloud: - - - Identity - Service APIs - - - Compute API and - Extensions - - - Image Service - APIs - - - Block - Storage Service API - - - Networking - API - - - Object - Storage API - - - Orchestration API - - - Telemetry API - - - You must install the packages for each API separately. After - you authenticate through the Identity Service - API, you can use the other APIs and extensions to launch - server instances, create images, assign metadata to instances - and images, create containers and objects, and complete other - actions in your OpenStack cloud. - To get started with the APIs, see the OpenStack API Quick Start. For detailed information, - read the - references for each API. -   - + diff --git a/api-ref/src/docbkx/bk-api-ref-blockstorage.xml b/api-ref/src/docbkx/bk-api-ref-blockstorage.xml new file mode 100644 index 000000000..b56c20123 --- /dev/null +++ b/api-ref/src/docbkx/bk-api-ref-blockstorage.xml @@ -0,0 +1,50 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + + OpenStack Block Storage API v2.0 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2013 + OpenStack Foundation + + OpenStack Block Storage + + + + Copyright details are filled in by the + template. + + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref-compute-ext.xml b/api-ref/src/docbkx/bk-api-ref-compute-ext.xml new file mode 100644 index 000000000..1d638bcbe --- /dev/null +++ b/api-ref/src/docbkx/bk-api-ref-compute-ext.xml @@ -0,0 +1,38 @@ + + + + OpenStack Compute API v2 Extensions Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2014 + OpenStack Foundation + + OpenStack Compute + + + + Copyright details are filled in by the + template. + + + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref-compute.xml b/api-ref/src/docbkx/bk-api-ref-compute.xml new file mode 100644 index 000000000..e0e71173c --- /dev/null +++ b/api-ref/src/docbkx/bk-api-ref-compute.xml @@ -0,0 +1,50 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + + OpenStack Compute API v2 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2014 + OpenStack Foundation + + OpenStack Compute + + + + Copyright details are filled in by the + template. + + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref-identity.xml b/api-ref/src/docbkx/bk-api-ref-identity.xml new file mode 100644 index 000000000..40f86b087 --- /dev/null +++ b/api-ref/src/docbkx/bk-api-ref-identity.xml @@ -0,0 +1,53 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + + OpenStack Identity Service API Reference + Identity Service API Reference + + + + + + + OpenStack Foundation + + + + 2010-2013 + OpenStack Foundation + + OpenStack Identity Service + + + + Copyright details are filled in by the + template. + + + + + + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref-image.xml b/api-ref/src/docbkx/bk-api-ref-image.xml new file mode 100644 index 000000000..fc17595ac --- /dev/null +++ b/api-ref/src/docbkx/bk-api-ref-image.xml @@ -0,0 +1,38 @@ + + + + OpenStack Image Service API v2 and API v1 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2013 + OpenStack Foundation + + OpenStack Image Service + + + + Copyright details are filled in by the + template. + + + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref-networking.xml b/api-ref/src/docbkx/bk-api-ref-networking.xml new file mode 100644 index 000000000..1d27b8d76 --- /dev/null +++ b/api-ref/src/docbkx/bk-api-ref-networking.xml @@ -0,0 +1,41 @@ + + + + OpenStack Networking API v2.0 and Extensions + Reference + + + Networking API Reference + + + + + + + OpenStack Foundation + + + + 2010-2013 + OpenStack Foundation + + OpenStack Networking + + + + Copyright details are filled in by the + template. + + + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref-objectstorage.xml b/api-ref/src/docbkx/bk-api-ref-objectstorage.xml new file mode 100644 index 000000000..dee3d802f --- /dev/null +++ b/api-ref/src/docbkx/bk-api-ref-objectstorage.xml @@ -0,0 +1,37 @@ + + + + OpenStack Object Storage API v1 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2013 + OpenStack Foundation + + OpenStack Object Storage + + + + Copyright details are filled in by the + template. + + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref-orchestration.xml b/api-ref/src/docbkx/bk-api-ref-orchestration.xml new file mode 100644 index 000000000..68c29bc5c --- /dev/null +++ b/api-ref/src/docbkx/bk-api-ref-orchestration.xml @@ -0,0 +1,37 @@ + + + + OpenStack Orchestration API v1.0 Reference + Orchestration API Reference + + + + + + + OpenStack Foundation + + + + 2010-2013 + OpenStack Foundation + + OpenStack Orchestration + + + + Copyright details are filled in by the + template. + + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref-telemetry.xml b/api-ref/src/docbkx/bk-api-ref-telemetry.xml new file mode 100644 index 000000000..59c3e5e89 --- /dev/null +++ b/api-ref/src/docbkx/bk-api-ref-telemetry.xml @@ -0,0 +1,37 @@ + + + + OpenStack Metering API v2.0 Reference + Metering API Reference + + + + + + + OpenStack Foundation + + + + 2010-2013 + OpenStack Foundation + + OpenStack Metering + + + + Copyright details are filled in by the + template. + + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref.xml b/api-ref/src/docbkx/bk-api-ref.xml new file mode 100644 index 000000000..d2940167a --- /dev/null +++ b/api-ref/src/docbkx/bk-api-ref.xml @@ -0,0 +1,51 @@ + + + + OpenStack API Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2013 + OpenStack Foundation + + OpenStack + + + + Copyright details are filled in by the + template. + + + + + + + + + + + + + + + + + + + + diff --git a/api-ref/src/docbkx/ch_blockstorage-api.xml b/api-ref/src/docbkx/ch_blockstorage-api.xml new file mode 100644 index 000000000..daf5e928e --- /dev/null +++ b/api-ref/src/docbkx/ch_blockstorage-api.xml @@ -0,0 +1,78 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Block Storage API v2.0 + Manages volumes and snapshots for use with the Block Storage + API, also known as cinder services. +
+ Volumes + + + + + + + + + + + + + + +
+
+ Volume types + + + + + + + + +
+
+ Snapshots + + + + + + + + + + + + + + +
+ diff --git a/api-ref/src/docbkx/api-ref-compute-core.xml b/api-ref/src/docbkx/ch_compute-core.xml similarity index 91% rename from api-ref/src/docbkx/api-ref-compute-core.xml rename to api-ref/src/docbkx/ch_compute-core.xml index 5bb4d5adb..0bd0e45bb 100644 --- a/api-ref/src/docbkx/api-ref-compute-core.xml +++ b/api-ref/src/docbkx/ch_compute-core.xml @@ -1,19 +1,30 @@ GET'>PUT'>POST'>DELETE'>]> + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + version="5.0-extension RackBook-2.0" xml:id="compute-core-v2"> Compute API v2 Launches virtual machines from images or images stored on persistent volumes. API v1.1 is identical to API v2.
Versions - Get information about a specific version of the + Gets information about a specific version of the API.
- Server Metadata + Server metadata Sets, lists, gets details for, and deletes server metadata or metadata items. @@ -92,7 +103,7 @@
- Server Addresses + Server addresses Lists addresses for a specified server or a specified server and network. @@ -104,7 +115,7 @@
- Server Actions + Server actions Performs actions for a specified server, including change administrator password, reboot, rebuild, resize, and create image from server. @@ -170,7 +181,7 @@
- Image Metadata + Image metadata Sets, lists, gets details for, and deletes image metadata or metadata items. diff --git a/api-ref/src/docbkx/ch_compute-ext.xml b/api-ref/src/docbkx/ch_compute-ext.xml new file mode 100644 index 000000000..25b31bf43 --- /dev/null +++ b/api-ref/src/docbkx/ch_compute-ext.xml @@ -0,0 +1,466 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Compute API v2 extensions + Adds capabilities to the core Compute API. Use extensions to + add features, MIME types, actions, states, headers, + parameters, and resources to the core API. Query the Compute + API to list available extensions with a &GET; request to + v2/extensions. +
+ Server admin actions (action) + Permits administrators to perform actions on a server. + Specify the action in the request body. + +
+
+ Server console output (os-console-output) + Gets console output for a server instance. + +
+
+ Server console (os-consoles) + Gets a console for a server instance. + +
+
+ Server deferred delete (os-deferred-delete) + Force-deletes a server or restores a deleted + server. + +
+
+ Server diagnostics (diagnostics) + Gets the usage data for a server. + +
+
+ Flavor access (flavors) + Creates and gets details for private flavors. Also, + lists, adds and removes tenants' access to private + flavors. + +
+
+ Flavors with FlavorDisabled attribute (flavors) + Gets details for a flavor, and lists details for + available flavors. Includes the + OS-FLV-DISABLED:disabled extended + attribute. + +
+
+ Flavor extra-specs (os-extra-specs) + Lists, creates, and updates the extra-specs or keys for + a flavor. + +
+
+ Flavors with rxtx_factor extended attribute + (flavors) + Creates a flavor, gets details for a specified flavor, + and lists details for available flavors. Includes the + rxtx_factor extended attribute, + related to configured bandwidth cap values. + +
+
+ Flavors with extended attributes (flavors) + Creates a flavor, gets details for a flavor, and lists + details for available flavors. Includes the + rxtx_factor, + OS-FLV-EXT-DATA:ephemeral, and + swap extended attributes. + +
+
+ Flavors create or delete (flavors) + Creates or deletes flavors. + +
+
+ Images with size attribute (images) + Lists details for available images or gets details for a + specified image. Includes the + OS-EXT-IMG-SIZE:size extended attribute, + which shows the image size. + +
+
+ Limits with project usage (limits) + Extends limits to show the project usage. Shows + information such as RAM or instance quotas usage. + +
+
+ Limits with project usage for administrators + (limits) + Extends limits to enable administrators to show the + project usage for a specified customer project ID. Shows + information such as RAM or instance quotas usage. + +
+
+ Guest agents (os-agents) + Creates, updates, and deletes guest agents. Use guest + agents to access files on the disk, configure networking, + or run other applications or scripts in the guest while it + runs. This hypervisor-specific extension is not currently + enabled for KVM. Use of guest agents is possible only if + the underlying service provider uses the Xen + driver. + +
+
+ Host aggregates (os-aggregates) + Creates and manages host aggregates. An aggregate + assigns metadata to groups of compute nodes. Aggregates + are only visible to the cloud provider. + +
+
+ Attach interfaces (os-attach-interfaces) + Creates, lists, and gets details for port + interfaces. + +
+
+ Root certificates (os-certificates) + Creates and shows details for a root certificate. + +
+
+ Cloudpipe (os-cloudpipe) + Manages virtual VPNs for projects. + +
+
+ Coverage reports (os-coverage) + +
+
+ Fixed IPs (os-fixed-ips) + Shows data for a specified fixed IP, such as host name, + CIDR, and address. Also, reserves or frees a fixed + IP. + +
+
+ Floating IP DNS records (os-floating-ip-dns) + Manages DNS records associated with IP addresses + allocated by the Floating IPs extension. Requests are + dispatched to a DNS driver selected at startup. + +
+
+ Floating IP pools (os-floating-ip-pools) + Manages groups of floating IPs. + +
+
+ Floating IPs (os-floating-ips) + Assigns and allocates floating IP addresses to instances + that run in an OpenStack cloud. + +
+
+ Floating IPs bulk (os-floating-ips-bulk) + Bulk creates, deletes, and lists floating IPs. By + default, the pool is named nova. Use the + os-floating-ip-pools extension to + view available pools. + +
+
+ Hosts (os-hosts) + Manages physical hosts. + +
+
+ Hypervisors (os-hypervisors) + Displays extra statistical information from the machine + that hosts the hypervisor through the API for the + hypervisor (XenAPI or KVM/libvirt). + +
+
+ Server actions (os-instance-actions) + Permits all users to list available actions for a + specified server. Permits administrators to get details + for a specified action for a specified server. + +
+
+ Keypairs (os-keypairs) + Generates, imports, and deletes SSH keys. + +
+
+ Migrations (os-migrations) + Enables administrative users to fetch in-progress + migrations for a region or a specified cell in a + region. + +
+
+ Networks (os-networks) + Shows network information for or deletes networks. Also, + disassociates a network from a project if you use vlan + mode. + +
+
+ Quota sets (os-quota-sets) + Permits administrators, depending on policy settings, to + view quotas for a tenant and view and update default + quotas. + +
+
+ Server rescue and unrescue (os-rescue) + Puts a server into rescue mode or unrescues a server in + rescue mode. + +
+
+ Server start and stop (os-server-start-stop) + Starts a stopped server or stops a running + server. + +
+
+ Security groups (os-security-groups) + Lists, shows information for, creates, and deletes + security groups. + +
+
+ Rules for default security group + (os-security-group-default-rules) + Lists, shows information for, and creates default + security group rules. + +
+
+ Server password (os-server-password) + Retrieves and resets the encrypted admin password set + through metadata service. + +
+
+ Manage services (os-services) + Lists, enables, and disables Compute services in all + hosts. + +
+
+ Usage reports (os-simple-tenant-usage) + Reports usage statistics on compute and storage + resources. + +
+
+ Virtual interfaces (os-virtual-interfaces) + Lists the virtual interfaces for a specified server + instance. + +
+
+ Volume extension (os-volumes, os-snapshots) + Manages volumes and snapshots for use with the Compute + API. + +
+
+ Volume attachments (os-volume_attachments) + Attaches volumes created through the volume API to + server instances. Also, lists volume attachments for a + server instance, gets volume details for a volume + attachment, and deletes a volume attachment. + +
+
+ Servers with block device mapping format + (servers) + Creates a server with a block device mapping. + +
+
+ Server OS-EXT-IPS-MAC:mac_addr extended attribute + (servers) + Adds OS-EXT-IPS-MAC:mac_addr extended attribute when you + create, show information for, or list servers. + +
+
+ Configuration drive (servers) + Extends servers and images with a configuration + drive. + +
+
+ Servers with extended availability zones + (servers) + Shows the instance availability zone for compute nodes + (nova-compute). Internal services appear in their own + internal + availability zone. + +
+
+ Servers and images with disk config (servers, + images) + Extends servers with the diskConfig attribute. + +
+
+ Server IP type (servers) + Shows the type of the IP addresses assigned to an + instance. Type is either fixed or floating. + +
+
+ Server extended attributes (servers) + Shows metadata for servers. + +
+
+ Server extended status (servers) + Shows extended status information, vm_state, task_state, + and power_state, in detailed server responses. + +
+
+ Servers with scheduler hints (servers) + Creates a server with scheduler hints. + +
+
+ Servers multiple create (servers) + Creates one or more servers with an optional reservation + ID. The request and response examples show how to create + multiple servers with or without a reservation ID. + +
+ diff --git a/api-ref/src/docbkx/ch_identity-admin-v2.xml b/api-ref/src/docbkx/ch_identity-admin-v2.xml new file mode 100644 index 000000000..25d406d9d --- /dev/null +++ b/api-ref/src/docbkx/ch_identity-admin-v2.xml @@ -0,0 +1,24 @@ + + + Identity Service admin API v2.0 + Gets an authentication token that permits access to the + Compute API for 24 hours. + + + + + + diff --git a/api-ref/src/docbkx/ch_identity-v2-ext.xml b/api-ref/src/docbkx/ch_identity-v2-ext.xml new file mode 100644 index 000000000..756f378fd --- /dev/null +++ b/api-ref/src/docbkx/ch_identity-v2-ext.xml @@ -0,0 +1,88 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Identity Service API v2.0 extensions + Adds capabilities to the core Identity Service Admin API + v2.0. + Query the Identity Service API to list available extensions + with a &GET; request to v2.0/extensions. +
+ HP-IDM-serviceId extended parameter + +
+
+ OS-KSADM admin extension + +
+
+ OS-KSCATALOG admin extension + +
+
+ OS-KSEC2 admin extension + +
+
+ OS-KSS3 admin extension + +
+
+ OS-KSVALIDATE admin extension + +
+
+ RAX-GRPADM admin extension + +
+
+ RAX-KSGRP admin extension + +
+
+ RAX-KSKEY admin extension + +
+
+ RAX-KSQA admin extension + +
+ diff --git a/api-ref/src/docbkx/ch_identity-v2.xml b/api-ref/src/docbkx/ch_identity-v2.xml new file mode 100644 index 000000000..3adf992d3 --- /dev/null +++ b/api-ref/src/docbkx/ch_identity-v2.xml @@ -0,0 +1,29 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Identity Service API v2.0 + Gets an authentication token that permits access to the + Compute API for 24 hours. + + diff --git a/api-ref/src/docbkx/ch_identity-v3-ext.xml b/api-ref/src/docbkx/ch_identity-v3-ext.xml new file mode 100644 index 000000000..160c27c5c --- /dev/null +++ b/api-ref/src/docbkx/ch_identity-v3-ext.xml @@ -0,0 +1,80 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Identity Service API v3 extensions + Adds capabilities to the core Identity Service Admin API + v3. + Query the Identity Service API to list available extensions + with a &GET; request to v3/extensions. +
+ OS-OAUTH1 extension + Enables users to delegate roles to third-party consumers + through the OAuth 1.0a specification. + A user is an Identity Service API user who delegates its + roles and who authorizes request tokens. A consumer is a + third-party application that uses OAuth to access a + protected resource. An OAuth-derived token enables admin + users to act on behalf of the authorizing user. A request + token is a token that the consumer uses to get + authorization from the user and exchanges with an OAuth + verifier for an access token. The OAuth verifier is a + required string that is provided with the corresponding + request token in exchange for an access token. An access + token is a token that the consumer uses to request + Identity Service API tokens on behalf of the authorizing + user instead of using the credentials for the user. + Request and access tokens use token keys to identify + themselves. For OpenStack purposes, the token key is the + token ID. The consumer uses a token secret to establish + ownership of a specified token. Both request and access + tokens have token secrets. + Delegated authentication through OAuth occurs as + follows: + + + A user creates a consumer. + + + The consumer gets an unauthorized request token. + Then, the consumer uses the request token to + initiate user authorization. + + + The user authorizes the request token. + + + The consumer exchanges the authorized request + token and the OAuth verifier for an access + token. + The authorizing user receives the request token + key from the consumer out-of-band. + + + The consumer uses the access token to request a + Identity Service API token. + + + +
+ diff --git a/api-ref/src/docbkx/ch_identity-v3.xml b/api-ref/src/docbkx/ch_identity-v3.xml new file mode 100644 index 000000000..52d7a063b --- /dev/null +++ b/api-ref/src/docbkx/ch_identity-v3.xml @@ -0,0 +1,233 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Identity Service API v3 + Gets an authentication token that permits access to the + Compute API for 24 hours. +
+ Versions + + + + +
+ +
+ Tokens + Enables service developers to manage tokens. + + + + +
+ +
+ Service catalog + Enables service developers to manage the catalog of + services. + + + + + +
+ +
+ Endpoints + Enables service developers to manage endpoints. + + + + + +
+ +
+ Domains + Enables service developers to manage domains. + Domains represent collections of users, groups, and + projects. Each is owned by exactly one domain. Users, + however, can be associated with multiple projects by + granting roles to the user on a project, including + projects owned by other domains. + Each domain defines a namespace where certain + API-visible name attributes exist, which affects whether + those names must be globally unique or unique within that + domain. In the Identity API, the uniqueness of the + following attributes is as follows: + + + Domain Name: + Globally unique across all domains. + + + Role Name: + Globally unique across all domains. + + + User Name: + Unique within the owning domain. + + + Project Name: + Unique within the owning domain. + + + Group Name: + Unique within the owning domain. + + + + + + + + + + + +
+ +
+ Projects + Enables service developers to manage projects. + + + + + + + + + + + + + + +
+ +
+ Users + Enables service developers to manage users. + + + + + + + + +
+ +
+ Groups + Enables service developers to manage groups. + + + + + + + + + + +
+ +
+ Credentials + Enables service developers to manage credentials. + + + + + +
+ +
+ Roles + Enables service developers to manage roles. + + + + + + +
+ +
+ Policies + Enables service developers to manage policies. + + + + + +
+ diff --git a/api-ref/src/docbkx/ch_images-v1.xml b/api-ref/src/docbkx/ch_images-v1.xml new file mode 100644 index 000000000..826ccf049 --- /dev/null +++ b/api-ref/src/docbkx/ch_images-v1.xml @@ -0,0 +1,28 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Image Service API v1 + Loads images for use at launch time by the Compute API. + Also, assigns metadata to images. Some cloud implementations + do not expose this API and offer pretested images only. + + diff --git a/api-ref/src/docbkx/ch_images-v2.xml b/api-ref/src/docbkx/ch_images-v2.xml new file mode 100644 index 000000000..d7551f790 --- /dev/null +++ b/api-ref/src/docbkx/ch_images-v2.xml @@ -0,0 +1,40 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Image Service API v2 + Image Service API v2.0, API v2.1, and API v2.2. +
+ Images + Creates, updates, and deletes image metadata records. + Enables users to share images with each other. Also, + uploads and downloads raw image data. + +
+
+ Image schemas + Gets a JSON-schema document that represents an images or + image entity. + +
+ diff --git a/api-ref/src/docbkx/ch_netconn-ext-v2.xml b/api-ref/src/docbkx/ch_netconn-ext-v2.xml new file mode 100644 index 000000000..d5ef7dee1 --- /dev/null +++ b/api-ref/src/docbkx/ch_netconn-ext-v2.xml @@ -0,0 +1,48 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Networking API v2.0 extensions +
+ Quotas extension + Lists, shows information for, updates, and resets + quotas. + +
+
+ Networks provider extended attributes + +
+
+ Ports binding extended attributes + +
+
+ Security groups and rules + +
+ diff --git a/api-ref/src/docbkx/ch_netconn-v2.xml b/api-ref/src/docbkx/ch_netconn-v2.xml new file mode 100644 index 000000000..bc08ff9e5 --- /dev/null +++ b/api-ref/src/docbkx/ch_netconn-v2.xml @@ -0,0 +1,54 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Networking API v2.0 + Provides virtual networking services among devices that are + managed by the OpenStack Compute service. The Networking API + v2.0 combines the API v1.1 functionality with some essential + Internet Protocol Address Management (IPAM) functionality. + Enables users to associate IP address blocks and other network + configuration settings with a neutron network. You can choose + a specific IP address from the block or let neutron choose the + first available IP address. +
+ Networks + Lists, shows information for, creates, updates, and + deletes networks. + +
+
+ Subnets + Lists, shows information for, creates, updates, and + deletes subnet resources. + +
+
+ Ports + Lists, shows information for, creates, updates, and + deletes ports. + +
+ diff --git a/api-ref/src/docbkx/ch_objectstorage-v1.xml b/api-ref/src/docbkx/ch_objectstorage-v1.xml new file mode 100644 index 000000000..606dee0c9 --- /dev/null +++ b/api-ref/src/docbkx/ch_objectstorage-v1.xml @@ -0,0 +1,28 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Object Storage API v1 + Manages the accounts, containers, and objects in the object + storage system. + + diff --git a/api-ref/src/docbkx/ch_orchestration-v1.xml b/api-ref/src/docbkx/ch_orchestration-v1.xml new file mode 100644 index 000000000..334635143 --- /dev/null +++ b/api-ref/src/docbkx/ch_orchestration-v1.xml @@ -0,0 +1,91 @@ + + + Orchestration API v1.0 + Uses a template language to orchestrate OpenStack + services. +
+ Stacks + + + + + + + + + + + + + + +
+
+ Stack resources + + + + + + + + + + + + + + + + + +
+
+ Stack events + + + + + + + + + + + + + + +
+
+ Templates + + + + + + + + +
+ diff --git a/api-ref/src/docbkx/ch_telemetry-v2.xml b/api-ref/src/docbkx/ch_telemetry-v2.xml new file mode 100644 index 000000000..5e2b928e5 --- /dev/null +++ b/api-ref/src/docbkx/ch_telemetry-v2.xml @@ -0,0 +1,83 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Telemetry API v2.0 + Manages telemetry operations. +
+ Alarms + Lists, creates, gets details for, updates, and deletes + alarms. + + + + + + + + + + + + + + + + + +
+
+ Meters + Gets information for meters. + + + + + + + + + + + + +
+
+ Resources + Gets information for resources. + + + + + + + + +
+ diff --git a/api-ref/src/docbkx/preface.xml b/api-ref/src/docbkx/preface.xml new file mode 100644 index 000000000..d7f9b6c8e --- /dev/null +++ b/api-ref/src/docbkx/preface.xml @@ -0,0 +1,82 @@ + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> +]> + + Preface + Use these OpenStack APIs and extensions in your OpenStack + cloud: + + + Block Storage Service API + + + Compute API + + + Compute API extensions + + + Identity Service API and extensions + + + Image Service API + + + Networking API and extensions + + + Object + Storage API + + + Orchestration API + + + Telemetry API + + + You must install the packages for each API separately. After + you authenticate through the Identity Service API, you can use the other APIs + and extensions to launch server instances, create images, + assign metadata to instances and images, create containers and + objects, and complete other actions in your OpenStack + cloud. + To get started with the APIs, see the OpenStack API Quick Start. +   + diff --git a/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/server-post-req.xml b/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/server-post-req.xml index 0a3c8bb53..04874aa0d 100644 --- a/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/server-post-req.xml +++ b/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/server-post-req.xml @@ -1,19 +1,21 @@ - + Apache1 - ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp - dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k - IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs - c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g - QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo - ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv - dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy - c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6 - b25zLiINCg0KLVJpY2hhcmQgQmFjaA== - + ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp + dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k + IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs + c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g + QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo + ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv + dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy + c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6 + b25zLiINCg0KLVJpY2hhcmQgQmFjaA== - \ No newline at end of file + diff --git a/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/server-post-resp.xml b/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/server-post-resp.xml index d620ed00b..29fc8dc17 100644 --- a/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/server-post-resp.xml +++ b/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/server-post-resp.xml @@ -1,6 +1,12 @@ - + - - - \ No newline at end of file + + + diff --git a/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/vifs-list-resp.xml b/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/vifs-list-resp.xml index d5a587d55..9d7497601 100644 --- a/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/vifs-list-resp.xml +++ b/api-ref/src/wadls/compute-api/src/api_samples/OS-EXT-VIF-NET/vifs-list-resp.xml @@ -1,8 +1,8 @@ + xmlns:OS-EXT-VIF-NET="http://docs.openstack.org/compute/ext/extended-virtual-interfaces-net/api/v1.1" + xmlns="http://docs.openstack.org/compute/api/v1.1"> + mac_address="fa:16:3e:7d:31:9a" + OS-EXT-VIF-NET:net_id="94edf7aa-565a-469a-8f45-656b4acf8230"/> diff --git a/api-ref/src/wadls/compute-api/src/common.ent b/api-ref/src/wadls/compute-api/src/common.ent index a123f8409..f3806ceaa 100644 --- a/api-ref/src/wadls/compute-api/src/common.ent +++ b/api-ref/src/wadls/compute-api/src/common.ent @@ -85,310 +85,606 @@

A time/date stamp for when the image last changed status.

 -

Name of the server in URL format.

 -

Name of the image as a string.

 -

Value of the status of the image so that you can filter on "ACTIVE" for example.

 -

UUID of the image at which you want to set a marker.

 -

Integer value for the limit of values to return.

 -

Value of the type of image, such as BASE, SERVER, or ALL.

 + + + A time/date stamp for when the image last changed status. + + + Name of the server in URL format. + + + Name of the image as a string. + + + Value of the status of the image so that you can filter on "ACTIVE" for example. + + + UUID of the image at which you want to set a marker. + + + Integer value for the limit of values to return. + + + Value of the type of image, such as BASE, SERVER, or ALL.