Skip to content
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.

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

ユーザー情報更新用APIエンドポイントを再構成 #41

Open
CornerSyrup opened this issue Jul 31, 2022 · 0 comments
Open
Labels
api-design Related to API definition
Milestone

Comments

@CornerSyrup
Copy link
Member

CornerSyrup commented Jul 31, 2022

本来のエンドポイントは /users/:user でユーザー情報を一括で更新しようとしているが、
一部の用途を分けて独立なエンドポイントがあったほうがいい

パスワード更新用: #46
ユーザー名更新用: #47

独立しない部分はクエリーパラメータをしてして更新するように定義する

現状では更新エンドポイントのメソッドは PUT なのに、
更新情報を提供するスキーマは未定義のまま

put:
summary: 各ユーザー情報を編集する
description: プロフィール画面にアクセスした際にユーザ情報の更新、退会画面時のユーザ情報の更新用API
operationId: updateUser
parameters:
- $ref: "#/components/parameters/user-path"
responses:
"201":
$ref: "#/components/responses/updateUser-201"
"204":
$ref: "#/components/responses/updateUser-204"

@CornerSyrup CornerSyrup changed the title ユーザー情報を更新するAPIエンドポイントのリクエストは未定義 ユーザー情報更新用APIエンドポイントを再構成 Aug 7, 2022
@CornerSyrup CornerSyrup added the api-design Related to API definition label Aug 17, 2022
@CornerSyrup CornerSyrup added this to the api-v0.4.1 milestone Aug 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-design Related to API definition
Projects
None yet
Development

No branches or pull requests

1 participant