summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/username
diff options
context:
space:
mode:
Diffstat (limited to 'src/server/api/endpoints/username')
-rw-r--r--src/server/api/endpoints/username/available.ts17
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.'
+ }
+ }
}
};