diff --git a/tickets/openapi.yaml b/tickets/openapi.yaml index 656c193..4e94da8 100644 --- a/tickets/openapi.yaml +++ b/tickets/openapi.yaml @@ -1,7 +1,12 @@ openapi: 3.0.1 info: title: Tickets API - description: "" + description: | + 티켓 관리 시스템을 위한 RESTful API입니다. + 이 API를 통해 티켓을 생성, 조회, 수정, 삭제하고 댓글을 관리할 수 있습니다. + + 각 티켓은 고유 ID, 제목, 설명, 상태를 가지며 여러 댓글을 포함할 수 있습니다. + 티켓 상태는 open, closed 등으로 관리됩니다. version: 1.0.0 tags: - name: tickets api @@ -26,32 +31,7 @@ paths: type: array description: 티켓 목록 items: - type: object - properties: - id: - type: string - description: 티켓 ID - title: - type: string - description: 티켓 제목 - description: - type: string - description: 티켓 내용 - status: - type: string - description: 티켓 상태 - comments: - type: array - description: 댓글 목록 - items: - type: object - properties: - id: - type: string - description: 댓글 ID - content: - type: string - description: 댓글 내용 + $ref: "#/components/schemas/Ticket" example: tickets: - id: 01JQA8YHB2WQ5GTDWDKWK744B9 @@ -104,8 +84,7 @@ paths: content: application/json: schema: - type: object - properties: {} + $ref: "#/components/schemas/Ticket" example: id: 01JQX1FTS2KJFQRFEWVEM83QH2 title: New Ticket @@ -135,8 +114,7 @@ paths: content: application/json: schema: - type: object - properties: {} + $ref: "#/components/schemas/Ticket" example: id: 01JQA8YHB2WQ5GTDWDKWK744B9 title: Some Ticket @@ -178,8 +156,7 @@ paths: content: application/json: schema: - type: object - properties: {} + $ref: "#/components/schemas/Ticket" example: id: 01JQA8YHB2WQ5GTDWDKWK744B9 title: Some Ticket @@ -208,8 +185,7 @@ paths: content: application/json: schema: - type: object - properties: {} + $ref: "#/components/schemas/Ticket" example: id: 01JQX1FTS2KJFQRFEWVEM83QH2 title: Some Ticket @@ -251,8 +227,9 @@ paths: content: application/json: schema: - type: object - properties: {} + type: array + items: + $ref: "#/components/schemas/Comment" example: - id: 01JQFRVCZ36PC7C3CDYWGGGVH2 content: This is the first comment. @@ -291,8 +268,7 @@ paths: content: application/json: schema: - type: object - properties: {} + $ref: "#/components/schemas/Comment" example: id: 01JQX26V9XH60Y98S7Z1J87EYR content: This is the first comment. @@ -326,15 +302,44 @@ paths: content: application/json: schema: - type: object - properties: {} + $ref: "#/components/schemas/Comment" example: id: 01JQX26V9XH60Y98S7Z1J87EYR content: This is the first comment. headers: {} security: [] components: - schemas: {} + schemas: + Comment: + type: object + properties: + id: + type: string + description: 댓글 ID + content: + type: string + description: 댓글 내용 + + Ticket: + type: object + properties: + id: + type: string + description: 티켓 ID + title: + type: string + description: 티켓 제목 + description: + type: string + description: 티켓 내용 + status: + type: string + description: 티켓 상태 + comments: + type: array + description: 댓글 목록 + items: + $ref: "#/components/schemas/Comment" securitySchemes: {} servers: - url: https://tickets-api.codedemo.co