opendev/python-storyboardclient
Code Issues Proposed changes

Note importance of using https url instead of http

Browse Source 
Otherwise, the user will get this error:

`AttributeError: 'list' object has no attribute 'iteritems'`

which is rather difficult to track down.

Change-Id: I49f69bb34e38f7dda0e37fad7f50f11c07b71880
This commit is contained in:
Zara 2016-09-05 15:15:12 +00:00
parent 3695e1f312
commit 1b0c01e7b7
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/usage.rst
View File

@ -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()