wip

packages/misskey-js/src/schemas/federation-instance.ts

@@ -1,97 +1,112 @@
+import type { JSONSchema7Definition } from 'schema-type';
+
 export const packedFederationInstanceSchema = {
+	$id: 'https://misskey-hub.net/api/schemas/FederationInstance',
+
 	type: 'object',
 	properties: {
-		id: {
+		id: { $ref: 'https://misskey-hub.net/api/schemas/Id' },
-			type: 'string',
-			optional: false, nullable: false,
-			format: 'id',
-		},
 		firstRetrievedAt: {
 			type: 'string',
-			optional: false, nullable: false,
 			format: 'date-time',
 		},
 		host: {
 			type: 'string',
-			optional: false, nullable: false,
+			examples: 'misskey.example.com',
-			example: 'misskey.example.com',
 		},
 		usersCount: {
 			type: 'number',
-			optional: false, nullable: false,
 		},
 		notesCount: {
 			type: 'number',
-			optional: false, nullable: false,
 		},
 		followingCount: {
 			type: 'number',
-			optional: false, nullable: false,
 		},
 		followersCount: {
 			type: 'number',
-			optional: false, nullable: false,
 		},
 		isNotResponding: {
 			type: 'boolean',
-			optional: false, nullable: false,
 		},
 		isSuspended: {
 			type: 'boolean',
-			optional: false, nullable: false,
 		},
 		isBlocked: {
 			type: 'boolean',
-			optional: false, nullable: false,
 		},
 		softwareName: {
-			type: 'string',
+			type: ['string', 'null'],
-			optional: false, nullable: true,
+			examples: 'misskey',
-			example: 'misskey',
 		},
 		softwareVersion: {
-			type: 'string',
+			type: ['string', 'null'],
-			optional: false, nullable: true,
 		},
 		openRegistrations: {
-			type: 'boolean',
+			type: ['boolean', 'null'],
-			optional: false, nullable: true,
+			examples: true,
-			example: true,
 		},
 		name: {
-			type: 'string',
+			type: ['string', 'null'],
-			optional: false, nullable: true,
 		},
 		description: {
-			type: 'string',
+			type: ['string', 'null'],
-			optional: false, nullable: true,
 		},
 		maintainerName: {
-			type: 'string',
+			type: ['string', 'null'],
-			optional: false, nullable: true,
 		},
 		maintainerEmail: {
-			type: 'string',
+			type: ['string', 'null'],
-			optional: false, nullable: true,
 		},
 		iconUrl: {
+			oneOf: [{
 				type: 'string',
-			optional: false, nullable: true,
 				format: 'url',
+			}, {
+				type: 'null',
+			}],
 		},
 		faviconUrl: {
+			oneOf: [{
 				type: 'string',
-			optional: false, nullable: true,
 				format: 'url',
+			}, {
+				type: 'null',
+			}],
 		},
 		themeColor: {
-			type: 'string',
+			type: ['string', 'null'],
-			optional: false, nullable: true,
 		},
 		infoUpdatedAt: {
+			oneOf: [{
 				type: 'string',
-			optional: false, nullable: true,
 				format: 'date-time',
+			}, {
+				type: 'null',
+			}],
 		},
 	},
-} as const;
+	required: [
+		'id',
+		'firstRetrievedAt',
+		'host',
+		'usersCount',
+		'notesCount',
+		'followingCount',
+		'followersCount',
+		'isNotResponding',
+		'isSuspended',
+		'isBlocked',
+		'softwareName',
+		'softwareVersion',
+		'openRegistrations',
+		'name',
+		'description',
+		'maintainerName',
+		'maintainerEmail',
+		'iconUrl',
+		'faviconUrl',
+		'themeColor',
+		'infoUpdatedAt',
+	],
+} as const satisfies JSONSchema7Definition;