From 31802c97494c27f019c127077d7f1d88fd753fb8 Mon Sep 17 00:00:00 2001
From: syuilo <syuilotan@yahoo.co.jp>
Date: Mon, 25 Feb 2019 03:21:54 +0900
Subject: Improve doc

---
 src/server/api/endpoints/meta.ts | 50 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 49 insertions(+), 1 deletion(-)

(limited to 'src/server/api/endpoints/meta.ts')

diff --git a/src/server/api/endpoints/meta.ts b/src/server/api/endpoints/meta.ts
index 07a475d4c2..d7099ea045 100644
--- a/src/server/api/endpoints/meta.ts
+++ b/src/server/api/endpoints/meta.ts
@@ -24,6 +24,54 @@ export const meta = {
 			default: true
 		}
 	},
+
+	res: {
+		type: 'object',
+		properties: {
+			version: {
+				type: 'string',
+				description: 'The version of Misskey of this instance.',
+				example: pkg.version
+			},
+			name: {
+				type: 'string',
+				description: 'The name of this instance.',
+			},
+			description: {
+				type: 'string',
+				description: 'The description of this instance.',
+			},
+			announcements: {
+				type: 'array',
+				items: {
+					type: 'object',
+					properties: {
+						title: {
+							type: 'string',
+							description: 'The title of the announcement.',
+						},
+						text: {
+							type: 'string',
+							description: 'The text of the announcement. (can be HTML)',
+						},
+					}
+				},
+				description: 'The description of this instance.',
+			},
+			disableRegistration: {
+				type: 'boolean',
+				description: 'Whether disabled open registration.',
+			},
+			disableLocalTimeline: {
+				type: 'boolean',
+				description: 'Whether disabled LTL and STL.',
+			},
+			disableGlobalTimeline: {
+				type: 'boolean',
+				description: 'Whether disabled GTL.',
+			},
+		}
+	}
 };
 
 export default define(meta, async (ps, me) => {
@@ -55,7 +103,7 @@ export default define(meta, async (ps, me) => {
 			cores: os.cpus().length
 		},
 
-		broadcasts: instance.broadcasts || [],
+		announcements: instance.announcements || [],
 		disableRegistration: instance.disableRegistration,
 		disableLocalTimeline: instance.disableLocalTimeline,
 		disableGlobalTimeline: instance.disableGlobalTimeline,
-- 
cgit v1.2.3-freya