Skip to content

Backend Routes

Jump to bottom
Ed Herman edited this page Dec 5, 2019 · 4 revisions

HTML

  • GET /StaticPagesController#root

API Endpoints

users

  • GET /api/users returns author-info
  • POST /api/users sign up

session

  • POST /api/session log in
  • DELETE /api/session log out

projects

  • GET api/projects returns a list of projects you are subscribed to
  • GET api/projects/:id returns the project page if you are subscribed
  • POST api/projects creates a new project (and blank todo_lists, messages, and events??!!??)
  • PATCH api/projects/:id edit a project if you are subscribed
  • DELETE api/projects/:id delete a project if you are subscribed

todo_lists

  • GET api/projects/:project_id/todo_lists returns the todo lists in the current project
  • GET api/projects/:project_id/todo_lists/:id returns the todo list,todo-comments and comment-boosts
  • POST api/projects/:project_id/todo_lists creates a new todo list
  • PATCH api/projects/:project_id/todo_lists/:id edit a todo list if you are subscribed
  • DELETE api/projects/:project_id/todo_lists/:id delete a todo list if you are subscribed

todo

  • GET api/projects/:project_id/todo_lists/:list_id/todo/:id returns the todo, its todo-comments, and comment-boosts
  • POST api/projects/:project_id/todo_lists/:list_id/todo/ create a todo
  • PATCH api/projects/:project_id/todo_lists/:list_id/todo/:id edit the todo if you are subscribed
  • DELETE api/projects/:project_id/todo_lists/:list_id/todo/:id deletes the todo if you are subscribed

messages

  • GET api/projects/:project_id/messages returns the messages in the current project
  • GET api/projects/:project_id/messages/:id returns the message, its message-boosts, its message-comments, and comment-boosts
  • POST api/projects/:project_id/messages creates a message
  • PATCH api/projects/:project_id/messages/:id edits the message
  • DELETE api/projects/:project_id/messages/:id deletes the message if you are subscribed

events

  • GET api/projects/:project_id/events returns the events in the current project
  • GET api/projects/:project_id/events/:id returns the event, its event-boosts, its event-comments, and comment-boosts
  • POST api/projects/:project_id/events creates a event
  • PATCH api/projects/:project_id/events/:id edits the event
  • DELETE api/projects/:project_id/events/:id deletes the event if you are subscribed

comments

  • POST api/projects/:project_id/comments creates a comment
  • PATCH api/projects/:project_id/comments/:id edits the comment if you are the comment-author
  • DELETE api/projects/:project_id/comments/:id deletes the comment if you are the comment-author or commented-item-author

boosts

  • POST api/projects/:project_id/boosts creates a boost
  • PATCH api/projects/:project_id/boosts/:id edits the boost if you are the boost-author
  • DELETE api/projects/:project_id/boosts/:id deletes the boost if you are the boost-author
Clone this wiki locally