diff --git a/groupAPI.yaml b/groupAPI.yaml index c144344..744d289 100644 --- a/groupAPI.yaml +++ b/groupAPI.yaml @@ -48,12 +48,12 @@ description: "成功時のレスポンス" schema: $ref: "#/definitions/newGroupInfo" - /cosmos/groups/{groupId}: + /cosmos/groups/{gId}: get: summary: "グループ情報API" description: "指定されたグループの情報を返します" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "取得したいグループのID" required: true @@ -71,7 +71,7 @@ summary: "delete a group" description: "指定されたグループを削除" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "削除したいグループのID" required: true @@ -81,12 +81,12 @@ description: "成功時のレスポンス" schema: $ref: "#/definitions/delete" - /cosmos/groups/{groupId}/members: + /cosmos/groups/{gId}/members: get: summary: "メンバー情報" description: "指定されたグループのメンバーの情報" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "取得したいグループのID" required: true @@ -102,7 +102,7 @@ consumes: - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "取得したいグループのID" required: true @@ -123,7 +123,7 @@ consumes: - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "取得したいグループのID" required: true @@ -138,12 +138,12 @@ description: "成功時のレスポンス" schema: $ref: "#/definitions/membersInfo" - /cosmos/groups/{groupId}/requests: + /cosmos/groups/{gId}/requests: get: summary: "リクエスト情報の取得" description: "指定したグループのリクエストの情報を取得" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "取得したいグループのID" required: true @@ -159,7 +159,7 @@ consumes: - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "リクエスト発行先グループのID" required: true @@ -197,7 +197,7 @@ consumes: - "multipart/form-data" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "リクエスト変更先グループのID" required: true @@ -220,26 +220,31 @@ format: "date" - name: "location" in: "formData" - description: "場所の業種コード" + description: "YahooローカルサーチAPIの業種コード" required: false type: "integer" format: "int64" + - name: "done" + in: "formData" + description: "達成済みか否か" + required: true + type: boolean responses: 200: description: "成功時のレスポンス" schema: $ref: "#/definitions/requestInfo" - /cosmos/groups/{groupId}/requests/{requestId}: + /cosmos/groups/{gId}/requests/{rId}: get: summary: "リクエスト情報の詳細を取得" description: "指定したグループの指定したリクエストの情報を取得" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "(指定したい)グループのID" required: true type: "string" - - name: "requestId" + - name: "rId" in: "path" description: "取得したいリクエストのID" required: true @@ -253,12 +258,12 @@ summary: "リクエストの削除" description: "指定したグループの指定したリクエストを削除" parameters: - - name: "groupId" + - name: "gId" in: "path" description: "(指定したい)グループのID" required: true type: "string" - - name: "requestId" + - name: "rId" in: "path" description: "削除したいリクエストのID" required: true