diff --git a/userAPI.yaml b/userAPI.yaml index 992757d..add4922 100644 --- a/userAPI.yaml +++ b/userAPI.yaml @@ -34,7 +34,7 @@ type: "string" - name: "icon-image" in: "formData" - description: "アイコンイメージ" + description: "アイコンイメージ(base64)" required: false type: "string" - name: "token" @@ -100,22 +100,30 @@ - name: "name" in: "formData" description: "ユーザー名の更新" - required: false + required: true type: "string" - name: "pw" in: "formData" description: "パスワードの更新" - required: false + required: true type: "string" - name: "icon-image" in: "formData" - description: "アイコンイメージの更新" + description: "アイコンイメージの更新(base64)" required: false type: "string" responses: 200: description: "更新しました" - + schema: + type: "object" + properties: + uId: + type: "string" + example: "1234" + uri: + type: "string" + example: "http://nitta-lab-www.is.konan-u.ac.jp/cosmos/users/{uId}" delete: summary: "ユーザー情報を削除" description: "userIdを指定してユーザーの情報を削除します。" @@ -134,14 +142,32 @@ type: "string" responses: 200: - description: "削除しました" + description: "成功時のレスポンス" + schema: + type: "object" + properties: + massage: + type: "string" + example: "Already Deleted" 400: description: "無効なユーザが指定されました。" + schema: + type: "object" + properties: + massage: + type: "string" + example: "Invalid User" 404: description: "ユーザが見つかりませんでした。" + schema: + type: "object" + properties: + massage: + type: "string" + example: "User Not Found" /users/{uId}/login: - put: + post: summary: "ログイン" description: "" parameters: @@ -164,7 +190,7 @@ description: "ユーザIDもしくはパスワードが間違っています。" /users/{uId}/logout: - put: + delete: summary: "ログアウト" description: "" consumes: @@ -192,7 +218,7 @@ properties: uId: type: "string" - example: "12345@6789.com" + example: "12345" name: type: "string" example: "甲南 太郎"