Skip to content

API 응답 스키마 수정, Comment와 Ticket 공통 스키마 추가 #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 8, 2025
Merged

API 응답 스키마 수정, Comment와 Ticket 공통 스키마 추가 #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b741c1
API 응답 스키마 수정, Comment와 Ticket 공통 스키마 추가
nakyeonko3 Apr 8, 2025
2f89313
API info 설명 개선
nakyeonko3 Apr 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 47 additions & 42 deletions tickets/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down Expand Up @@ -104,8 +84,7 @@ paths:
content:
application/json:
schema:
type: object
properties: {}
$ref: "#/components/schemas/Ticket"
example:
id: 01JQX1FTS2KJFQRFEWVEM83QH2
title: New Ticket
Expand Down Expand Up @@ -135,8 +114,7 @@ paths:
content:
application/json:
schema:
type: object
properties: {}
$ref: "#/components/schemas/Ticket"
example:
id: 01JQA8YHB2WQ5GTDWDKWK744B9
title: Some Ticket
Expand Down Expand Up @@ -178,8 +156,7 @@ paths:
content:
application/json:
schema:
type: object
properties: {}
$ref: "#/components/schemas/Ticket"
example:
id: 01JQA8YHB2WQ5GTDWDKWK744B9
title: Some Ticket
Expand Down Expand Up @@ -208,8 +185,7 @@ paths:
content:
application/json:
schema:
type: object
properties: {}
$ref: "#/components/schemas/Ticket"
example:
id: 01JQX1FTS2KJFQRFEWVEM83QH2
title: Some Ticket
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down