summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/endpoints.ts
diff options
context:
space:
mode:
authorYuzuRyo61 <yuzuryo61@yuzulia.work>2021-03-06 22:34:11 +0900
committerGitHub <noreply@github.com>2021-03-06 22:34:11 +0900
commita07d753da84191bc8c185a7bcd6d73fab9529b5d (patch)
tree085bc62b1f979020796a73373c3050f4948ed2bd /src/server/api/endpoints/endpoints.ts
parentfeat: video play inline (using video tag) (#7242) (diff)
downloadsharkey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.tar.gz
sharkey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.tar.bz2
sharkey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.zip
APIドキュメントの改善 (#6757)
* Update api document in admin/announcements * Update api document in announcements * Update api document in i/read-announcements * Update api document in username/available * Update api document & Fix typo in API 403 error * Update api document * Update api document * Update api document * Fix API permission definition * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Fix bug in users (api) * Apply reviews #6757 * Apply reviews #6757 Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
Diffstat (limited to 'src/server/api/endpoints/endpoints.ts')
-rw-r--r--src/server/api/endpoints/endpoints.ts20
1 files changed, 20 insertions, 0 deletions
diff --git a/src/server/api/endpoints/endpoints.ts b/src/server/api/endpoints/endpoints.ts
index 3ab14389a9..84ab107c6a 100644
--- a/src/server/api/endpoints/endpoints.ts
+++ b/src/server/api/endpoints/endpoints.ts
@@ -2,12 +2,32 @@ import define from '../define';
import endpoints from '../endpoints';
export const meta = {
+ desc: {
+ 'ja-JP': '使用できるAPI一覧を返します。',
+ 'en-US': 'Returns a list of available APIs.'
+ },
+
requireCredential: false as const,
tags: ['meta'],
params: {
},
+
+ res: {
+ type: 'array' as const,
+ optional: false as const, nullable: false as const,
+ items: {
+ type: 'string' as const,
+ optional: false as const, nullable: false as const
+ },
+ example: [
+ 'admin/abuse-user-reports',
+ 'admin/accounts/create',
+ 'admin/announcements/create',
+ '...'
+ ]
+ }
};
export default define(meta, async () => {