summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-11-03 22:49:36 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-11-03 22:49:36 +0900
commita515c1f53ebcb8eba0c20b1f7951573d2ca7809e (patch)
treebc483f3f9a8033c74687472d8c8c82b359518103 /src
parentRefactoring (diff)
downloadsharkey-a515c1f53ebcb8eba0c20b1f7951573d2ca7809e.tar.gz
sharkey-a515c1f53ebcb8eba0c20b1f7951573d2ca7809e.tar.bz2
sharkey-a515c1f53ebcb8eba0c20b1f7951573d2ca7809e.zip
Improve API documentation
Diffstat (limited to 'src')
-rw-r--r--src/server/api/endpoints/following/requests/accept.ts4
-rw-r--r--src/server/api/endpoints/following/requests/cancel.ts4
-rw-r--r--src/server/api/endpoints/following/requests/reject.ts4
-rw-r--r--src/server/api/endpoints/following/stalk.ts4
-rw-r--r--src/server/api/endpoints/following/unstalk.ts4
-rw-r--r--src/server/api/endpoints/games/reversi/match.ts4
-rw-r--r--src/server/api/endpoints/messaging/messages.ts4
-rw-r--r--src/server/api/endpoints/messaging/messages/create.ts4
-rw-r--r--src/server/api/endpoints/mute/create.ts4
-rw-r--r--src/server/api/endpoints/mute/delete.ts4
-rw-r--r--src/server/api/endpoints/notes/conversation.ts4
-rw-r--r--src/server/api/endpoints/notes/polls/vote.ts4
-rw-r--r--src/server/api/endpoints/notes/reactions/delete.ts4
-rw-r--r--src/server/api/endpoints/notes/renotes.ts4
-rw-r--r--src/server/api/endpoints/notes/replies.ts4
-rw-r--r--src/server/api/endpoints/users/followers.ts4
-rw-r--r--src/server/api/endpoints/users/following.ts4
-rw-r--r--src/server/api/endpoints/users/get_frequently_replied_users.ts4
-rw-r--r--src/server/api/endpoints/users/lists/push.ts4
-rw-r--r--src/server/api/endpoints/users/notes.ts3
-rw-r--r--src/server/api/endpoints/users/show.ts3
21 files changed, 80 insertions, 2 deletions
diff --git a/src/server/api/endpoints/following/requests/accept.ts b/src/server/api/endpoints/following/requests/accept.ts
index 36c3694eed..2cca3a1ccb 100644
--- a/src/server/api/endpoints/following/requests/accept.ts
+++ b/src/server/api/endpoints/following/requests/accept.ts
@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
}
}
};
diff --git a/src/server/api/endpoints/following/requests/cancel.ts b/src/server/api/endpoints/following/requests/cancel.ts
index bfb7d0713c..f2dec9ffae 100644
--- a/src/server/api/endpoints/following/requests/cancel.ts
+++ b/src/server/api/endpoints/following/requests/cancel.ts
@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
}
}
};
diff --git a/src/server/api/endpoints/following/requests/reject.ts b/src/server/api/endpoints/following/requests/reject.ts
index bd0b3bba22..cce41e2df4 100644
--- a/src/server/api/endpoints/following/requests/reject.ts
+++ b/src/server/api/endpoints/following/requests/reject.ts
@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
}
}
};
diff --git a/src/server/api/endpoints/following/stalk.ts b/src/server/api/endpoints/following/stalk.ts
index 1fef9a429a..3a58e2192f 100644
--- a/src/server/api/endpoints/following/stalk.ts
+++ b/src/server/api/endpoints/following/stalk.ts
@@ -16,6 +16,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
}
}
};
diff --git a/src/server/api/endpoints/following/unstalk.ts b/src/server/api/endpoints/following/unstalk.ts
index 66e99bed58..ad07ec38ba 100644
--- a/src/server/api/endpoints/following/unstalk.ts
+++ b/src/server/api/endpoints/following/unstalk.ts
@@ -16,6 +16,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
}
}
};
diff --git a/src/server/api/endpoints/games/reversi/match.ts b/src/server/api/endpoints/games/reversi/match.ts
index e0f9c20cbb..43b6fc8eed 100644
--- a/src/server/api/endpoints/games/reversi/match.ts
+++ b/src/server/api/endpoints/games/reversi/match.ts
@@ -13,6 +13,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
},
}
};
diff --git a/src/server/api/endpoints/messaging/messages.ts b/src/server/api/endpoints/messaging/messages.ts
index 50a5eb00d8..3d033f1109 100644
--- a/src/server/api/endpoints/messaging/messages.ts
+++ b/src/server/api/endpoints/messaging/messages.ts
@@ -19,6 +19,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
},
limit: {
diff --git a/src/server/api/endpoints/messaging/messages/create.ts b/src/server/api/endpoints/messaging/messages/create.ts
index bcd4d6b63c..f8901449fe 100644
--- a/src/server/api/endpoints/messaging/messages/create.ts
+++ b/src/server/api/endpoints/messaging/messages/create.ts
@@ -25,6 +25,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
},
text: {
diff --git a/src/server/api/endpoints/mute/create.ts b/src/server/api/endpoints/mute/create.ts
index f3bb3da14f..13323da324 100644
--- a/src/server/api/endpoints/mute/create.ts
+++ b/src/server/api/endpoints/mute/create.ts
@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
},
}
};
diff --git a/src/server/api/endpoints/mute/delete.ts b/src/server/api/endpoints/mute/delete.ts
index 68de0feb28..3808c15270 100644
--- a/src/server/api/endpoints/mute/delete.ts
+++ b/src/server/api/endpoints/mute/delete.ts
@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
},
}
};
diff --git a/src/server/api/endpoints/notes/conversation.ts b/src/server/api/endpoints/notes/conversation.ts
index 7703ef7d2e..5e6e5ddb0f 100644
--- a/src/server/api/endpoints/notes/conversation.ts
+++ b/src/server/api/endpoints/notes/conversation.ts
@@ -14,6 +14,10 @@ export const meta = {
noteId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象の投稿のID',
+ 'en-US': 'Target note ID'
+ }
},
limit: {
diff --git a/src/server/api/endpoints/notes/polls/vote.ts b/src/server/api/endpoints/notes/polls/vote.ts
index f50e84ba13..dc012152c6 100644
--- a/src/server/api/endpoints/notes/polls/vote.ts
+++ b/src/server/api/endpoints/notes/polls/vote.ts
@@ -21,6 +21,10 @@ export const meta = {
noteId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象の投稿のID',
+ 'en-US': 'Target note ID'
+ }
},
choice: {
diff --git a/src/server/api/endpoints/notes/reactions/delete.ts b/src/server/api/endpoints/notes/reactions/delete.ts
index 60f49fb275..53e2f476b2 100644
--- a/src/server/api/endpoints/notes/reactions/delete.ts
+++ b/src/server/api/endpoints/notes/reactions/delete.ts
@@ -17,6 +17,10 @@ export const meta = {
noteId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象の投稿のID',
+ 'en-US': 'Target note ID'
+ }
},
}
};
diff --git a/src/server/api/endpoints/notes/renotes.ts b/src/server/api/endpoints/notes/renotes.ts
index 85d5820e58..2a434dd06e 100644
--- a/src/server/api/endpoints/notes/renotes.ts
+++ b/src/server/api/endpoints/notes/renotes.ts
@@ -14,6 +14,10 @@ export const meta = {
noteId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象の投稿のID',
+ 'en-US': 'Target note ID'
+ }
},
limit: {
diff --git a/src/server/api/endpoints/notes/replies.ts b/src/server/api/endpoints/notes/replies.ts
index 8b5a3593d1..6046b9b310 100644
--- a/src/server/api/endpoints/notes/replies.ts
+++ b/src/server/api/endpoints/notes/replies.ts
@@ -14,6 +14,10 @@ export const meta = {
noteId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象の投稿のID',
+ 'en-US': 'Target note ID'
+ }
},
limit: {
diff --git a/src/server/api/endpoints/users/followers.ts b/src/server/api/endpoints/users/followers.ts
index 9e3a30f6f1..e7f74b0651 100644
--- a/src/server/api/endpoints/users/followers.ts
+++ b/src/server/api/endpoints/users/followers.ts
@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
},
limit: {
diff --git a/src/server/api/endpoints/users/following.ts b/src/server/api/endpoints/users/following.ts
index 57bf1e1e8b..371a54f901 100644
--- a/src/server/api/endpoints/users/following.ts
+++ b/src/server/api/endpoints/users/following.ts
@@ -17,6 +17,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
},
limit: {
diff --git a/src/server/api/endpoints/users/get_frequently_replied_users.ts b/src/server/api/endpoints/users/get_frequently_replied_users.ts
index 6b8b985eea..cf123b82ba 100644
--- a/src/server/api/endpoints/users/get_frequently_replied_users.ts
+++ b/src/server/api/endpoints/users/get_frequently_replied_users.ts
@@ -10,6 +10,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
},
limit: {
diff --git a/src/server/api/endpoints/users/lists/push.ts b/src/server/api/endpoints/users/lists/push.ts
index 5c11f25dc4..396f9813a4 100644
--- a/src/server/api/endpoints/users/lists/push.ts
+++ b/src/server/api/endpoints/users/lists/push.ts
@@ -26,6 +26,10 @@ export const meta = {
userId: {
validator: $.type(ID),
transform: transform,
+ desc: {
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
+ }
},
}
};
diff --git a/src/server/api/endpoints/users/notes.ts b/src/server/api/endpoints/users/notes.ts
index 4bbacab2bf..7901ac1de1 100644
--- a/src/server/api/endpoints/users/notes.ts
+++ b/src/server/api/endpoints/users/notes.ts
@@ -15,7 +15,8 @@ export const meta = {
validator: $.type(ID).optional,
transform: transform,
desc: {
- 'ja-JP': 'ユーザーID'
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
}
},
diff --git a/src/server/api/endpoints/users/show.ts b/src/server/api/endpoints/users/show.ts
index 93223b3f9f..6e4cf514de 100644
--- a/src/server/api/endpoints/users/show.ts
+++ b/src/server/api/endpoints/users/show.ts
@@ -17,7 +17,8 @@ export const meta = {
validator: $.type(ID).optional,
transform: transform,
desc: {
- 'ja-JP': 'ユーザーID'
+ 'ja-JP': '対象のユーザーのID',
+ 'en-US': 'Target user ID'
}
},
generated by cgit v1.2.3-freya (git 2.53.0.84.g453e7b744a) at 2026-03-03 22:52:12 +0000