134 lines
2.8 KiB
ReStructuredText
134 lines
2.8 KiB
ReStructuredText
==========
|
|
V1 Web API
|
|
==========
|
|
|
|
###
|
|
API
|
|
###
|
|
|
|
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/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
|
|
|
|
############
|
|
Object model
|
|
############
|
|
|
|
Project
|
|
=======
|
|
.. autotype:: storyboard.api.v1.projects.Project
|
|
:members:
|
|
|
|
|
|
Story
|
|
=====
|
|
.. autotype:: storyboard.api.v1.stories.Story
|
|
:members:
|
|
|
|
|
|
Comment
|
|
=======
|
|
.. autotype:: storyboard.api.v1.timeline.Comment
|
|
:members:
|
|
|
|
|
|
Timeline event
|
|
==============
|
|
.. autotype:: storyboard.api.v1.timeline.TimeLineEvent
|
|
:members:
|
|
|
|
|
|
Task
|
|
====
|
|
.. autotype:: storyboard.api.v1.tasks.Task
|
|
:members:
|
|
|
|
|
|
User
|
|
====
|
|
.. autotype:: storyboard.api.v1.users.User
|
|
:members:
|
|
|
|
SystemInfo
|
|
==========
|
|
.. autotype:: storyboard.api.v1.system_info.SystemInfo
|
|
:members:
|