Skip to content

Commit

Permalink
docs: api 문서 업데이트
Browse files Browse the repository at this point in the history
  • Loading branch information
nuyh99 committed Nov 23, 2023
1 parent 8a72b3c commit 39b5b32
Showing 1 changed file with 30 additions and 6 deletions.
36 changes: 30 additions & 6 deletions src/main/resources/static/api/openapi3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,21 @@ paths:
responses:
"204":
description: "204"
/auth:
get:
tags:
- auth
operationId: 현재 유저 정보 조회하기
responses:
"200":
description: "200"
content:
application/json:
schema:
$ref: '#/components/schemas/auth-1376103110'
examples:
현재 유저 정보 조회하기:
value: "{\"email\":\"[email protected]\",\"role\":\"USER\"}"
/auth/email:
get:
tags:
Expand Down Expand Up @@ -264,14 +279,14 @@ paths:
examples:
자신의 회의실 예약 목록 최신 순으로 보기:
value: "[{\"id\":1,\"status\":\"RESERVED\",\"cancelReason\":null,\"\
startTime\":\"2023-11-06T17:28:45.404875\",\"endTime\":\"2023-11-06T19:28:45.40488\"\
startTime\":\"2023-11-23T23:50:44.314618\",\"endTime\":\"2023-11-24T01:50:44.314623\"\
,\"name\":\"황재현\",\"phone\":\"01012341234\",\"reservedAt\":\"\
2023-11-06T17:28:45.404892\",\"roomId\":1,\"roomName\":\"대회의실\"\
2023-11-23T23:50:44.314633\",\"roomId\":1,\"roomName\":\"대회의실\"\
},{\"id\":2,\"status\":\"CANCELED\",\"cancelReason\":\"쓰기 싫어졌어\
요..\",\"startTime\":\"2023-11-06T17:28:45.4049\",\"endTime\":\"\
2023-11-06T19:28:45.404901\",\"name\":\"황재현\",\"phone\":\"01012341234\"\
,\"reservedAt\":\"2023-11-06T17:28:45.404903\",\"roomId\":1,\"\
roomName\":\"대회의실\"}]"
요..\",\"startTime\":\"2023-11-23T23:50:44.314641\",\"endTime\"\
:\"2023-11-24T01:50:44.314642\",\"name\":\"황재현\",\"phone\":\"\
01012341234\",\"reservedAt\":\"2023-11-23T23:50:44.314645\",\"\
roomId\":1,\"roomName\":\"대회의실\"}]"
post:
tags:
- reservations
Expand Down Expand Up @@ -362,6 +377,15 @@ paths:
,\"isMine\":false}]}]"
components:
schemas:
auth-1376103110:
type: object
properties:
role:
type: string
description: 계정 권한
email:
type: string
description: 이메일
reservations-740649445:
type: object
properties:
Expand Down

0 comments on commit 39b5b32

Please sign in to comment.