diff --git a/tickets/openapi.yaml b/tickets/openapi.yaml index 7ce74c9..b867d83 100644 --- a/tickets/openapi.yaml +++ b/tickets/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: My Project + title: Tickets API description: "" version: 1.0.0 tags: @@ -16,7 +16,7 @@ paths: parameters: [] responses: "200": - description: "" + description: 성공 content: application/json: schema: @@ -28,7 +28,10 @@ paths: title: First Ticket description: This is the first ticket. status: open - comments: [] + comments: + - id: 01JQFRVCZ36PC7C3CDYWGGGVH2 + ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP + content: This is the first comment. - id: 01JQA8YHSK6NSD1QEEJPES8592 title: Slow load description: Page takes long. @@ -39,14 +42,6 @@ paths: description: Click does nothing. status: open comments: [] - - id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP - title: 새로운 티켓 - description: 티켓을 하나 추가하려고 합니다. - status: open - comments: - - id: 01JQFRVCZ36PC7C3CDYWGGGVH2 - ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP - content: 첫 댓글의 주인공이 되세요! headers: {} security: [] post: @@ -64,19 +59,19 @@ paths: properties: title: type: string - description: 새로운 티켓 + description: 제목 description: type: string - description: 티켓을 하나 추가하려고 합니다 + description: 본문 required: - title - description example: - title: 새로운 티켓 - description: 티켓 하나를 추가하려고 합니다. + title: New Ticket + description: This is a new ticket. responses: "200": - description: "" + description: 티켓 생성 성공 content: application/json: schema: @@ -84,8 +79,8 @@ paths: properties: {} example: id: 01JQX1FTS2KJFQRFEWVEM83QH2 - title: 새로운 티켓 - description: 티켓 하나를 추가하려고 합니다. + title: New Ticket + description: This is a new ticket. status: open comments: [] headers: {} @@ -100,14 +95,14 @@ paths: parameters: - name: id in: path - description: "" + description: 티켓 ID required: true example: 01JQA8YHB2WQ5GTDWDKWK744B9 schema: type: string responses: "200": - description: "" + description: 성공 content: application/json: schema: @@ -115,8 +110,8 @@ paths: properties: {} example: id: 01JQA8YHB2WQ5GTDWDKWK744B9 - title: First Ticket - description: This is the first ticket. + title: Some Ticket + description: This is a ticket. status: open comments: [] headers: {} @@ -130,7 +125,7 @@ paths: parameters: - name: id in: path - description: "" + description: 티켓 ID required: true example: 01JQA8YHB2WQ5GTDWDKWK744B9 schema: @@ -143,14 +138,14 @@ paths: properties: status: type: string - description: closed + description: 티켓 상태 required: - status example: status: closed responses: "200": - description: "" + description: 티켓 수정 성공 content: application/json: schema: @@ -158,8 +153,8 @@ paths: properties: {} example: id: 01JQA8YHB2WQ5GTDWDKWK744B9 - title: First Ticket - description: This is the first ticket. + title: Some Ticket + description: This is a ticket. status: closed comments: [] headers: {} @@ -173,14 +168,14 @@ paths: parameters: - name: id in: path - description: "" + description: 티켓 ID required: true example: 01JQX1FTS2KJFQRFEWVEM83QH2 schema: type: string responses: "200": - description: "" + description: 티켓 삭제 성공 content: application/json: schema: @@ -188,13 +183,13 @@ paths: properties: {} example: id: 01JQX1FTS2KJFQRFEWVEM83QH2 - title: 새로운 티켓 - description: 티켓 하나를 추가하려고 합니다. + title: Some Ticket + description: This is a ticket. status: closed comments: [] headers: {} "404": - description: "" + description: 티켓을 찾을 수 없음 content: application/json: schema: @@ -216,14 +211,14 @@ paths: parameters: - name: ticketId in: path - description: "" + description: 티켓 ID required: true example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP schema: type: string responses: "200": - description: "" + description: 성공 content: application/json: schema: @@ -232,7 +227,7 @@ paths: example: - id: 01JQFRVCZ36PC7C3CDYWGGGVH2 ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP - content: 첫 댓글의 주인공이 되세요! + content: This is the first comment. headers: {} security: [] post: @@ -244,7 +239,7 @@ paths: parameters: - name: ticketId in: path - description: "" + description: 티켓 ID required: true example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP schema: @@ -257,14 +252,14 @@ paths: properties: content: type: string - description: 첫 댓글의 주인공이 되세요 + description: 댓글 본문 required: - content example: - content: 첫 댓글의 주인공이 되세요! + content: This is the first comment. responses: "200": - description: "" + description: 댓글 생성 성공 content: application/json: schema: @@ -273,35 +268,34 @@ paths: example: id: 01JQX26V9XH60Y98S7Z1J87EYR ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP - content: 첫 댓글의 주인공이 되세요! + content: This is the first comment. headers: {} security: [] /tickets/{ticketId}/comments/{id}: delete: summary: DELETE /tickets/:ticketId/comments/:id deprecated: false - description: | - 댓글 삭제 + description: 댓글 삭제 tags: - tickets api parameters: - name: ticketId in: path - description: "" + description: 티켓 ID required: true example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP schema: type: string - name: id in: path - description: "" + description: 댓글 ID required: true example: 01JQX26V9XH60Y98S7Z1J87EYR schema: type: string responses: "200": - description: "" + description: 댓글 삭제 성공 content: application/json: schema: @@ -310,7 +304,7 @@ paths: example: id: 01JQX26V9XH60Y98S7Z1J87EYR ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP - content: 첫 댓글의 주인공이 되세요! + content: This is the first comment. headers: {} security: [] components: