Updates to WADLs and samples for the API Ref page for Identity v2.0

bug: #1194997 Change-Id: I9e99fa333cee4af0d047afb63890dfa5f8539718 author: diane fleming
openstack · Jul 11, 2013 · 4011a80 · 4011a80
1 parent d47de7e
commit 4011a80
Show file tree

Hide file tree

Showing 358 changed files with 10,970 additions and 2,662 deletions.
diff --git a/api-ref/src/docbkx/api-ref.xml b/api-ref/src/docbkx/api-ref.xml
@@ -30,48 +30,127 @@
   </info>
   <preface xml:id="Overview">
     <title>OpenStack API Reference</title>
-    <para>Use the following OpenStack APIs in your OpenStack cloud:
-      <link xlink:href="#identity">Identity Service API v2.0</link>, 
-      <link xlink:href="#compute">Compute API v2</link>, 
-      <link xlink:href="#compute-ext">Compute API v2 extensions</link>, 
-      <link xlink:href="#os-images-1.0">Image Service API v1</link>,
-      <link xlink:href="#volumes-api">Block Storage Service API v2</link>, and 
-      <link xlink:href="#os-object-api-1.0">Object Storage API v1</link>. 
-      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. </para>
+    <para>In your OpenStack cloud, you can use the <!--<link
+        xlink:href="#identity-v3">Identity Service API v3</link>, -->
+      <link xlink:href="#identity-v2.0">Identity Service API
+        v2.0</link> and <link xlink:href="#identity-v2.0"
+        >extensions</link>, , <link xlink:href="#identity-admin-v2.0"
+        >Identity Service Admin API v2.0</link>, <link
+        xlink:href="#compute">Compute API v2</link> and <link
+        xlink:href="#compute-ext">extensions</link>, <link
+        xlink:href="#os-images-1.0">Image Service API v1</link>, <link
+        xlink:href="#volumes-api">Block Storage Service API v2</link>,
+      and <link xlink:href="#os-object-api-1.0">Object Storage API
+        v1</link>. You must install the packages for each API
+      separately. After you authenticate through the Identity 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. </para>
     <para>To get started with the APIs, see the <link
         xlink:href="http://docs.openstack.org/api/quick-start/content/"
-          >OpenStack API Quick Start</link>.
-      For detailed information, <link
-        xlink:href="http://docs.openstack.org/api/api-specs.html">read
-        the specifications</link> for each API. </para>
+        >OpenStack API Quick Start</link>. For detailed information,
+        <link xlink:href="http://docs.openstack.org">read the
+        references</link> for each API. </para>
     <para>&nbsp;</para>
   </preface>
-  <chapter xml:id="identity" xlink:href="#identity">
+  <chapter xml:id="identity-v2.0" xlink:href="#identity-v2.0">
     <title>Identity Service API v2.0</title>
     <para>Gets an authentication token that permits access to the
       Compute API for 24 hours.</para>
-    <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
+    <wadl:resources
+      href="../wadls/identity-api/src/v2.0/wadl/identity.wadl"
+      xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+  </chapter>
+  <chapter xml:id="identity-admin-v2.0"
+    xlink:href="#identity-admin-v2.0">
+    <title>Identity Service Admin API v2.0</title>
+    <para>Gets an authentication token that permits access to the
+      Compute API for 24 hours.</para>
+    <wadl:resources
+      href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl"
+      xmlns:wadl="http://wadl.dev.java.net/2009/02">
+      <wadl:resource
+        href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tokenById"/>
       <wadl:resource
-        href="../wadls/identity-api/src/service/identity.wadl#tokens">
-        <wadl:method href="#authenticate"/>
-      </wadl:resource>
+        href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#users"/>
       <wadl:resource
-        href="../wadls/identity-api/src/service/identity.wadl#tenants">
-        <wadl:method href="#listTenants"/>
-      </wadl:resource>
+        href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tenants"
+      />
     </wadl:resources>
   </chapter>
+  <chapter xml:id="identity-v2.0-ext" xlink:href="#identity-v2.0-ext">
+    <title>Identity API v2.0 Extensions</title>
+    <para>Adds capabilities to the core Identity Service v2.0 API.
+      Query the Identity API to list available extensions with a &GET;
+      request to <code>v2.0/extensions</code>.</para>
+    <section xml:id="hp-idm-admin-ext">
+      <title>HP-IDM-serviceId Extended Parameter</title>
+      <wadl:resources
+        href="../wadls/identity-api/src/v2.0/wadl/HP-IDM-admin.wadl"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
+    <section xml:id="os-ksadm-admin-ext">
+      <title>OS-KSADM Admin Extension</title>
+      <wadl:resources
+        href="../wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
+    <section xml:id="os-kscatalog-ext">
+      <title>OS-KSCATALOG Admin Extension</title>
+      <wadl:resources
+        href="../wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
+    <section xml:id="os-ksec2-admin-ext">
+      <title>OS-KSEC2 Admin Extension</title>
+      <wadl:resources
+        href="../wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
+    <section xml:id="os-kss3-admin-ext">
+      <title>OS-KSS3 Admin Extension</title>
+      <wadl:resources
+        href="../wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
+    <section xml:id="os-ksvalidate-ext">
+      <title>OS-KSVALIDATE Admin Extension</title>
+      <wadl:resources
+        href="../wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
+    <section xml:id="rax-grpadm-ext">
+      <title>RAX-GRPADM Admin Extension</title>
+      <wadl:resources
+        href="../wadls/identity-api/src/v2.0/wadl/RAX-GRPADM.wadl"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
+    <section xml:id="rax-ksgrp-admin-ext">
+      <title>RAX-KSGRP Admin Extension</title>
+      <wadl:resources
+        href="../wadls/identity-api/src/v2.0/wadl/RAX-KSGRP-admin.wadl"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
+    <section xml:id="rax-kskey-admin-ext">
+      <title>RAX-KSKEY Admin Extension</title>
+      <wadl:resources
+        href="../wadls/identity-api/src/v2.0/wadl/RAX-KSKEY-admin.wadl"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
+    <section xml:id="rax-ksqa-admin-ext">
+      <title>RAX-KSQA Admin Extension</title>
+      <wadl:resources
+        href="../wadls/identity-api/src/v2.0/wadl/RAX-KSQA-admin.wadl"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
+    </section>
+  </chapter>
   <chapter xml:id="compute">
     <title>Compute API v2</title>
-    <para>Launches virtual machines (VMs) based on the images uploaded
-      to the system. Also, connects to a server instance securely
-      through SSH once it starts and reboots or resizes server
-      instances as needed. API v1.1 is identical to API v2.</para>
+    <para>Launches virtual machines based on the images uploaded to
+      the system. Also, connects to a server instance securely through
+      SSH once it starts and reboots or resizes server instances as
+      needed. API v1.1 is identical to API v2.</para>
     <wadl:resources href="../wadls/compute-api/src/os-compute-2.wadl"
       xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
   </chapter>