Mizah/Sharkey
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

APIドキュメントの改善 (#6757)

Browse source 
* 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:
YuzuRyo61 2021-03-06 22:34:11 +09:00 • committed by GitHub
parent 3003100443
commit a07d753da8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
100 changed files with 3050 additions and 109 deletions
Download patch file Download diff file Expand all files Collapse all files

46
src/server/api/endpoints/admin/announcements/create.ts
View file

@ -4,6 +4,11 @@ import { Announcements } from '../../../../../models';
import { genId } from '../../../../../misc/gen-id';
export const meta = {
desc: {
'ja-JP': 'アナウンスを作成します。',
'en-US': 'Create a announcement.'
},
tags: ['admin'],
requireCredential: true as const,
@ -19,6 +24,47 @@ export const meta = {
imageUrl: {
validator: $.nullable.str.min(1)
}
},
res: {
type: 'object' as const,
optional: false as const, nullable: false as const,
properties: {
id: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
description: 'The unique identifier for this Announcement.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
description: 'The date that the Announcement was created.'
},
updatedAt: {
type: 'string' as const,
optional: false as const, nullable: true as const,
format: 'date-time',
description: 'The date that the Announcement was updated.'
},
title: {
type: 'string' as const,
optional: false as const, nullable: false as const,
description: 'Announcement title.'
},
text: {
type: 'string' as const,
optional: false as const, nullable: false as const,
description: 'Announcement text.'
},
imageUrl: {
type: 'string' as const,
optional: false as const, nullable: true as const,
description: 'Announcement image.'
}
}
}
};