diff --git a/groupAPI.yaml b/groupAPI.yaml index 744d289..6143e82 100644 --- a/groupAPI.yaml +++ b/groupAPI.yaml @@ -13,13 +13,18 @@ /cosmos/groups: get: summary: "グループ取得" - description: "所属する全てのグループの情報" + description: "自分が所属する全てのグループの情報を取得" consumes: - "multipart/form-data" parameters: - name: "uId" - in: "query" - description: "取得したいユーザーのID" + in: "formData" + description: "自分のユーザーID" + required: true + type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" required: true type: "string" responses: @@ -43,6 +48,11 @@ description: "新規グループ作成者のuId" required: true type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -51,13 +61,20 @@ /cosmos/groups/{gId}: get: summary: "グループ情報API" - description: "指定されたグループの情報を返します" + description: "自分が所属するグループの中で指定されたグループの情報を返します" + consumes: + - "multipart/form-data" parameters: - name: "gId" in: "path" description: "取得したいグループのID" required: true type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -70,12 +87,19 @@ delete: summary: "delete a group" description: "指定されたグループを削除" + consumes: + - "multipart/form-data" parameters: - name: "gId" in: "path" description: "削除したいグループのID" required: true type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -85,12 +109,19 @@ get: summary: "メンバー情報" description: "指定されたグループのメンバーの情報" + consumes: + - "multipart/form-data" parameters: - name: "gId" in: "path" description: "取得したいグループのID" required: true type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -112,6 +143,11 @@ description: "追加したいメンバーのuId" required: true type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -133,6 +169,11 @@ description: "削除したいメンバーのuId" required: true type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -142,12 +183,19 @@ get: summary: "リクエスト情報の取得" description: "指定したグループのリクエストの情報を取得" + consumes: + - "multipart/form-data" parameters: - name: "gId" in: "path" description: "取得したいグループのID" required: true type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -186,11 +234,44 @@ required: false type: "integer" format: "int64" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" schema: $ref: "#/definitions/requestInfo" + + /cosmos/groups/{gId}/requests/{rId}: + get: + summary: "リクエスト情報の詳細を取得" + description: "指定したグループの指定したリクエストの情報を取得" + consumes: + - "multipart/form-data" + parameters: + - name: "gId" + in: "path" + description: "(指定したい)グループのID" + required: true + type: "string" + - name: "rId" + in: "path" + description: "取得したいリクエストのID" + required: true + type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" + responses: + 200: + description: "成功時のレスポンス" + schema: + $ref: "#/definitions/requestDetail" put: summary: "リクエストの変更" description: "指定したグループにリクエスト変更" @@ -202,6 +283,11 @@ description: "リクエスト変更先グループのID" required: true type: "string" + - name: "rId" + in: "path" + description: "変更したいリクエストのID" + required: true + type: "string" - name: "uId" in: "formData" description: "発行者ID" @@ -229,34 +315,21 @@ description: "達成済みか否か" required: true type: boolean + - name: "token" + in: "formData" + description: "端末ごとに所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" schema: $ref: "#/definitions/requestInfo" - /cosmos/groups/{gId}/requests/{rId}: - get: - summary: "リクエスト情報の詳細を取得" - description: "指定したグループの指定したリクエストの情報を取得" - parameters: - - name: "gId" - in: "path" - description: "(指定したい)グループのID" - required: true - type: "string" - - name: "rId" - in: "path" - description: "取得したいリクエストのID" - required: true - type: "string" - responses: - 200: - description: "成功時のレスポンス" - schema: - $ref: "#/definitions/requestDetail" delete: summary: "リクエストの削除" description: "指定したグループの指定したリクエストを削除" + consumes: + - "multipart/form-data" parameters: - name: "gId" in: "path" @@ -268,6 +341,11 @@ description: "削除したいリクエストのID" required: true type: "string" + - name: "token" + in: "formData" + description: "端末ごとに所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス"