5624266bf5
Change-Id: I1c156dfc6c221b59b9d9364a94654926642b28a8 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
225 lines
4.8 KiB
ReStructuredText
225 lines
4.8 KiB
ReStructuredText
==========
|
|
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
|
|
:webprefix: /v1/projects
|
|
|
|
Project Groups
|
|
==============
|
|
.. rest-controller:: storyboard.api.v1.project_groups:ProjectGroupsController
|
|
:webprefix: /v1/project_groups
|
|
|
|
.. rest-controller:: storyboard.api.v1.project_groups:ProjectsSubcontroller
|
|
:webprefix: /v1/project_groups/<project_group_id>/projects
|
|
|
|
Stories
|
|
=======
|
|
.. rest-controller:: storyboard.api.v1.stories:StoriesController
|
|
:webprefix: /v1/stories
|
|
|
|
.. rest-controller:: storyboard.api.v1.stories:TasksNestedController
|
|
:webprefix: /v1/stories/<story_id>/tasks
|
|
|
|
Comments and Timeline events
|
|
============================
|
|
.. rest-controller:: storyboard.api.v1.timeline:CommentsController
|
|
:webprefix: /v1/stories/<story_id>/comments
|
|
|
|
.. rest-controller:: storyboard.api.v1.timeline:TimeLineEventsController
|
|
:webprefix: /v1/events
|
|
|
|
.. rest-controller:: storyboard.api.v1.timeline:NestedTimeLineEventsController
|
|
:webprefix: /v1/stories/<story_id>/events
|
|
|
|
Tasks
|
|
=====
|
|
.. rest-controller:: storyboard.api.v1.tasks:TasksPrimaryController
|
|
:webprefix: /v1/tasks
|
|
|
|
Branches
|
|
========
|
|
.. rest-controller:: storyboard.api.v1.branches:BranchesController
|
|
:webprefix: /v1/branches
|
|
|
|
Milestones
|
|
==========
|
|
.. rest-controller:: storyboard.api.v1.milestones:MilestonesController
|
|
:webprefix: /v1/milestones
|
|
|
|
Tags
|
|
====
|
|
.. rest-controller:: storyboard.api.v1.tags:TagsController
|
|
:webprefix: /v1/tags
|
|
|
|
Subscriptions
|
|
=============
|
|
.. rest-controller:: storyboard.api.v1.subscriptions:SubscriptionsController
|
|
:webprefix: /v1/subscriptions
|
|
|
|
Users
|
|
=====
|
|
.. rest-controller:: storyboard.api.v1.users:UsersController
|
|
:webprefix: /v1/users
|
|
|
|
Teams
|
|
=====
|
|
.. rest-controller:: storyboard.api.v1.teams:TeamsController
|
|
:webprefix: /v1/teams
|
|
|
|
.. rest-controller:: storyboard.api.v1.teams:UsersSubcontroller
|
|
:webprefix: /v1/teams/<team_id>/users
|
|
|
|
User Preferences
|
|
================
|
|
.. rest-controller:: storyboard.api.v1.user_preferences:UserPreferencesController
|
|
:webprefix: /v1/users/<user_id>/preferences
|
|
|
|
System Info
|
|
===========
|
|
.. rest-controller:: storyboard.api.v1.system_info:SystemInfoController
|
|
:webprefix: /v1/systeminfo
|
|
|
|
User Tokens
|
|
===========
|
|
.. rest-controller:: storyboard.api.v1.user_tokens:UserTokensController
|
|
:webprefix: /v1/users/<user_id>/tokens
|
|
|
|
Worklists
|
|
=========
|
|
.. rest-controller:: storyboard.api.v1.worklists:WorklistsController
|
|
:webprefix: /v1/worklists
|
|
|
|
Filters
|
|
-------
|
|
.. rest-controller:: storyboard.api.v1.worklists:FilterSubcontroller
|
|
:webprefix: /v1/worklists/<worklist_id>/filters
|
|
|
|
Items
|
|
-----
|
|
.. rest-controller:: storyboard.api.v1.worklists:ItemsSubcontroller
|
|
:webprefix: /v1/worklists/<worklist_id>/items
|
|
|
|
Permissions
|
|
-----------
|
|
.. rest-controller:: storyboard.api.v1.worklists:PermissionsController
|
|
:webprefix: /v1/worklists/<worklist_id>/permissions
|
|
|
|
Boards
|
|
======
|
|
.. rest-controller:: storyboard.api.v1.boards:BoardsController
|
|
:webprefix: /v1/boards
|
|
|
|
Permissions
|
|
-----------
|
|
.. rest-controller:: storyboard.api.v1.boards:PermissionsController
|
|
:webprefix: /v1/boards/<board_id>/permissions
|
|
|
|
Due Dates
|
|
=========
|
|
.. rest-controller:: storyboard.api.v1.due_dates:DueDatesController
|
|
:webprefix: /v1/due_dates
|
|
|
|
Permissions
|
|
-----------
|
|
.. rest-controller:: storyboard.api.v1.due_dates:PermissionsController
|
|
:webprefix: /v1/due_dates/<due_date_id>/permissions
|
|
|
|
############
|
|
Object model
|
|
############
|
|
|
|
Story
|
|
=====
|
|
.. autotype:: storyboard.api.v1.wmodels.Story
|
|
:members:
|
|
|
|
|
|
Task
|
|
====
|
|
.. autotype:: storyboard.api.v1.wmodels.Task
|
|
:members:
|
|
|
|
|
|
Project
|
|
=======
|
|
.. autotype:: storyboard.api.v1.wmodels.Project
|
|
:members:
|
|
|
|
|
|
ProjectGroup
|
|
============
|
|
.. autotype:: storyboard.api.v1.wmodels.ProjectGroup
|
|
:members:
|
|
|
|
|
|
Comment
|
|
=======
|
|
.. autotype:: storyboard.api.v1.wmodels.Comment
|
|
:members:
|
|
|
|
|
|
Timeline event
|
|
==============
|
|
.. autotype:: storyboard.api.v1.wmodels.TimeLineEvent
|
|
:members:
|
|
|
|
|
|
Due Date
|
|
========
|
|
.. autotype:: storyboard.api.v1.wmodels.DueDate
|
|
:members:
|
|
|
|
|
|
Board
|
|
=====
|
|
.. autotype:: storyboard.api.v1.wmodels.Board
|
|
:members:
|
|
|
|
|
|
Worklist
|
|
========
|
|
.. autotype:: storyboard.api.v1.wmodels.Worklist
|
|
:members:
|
|
|
|
|
|
WorklistItem
|
|
============
|
|
.. autotype:: storyboard.api.v1.wmodels.WorklistItem
|
|
:members:
|
|
|
|
|
|
WorklistFilter
|
|
==============
|
|
.. autotype:: storyboard.api.v1.wmodels.WorklistFilter
|
|
:members:
|
|
|
|
|
|
FilterCriterion
|
|
===============
|
|
.. autotype:: storyboard.api.v1.wmodels.FilterCriterion
|
|
:members:
|
|
|
|
|
|
User
|
|
====
|
|
.. autotype:: storyboard.api.v1.wmodels.User
|
|
:members:
|
|
|
|
|
|
SystemInfo
|
|
==========
|
|
.. autotype:: storyboard.api.v1.wmodels.SystemInfo
|
|
:members:
|