openstack/python-zaqarclient
Code Issues Proposed changes

update doc to Api v2.0

Browse Source 
Make the api v2.0 as the reference now.

Change-Id: I1d7dd4aa75de5d080b45c6fa7c77d56aad59bb21
This commit is contained in:
wangxiyuan 2016-12-19 17:29:26 +08:00
parent 5507161dfa
commit 002a3cf980
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/client.rst
View File

@ -10,9 +10,14 @@ Client
Client Object Reference Client Object Reference
----------------------- -----------------------
This is the reference documentation for the latest, recommended, API version. This is the reference documentation for all API version.
.. Link here older API versions, if any. API v1 and v1.1:
.. autoclass:: zaqarclient.queues.v1.client.Client .. autoclass:: zaqarclient.queues.v1.client.Client
:members: :members:
API v2.0:
.. autoclass:: zaqarclient.queues.v2.client.Client
:members:

10
zaqarclient/queues/client.py
View File

@ -24,7 +24,7 @@ server and a version number::
from zaqarclient.queues import client from zaqarclient.queues import client
cli = client.Client(\'http://zaqar.example.com:8888/\', version=1.1) cli = client.Client(\'http://zaqar.example.com:8888/\', version=2)
which will load the appropriate client based on the specified which will load the appropriate client based on the specified
version. Optionally, you can also supply a config dictionary:: version. Optionally, you can also supply a config dictionary::
@ -32,7 +32,7 @@ version. Optionally, you can also supply a config dictionary::
from zaqarclient.queues import client from zaqarclient.queues import client
cli = client.Client(\'http://zaqar.example.com:8888/\', cli = client.Client(\'http://zaqar.example.com:8888/\',
version=1.1, conf={}) version=2, conf={})
The arguments passed to this function will be passed to the client The arguments passed to this function will be passed to the client
instances as well. instances as well.
@ -42,11 +42,11 @@ lower level API as it has been designed to ease the interaction with
the server and it gives enough control for the most common cases. the server and it gives enough control for the most common cases.
A simple example for accessing an existing queue through a client A simple example for accessing an existing queue through a client
instance - based on the API v1.1 - would look like:: instance - based on the API v2 - would look like::
from zaqarclient.queues import client from zaqarclient.queues import client
cli = client.Client(\'http://zaqar.example.com:8888/\', version=1.1) cli = client.Client(\'http://zaqar.example.com:8888/\', version=2)
queue = cli.queue(\'my_queue\') queue = cli.queue(\'my_queue\')
Through the queue instance will be then possible to access all the Through the queue instance will be then possible to access all the
@ -58,7 +58,7 @@ allows you to also access admin endpoints, for example::
from zaqarclient.queues import client from zaqarclient.queues import client
cli = client.Client(\'http://zaqar.example.com:8888/\', version=1.1) cli = client.Client(\'http://zaqar.example.com:8888/\', version=2)
flavor = cli.flavor(\'tasty\', flavor = cli.flavor(\'tasty\',
pool=\'my-pool-group\', pool=\'my-pool-group\',
auto_create=True) auto_create=True)