API Endpoints

Following API Endpoints related to Projects are created in the backend.

Project

URL: /api/project

Methods Allowed: GET, POST, PUT, HEAD, OPTIONS

Usage:

• POST

  params: {
    "project_id": string,
    "project_name": string,
    "description": string,
    "owner": number,
    "current_stage": string
  }
  

• GET

  params: {
    id: number
  }
  

  response: {
    "id": number,
    "project_name": string,
    "project_id": string,
    "collaborators": array<User>,
    "description": string,
    "owner": string,
    "created_on": timestamp,
    "current_stage": string,
    "area_of_issues_open": [
        {
            "Design": array<Issue>,
            "Ideation": array<Issue>,
            "Market": array<Issue>,
            "Tech Stack": array<Issue>,
            "Product Domain": array<Issue>,
            "MVP": array<Issue>,
            "Security": array<Issue>,
            "Funding": array<Issue>,
            "Team": array<Issue>,
            "Miscellaneous": array<Issue>
        }
    ],
    "watching": array<User>,
    "endorsements": array<User>,
    "timestamp": timestamp
  }
  

• PUT

  params: {
    "update_reference": `name of field you want to update`,
    "new_value": string,
    "project_id": number
  }
  

Issue

URL: /api/project/issue

Methods Allowed: GET, POST, PUT, HEAD, OPTIONS

Usage:

• POST

  params: {
    "project_id": number,
    "checkpoint_name": string,
    "created_by": number,
    "description": string
  }
  

• GET

  params: {
    id: number
  }
  

  response: {
    "id": number,
    "checkpoint_name": string,
    "comments": Array<IssueComments>,
    "created_by": string,
    "created_on": timestamp,
    "description": string,
    "is_resolved": boolean,
    "project_id": number,
  

• PUT

  params: {
    "update_reference": `name of field you want to update`,
    "new_value": string,
    "issue_id": number
  }
  

IssueComments

URL: /api/project/issue/comment

Methods Allowed: GET, POST, PUT, HEAD, OPTIONS

Usage:

• POST

  params: {
    "project_id": number,
    "issue_id": number,
    "commenter": number,
    "comment_text": string
  }
  

• GET

  params: {
    id: number
  }
  

  response: 
  [
    {
       "comment_replies": string,
       "comment_text": string,
       "commenter": number,
       "issue_id": number,
       "likes": number,
       "previous_edits": Array<string>,
       "project_id": number,
       "timestamp": timestamp
    }
  ]
  

• PUT

  params: {
    "update_reference": `name of field you want to update`,
    "new_value": string,
    "comment_id": number
  }
  

IssueReplies

URL: /api/project/issue/reply

Methods Allowed: GET, POST, PUT, HEAD, OPTIONS

Usage:

• POST

  params: {
    "comment_id": number,
    "reply_text": number,
    "respondent": number,
  }
  

• GET

  params: {
    id: number
  }
  

  response: 
  [
    {
       "comment_id": number,
       "reply_text": string,
       "respondent": number,
       "likes": number,
       "previous_edits": Array<string>,
       "timestamp": timestamp
    }
  ]
  

• PUT

  params: {
    "update_reference": `name of field you want to update`,
    "new_value": string,
    "reply_id": number
  }