Skip to content

Add Tickets App API specification #8

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

Add Tickets App API specification #8

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions tickets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Tickets application API specification
322 changes: 322 additions & 0 deletions tickets/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,322 @@
openapi: 3.0.1
info:
title: My Project
Copy link

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

Choose a reason for hiding this comment

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

medium

Consider providing a more descriptive title for the project. For example, 'Tickets Management API'.

  title: Tickets Management API

description: ""
version: 1.0.0
tags:
- name: tickets api
paths:
/tickets:
get:
summary: GET /tickets
deprecated: false
description: 티켓 목록 확인
Copy link

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

Choose a reason for hiding this comment

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

high

The description is in Korean. Please provide an English description for internationalization and consistency.

      description: Retrieves a list of tickets

tags:
- tickets api
parameters: []
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
properties: {}
Comment on lines +23 to +24
Copy link

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

Choose a reason for hiding this comment

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

medium

The properties field is empty. Define the properties of the response object to provide more information about the data structure.

              schema:
                type: object
                properties:
                  tickets:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier for the ticket
                        title:
                          type: string
                          description: Title of the ticket
                        description:
                          type: string
                          description: Detailed description of the ticket
                        status:
                          type: string
                          description: Status of the ticket (open, closed, etc.)
                        comments:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Unique identifier for the comment
                              ticket_id:
                                type: string
                                description: Identifier of the ticket the comment belongs to
                              content:
                                type: string
                                description: Content of the comment

example:
tickets:
- id: 01JQA8YHB2WQ5GTDWDKWK744B9
title: First Ticket
description: This is the first ticket.
status: open
comments: []
- id: 01JQA8YHSK6NSD1QEEJPES8592
title: Slow load
description: Page takes long.
status: open
comments: []
- id: 01JQA8YJ8G5G5J6XTXJEB4RE13
title: Button broken
description: Click does nothing.
status: open
comments: []
- id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
title: 새로운 티켓
description: 티켓을 하나 추가하려고 합니다.
Copy link

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

Choose a reason for hiding this comment

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

high

The description is in Korean. Please provide an English description for internationalization and consistency.

            description: A new ticket to be added.

status: open
comments:
- id: 01JQFRVCZ36PC7C3CDYWGGGVH2
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
content: 첫 댓글의 주인공이 되세요!
headers: {}
security: []
post:
summary: POST /tickets
deprecated: false
description: 티켓 생성
tags:
- tickets api
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 새로운 티켓
Copy link

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

Choose a reason for hiding this comment

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

high

The description is in Korean. Please provide an English description for internationalization and consistency.

                  description: Title of the new ticket

description:
type: string
description: 티켓을 하나 추가하려고 합니다
Copy link

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

Choose a reason for hiding this comment

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

high

The description is in Korean. Please provide an English description for internationalization and consistency.

                  description: Description of the new ticket

required:
- title
- description
example:
title: 새로운 티켓
description: 티켓 하나를 추가하려고 합니다.
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
properties: {}
Copy link

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

Choose a reason for hiding this comment

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

medium

The properties field is empty. Define the properties of the response object to provide more information about the data structure.

              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier of the created ticket
                  title:
                    type: string
                    description: Title of the created ticket
                  description:
                    type: string
                    description: Description of the created ticket
                  status:
                    type: string
                    description: Status of the created ticket
                  comments:
                    type: array
                    items:
                      type: string

example:
id: 01JQX1FTS2KJFQRFEWVEM83QH2
title: 새로운 티켓
description: 티켓 하나를 추가하려고 합니다.
status: open
comments: []
headers: {}
security: []
/tickets/{id}:
get:
summary: GET /tickets/:id
deprecated: false
description: 특정 티켓 확인
tags:
- tickets api
parameters:
- name: id
in: path
description: ""
required: true
example: 01JQA8YHB2WQ5GTDWDKWK744B9
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
properties: {}
Comment on lines +114 to +115
Copy link

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

Choose a reason for hiding this comment

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

medium

The properties field is empty. Define the properties of the response object to provide more information about the data structure.

              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier of the ticket
                  title:
                    type: string
                    description: Title of the ticket
                  description:
                    type: string
                    description: Description of the ticket
                  status:
                    type: string
                    description: Status of the ticket
                  comments:
                    type: array
                    items:
                      type: string

example:
id: 01JQA8YHB2WQ5GTDWDKWK744B9
title: First Ticket
description: This is the first ticket.
status: open
comments: []
headers: {}
security: []
patch:
summary: PATCH /tickets/:id
deprecated: false
description: 티켓 수정
Copy link

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

Choose a reason for hiding this comment

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

high

The description is in Korean. Please provide an English description for internationalization and consistency.

      description: Updates an existing ticket

tags:
- tickets api
parameters:
- name: id
in: path
description: ""
required: true
example: 01JQA8YHB2WQ5GTDWDKWK744B9
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: closed
required:
- status
example:
status: closed
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
properties: {}
Comment on lines +157 to +158
Copy link

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

Choose a reason for hiding this comment

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

medium

The properties field is empty. Define the properties of the response object to provide more information about the data structure.

              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier of the ticket
                  title:
                    type: string
                    description: Title of the ticket
                  description:
                    type: string
                    description: Description of the ticket
                  status:
                    type: string
                    description: Updated status of the ticket
                  comments:
                    type: array
                    items:
                      type: string

example:
id: 01JQA8YHB2WQ5GTDWDKWK744B9
title: First Ticket
description: This is the first ticket.
status: closed
comments: []
headers: {}
security: []
delete:
summary: DELETE /tickets/:id
deprecated: false
description: 티켓 삭제
Copy link

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

Choose a reason for hiding this comment

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

high

The description is in Korean. Please provide an English description for internationalization and consistency.

      description: Deletes a ticket

tags:
- tickets api
parameters:
- name: id
in: path
description: ""
required: true
example: 01JQX1FTS2KJFQRFEWVEM83QH2
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
properties: {}
example:
id: 01JQX1FTS2KJFQRFEWVEM83QH2
title: 새로운 티켓
description: 티켓 하나를 추가하려고 합니다.
status: closed
comments: []
headers: {}
"404":
description: ""
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
headers: {}
security: []
/tickets/{ticketId}/comments:
get:
summary: GET /tickets/:ticketId/comments
deprecated: false
description: 댓글 목록
Copy link

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

Choose a reason for hiding this comment

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

high

The description is in Korean. Please provide an English description for internationalization and consistency.

      description: Retrieves a list of comments for a specific ticket

tags:
- tickets api
parameters:
- name: ticketId
in: path
description: ""
required: true
example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
properties: {}
Comment on lines +230 to +231
Copy link

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

Choose a reason for hiding this comment

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

medium

The properties field is empty. Define the properties of the response object to provide more information about the data structure.

              schema:
                type: object
                properties:
                  comments:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier for the comment
                        ticket_id:
                          type: string
                          description: Identifier of the ticket the comment belongs to
                        content:
                          type: string
                          description: Content of the comment

example:
- id: 01JQFRVCZ36PC7C3CDYWGGGVH2
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
content: 첫 댓글의 주인공이 되세요!
headers: {}
security: []
post:
summary: POST /tickets/:ticketId/comments
deprecated: false
description: 댓글 생성
Copy link

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

Choose a reason for hiding this comment

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

high

The description is in Korean. Please provide an English description for internationalization and consistency.

      description: Creates a new comment for a specific ticket

tags:
- tickets api
parameters:
- name: ticketId
in: path
description: ""
required: true
example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
content:
type: string
description: 첫 댓글의 주인공이 되세요
Copy link

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

Choose a reason for hiding this comment

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

high

The description is in Korean. Please provide an English description for internationalization and consistency.

                  description: Content of the new comment

required:
- content
example:
content: 첫 댓글의 주인공이 되세요!
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
properties: {}
Comment on lines +271 to +272
Copy link

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

Choose a reason for hiding this comment

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

medium

The properties field is empty. Define the properties of the response object to provide more information about the data structure.

              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier of the comment
                  ticket_id:
                    type: string
                    description: Identifier of the ticket the comment belongs to
                  content:
                    type: string
                    description: Content of the comment

example:
id: 01JQX26V9XH60Y98S7Z1J87EYR
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
content: 첫 댓글의 주인공이 되세요!
headers: {}
security: []
/tickets/{ticketId}/comments/{id}:
delete:
summary: DELETE /tickets/:ticketId/comments/:id
deprecated: false
description: |
댓글 삭제
Comment on lines +283 to +284
Copy link

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

Choose a reason for hiding this comment

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

high

The description is in Korean. Please provide an English description for internationalization and consistency.

      description: Deletes a comment

tags:
- tickets api
parameters:
- name: ticketId
in: path
description: ""
required: true
example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
schema:
type: string
- name: id
in: path
description: ""
required: true
example: 01JQX26V9XH60Y98S7Z1J87EYR
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
Comment on lines +307 to +308
Copy link

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

Choose a reason for hiding this comment

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

medium

The properties field is empty. Define the properties of the response object to provide more information about the data structure.

              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier of the comment
                  ticket_id:
                    type: string
                    description: Identifier of the ticket the comment belongs to
                  content:
                    type: string
                    description: Content of the comment

properties: {}
example:
id: 01JQX26V9XH60Y98S7Z1J87EYR
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
content: 첫 댓글의 주인공이 되세요!
headers: {}
security: []
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://tickets-api.codedemo.co
description: tickets-api.codedemo
security: []