From 1e7481c92caedf0f02cccd73c74bc67f92c26a6f Mon Sep 17 00:00:00 2001
From: Florent Flament <florent.flament-ext@cloudwatt.com>
Date: Fri, 20 Dec 2013 13:24:03 +0000
Subject: [PATCH] Documents keystone v3 API usage - part 1

docs/source/using-api.rst documents how to use the V2 API. This patch
starts the equivalent documentation (using-api-v3.rst) about how to
use Keystone v3 API. Introduction and Authentication sections have
been written.

Change-Id: I5a2d45d80ba712492717a75ac5901f5ca775daa4
Partial-Bug: #1260527
---
 doc/source/using-api-v3.rst | 110 ++++++++++++++++++++++++++++++++++++
 1 file changed, 110 insertions(+)
 create mode 100644 doc/source/using-api-v3.rst

diff --git a/doc/source/using-api-v3.rst b/doc/source/using-api-v3.rst
new file mode 100644
index 000000000..a842f634d
--- /dev/null
+++ b/doc/source/using-api-v3.rst
@@ -0,0 +1,110 @@
+=================
+The Client v3 API
+=================
+
+Introduction
+============
+
+The main concepts in the Identity v3 API are:
+
+ * credentials
+ * domains
+ * endpoints
+ * groups
+ * policies
+ * projects
+ * roles
+ * services
+ * trusts
+ * users
+
+The ``keystoneclient.v3.client`` API lets you query and make changes
+through ``managers``. For example, to manipulate a project (formerly
+called tenant), you interact with a
+``keystoneclient.v3.projects.ProjectManager`` object.
+
+You obtain access to managers through attributes of a
+``keystoneclient.v3.client.Client`` object. For example, the
+``projects`` attribute of a ``Client`` object is a projects manager::
+
+    >>> from keystoneclient.v3 import client
+    >>> keystone = client.Client(...)
+    >>> keystone.projects.list() # List projects
+
+While it is possible to instantiate a
+``keystoneclient.v3.client.Client`` object (as done above for
+clarity), the recommended approach is to use the discovery mechanism
+provided by the ``keystone.client.Client`` class. The appropriate
+class will be instantiated depending on the API versions available::
+
+    >>> from keystoneclient import client
+    >>> keystone =
+    ...    client.Client(auth_url='http://localhost:5000', ...)
+    >>> type(keystone)
+    <class 'keystoneclient.v3.client.Client'>
+
+One can force the use of a specific version of the API, either by
+using the ``version`` keyword argument::
+
+    >>> from keystoneclient import client
+    >>> keystone = client.Client(auth_url='http://localhost:5000',
+                                 version=(2,), ...)
+    >>> type(keystone)
+    <class 'keystoneclient.v2_0.client.Client'>
+    >>> keystone = client.Client(auth_url='http://localhost:5000',
+                                 version=(3,), ...)
+    >>> type(keystone)
+    <class 'keystoneclient.v3.client.Client'>
+
+Or by specifying directly the specific API version authentication URL
+as the auth_url keyword argument::
+
+    >>> from keystoneclient import client
+    >>> keystone =
+    ...     client.Client(auth_url='http://localhost:5000/v2.0', ...)
+    >>> type(keystone)
+    <class 'keystoneclient.v2_0.client.Client'>
+    >>> keystone =
+    ...     client.Client(auth_url='http://localhost:5000/v3', ...)
+    >>> type(keystone)
+    <class 'keystoneclient.v3.client.Client'>
+
+Upon successful authentication, a ``keystoneclient.v3.client.Client``
+object is returned (when using the Identity v3 API). Authentication and
+examples of common tasks are provided below.
+
+You can generally expect that when the client needs to propagate an
+exception it will raise an instance of subclass of
+``keystoneclient.exceptions.ClientException``
+
+Authenticating
+==============
+
+You can authenticate against Keystone using a username, a user domain
+name (which will default to 'Default' if it is not specified) and a
+password::
+
+    >>> from keystoneclient import client
+    >>> auth_url = 'http://localhost:5000'
+    >>> username = 'adminUser'
+    >>> user_domain_name = 'Default'
+    >>> password = 'secreetword'
+    >>> keystone = client.Client(auth_url=auth_url, version=(3,),
+    ...                          username=username, password=password,
+    ...                          user_domain_name=user_domain_name)
+
+You may optionally specify a domain or project (along with its project
+domain name), to obtain a scoped token::
+
+    >>> from keystoneclient import client
+    >>> auth_url = 'http://localhost:5000'
+    >>> username = 'adminUser'
+    >>> user_domain_name = 'Default'
+    >>> project_name = 'demo'
+    >>> project_domain_name = 'Default'
+    >>> password = 'secreetword'
+    >>> keystone = client.Client(auth_url=auth_url, version=(3,),
+    ...                          username=username, password=password,
+    ...                          user_domain_name=user_domain_name,
+    ...                          project_name=project_name,
+    ...                          project_domain_name=project_domain_name)