jointrashposs/content/ja/.docs-legacy/api/endpoints/username/available.json5
2023-07-11 23:48:17 +09:00

38 lines
678 B
Plaintext

{
summary: 'ユーザー名が利用可能か確認します。',
description: 'ユーザー名が利用可能か確認します。',
tags: [
'users',
],
requireCredential: false,
req: {
type: 'object',
properties: {
username: {
type: 'string',
pattern: '^\\w{1,20}$',
description: 'ユーザー名',
},
},
required: [
'username',
],
},
res: {
type: 'object',
optional: false,
nullable: false,
properties: {
available: {
type: 'boolean',
optional: false,
nullable: false,
description: 'ユーザー名が利用可能であれば true です。',
},
},
required: [
'available',
],
},
errors: {},
}