summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/announcements.ts
diff options
context:
space:
mode:
Diffstat (limited to 'src/server/api/endpoints/announcements.ts')
-rw-r--r--src/server/api/endpoints/announcements.ts55
1 files changed, 55 insertions, 0 deletions
diff --git a/src/server/api/endpoints/announcements.ts b/src/server/api/endpoints/announcements.ts
index ca46192de2..5d0fd9bdfa 100644
--- a/src/server/api/endpoints/announcements.ts
+++ b/src/server/api/endpoints/announcements.ts
@@ -5,6 +5,11 @@ import { Announcements, AnnouncementReads } from '../../../models';
import { makePaginationQuery } from '../common/make-pagination-query';
export const meta = {
+ desc: {
+ 'ja-JP': 'アナウンスを表示します。',
+ 'en-US': 'Show announcements.'
+ },
+
tags: ['meta'],
requireCredential: false as const,
@@ -27,6 +32,56 @@ export const meta = {
untilId: {
validator: $.optional.type(ID),
},
+ },
+
+ res: {
+ type: 'array' as const,
+ optional: false as const, nullable: false as const,
+ items: {
+ 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.'
+ },
+ text: {
+ type: 'string' as const,
+ optional: false as const, nullable: false as const,
+ description: 'Announcement text.'
+ },
+ title: {
+ type: 'string' as const,
+ optional: false as const, nullable: false as const,
+ description: 'Announcement title.'
+ },
+ imageUrl: {
+ type: 'string' as const,
+ optional: false as const, nullable: true as const,
+ description: 'Announcement image.'
+ },
+ isRead: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const,
+ description: 'Indicates that you have read this announcement'
+ }
+ }
+ }
}
};