35bc126876
The only information retreived in this change is the storyboard version. Keeping the object broad so additional info can piggy back down the road. Change-Id: I86a2bbdc367b9abb179937d74f4aa5ed937b077e
93 lines
1.7 KiB
ReStructuredText
93 lines
1.7 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
|
|
|
|
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:TasksController
|
|
:webprefix: /v1/tasks
|
|
|
|
Users
|
|
=====
|
|
.. rest-controller:: storyboard.api.v1.users:UsersController
|
|
:webprefix: /v1/users
|
|
|
|
System Info
|
|
===========
|
|
.. rest-controller:: storyboard.api.v1.system_info:SystemInfoController
|
|
:webprefix: /v1/systeminfo
|
|
|
|
############
|
|
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:
|