Nikita Konovalov 7fa5d07762 Docs for User class fixed
The class was specified with a wrong module.

Change-Id: Ie68633712bff8f340fea019e6d8e8dc2c33fc65a
2014-06-23 14:42:13 +04:00

84 lines
1.5 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
############
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: