Skip to content

OpenAPI 스펙 텍스트 수정 #9

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 1 commit into from
Apr 7, 2025
Merged

OpenAPI 스펙 텍스트 수정 #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
86 changes: 40 additions & 46 deletions tickets/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.1
info:
title: My Project
title: Tickets API
description: ""
version: 1.0.0
tags:
Expand All @@ -16,7 +16,7 @@ paths:
parameters: []
responses:
"200":
description: ""
description: 성공
Copy link

@gemini-code-assist gemini-code-assist bot Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider translating this description to English for consistency with other parts of the specification, or maintaining the entire specification in Korean if that's the target audience. Mixing languages can reduce the usability of the documentation.

description: Success

Copy link
Member Author

@ahastudio ahastudio Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

일단은 한국어 쓸 거야.

content:
application/json:
schema:
Expand All @@ -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.
Expand All @@ -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:
Expand All @@ -64,28 +59,28 @@ 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: 티켓 생성 성공
Copy link

@gemini-code-assist gemini-code-assist bot Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider translating this description to English for consistency with other parts of the specification, or maintaining the entire specification in Korean if that's the target audience. Mixing languages can reduce the usability of the documentation.

description: Ticket creation successful

content:
application/json:
schema:
type: object
properties: {}
example:
id: 01JQX1FTS2KJFQRFEWVEM83QH2
title: 새로운 티켓
description: 티켓 하나를 추가하려고 합니다.
title: New Ticket
description: This is a new ticket.
status: open
comments: []
headers: {}
Expand All @@ -100,23 +95,23 @@ paths:
parameters:
- name: id
in: path
description: ""
description: 티켓 ID
required: true
example: 01JQA8YHB2WQ5GTDWDKWK744B9
schema:
type: string
responses:
"200":
description: ""
description: 성공
content:
application/json:
schema:
type: object
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: {}
Expand All @@ -130,7 +125,7 @@ paths:
parameters:
- name: id
in: path
description: ""
description: 티켓 ID
required: true
example: 01JQA8YHB2WQ5GTDWDKWK744B9
schema:
Expand All @@ -143,23 +138,23 @@ paths:
properties:
status:
type: string
description: closed
description: 티켓 상태
required:
- status
example:
status: closed
responses:
"200":
description: ""
description: 티켓 수정 성공
Copy link

@gemini-code-assist gemini-code-assist bot Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider translating this description to English for consistency with other parts of the specification, or maintaining the entire specification in Korean if that's the target audience. Mixing languages can reduce the usability of the documentation.

description: Ticket update successful

content:
application/json:
schema:
type: object
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: {}
Expand All @@ -173,28 +168,28 @@ paths:
parameters:
- name: id
in: path
description: ""
description: 티켓 ID
required: true
example: 01JQX1FTS2KJFQRFEWVEM83QH2
schema:
type: string
responses:
"200":
description: ""
description: 티켓 삭제 성공
Copy link

@gemini-code-assist gemini-code-assist bot Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider translating this description to English for consistency with other parts of the specification, or maintaining the entire specification in Korean if that's the target audience. Mixing languages can reduce the usability of the documentation.

description: Ticket deletion successful

content:
application/json:
schema:
type: object
properties: {}
example:
id: 01JQX1FTS2KJFQRFEWVEM83QH2
title: 새로운 티켓
description: 티켓 하나를 추가하려고 합니다.
title: Some Ticket
description: This is a ticket.
status: closed
comments: []
headers: {}
"404":
description: ""
description: 티켓을 찾을 수 없음
Copy link

@gemini-code-assist gemini-code-assist bot Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider translating this description to English for consistency with other parts of the specification, or maintaining the entire specification in Korean if that's the target audience. Mixing languages can reduce the usability of the documentation.

description: Ticket not found

content:
application/json:
schema:
Expand All @@ -216,14 +211,14 @@ paths:
parameters:
- name: ticketId
in: path
description: ""
description: 티켓 ID
required: true
example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
schema:
type: string
responses:
"200":
description: ""
description: 성공
Copy link

@gemini-code-assist gemini-code-assist bot Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider translating this description to English for consistency with other parts of the specification, or maintaining the entire specification in Korean if that's the target audience. Mixing languages can reduce the usability of the documentation.

description: Success

content:
application/json:
schema:
Expand All @@ -232,7 +227,7 @@ paths:
example:
- id: 01JQFRVCZ36PC7C3CDYWGGGVH2
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
content: 첫 댓글의 주인공이 되세요!
content: This is the first comment.
headers: {}
security: []
post:
Expand All @@ -244,7 +239,7 @@ paths:
parameters:
- name: ticketId
in: path
description: ""
description: 티켓 ID
required: true
example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
schema:
Expand All @@ -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: 댓글 생성 성공
Copy link

@gemini-code-assist gemini-code-assist bot Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider translating this description to English for consistency with other parts of the specification, or maintaining the entire specification in Korean if that's the target audience. Mixing languages can reduce the usability of the documentation.

description: Comment creation successful

content:
application/json:
schema:
Expand All @@ -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: 댓글 삭제 성공
Copy link

@gemini-code-assist gemini-code-assist bot Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider translating this description to English for consistency with other parts of the specification, or maintaining the entire specification in Korean if that's the target audience. Mixing languages can reduce the usability of the documentation.

description: Comment deletion successful

content:
application/json:
schema:
Expand All @@ -310,7 +304,7 @@ paths:
example:
id: 01JQX26V9XH60Y98S7Z1J87EYR
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
content: 첫 댓글의 주인공이 되세요!
content: This is the first comment.
headers: {}
security: []
components:
Expand Down