Skip to content

Commit

Permalink
api仕様策定完了
Browse files Browse the repository at this point in the history
  • Loading branch information
tako0614 committed Jul 6, 2024
1 parent 055dd20 commit 5be4e0e
Show file tree
Hide file tree
Showing 37 changed files with 154 additions and 32 deletions.
44 changes: 20 additions & 24 deletions fresh.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,10 @@ import * as $api_v2_client_users_icon from "./routes/api/v2/client/users/icon.ts
import * as $api_v2_client_users_profile from "./routes/api/v2/client/users/profile.ts"
import * as $api_v2_client_users_settings from "./routes/api/v2/client/users/settings.ts"
import * as $api_v2_client_welcome from "./routes/api/v2/client/welcome.ts"
import * as $api_v2_server_activity_accept_community from "./routes/api/v2/server/activity/accept/community.ts"
import * as $api_v2_server_activity_accept_friend from "./routes/api/v2/server/activity/accept/friend.ts"
import * as $api_v2_server_activity_accept_group from "./routes/api/v2/server/activity/accept/group.ts"
import * as $api_v2_server_activity_block_user from "./routes/api/v2/server/activity/block/user.ts"
import * as $api_v2_server_activity_create_community from "./routes/api/v2/server/activity/create/community.ts"
import * as $api_v2_server_activity_create_group from "./routes/api/v2/server/activity/create/group.ts"
import * as $api_v2_server_activity_delete_community from "./routes/api/v2/server/activity/delete/community.ts"
import * as $api_v2_server_activity_delete_group from "./routes/api/v2/server/activity/delete/group.ts"
import * as $api_v2_server_activity_delete_message from "./routes/api/v2/server/activity/delete/message.ts"
import * as $api_v2_server_activity_flag_community from "./routes/api/v2/server/activity/flag/community.ts"
import * as $api_v2_server_activity_flag_group from "./routes/api/v2/server/activity/flag/group.ts"
Expand All @@ -83,10 +80,9 @@ import * as $api_v2_server_activity_ignore_friend from "./routes/api/v2/server/a
import * as $api_v2_server_activity_ignore_group from "./routes/api/v2/server/activity/ignore/group.ts"
import * as $api_v2_server_activity_invite_group from "./routes/api/v2/server/activity/invite/group.ts"
import * as $api_v2_server_activity_join_community from "./routes/api/v2/server/activity/join/community.ts"
import * as $api_v2_server_activity_join_group from "./routes/api/v2/server/activity/join/group.ts"
import * as $api_v2_server_activity_read_message from "./routes/api/v2/server/activity/read/message.ts"
import * as $api_v2_server_activity_read_request from "./routes/api/v2/server/activity/read/request.ts"
import * as $api_v2_server_activity_req_friend from "./routes/api/v2/server/activity/req/friend.ts"
import * as $api_v2_server_activity_request_community from "./routes/api/v2/server/activity/request/community.ts"
import * as $api_v2_server_activity_request_friend from "./routes/api/v2/server/activity/request/friend.ts"
import * as $api_v2_server_activity_talk_audio from "./routes/api/v2/server/activity/talk/audio.ts"
import * as $api_v2_server_activity_talk_image from "./routes/api/v2/server/activity/talk/image.ts"
import * as $api_v2_server_activity_talk_text from "./routes/api/v2/server/activity/talk/text.ts"
Expand All @@ -95,11 +91,13 @@ import * as $api_v2_server_activity_update_profile from "./routes/api/v2/server/
import * as $api_v2_server_activity_update_text from "./routes/api/v2/server/activity/update/text.ts"
import * as $api_v2_server_blocked from "./routes/api/v2/server/blocked.ts"
import * as $api_v2_server_info from "./routes/api/v2/server/info.ts"
import * as $api_v2_server_information_users_ID_icon_friend from "./routes/api/v2/server/information/users/[ID]/icon/friend.ts"
import * as $api_v2_server_information_users_ID_icon_friendcode from "./routes/api/v2/server/information/users/[ID]/icon/friendcode.ts"
import * as $api_v2_server_information_users_ID_icon_group from "./routes/api/v2/server/information/users/[ID]/icon/group.ts"
import * as $api_v2_server_information_users_ID_name from "./routes/api/v2/server/information/users/[ID]/name.ts"
import * as $api_v2_server_information_users_ID_uuid from "./routes/api/v2/server/information/users/[ID]/uuid.ts"
import * as $api_v2_server_information_talk_ID_image from "./routes/api/v2/server/information/talk/[ID]/image.ts"
import * as $api_v2_server_information_talk_ID_index from "./routes/api/v2/server/information/talk/[ID]/index.ts"
import * as $api_v2_server_information_users_friendID_icon_friend from "./routes/api/v2/server/information/users/[friendid]/icon/friend.ts"
import * as $api_v2_server_information_users_friendID_icon_friendcode from "./routes/api/v2/server/information/users/[friendid]/icon/friendcode.ts"
import * as $api_v2_server_information_users_friendID_icon_group from "./routes/api/v2/server/information/users/[friendid]/icon/group.ts"
import * as $api_v2_server_information_users_friendID_name from "./routes/api/v2/server/information/users/[friendid]/name.ts"
import * as $api_v2_server_information_users_friendID_uuid from "./routes/api/v2/server/information/users/[friendid]/uuid.ts"
import * as $api_v2_server_information_users_profile from "./routes/api/v2/server/information/users/profile.ts"
import * as $api_v2_server_pubkey from "./routes/api/v2/server/pubkey.ts"
import * as $home_roomid_ from "./routes/home/[roomid].tsx"
Expand Down Expand Up @@ -198,13 +196,10 @@ const manifest = {
"./routes/api/v2/client/users/profile.ts": $api_v2_client_users_profile,
"./routes/api/v2/client/users/settings.ts": $api_v2_client_users_settings,
"./routes/api/v2/client/welcome.ts": $api_v2_client_welcome,
"./routes/api/v2/server/activity/accept/community.ts": $api_v2_server_activity_accept_community,
"./routes/api/v2/server/activity/accept/friend.ts": $api_v2_server_activity_accept_friend,
"./routes/api/v2/server/activity/accept/group.ts": $api_v2_server_activity_accept_group,
"./routes/api/v2/server/activity/block/user.ts": $api_v2_server_activity_block_user,
"./routes/api/v2/server/activity/create/community.ts": $api_v2_server_activity_create_community,
"./routes/api/v2/server/activity/create/group.ts": $api_v2_server_activity_create_group,
"./routes/api/v2/server/activity/delete/community.ts": $api_v2_server_activity_delete_community,
"./routes/api/v2/server/activity/delete/group.ts": $api_v2_server_activity_delete_group,
"./routes/api/v2/server/activity/delete/message.ts": $api_v2_server_activity_delete_message,
"./routes/api/v2/server/activity/flag/community.ts": $api_v2_server_activity_flag_community,
"./routes/api/v2/server/activity/flag/group.ts": $api_v2_server_activity_flag_group,
Expand All @@ -213,10 +208,9 @@ const manifest = {
"./routes/api/v2/server/activity/ignore/group.ts": $api_v2_server_activity_ignore_group,
"./routes/api/v2/server/activity/invite/group.ts": $api_v2_server_activity_invite_group,
"./routes/api/v2/server/activity/join/community.ts": $api_v2_server_activity_join_community,
"./routes/api/v2/server/activity/join/group.ts": $api_v2_server_activity_join_group,
"./routes/api/v2/server/activity/read/message.ts": $api_v2_server_activity_read_message,
"./routes/api/v2/server/activity/read/request.ts": $api_v2_server_activity_read_request,
"./routes/api/v2/server/activity/req/friend.ts": $api_v2_server_activity_req_friend,
"./routes/api/v2/server/activity/request/community.ts": $api_v2_server_activity_request_community,
"./routes/api/v2/server/activity/request/friend.ts": $api_v2_server_activity_request_friend,
"./routes/api/v2/server/activity/talk/audio.ts": $api_v2_server_activity_talk_audio,
"./routes/api/v2/server/activity/talk/image.ts": $api_v2_server_activity_talk_image,
"./routes/api/v2/server/activity/talk/text.ts": $api_v2_server_activity_talk_text,
Expand All @@ -225,11 +219,13 @@ const manifest = {
"./routes/api/v2/server/activity/update/text.ts": $api_v2_server_activity_update_text,
"./routes/api/v2/server/blocked.ts": $api_v2_server_blocked,
"./routes/api/v2/server/info.ts": $api_v2_server_info,
"./routes/api/v2/server/information/users/[ID]/icon/friend.ts": $api_v2_server_information_users_ID_icon_friend,
"./routes/api/v2/server/information/users/[ID]/icon/friendcode.ts": $api_v2_server_information_users_ID_icon_friendcode,
"./routes/api/v2/server/information/users/[ID]/icon/group.ts": $api_v2_server_information_users_ID_icon_group,
"./routes/api/v2/server/information/users/[ID]/name.ts": $api_v2_server_information_users_ID_name,
"./routes/api/v2/server/information/users/[ID]/uuid.ts": $api_v2_server_information_users_ID_uuid,
"./routes/api/v2/server/information/talk/[ID]/image.ts": $api_v2_server_information_talk_ID_image,
"./routes/api/v2/server/information/talk/[ID]/index.ts": $api_v2_server_information_talk_ID_index,
"./routes/api/v2/server/information/users/[friendID]/icon/friend.ts": $api_v2_server_information_users_friendID_icon_friend,
"./routes/api/v2/server/information/users/[friendID]/icon/friendcode.ts": $api_v2_server_information_users_friendID_icon_friendcode,
"./routes/api/v2/server/information/users/[friendID]/icon/group.ts": $api_v2_server_information_users_friendID_icon_group,
"./routes/api/v2/server/information/users/[friendID]/name.ts": $api_v2_server_information_users_friendID_name,
"./routes/api/v2/server/information/users/[friendID]/uuid.ts": $api_v2_server_information_users_friendID_uuid,
"./routes/api/v2/server/information/users/profile.ts": $api_v2_server_information_users_profile,
"./routes/api/v2/server/pubkey.ts": $api_v2_server_pubkey,
"./routes/home/[roomid].tsx": $home_roomid_,
Expand Down
6 changes: 6 additions & 0 deletions routes/api/v2/server/activity/accept/community.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//communityサーバーへの参加申請を承認する
// POST /api/v2/server/activity/accept/community
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { userid: string, communityid: string }
// -> { status: boolean, message: string }
6 changes: 6 additions & 0 deletions routes/api/v2/server/activity/accept/friend.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//友達リクエストを承認する
// POST /api/v2/server/activity/accept/friend
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { friendid: string, userid: string }
// -> { status: boolean, message: string }
6 changes: 6 additions & 0 deletions routes/api/v2/server/activity/accept/group.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//グループの参加を承認する
// POST /api/v2/server/activity/accept/group
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { groupid: string, userid: string }
// -> { status: boolean, message: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/block/user.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//ユーザーをブロックしたことを通知する
// POST /api/v2/server/activity/block/user
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { userid: string, username: string }
Empty file.
Empty file.
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/delete/message.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//メッセージを削除するapi
//POST /api/v2/server/activity/delete/message
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { messageid: string, userid: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/flag/community.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//communityを通報する
// POST /api/v2/server/activity/flag/community
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { communityid: string, userid: string, reason: string }
6 changes: 6 additions & 0 deletions routes/api/v2/server/activity/flag/group.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//グループを通報するapi
//POST /api/v2/server/activity/flag/group
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { groupid: string, userid: string, reason: string }
// -> { status: boolean, message: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/flag/user.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//ユーザーを通報
// POST /api/v2/server/activity/flag/user
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { userid: string, reason: string, messageid: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/ignore/friend.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//リクエストを無視したことを通知
// POST /api/v2/server/activity/ignore/friend
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { friendid: string, userid: string }
6 changes: 6 additions & 0 deletions routes/api/v2/server/activity/ignore/group.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//グループの招待を無視する
// POST /api/v2/server/activity/ignore/group
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { groupid: string, userid: string }
// -> { status: boolean, message: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/invite/group.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//グループチャットに友達を招待
// POST /api/v2/server/activity/invite/group
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { groupid: string, userid: string, friendid: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/join/community.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//公開されたcommunityサーバーに参加する
// POST /api/v2/server/activity/join/community
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { communityid: string, userid: string }
Empty file.
6 changes: 6 additions & 0 deletions routes/api/v2/server/activity/read/message.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//メッセージを読んだことをサーバーに通知する
// POST /api/v2/server/activity/read/message
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { messageid: string, userid: string }
// -> { status: boolean, message: string }
Empty file.
Empty file.
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/request/community.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//communityサーバーへ参加申請を送信する
// POST /api/v2/server/activity/join/request/community
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { userid: string, communityid: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/request/friend.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//友達申請を申請
// POST: /api/v2/server/activity/request/friend
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { userid: string, friendid: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/talk/audio.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//音声メッセージを送信したことを受け取る
// POST /api/v2/server/activity/talk/audio
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { messageid: string, userid: string, roomid: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/talk/image.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//画像メッセージを送信したことを受け取る
// POST /api/v2/server/activity/talk/image
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { messageid: string, userid: string, roomid: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/talk/text.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//テキストメッセージを送信したことを受け取る
// POST /api/v2/server/activity/talk/text
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { messageid: string, userid: string, roomid: string, text: string }
5 changes: 5 additions & 0 deletions routes/api/v2/server/activity/talk/video.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//動画メッセージを送信したことを受け取る
// POST /api/v2/server/activity/talk/video
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { messageid: string, userid: string, roomid: string}
6 changes: 6 additions & 0 deletions routes/api/v2/server/activity/update/profile.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//プロフィールを変更したことを通知
// POST /api/v2/server/activity/update/profile
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { userid: string }
// -> { status: boolean, message: string }
6 changes: 6 additions & 0 deletions routes/api/v2/server/information/talk/[ID]/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//トークデータを取得する
// GET /api/v2/server/information/talk/:id
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
//ある時間以前のトークデータを取得する
// body: { roomid: string, userid: string, limit: number, before: number }
Empty file.
Empty file.
Empty file.
3 changes: 0 additions & 3 deletions routes/api/v2/server/information/users/[ID]/name.ts

This file was deleted.

3 changes: 0 additions & 3 deletions routes/api/v2/server/information/users/[ID]/uuid.ts

This file was deleted.

6 changes: 6 additions & 0 deletions routes/api/v2/server/information/users/icon.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//アイコンを取得する
//POST /api/v2/server/information/users/icon
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { userid: string, friendid: string }
// -> { status: boolean, icon: file }
6 changes: 5 additions & 1 deletion routes/api/v2/server/information/users/profile.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
//ユーザーのプロフィールを取得
//POST /api/v2/server/information/users/profile
//POST /api/v2/server/information/users/profile
// { host: string, body: string }
// bodyは秘密鍵で署名されたJSON
// body: { userid: string, friendid: string }
// -> { status: boolean, profile: { name: string, icon: string, description: string, birthday: string} }
File renamed without changes.
11 changes: 10 additions & 1 deletion util/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,13 @@ interface Profile {
userId: string;
nickName: string;
age?: number;
}
}
const types = {
client: {
block: {
user: {
}
},
}
}
export default types;

0 comments on commit 5be4e0e

Please sign in to comment.