Improve doc

4 files changed, 68 insertions, 8 deletions

diff --git a/src/server/api/endpoints/admin/update-meta.ts b/src/server/api/endpoints/admin/update-meta.ts
index 46fdeff759..5d08a6e37e 100644
--- a/src/server/api/endpoints/admin/update-meta.ts
+++ b/src/server/api/endpoints/admin/update-meta.ts
@@ -13,10 +13,10 @@ export const meta = {
 	requireModerator: true,
 
 	params: {
-		broadcasts: {
+		announcements: {
 			validator: $.optional.nullable.arr($.obj()),
 			desc: {
-				'ja-JP': 'ブロードキャスト'
+				'ja-JP': 'お知らせ'
 			}
 		},
 
@@ -328,8 +328,8 @@ export const meta = {
 export default define(meta, async (ps) => {
 	const set = {} as any;
 
-	if (ps.broadcasts) {
-		set.broadcasts = ps.broadcasts;
+	if (ps.announcements) {
+		set.announcements = ps.announcements;
 	}
 
 	if (typeof ps.disableRegistration === 'boolean') {
diff --git a/src/server/api/endpoints/drive.ts b/src/server/api/endpoints/drive.ts
index 9c4482f915..138adffad2 100644
--- a/src/server/api/endpoints/drive.ts
+++ b/src/server/api/endpoints/drive.ts
@@ -12,7 +12,19 @@ export const meta = {
 
 	requireCredential: true,
 
-	kind: 'drive-read'
+	kind: 'drive-read',
+
+	res: {
+		type: 'object',
+		properties: {
+			capacity: {
+				type: 'number'
+			},
+			usage: {
+				type: 'number'
+			}
+		}
+	}
 };
 
 export default define(meta, async (ps, user) => {
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,
diff --git a/src/server/nodeinfo.ts b/src/server/nodeinfo.ts
index 9e4ce37b81..a783eea90b 100644
--- a/src/server/nodeinfo.ts
+++ b/src/server/nodeinfo.ts
@@ -20,7 +20,7 @@ export const links = [/* (awaiting release) {
 
 const nodeinfo2 = async () => {
 	const [
-		{ name, description, maintainer, langs, broadcasts, disableRegistration, disableLocalTimeline, disableGlobalTimeline, enableRecaptcha, maxNoteTextLength, enableTwitterIntegration, enableGithubIntegration, enableDiscordIntegration, enableEmail, enableServiceWorker },
+		{ name, description, maintainer, langs, announcements, disableRegistration, disableLocalTimeline, disableGlobalTimeline, enableRecaptcha, maxNoteTextLength, enableTwitterIntegration, enableGithubIntegration, enableDiscordIntegration, enableEmail, enableServiceWorker },
 		// total,
 		// activeHalfyear,
 		// activeMonth,
@@ -52,7 +52,7 @@ const nodeinfo2 = async () => {
 			// localPosts,
 			// localComments
 		},
-		metadata: { name, description, maintainer, langs, broadcasts, disableRegistration, disableLocalTimeline, disableGlobalTimeline, enableRecaptcha, maxNoteTextLength, enableTwitterIntegration, enableGithubIntegration, enableDiscordIntegration, enableEmail, enableServiceWorker }
+		metadata: { name, description, maintainer, langs, announcements, disableRegistration, disableLocalTimeline, disableGlobalTimeline, enableRecaptcha, maxNoteTextLength, enableTwitterIntegration, enableGithubIntegration, enableDiscordIntegration, enableEmail, enableServiceWorker }
 	};
 };