Skip to content

Commit

Permalink
Merge pull request YJU-OKURA#217 from yuminn-k/feat/swagger-bearer-auth
Browse files Browse the repository at this point in the history
SwaggerにBearer Authenticationを実装
yuminn-k authored Apr 23, 2024
2 parents 05e907c + ad76594 commit 9b9add3
Showing 3 changed files with 504 additions and 0 deletions.
209 changes: 209 additions & 0 deletions docs/docs.go
Original file line number Diff line number Diff line change
@@ -17,6 +17,11 @@ const docTemplate = `{
"paths": {
"/at/attendance/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDの出席情報を取得",
"consumes": [
"application/json"
@@ -53,6 +58,11 @@ const docTemplate = `{
}
},
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDの出席情報を削除",
"consumes": [
"application/json"
@@ -105,6 +115,11 @@ const docTemplate = `{
},
"/at/{cid}/{uid}/{csid}": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "出席情報を作成または更新",
"consumes": [
"application/json"
@@ -164,6 +179,11 @@ const docTemplate = `{
},
"/at/{classID}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "クラスの全ての出席情報を取得",
"consumes": [
"application/json"
@@ -314,6 +334,11 @@ const docTemplate = `{
},
"/cb": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "cidに基づいて、グループの全ての掲示板を取得します。",
"consumes": [
"application/json"
@@ -379,6 +404,9 @@ const docTemplate = `{
"security": [
{
"ApiKeyAuth": []
},
{
"Bearer": []
}
],
"description": "クラス掲示板を作成します。",
@@ -464,6 +492,11 @@ const docTemplate = `{
},
"/cb/announced": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "cidに基づいて、公告されたグループの掲示板を取得します。",
"consumes": [
"application/json"
@@ -508,6 +541,11 @@ const docTemplate = `{
},
"/cb/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDのグループ掲示板の詳細を取得します。",
"consumes": [
"application/json"
@@ -559,6 +597,9 @@ const docTemplate = `{
"security": [
{
"ApiKeyAuth": []
},
{
"Bearer": []
}
],
"description": "指定されたIDのグループ掲示板を削除します。",
@@ -631,6 +672,11 @@ const docTemplate = `{
},
"/cb/{id}/{cid}/{uid}": {
"patch": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDのグループ掲示板の詳細を更新します。",
"consumes": [
"application/json"
@@ -710,6 +756,11 @@ const docTemplate = `{
},
"/cc/checkSecretExists": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたグループコードにシークレットがあるかどうかをチェックする。",
"consumes": [
"application/json"
@@ -754,6 +805,11 @@ const docTemplate = `{
},
"/cc/verifyClassCode": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "グループコードと、該当する場合はそのシークレットを確認する。また、指定されたユーザーに役割を割り当てる。",
"consumes": [
"application/json"
@@ -817,6 +873,11 @@ const docTemplate = `{
},
"/chat/create-room/{scheduleId}": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "チャットルームを作成する。",
"consumes": [
"application/json"
@@ -855,6 +916,11 @@ const docTemplate = `{
},
"/chat/dm/{senderId}/{receiverId}": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "Send a direct message to a specific user",
"consumes": [
"application/json"
@@ -901,6 +967,11 @@ const docTemplate = `{
},
"/chat/dm/{userId1}/{userId2}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "Get direct messages history between two users",
"consumes": [
"application/json"
@@ -940,6 +1011,11 @@ const docTemplate = `{
},
"/chat/messages/{roomid}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "チャットメッセージを取得する。",
"consumes": [
"application/json"
@@ -972,6 +1048,11 @@ const docTemplate = `{
},
"/chat/room/{scheduleId}": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "チャットルームにメッセージを投稿する。",
"consumes": [
"multipart/form-data"
@@ -1016,6 +1097,11 @@ const docTemplate = `{
}
},
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "チャットルームを削除する。",
"consumes": [
"application/json"
@@ -1048,6 +1134,11 @@ const docTemplate = `{
},
"/chat/room/{scheduleId}/{userId}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "チャットルームをハンドルする。",
"consumes": [
"text/html"
@@ -1087,6 +1178,11 @@ const docTemplate = `{
},
"/chat/stream/{scheduleId}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "チャットをストリームする。",
"consumes": [
"application/json"
@@ -1112,6 +1208,11 @@ const docTemplate = `{
},
"/cl/create": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "名前、定員、説明、画像URL、作成者のUIDを持つ新しいクラスを作成します。画像はオプショナルです。",
"consumes": [
"multipart/form-data"
@@ -1184,6 +1285,11 @@ const docTemplate = `{
},
"/cl/{cid}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDを持つクラスの情報を取得します。",
"consumes": [
"application/json"
@@ -1237,6 +1343,11 @@ const docTemplate = `{
},
"/cl/{uid}/{cid}": {
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDを持つクラスを削除します。",
"consumes": [
"application/json"
@@ -1289,6 +1400,11 @@ const docTemplate = `{
}
},
"patch": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDを持つクラスの情報を更新します。",
"consumes": [
"multipart/form-data"
@@ -1374,6 +1490,11 @@ const docTemplate = `{
},
"/cs": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたクラスIDの全てのクラススケジュールを取得する。",
"consumes": [
"application/json"
@@ -1415,6 +1536,11 @@ const docTemplate = `{
}
},
"post": {
"security": [
{
"Bearer": []
}
],
"description": "新しいクラススケジュールを作成する。",
"consumes": [
"application/json"
@@ -1475,6 +1601,11 @@ const docTemplate = `{
},
"/cs/date": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたクラスIDと日付のクラススケジュールを取得する。",
"consumes": [
"application/json"
@@ -1532,6 +1663,11 @@ const docTemplate = `{
},
"/cs/live": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたクラスIDのライブ中のクラススケジュールを取得する。",
"consumes": [
"application/json"
@@ -1576,6 +1712,11 @@ const docTemplate = `{
},
"/cs/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDのクラススケジュールを取得する。",
"consumes": [
"application/json"
@@ -1618,6 +1759,11 @@ const docTemplate = `{
}
},
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDのクラススケジュールを削除する。",
"consumes": [
"application/json"
@@ -1674,6 +1820,11 @@ const docTemplate = `{
}
},
"patch": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDのクラススケジュールを更新する。",
"consumes": [
"application/json"
@@ -1741,6 +1892,11 @@ const docTemplate = `{
},
"/cu/class/{cid}/{role}/members": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたcidのクラスに所属しているメンバーの情報を取得します。",
"consumes": [
"application/json"
@@ -1796,6 +1952,11 @@ const docTemplate = `{
},
"/cu/{uid}/classes": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "特定のユーザーが参加している全てのクラスの情報を取得します。",
"consumes": [
"application/json"
@@ -1845,6 +2006,11 @@ const docTemplate = `{
},
"/cu/{uid}/classes/{roleID}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "ユーザーIDとロールIDに基づいて、ユーザーが所属しているクラスの情報を取得します。ロールIDが2の場合は自分が作ったクラスリスト、ロールIDが4の場合はユーザーから申し込んだクラスリスト、ロールIDが6の場合はクラスの管理者から招待されたクラスリストを取得します。",
"consumes": [
"application/json"
@@ -1919,6 +2085,11 @@ const docTemplate = `{
},
"/cu/{uid}/favorite-classes": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "ユーザーIDに基づいて、お気에入りに設定されたクラスの情報を取得します。",
"consumes": [
"application/json"
@@ -1986,6 +2157,11 @@ const docTemplate = `{
},
"/cu/{uid}/{cid}/info": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "特定のユーザーIDに基づいて、クラスユーザー情報を取得します。",
"consumes": [
"application/json"
@@ -2043,6 +2219,11 @@ const docTemplate = `{
},
"/cu/{uid}/{cid}/remove": {
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "指定したユーザーIDとクラスIDに基づいて、ユーザーをクラスから削除します。",
"consumes": [
"application/json"
@@ -2100,6 +2281,11 @@ const docTemplate = `{
},
"/cu/{uid}/{cid}/rename": {
"put": {
"security": [
{
"Bearer": []
}
],
"description": "特定のユーザーIDとグループIDに対してユーザーの名前を更新します。",
"consumes": [
"application/json"
@@ -2155,6 +2341,11 @@ const docTemplate = `{
},
"/cu/{uid}/{cid}/toggle-favorite": {
"patch": {
"security": [
{
"Bearer": []
}
],
"description": "ユーザーIDとクラスIDに基づいて、お気に入りのクラスを切り替えます。",
"consumes": [
"application/json"
@@ -2212,6 +2403,11 @@ const docTemplate = `{
},
"/cu/{uid}/{cid}/{roleID}": {
"patch": {
"security": [
{
"Bearer": []
}
],
"description": "ユーザーのロールを変更します。",
"consumes": [
"application/json"
@@ -2515,6 +2711,11 @@ const docTemplate = `{
},
"/u/{userID}/applying-classes": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "ユーザーが申し込んだクラスを取得します。",
"consumes": [
"application/json"
@@ -2849,6 +3050,14 @@ const docTemplate = `{
}
}
}
},
"securityDefinitions": {
"Bearer": {
"description": "Type \"Bearer\" followed by a space and JWT token.",
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}`

209 changes: 209 additions & 0 deletions docs/swagger.json
Original file line number Diff line number Diff line change
@@ -6,6 +6,11 @@
"paths": {
"/at/attendance/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDの出席情報を取得",
"consumes": [
"application/json"
@@ -42,6 +47,11 @@
}
},
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDの出席情報を削除",
"consumes": [
"application/json"
@@ -94,6 +104,11 @@
},
"/at/{cid}/{uid}/{csid}": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "出席情報を作成または更新",
"consumes": [
"application/json"
@@ -153,6 +168,11 @@
},
"/at/{classID}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "クラスの全ての出席情報を取得",
"consumes": [
"application/json"
@@ -303,6 +323,11 @@
},
"/cb": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "cidに基づいて、グループの全ての掲示板を取得します。",
"consumes": [
"application/json"
@@ -368,6 +393,9 @@
"security": [
{
"ApiKeyAuth": []
},
{
"Bearer": []
}
],
"description": "クラス掲示板を作成します。",
@@ -453,6 +481,11 @@
},
"/cb/announced": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "cidに基づいて、公告されたグループの掲示板を取得します。",
"consumes": [
"application/json"
@@ -497,6 +530,11 @@
},
"/cb/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDのグループ掲示板の詳細を取得します。",
"consumes": [
"application/json"
@@ -548,6 +586,9 @@
"security": [
{
"ApiKeyAuth": []
},
{
"Bearer": []
}
],
"description": "指定されたIDのグループ掲示板を削除します。",
@@ -620,6 +661,11 @@
},
"/cb/{id}/{cid}/{uid}": {
"patch": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDのグループ掲示板の詳細を更新します。",
"consumes": [
"application/json"
@@ -699,6 +745,11 @@
},
"/cc/checkSecretExists": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたグループコードにシークレットがあるかどうかをチェックする。",
"consumes": [
"application/json"
@@ -743,6 +794,11 @@
},
"/cc/verifyClassCode": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "グループコードと、該当する場合はそのシークレットを確認する。また、指定されたユーザーに役割を割り当てる。",
"consumes": [
"application/json"
@@ -806,6 +862,11 @@
},
"/chat/create-room/{scheduleId}": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "チャットルームを作成する。",
"consumes": [
"application/json"
@@ -844,6 +905,11 @@
},
"/chat/dm/{senderId}/{receiverId}": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "Send a direct message to a specific user",
"consumes": [
"application/json"
@@ -890,6 +956,11 @@
},
"/chat/dm/{userId1}/{userId2}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "Get direct messages history between two users",
"consumes": [
"application/json"
@@ -929,6 +1000,11 @@
},
"/chat/messages/{roomid}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "チャットメッセージを取得する。",
"consumes": [
"application/json"
@@ -961,6 +1037,11 @@
},
"/chat/room/{scheduleId}": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "チャットルームにメッセージを投稿する。",
"consumes": [
"multipart/form-data"
@@ -1005,6 +1086,11 @@
}
},
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "チャットルームを削除する。",
"consumes": [
"application/json"
@@ -1037,6 +1123,11 @@
},
"/chat/room/{scheduleId}/{userId}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "チャットルームをハンドルする。",
"consumes": [
"text/html"
@@ -1076,6 +1167,11 @@
},
"/chat/stream/{scheduleId}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "チャットをストリームする。",
"consumes": [
"application/json"
@@ -1101,6 +1197,11 @@
},
"/cl/create": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "名前、定員、説明、画像URL、作成者のUIDを持つ新しいクラスを作成します。画像はオプショナルです。",
"consumes": [
"multipart/form-data"
@@ -1173,6 +1274,11 @@
},
"/cl/{cid}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDを持つクラスの情報を取得します。",
"consumes": [
"application/json"
@@ -1226,6 +1332,11 @@
},
"/cl/{uid}/{cid}": {
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDを持つクラスを削除します。",
"consumes": [
"application/json"
@@ -1278,6 +1389,11 @@
}
},
"patch": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDを持つクラスの情報を更新します。",
"consumes": [
"multipart/form-data"
@@ -1363,6 +1479,11 @@
},
"/cs": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたクラスIDの全てのクラススケジュールを取得する。",
"consumes": [
"application/json"
@@ -1404,6 +1525,11 @@
}
},
"post": {
"security": [
{
"Bearer": []
}
],
"description": "新しいクラススケジュールを作成する。",
"consumes": [
"application/json"
@@ -1464,6 +1590,11 @@
},
"/cs/date": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたクラスIDと日付のクラススケジュールを取得する。",
"consumes": [
"application/json"
@@ -1521,6 +1652,11 @@
},
"/cs/live": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたクラスIDのライブ中のクラススケジュールを取得する。",
"consumes": [
"application/json"
@@ -1565,6 +1701,11 @@
},
"/cs/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDのクラススケジュールを取得する。",
"consumes": [
"application/json"
@@ -1607,6 +1748,11 @@
}
},
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDのクラススケジュールを削除する。",
"consumes": [
"application/json"
@@ -1663,6 +1809,11 @@
}
},
"patch": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたIDのクラススケジュールを更新する。",
"consumes": [
"application/json"
@@ -1730,6 +1881,11 @@
},
"/cu/class/{cid}/{role}/members": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "指定されたcidのクラスに所属しているメンバーの情報を取得します。",
"consumes": [
"application/json"
@@ -1785,6 +1941,11 @@
},
"/cu/{uid}/classes": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "特定のユーザーが参加している全てのクラスの情報を取得します。",
"consumes": [
"application/json"
@@ -1834,6 +1995,11 @@
},
"/cu/{uid}/classes/{roleID}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "ユーザーIDとロールIDに基づいて、ユーザーが所属しているクラスの情報を取得します。ロールIDが2の場合は自分が作ったクラスリスト、ロールIDが4の場合はユーザーから申し込んだクラスリスト、ロールIDが6の場合はクラスの管理者から招待されたクラスリストを取得します。",
"consumes": [
"application/json"
@@ -1908,6 +2074,11 @@
},
"/cu/{uid}/favorite-classes": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "ユーザーIDに基づいて、お気에入りに設定されたクラスの情報を取得します。",
"consumes": [
"application/json"
@@ -1975,6 +2146,11 @@
},
"/cu/{uid}/{cid}/info": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "特定のユーザーIDに基づいて、クラスユーザー情報を取得します。",
"consumes": [
"application/json"
@@ -2032,6 +2208,11 @@
},
"/cu/{uid}/{cid}/remove": {
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "指定したユーザーIDとクラスIDに基づいて、ユーザーをクラスから削除します。",
"consumes": [
"application/json"
@@ -2089,6 +2270,11 @@
},
"/cu/{uid}/{cid}/rename": {
"put": {
"security": [
{
"Bearer": []
}
],
"description": "特定のユーザーIDとグループIDに対してユーザーの名前を更新します。",
"consumes": [
"application/json"
@@ -2144,6 +2330,11 @@
},
"/cu/{uid}/{cid}/toggle-favorite": {
"patch": {
"security": [
{
"Bearer": []
}
],
"description": "ユーザーIDとクラスIDに基づいて、お気に入りのクラスを切り替えます。",
"consumes": [
"application/json"
@@ -2201,6 +2392,11 @@
},
"/cu/{uid}/{cid}/{roleID}": {
"patch": {
"security": [
{
"Bearer": []
}
],
"description": "ユーザーのロールを変更します。",
"consumes": [
"application/json"
@@ -2504,6 +2700,11 @@
},
"/u/{userID}/applying-classes": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "ユーザーが申し込んだクラスを取得します。",
"consumes": [
"application/json"
@@ -2838,5 +3039,13 @@
}
}
}
},
"securityDefinitions": {
"Bearer": {
"description": "Type \"Bearer\" followed by a space and JWT token.",
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}
86 changes: 86 additions & 0 deletions docs/swagger.yaml
Original file line number Diff line number Diff line change
@@ -225,6 +225,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: 出席情報を作成または更新
tags:
- Attendance
@@ -252,6 +254,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: クラスの全ての出席情報を取得
tags:
- Attendance
@@ -287,6 +291,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: 出席情報を削除
tags:
- Attendance
@@ -311,6 +317,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: 出席情報を取得
tags:
- Attendance
@@ -427,6 +435,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: 全てのグループ掲示板を取得
tags:
- Class Board
@@ -484,6 +494,7 @@ paths:
type: string
security:
- ApiKeyAuth: []
- Bearer: []
summary: クラス掲示板を作成
tags:
- Class Board
@@ -533,6 +544,7 @@ paths:
type: string
security:
- ApiKeyAuth: []
- Bearer: []
summary: グループ掲示板を削除
tags:
- Class Board
@@ -565,6 +577,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: IDでグループ掲示板を取得
tags:
- Class Board
@@ -618,6 +632,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: グループ掲示板を更新
tags:
- Class Board
@@ -647,6 +663,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: 公告されたグループ掲示板を取得
tags:
- Class Board
@@ -676,6 +694,8 @@ paths:
description: コードが見つかりません
schema:
type: string
security:
- Bearer: []
summary: グループコードにシークレットが存在するかチェック
tags:
- Class Code
@@ -718,6 +738,8 @@ paths:
description: コードが見つかりません
schema:
type: string
security:
- Bearer: []
summary: グループコードとシークレットを検証&ユーザーに役割を割り当てる
tags:
- Class Code
@@ -743,6 +765,8 @@ paths:
description: Failed to create chat room
schema:
type: string
security:
- Bearer: []
summary: チャットルームを作成
tags:
- Chat Room
@@ -774,6 +798,8 @@ paths:
description: Message sent successfully
schema:
type: string
security:
- Bearer: []
summary: Send a direct message
tags:
- Direct Message
@@ -800,6 +826,8 @@ paths:
description: Messages fetched successfully
schema:
type: string
security:
- Bearer: []
summary: Get direct messages
tags:
- Direct Message
@@ -821,6 +849,8 @@ paths:
description: success
schema:
type: string
security:
- Bearer: []
summary: チャットメッセージを取得
tags:
- Chat Room
@@ -842,6 +872,8 @@ paths:
description: success
schema:
type: string
security:
- Bearer: []
summary: チャットルームを削除
tags:
- Chat Room
@@ -872,6 +904,8 @@ paths:
description: success
schema:
type: string
security:
- Bearer: []
summary: チャットルームに投稿
tags:
- Chat Room
@@ -898,6 +932,8 @@ paths:
description: チャットルームが正常にハンドルされました
schema:
type: string
security:
- Bearer: []
summary: チャットルームをハンドル
tags:
- Chat Room
@@ -915,6 +951,8 @@ paths:
produces:
- application/json
responses: {}
security:
- Bearer: []
summary: チャットをストリーム
tags:
- Chat Room
@@ -951,6 +989,8 @@ paths:
schema:
additionalProperties: true
type: object
security:
- Bearer: []
summary: クラスの情報を取得します
tags:
- Class
@@ -988,6 +1028,8 @@ paths:
schema:
additionalProperties: true
type: object
security:
- Bearer: []
summary: クラスを削除します
tags:
- Class
@@ -1045,6 +1087,8 @@ paths:
schema:
additionalProperties: true
type: object
security:
- Bearer: []
summary: クラス情報を更新します
tags:
- Class
@@ -1094,6 +1138,8 @@ paths:
schema:
additionalProperties: true
type: object
security:
- Bearer: []
summary: 新しいクラスを作成します
tags:
- Class
@@ -1122,6 +1168,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: 全てのクラススケジュールを取得
tags:
- Class Schedule
@@ -1161,6 +1209,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: クラススケジュールを作成
tags:
- Class Schedule
@@ -1200,6 +1250,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: クラススケジュールを削除
tags:
- Class Schedule
@@ -1228,6 +1280,8 @@ paths:
description: クラススケジュールが見つかりません
schema:
type: string
security:
- Bearer: []
summary: IDでクラススケジュールを取得
tags:
- Class Schedule
@@ -1272,6 +1326,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: クラススケジュールを更新
tags:
- Class Schedule
@@ -1310,6 +1366,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: 日付でクラススケジュールを取得
tags:
- Class Schedule
@@ -1339,6 +1397,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: ライブ中のクラススケジュールを取得
tags:
- Class Schedule
@@ -1379,6 +1439,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: ユーザーのロールを変更します。
tags:
- Class User
@@ -1417,6 +1479,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: ユーザーに関連するクラスユーザー情報を取得
tags:
- Class User
@@ -1455,6 +1519,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: ユーザーをクラスから削除します。
tags:
- Class User
@@ -1492,6 +1558,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: ユーザーの名前を更新します。
tags:
- Class User
@@ -1530,6 +1598,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: お気に入りのクラスを切り替えます
tags:
- Class User
@@ -1563,6 +1633,8 @@ paths:
items:
$ref: '#/definitions/models.Class'
type: array
security:
- Bearer: []
summary: ユーザーが参加しているクラスのリストを取得
tags:
- Class User
@@ -1613,6 +1685,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: ユーザーとロールに関連するクラス情報を取得
tags:
- Class User
@@ -1658,6 +1732,8 @@ paths:
description: サーバーエラーが発生しました
schema:
type: string
security:
- Bearer: []
summary: お気に入りのクラス情報を取得
tags:
- Class User
@@ -1695,6 +1771,8 @@ paths:
schema:
additionalProperties: true
type: object
security:
- Bearer: []
summary: クラスメンバーの情報を取得します
tags:
- Class User
@@ -1898,7 +1976,15 @@ paths:
description: 内部サーバーエラー
schema:
type: string
security:
- Bearer: []
summary: 申し込んだクラスを取得
tags:
- User
securityDefinitions:
Bearer:
description: Type "Bearer" followed by a space and JWT token.
in: header
name: Authorization
type: apiKey
swagger: "2.0"

0 comments on commit 9b9add3

Please sign in to comment.