summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/admin/invite.ts
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2021-03-06 22:34:51 +0900
committersyuilo <Syuilotan@yahoo.co.jp>2021-03-06 22:34:51 +0900
commitdeda2b2782e37c925c67f730e4dd8770d4ef3034 (patch)
treeb6cfb688d446f85078cfaa819f463ac10488aec1 /src/server/api/endpoints/admin/invite.ts
parentfix bug (diff)
parentAPIドキュメントの改善 (#6757) (diff)
downloadsharkey-deda2b2782e37c925c67f730e4dd8770d4ef3034.tar.gz
sharkey-deda2b2782e37c925c67f730e4dd8770d4ef3034.tar.bz2
sharkey-deda2b2782e37c925c67f730e4dd8770d4ef3034.zip
Merge branch 'develop' of https://github.com/syuilo/misskey into develop
Diffstat (limited to 'src/server/api/endpoints/admin/invite.ts')
-rw-r--r--src/server/api/endpoints/admin/invite.ts20
1 files changed, 18 insertions, 2 deletions
diff --git a/src/server/api/endpoints/admin/invite.ts b/src/server/api/endpoints/admin/invite.ts
index 52e3da8f84..4529d16adf 100644
--- a/src/server/api/endpoints/admin/invite.ts
+++ b/src/server/api/endpoints/admin/invite.ts
@@ -5,7 +5,8 @@ import { genId } from '../../../../misc/gen-id';
export const meta = {
desc: {
- 'ja-JP': '招待コードを発行します。'
+ 'ja-JP': '招待コードを発行します。',
+ 'en-US': 'Issue an invitation code.'
},
tags: ['admin'],
@@ -13,7 +14,22 @@ export const meta = {
requireCredential: true as const,
requireModerator: true,
- params: {}
+ params: {},
+
+ res: {
+ type: 'object' as const,
+ optional: false as const, nullable: false as const,
+ properties: {
+ code: {
+ type: 'string' as const,
+ optional: false as const, nullable: false as const,
+ description: 'Give this code to the applicant for registration.',
+ example: '2ERUA5VR',
+ maxLength: 8,
+ minLength: 8
+ }
+ }
+ }
};
export default define(meta, async () => {