API Issue

이슈

전체 목록 조회

GET /api/issues

?query {
    isClosed: true || false,

   //구현X
    author: "userId",
    labels: "label01,label02,...",
    milestone: "milestoneName",
    assignee: "userId01, userId02,...",
    commenter: "userId01,userId02,...",
}

// example
// "%2c" : comma(,)
query = "isClosed=false&author=seokju2ng&labels=server%2cbug"

queries when clicked filter buttons

"Open Issues": "is=open"
"Your Issues": "author=me"
"Everything assigned to you": "assignee=me"
"Everything commented by you": "commenter=me"
"Closed Issues": "is=closed"

• response

{
  open
  closed
  issues:[
    {
        num, 
        title, 
        author: { id },
        createdAt,
        isClosed,
        labels: [ { name, color }, ... ],
        milestone: { name },
        assignees: [ { id }, ... ]
        comment: { content }
    },
    ...
  ]
}

단일 이슈 조회

GET /api/issues/:num

• response status code

code	설명
200	정상적으로 조회
404	조회를 요청한 번호가 없는 경우
500	내부 서버 에러

• response

{
  num, 
  title, 
  author: { num, id },
  createdAt,
  isClosed,
  milestone: { 
    num, 
    title, 
    openedIssues,
    closedIssues
  },
  assignees: [ { num, id }, ... ],
  labels:[ { num, name, color }, ... ],
  comments: [
    {
      num,
      content,
      writer: { num, id },
      createdAt,
    },
    ...
  ]
}

이슈 추가

POST /api/issues

• request data

{ 
    title,
    content,
    milestoneNum,
    labels: [ num01, num02, ... ],
    assignees: [ num01, num02, ... ],
}

• response status code

code	설명
200	정상적으로 생성
400	content 없이 요청한 경우
500	title 없이 요청한 경우
500	내부 서버 에러

• response

{ 
  success,
  message: 에러시에만 에러 메시지가 응답에 포함됨
}

이슈 삭제

DELETE /api/issues/:num

• response status code

code	설명
200	정상적으로 삭제
404	삭제를 요청한 번호가 없는 경우
500	내부 서버 에러

• response

{ 
  success,
  message: 에러시에만 에러 메시지가 응답에 포함됨
}

이슈 수정

PATCH /api/issues/:num

• request data

title 수정

{ 
  title
}

milestone 수정

{ 
  milestoneNum  
}

status(open / closed) 수정

{ 
  isClosed
}

• response status code

code	설명
200	정상적으로 수정
404	수정을 요청한 번호의 이슈가 없는 경우
500	등록을 요청한 마일스톤 번호가 없는 경우 (내부 오류) 이외의 서버 에러

• response

{ 
  success,
  message: 에러시에만 에러 메시지가 응답에 포함됨
}