openstack
/
openstacksdk
Code Issues Proposed changes

Reword the entries in the README a bit 

Wanted to make each section a little better, but also to start to
indicate that legacy clients should really not be your first choice.

Change-Id: I26e08d037c7b28ced22a2a0126693d7e3e779f58
This commit is contained in:
Monty Taylor 2016-06-01 10:51:44 +03:00
parent 7d63f12edd
commit 4f36eca18f
No known key found for this signature in database
GPG Key ID: 3390DB68041A12F0
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.rst
View File

@ -429,9 +429,10 @@ Constructing REST API Clients
-----------------------------
What if you want to make direct REST calls via a Session interface? You're
in luck. The same interface for `make_sdk` is supported for
`make_rest_client` and will return you a keystoneauth Session object that is
mounted on the endpoint for the service you're looking for.
in luck. A similar interface is available as with `openstacksdk` and `shade`.
The main difference is that you need to specify which service you want to
talk to and `make_rest_client` will return you a keystoneauth Session object
that is mounted on the endpoint for the service you're looking for.
.. code-block:: python
@ -445,9 +446,9 @@ mounted on the endpoint for the service you're looking for.
Constructing Legacy Client objects
----------------------------------
If all you want to do is get a Client object from a python-\*client library,
If you want get an old-style Client object from a python-\*client library,
and you want it to do all the normal things related to clouds.yaml, `OS_`
environment variables, a helper function is provided. The following
environment variables, a helper function is also provided. The following
will get you a fully configured `novaclient` instance.
.. code-block:: python