Skip to content

Commit

Permalink
docs:トークン情報をヘッダに含める
Browse files Browse the repository at this point in the history
  • Loading branch information
minusno0708 committed Mar 8, 2024
1 parent 29a93f0 commit f2a1ad0
Showing 1 changed file with 29 additions and 45 deletions.
74 changes: 29 additions & 45 deletions document.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -117,19 +117,13 @@ paths:
- user
description: |
ユーザー情報を取得する
requestBody:
description: アクセストークン
required: true
content:
application/json:
schema:
type: object
required:
- token
properties:
token:
type: "string"
example: "xxxxxxxxxxxxxxxxxxxxxxxx"
parameters:
- name: token
in: header
required: true
schema:
type: string
description: アクセストークン

responses:
200:
Expand Down Expand Up @@ -196,23 +190,26 @@ paths:
- user
description: |
ユーザー情報を更新する
parameters:
- name: token
in: header
required: true
schema:
type: string
description: アクセストークン
requestBody:
description: ユーザー情報とアクセストークン
description: 新規ユーザー名
required: true
content:
application/json:
schema:
type: object
required:
- username
- token
properties:
username:
type: "string"
example: "new_username"
token:
type: "string"
example: "xxxxxxxxxxxxxxxxxxxxxxxx"

responses:
200:
Expand Down Expand Up @@ -269,19 +266,13 @@ paths:
- user
description: |
ユーザー情報を削除する
requestBody:
description: アクセストークン
required: true
content:
application/json:
schema:
type: object
required:
- token
properties:
token:
type: "string"
example: "xxxxxxxxxxxxxxxxxxxxxxxx"
parameters:
- name: token
in: header
required: true
schema:
type: string
description: アクセストークン

responses:
200:
Expand Down Expand Up @@ -407,20 +398,13 @@ paths:
- auth
description: |
ログアウト用のエンドポイント
requestBody:
description: トークン
required: true
content:
application/json:
schema:
type: object
required:
- token
properties:
token:
type: "string"
example: ""
parameters:
- name: token
in: header
required: true
schema:
type: string
description: アクセストークン

responses:
200:
Expand Down

0 comments on commit f2a1ad0

Please sign in to comment.