Skip to content

API 명세서

ParkSeungHwan edited this page Nov 5, 2020 · 15 revisions

📌 issues

이슈 리스트

URL Method Body Query param
/ GET page:Number

Return

{
pagination: {
        page: Number,
        lastPage: Number
},
issues: [
  {
    "id": Number,
    "title": String,
    "isClosed": Boolean,
    "closedAt": Datetime or Null,
    "createdAt": Datetime, // 2020-11-04 15:33:33
    "updatedAt": Datetime,
    "authorId": Number,
    "milestoneId": Number,
    "Author": {
        "id": Number,
        "name": String
    },
    "Labels": [
        {
            "id": Number,
            "name": String,
            "description": String,
            "color": String
        }
    ],
    "Assignees": [
        {
            "id": Number,
            "profileLink": String
        }
    ],
    "Milestone": {
        "id": Number,
        "title": String
    }
  }
]
}

이슈

URL Method Body Query param
/ GET id:Number
{
    "id": Number,
    "title": String,
    "contents": String,
    "isClosed": Boolean,
    "closedAt": Datetime,
    "authorId": Number,
    "isAuthor": Boolean
    "milestoneId": Number,
    "createdAt": Datetime,
    "updatedAt": Datetime,
    "Author": {
        "id": Number,
        "name": String,
        "uid": String,
        "profileLink": String,
        "createdAt": Datetime,
        "updatedAt": Datetime
    },
    "Labels": [
        {
            "id": Number,
            "name": String,
            "description": String,
            "color": String
        }
    ],
    "Assignees": [
        {
            "id": Number,
            "name": String,
            "uid": String,
            "profileLink": String,
            "createdAt": Datetime,
            "updatedAt": Datetime
        }
    ],
    "Milestone": {
        "id": Number,
        "title": String,
        "description": String,
        "endDate": Datetime,
        "createdAt": Datetime,
        "updatedAt": Datetime
    },
}

📌 labels

URL Method Body Query param
/ GET

Return

[
    {
        "id" : Number,
        "name" : String,
        "color" : String,
        "description" : String,
    }
]

📌 users

URL Method Body Query param
/ GET

Return

[
    {
        "id": Number,
        "name": String,
        "uid": String,
        "profile_link": String
    }
]

📌 milestones

URL Method Body Query param
/ GET

Return

[
    {
        "id": Number,
        "title": String,
        "description": String,
        "end_date": String,
        "createdAt": String,
        "updatedAt": String
    }
]

Clone this wiki locally