opendev
/
python-storyboardclient
Code Issues Proposed changes

Merge "Note importance of using https url instead of http"

This commit is contained in:
Jenkins 2016-09-12 10:38:56 +00:00 committed by Gerrit Code Review
parent 9a21d1fa0e 1b0c01e7b7
commit 671732beb5
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()