From a07d753da84191bc8c185a7bcd6d73fab9529b5d Mon Sep 17 00:00:00 2001
From: YuzuRyo61 <yuzuryo61@yuzulia.work>
Date: Sat, 6 Mar 2021 22:34:11 +0900
Subject: APIドキュメントの改善 (#6757)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 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>
---
 src/server/api/endpoints/admin/server-info.ts | 88 +++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)

(limited to 'src/server/api/endpoints/admin/server-info.ts')

diff --git a/src/server/api/endpoints/admin/server-info.ts b/src/server/api/endpoints/admin/server-info.ts
index de4e933471..3b48a811e5 100644
--- a/src/server/api/endpoints/admin/server-info.ts
+++ b/src/server/api/endpoints/admin/server-info.ts
@@ -9,12 +9,100 @@ export const meta = {
 	requireModerator: true,
 
 	desc: {
+		'ja-JP': 'サーバー情報を表示します。',
+		'en-US': 'Show server information.'
 	},
 
 	tags: ['admin', 'meta'],
 
 	params: {
 	},
+
+	res: {
+		type: 'object' as const,
+		optional: false as const, nullable: false as const,
+		properties: {
+			machine: {
+				type: 'string' as const,
+				optional: false as const, nullable: false as const,
+				description: 'The name of the running server'
+			},
+			os: {
+				type: 'string' as const,
+				optional: false as const, nullable: false as const,
+				description: 'OS used by the server',
+				example: 'linux'
+			},
+			node: {
+				type: 'string' as const,
+				optional: false as const, nullable: false as const,
+				description: 'Version of Node.js'
+			},
+			psql: {
+				type: 'string' as const,
+				optional: false as const, nullable: false as const,
+				description: 'Version of Postgresql'
+			},
+			cpu: {
+				type: 'object' as const,
+				optional: false as const, nullable: false as const,
+				properties: {
+					model: {
+						type: 'string' as const,
+						optional: false as const, nullable: false as const,
+						description: 'The name of the CPU you are using'
+					},
+					cores: {
+						type: 'number' as const,
+						optional: false as const, nullable: false as const,
+						description: 'Number of CPU cores used (number of logical processors)'
+					}
+				}
+			},
+			mem: {
+				type: 'object' as const,
+				optional: false as const, nullable: false as const,
+				properties: {
+					total: {
+						type: 'number' as const,
+						optional: false as const, nullable: false as const,
+						format: 'bytes',
+						description: 'RAM capacity.'
+					}
+				}
+			},
+			fs: {
+				type: 'object' as const,
+				optional: false as const, nullable: false as const,
+				properties: {
+					total: {
+						type: 'number' as const,
+						optional: false as const, nullable: false as const,
+						format: 'bytes',
+						description: 'Total storage capacity.'
+					},
+					used: {
+						type: 'number' as const,
+						optional: false as const, nullable: false as const,
+						format: 'bytes',
+						description: 'Amount of storage used'
+					}
+				}
+			},
+			net: {
+				type: 'object' as const,
+				optional: false as const, nullable: false as const,
+				properties: {
+					interface: {
+						type: 'string' as const,
+						optional: false as const, nullable: false as const,
+						description: 'The interface name of your network.',
+						example: 'eth0'
+					}
+				}
+			}
+		}
+	}
 };
 
 export default define(meta, async () => {
-- 
cgit v1.2.3-freya