APIドキュメントの改善 (#6757)

* 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/blocking/create.ts

@@ -52,6 +52,12 @@ export const meta = {
 			code: 'ALREADY_BLOCKING',
 			id: '787fed64-acb9-464a-82eb-afbd745b9614'
 		},
+	},
+
+	res: {
+		type: 'object' as const,
+		optional: false as const, nullable: false as const,
+		ref: 'User'
 	}
 };
 

src/server/api/endpoints/blocking/delete.ts

@@ -52,6 +52,76 @@ export const meta = {
 			code: 'NOT_BLOCKING',
 			id: '291b2efa-60c6-45c0-9f6a-045c8f9b02cd'
 		},
+	},
+
+	res: {
+		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 blocking.',
+				example: 'xxxxxxxxxx',
+			},
+			name: {
+				type: 'string' as const,
+				optional: false as const, nullable: true as const
+			},
+			username: {
+				type: 'string' as const,
+				optional: false as const, nullable: false as const
+			},
+			host: {
+				type: 'string' as const,
+				optional: false as const, nullable: true as const
+			},
+			avatarUrl: {
+				type: 'string' as const,
+				optional: false as const, nullable: false as const,
+				format: 'url'
+			},
+			avatarBlurhash: {
+				type: 'string' as const,
+				optional: false as const, nullable: true as const
+			},
+			avatarColor: {
+				type: 'any' as const,
+				optional: false as const, nullable: true as const
+			},
+			emojis: {
+				type: 'array' as const,
+				optional: false as const, nullable: false as const,
+				items: {
+					type: 'object' as const,
+					nullable: false as const, optional: false as const,
+					properties: {
+						name: {
+							type: 'string' as const,
+							nullable: false as const, optional: false as const
+						},
+						host: {
+							type: 'string' as const,
+							nullable: true as const, optional: false as const
+						},
+						url: {
+							type: 'string' as const,
+							nullable: false as const, optional: false as const,
+							format: 'url'
+						},
+						aliases: {
+							type: 'array' as const,
+							nullable: false as const, optional: false as const,
+							items: {
+								type: 'string' as const,
+								nullable: false as const, optional: false as const
+							}
+						}
+					}
+				}
+			}
+		}
 	}
 };