From 4f36eca18f30953352e3fea42776e2e49d1db5fe Mon Sep 17 00:00:00 2001 From: Monty Taylor Date: Wed, 1 Jun 2016 10:51:44 +0300 Subject: [PATCH] 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 --- README.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 3d97476b1..a47e98bed 100644 --- a/README.rst +++ b/README.rst @@ -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