diff options
| author | YuzuRyo61 <yuzuryo61@yuzulia.work> | 2021-03-06 22:34:11 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-06 22:34:11 +0900 |
| commit | a07d753da84191bc8c185a7bcd6d73fab9529b5d (patch) | |
| tree | 085bc62b1f979020796a73373c3050f4948ed2bd /src/server/api/endpoints/username/available.ts | |
| parent | feat: video play inline (using video tag) (#7242) (diff) | |
| download | sharkey-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/username/available.ts')
| -rw-r--r-- | src/server/api/endpoints/username/available.ts | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/src/server/api/endpoints/username/available.ts b/src/server/api/endpoints/username/available.ts index 89f14d3dc2..6a5146e432 100644 --- a/src/server/api/endpoints/username/available.ts +++ b/src/server/api/endpoints/username/available.ts @@ -3,6 +3,11 @@ import define from '../../define'; import { Users, UsedUsernames } from '../../../../models'; export const meta = { + desc: { + 'ja-JP': 'ユーザーネームが使用されていないかをチェックします。', + 'en-US': 'Check if the username is being used.' + }, + tags: ['users'], requireCredential: false as const, @@ -11,6 +16,18 @@ export const meta = { username: { validator: $.use(Users.validateLocalUsername) } + }, + + res: { + type: 'object' as const, + optional: false as const, nullable: false as const, + properties: { + available: { + type: 'boolean' as const, + optional: false as const, nullable: false as const, + description: 'Returns true if the username is not used.' + } + } } }; |