From 1b0c01e7b72fe4eb2a5f4b79fb273738898dfd90 Mon Sep 17 00:00:00 2001 From: Zara Date: Mon, 5 Sep 2016 15:15:12 +0000 Subject: [PATCH] Note importance of using https url instead of http Otherwise, the user will get this error: `AttributeError: 'list' object has no attribute 'iteritems'` which is rather difficult to track down. Change-Id: I49f69bb34e38f7dda0e37fad7f50f11c07b71880 --- doc/source/usage.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/source/usage.rst b/doc/source/usage.rst index a124052..85499fb 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -5,11 +5,14 @@ Usage To use python-storyboardclient in a project:: from storyboardclient.v1 import client - api_url="http://storyboard-dev.openstack.org/api/v1" + api_url="https://storyboard-dev.openstack.org/api/v1" access_token="$MY_ACCESS_TOKEN" storyboard = client.Client(api_url, access_token) -That will not work with storyboard-dev because of certificates, but that demos the syntax. +That will not work with storyboard-dev at the moment, as storyboard-dev +uses a self-signed certificate-- but it demos the syntax. It is very +important to use https, not http, or you will get weird and wonderful +errors! Some sample commands to get things:: @@ -78,7 +81,7 @@ Longer sample script:: from storyboardclient.v1 import client - storyboard = client.Client(api_url="http://storyboard-dev.openstack.org/api/v1", access_token="$MY_ACCESS_TOKEN") + storyboard = client.Client(api_url="https://storyboard-dev.openstack.org/api/v1", access_token="$MY_ACCESS_TOKEN") stories = storyboard.stories.get_all()