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>
This commit is contained in:
@@ -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 () => {
|
||||
|
||||
Reference in New Issue
Block a user