opendev/storyboard
Code Issues Proposed changes

Add a paragraph instructing api users how to get a token

Browse Source 
First time api users do not know how or where to obtain a user
token. A user has to use the gui to get an initial token to use
the api, including the user token api, which will allow them to
get subsequent tokens.

Change-Id: Ib1696e60be02c17aa1a4020294fc27eb1a57b977
This commit is contained in:
Anita Kuno 2016-07-07 15:59:52 -04:00
parent 5a4da2cf51
commit 25b1dd96fc
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/webapi/v1.rst
View File

@ -6,6 +6,11 @@ V1 Web API
API
###
MY_ACCESS_TOKEN is to be replaced by a token for a given user obtained
from https://my.example.org/#!/profile/tokens initially. The User Tokens
section of the api documentation gives instructions for obtaining
subsequent tokens.
Projects
========
.. rest-controller:: storyboard.api.v1.projects:ProjectsController