diff --git a/groupAPI.yaml b/groupAPI.yaml index c144344..2efbc92 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" + description: "自分のユーザーID" + required: true + type: "string" + - name: "token" + in: "query" + description: "端末が所持するトークン" required: true type: "string" responses: @@ -43,21 +48,33 @@ description: "新規グループ作成者のuId" required: true type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" schema: $ref: "#/definitions/newGroupInfo" - /cosmos/groups/{groupId}: + /cosmos/groups/{gId}: get: summary: "グループ情報API" - description: "指定されたグループの情報を返します" + description: "自分が所属するグループの中で指定されたグループの情報を返します" + consumes: + - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "取得したいグループのID" required: true type: "string" + - name: "token" + in: "query" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -68,29 +85,43 @@ schema: $ref: "#/definitions/error" delete: - summary: "delete a group" + summary: "グループの削除" description: "指定されたグループを削除" + consumes: + - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "削除したいグループのID" required: true type: "string" + - name: "token" + in: "formData" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" schema: $ref: "#/definitions/delete" - /cosmos/groups/{groupId}/members: + /cosmos/groups/{gId}/members: get: summary: "メンバー情報" description: "指定されたグループのメンバーの情報" + consumes: + - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "取得したいグループのID" required: true type: "string" + - name: "token" + in: "query" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -102,9 +133,9 @@ consumes: - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" - description: "取得したいグループのID" + description: "所属メンバーを変更したいグループのID" required: true type: "string" - name: "uId" @@ -112,6 +143,11 @@ description: "追加したいメンバーのuId" required: true type: "string" + - name: "token" + in: "formData" + description: "追加する人の端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -123,7 +159,7 @@ consumes: - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "取得したいグループのID" required: true @@ -133,21 +169,33 @@ description: "削除したいメンバーのuId" required: true type: "string" + - name: "token" + in: "formData" + description: "削除する側の端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" schema: $ref: "#/definitions/membersInfo" - /cosmos/groups/{groupId}/requests: + /cosmos/groups/{gId}/requests: get: summary: "リクエスト情報の取得" description: "指定したグループのリクエストの情報を取得" + consumes: + - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "取得したいグループのID" required: true type: "string" + - name: "token" + in: "query" + description: "端末が所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -159,7 +207,7 @@ consumes: - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "リクエスト発行先グループのID" required: true @@ -182,26 +230,64 @@ format: "date" - name: "location" in: "formData" - description: "場所の業種コード" + description: "YahooローカルサーチAPIの業種コード(URL:https://developer.yahoo.co.jp/webapi/map/openlocalplatform/genre.html)" 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: "query" + description: "端末が所持するトークン" + required: true + type: "string" + responses: + 200: + description: "成功時のレスポンス" + schema: + $ref: "#/definitions/requestDetail" put: summary: "リクエストの変更" description: "指定したグループにリクエスト変更" consumes: - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "リクエスト変更先グループのID" required: true type: "string" + - name: "rId" + in: "path" + description: "変更したいリクエストのID" + required: true + type: "string" - name: "uId" in: "formData" description: "発行者ID" @@ -220,49 +306,46 @@ format: "date" - name: "location" in: "formData" - description: "場所の業種コード" + description: "YahooローカルサーチAPIの業種コード(URL:https://developer.yahoo.co.jp/webapi/map/openlocalplatform/genre.html)" required: false type: "integer" format: "int64" + - name: "done" + in: "formData" + description: "達成済みか否か" + required: true + type: boolean + - name: "token" + in: "formData" + description: "端末ごとに所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" schema: $ref: "#/definitions/requestInfo" - /cosmos/groups/{groupId}/requests/{requestId}: - get: - summary: "リクエスト情報の詳細を取得" - description: "指定したグループの指定したリクエストの情報を取得" - parameters: - - name: "groupId" - in: "path" - description: "(指定したい)グループのID" - required: true - type: "string" - - name: "requestId" - in: "path" - description: "取得したいリクエストのID" - required: true - type: "string" - responses: - 200: - description: "成功時のレスポンス" - schema: - $ref: "#/definitions/requestDetail" delete: summary: "リクエストの削除" description: "指定したグループの指定したリクエストを削除" + consumes: + - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "(指定したい)グループのID" required: true type: "string" - - name: "requestId" + - name: "rId" in: "path" description: "削除したいリクエストのID" required: true type: "string" + - name: "token" + in: "formData" + description: "端末ごとに所持するトークン" + required: true + type: "string" responses: 200: description: "成功時のレスポンス" @@ -312,10 +395,7 @@ example: [] requestInfo: type: "object" - properties: - requests: - type: "object" - example: {"rId":"123456789","uri":"http://123456789.com"} + example: {"rId":"123456789","uri":"http://123456789.com"} requestsInfo: type: "object" properties: