From 19103505a4494a1b8cc6284a22a62efc21c75592 Mon Sep 17 00:00:00 2001
From: ramyo564 <103474568+ramyo564@users.noreply.github.com>
Date: Fri, 11 Oct 2024 12:02:06 +0900
Subject: [PATCH 1/2] Update openapi.yaml
---
todo-app/openapi.yaml | 213 +++++++++++++++++++++++++++++++++++++++++-
1 file changed, 210 insertions(+), 3 deletions(-)
diff --git a/todo-app/openapi.yaml b/todo-app/openapi.yaml
index 2258929..e216b47 100644
--- a/todo-app/openapi.yaml
+++ b/todo-app/openapi.yaml
@@ -1,8 +1,13 @@
openapi: 3.0.3
info:
- title: To-do service API
+ title: Extreme To-do service API
description: |-
- 간단한 할 일 관리 서비스의 API
+ todo list에 할 일을 쌓아두기만? -> X
+ 하루에 중요한 할 일 딱 10개만 관리하는 todo list!
+
+ 지금 해야 할 일이 이미 10개 이상인가요?
+ 그럼 그중에서도 가장 급한 일 10개부터 끝내고 생각하세요!
+
version: 1.0.0
servers:
- url: http://localhost:8080
@@ -14,7 +19,7 @@ paths:
get:
tags:
- API
- summary: Health cehck
+ summary: Health check
description: |
API 서버가 잘 작동하는지 확인하는 용도의 API.
responses:
@@ -37,6 +42,7 @@ paths:
properties:
tasks:
type: array
+ description: 할 일 목록 배열
items:
type: object
properties:
@@ -48,7 +54,208 @@ paths:
type: string
description: 할 일에 대한 간단한 설명
example: 과제하기
+ contents:
+ type: string
+ description: 자세한 설명
+ example: 1강부터 3강까지 공부해야함
createdAt:
type: string
description: 할 일 등록 일시 (UTC)
example: "2024-10-01 12:34:56"
+ example:
+ tasks:
+ - id: "01BX5ZZKBKACTAV9WEVGEMMVRY"
+ title: "과제하기"
+ contents: "1강부터 3강까지 공부해야함"
+ createdAt: "2024-10-01 12:34:56"
+ - id: "01BX5ZZKBKACTAV9WEVGEMMVZZ"
+ title: "알고리즘 공부하기"
+ contents: "3시까지 정렬, 해시맵 공부"
+ createdAt: "2024-10-02 14:22:00"
+
+ post:
+ tags:
+ - API
+ summary: Create a task
+ description: |
+ 할 일 목록을 만들기
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ title:
+ type: string
+ description: 제목
+ example: "과제하기"
+ contents:
+ type: string
+ description: 내용
+ example: "1강부터 3강까지 공부해야함"
+ responses:
+ '200':
+ description: 할 일을 성공적으로 생성함.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Task의 식별자
+ example: 01BX5ZZKBKACTAV9WEVGEMMVRY
+ title:
+ type: string
+ description: 할 일에 대한 간단한 설명
+ example: 과제하기
+ contents:
+ type: string
+ description: 자세한 설명
+ example: 1강부터 3강까지 공부해야함
+ createdAt:
+ type: string
+ description: 할 일 등록 일시 (UTC)
+ example: "2024-10-01 12:34:56"
+
+ put:
+ tags:
+ - API
+ summary: Update a task
+ description: |
+ 할 일 수정하기 (전체 업데이트)
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ title:
+ type: string
+ description: 제목
+ example: "과제하기"
+ contents:
+ type: string
+ description: 내용
+ example: "4강부터 5강까지 공부해야함"
+ responses:
+ '200':
+ description: 할 일을 성공적으로 업데이트함.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Task의 식별자
+ example: 01BX5ZZKBKACTAV9WEVGEMMVRY
+ title:
+ type: string
+ description: 할 일에 대한 간단한 설명
+ example: 과제하기
+ contents:
+ type: string
+ description: 자세한 설명
+ example: 5강부터 10강까지 공부해야함
+ updatedAt:
+ type: string
+ description: 할 일 수정 일시 (UTC)
+ example: "2024-10-02 12:34:56"
+ /tasks/{taskId}:
+ patch:
+ tags:
+ - API
+ summary: Update a task
+ description: |
+ 할 일 수정하기 (부분 업데이트)
+ parameters:
+ - name: taskId
+ in: path
+ required: true
+ schema:
+ type: string
+ description: Task의 식별자
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ title:
+ type: string
+ description: 제목
+ example: "과제하기"
+ contents:
+ type: string
+ description: 내용
+ example: "5강부터 10강까지 공부해야함"
+ taskDone:
+ type: boolean
+ description: 할 일이 완료되었는지 여부
+ example: true
+ responses:
+ '200':
+ description: 할 일을 성공적으로 수정함.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Task의 식별자
+ example: 01BX5ZZKBKACTAV9WEVGEMMVRY
+ title:
+ type: string
+ description: 할 일에 대한 간단한 설명
+ example: 과제하기
+ contents:
+ type: string
+ description: 자세한 설명
+ example: 5강부터 10강까지 공부해야함
+ taskDone:
+ type: boolean
+ description: 할 일이 완료되었는지 여부
+ example: true
+ updatedAt:
+ type: string
+ description: 할 일 수정 일시 (UTC)
+ example: "2024-10-02 12:34:56"
+
+ delete:
+ tags:
+ - API
+ summary: Delete a task
+ description: |
+ 할 일 삭제하기
+ parameters:
+ - name: taskId
+ in: path
+ required: true
+ schema:
+ type: string
+ description: Task의 식별자
+ responses:
+ '200':
+ description: 할 일을 성공적으로 삭제함.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Task의 식별자
+ example: 01BX5ZZKBKACTAV9WEVGEMMVRY
+ deletedAt:
+ type: string
+ description: 할 일 삭제 일시 (UTC)
+ example: "2024-10-02 12:34:56"
+ isDeleted:
+ type: boolean
+ description: 삭제 여부
+ example: true
From eb7cdf0179668d98a4361e109e41b7d683e41809 Mon Sep 17 00:00:00 2001
From: ramyo564 <103474568+ramyo564@users.noreply.github.com>
Date: Fri, 11 Oct 2024 12:17:48 +0900
Subject: [PATCH 2/2] =?UTF-8?q?patch=20=EB=B6=80=EB=B6=84=20summary=20?=
=?UTF-8?q?=EC=88=98=EC=A0=95?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
todo-app/openapi.yaml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/todo-app/openapi.yaml b/todo-app/openapi.yaml
index e216b47..9a50bed 100644
--- a/todo-app/openapi.yaml
+++ b/todo-app/openapi.yaml
@@ -168,7 +168,7 @@ paths:
patch:
tags:
- API
- summary: Update a task
+ summary: Finish a task
description: |
할 일 수정하기 (부분 업데이트)
parameters: