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/i/get-word-muted-notes-count.ts

@@ -9,6 +9,17 @@ export const meta = {
 	kind: 'read:account',
 
 	params: {
+	},
+
+	res: {
+		type: 'object' as const,
+		optional: false as const, nullable: false as const,
+		properties: {
+			count: {
+				type: 'number' as const,
+				optional: false as const, nullable: false as const
+			}
+		}
 	}
 };
 

src/server/api/endpoints/i/page-likes.ts

@@ -29,6 +29,23 @@ export const meta = {
 		untilId: {
 			validator: $.optional.type(ID),
 		},
+	},
+
+	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'
+			},
+			page: {
+				type: 'object' as const,
+				optional: false as const, nullable: false as const,
+				ref: 'Page'
+			}
+		}
 	}
 };
 

src/server/api/endpoints/i/pages.ts

@@ -29,6 +29,16 @@ export const meta = {
 		untilId: {
 			validator: $.optional.type(ID),
 		},
+	},
+
+	res: {
+		type: 'array' as const,
+		optional: false as const, nullable: false as const,
+		items: {
+			type: 'object' as const,
+			optional: false as const, nullable: false as const,
+			ref: 'Page'
+		}
 	}
 };
 

src/server/api/endpoints/i/pin.ts

@@ -44,6 +44,12 @@ export const meta = {
 			code: 'ALREADY_PINNED',
 			id: '8b18c2b7-68fe-4edb-9892-c0cbaeb6c913'
 		},
+	},
+
+	res: {
+		type: 'object' as const,
+		optional: false as const, nullable: false as const,
+		ref: 'User'
 	}
 };
 

src/server/api/endpoints/i/read-announcement.ts

@@ -7,6 +7,11 @@ import { AnnouncementReads, Announcements, Users } from '../../../../models';
 import { publishMainStream } from '../../../../services/stream';
 
 export const meta = {
+	desc: {
+		'ja-JP': '指定したアナウンスを既読にします。',
+		'en-US': 'Marks the specified announcement as read.'
+	},
+
 	tags: ['account'],
 
 	requireCredential: true as const,

src/server/api/endpoints/i/unpin.ts

@@ -32,6 +32,12 @@ export const meta = {
 			code: 'NO_SUCH_NOTE',
 			id: '454170ce-9d63-4a43-9da1-ea10afe81e21'
 		},
+	},
+
+	res: {
+		type: 'object' as const,
+		optional: false as const, nullable: false as const,
+		ref: 'User'
 	}
 };
 

src/server/api/endpoints/i/update.ts

@@ -196,6 +196,12 @@ export const meta = {
 			code: 'NO_SUCH_PAGE',
 			id: '8e01b590-7eb9-431b-a239-860e086c408e'
 		},
+	},
+
+	res: {
+		type: 'object' as const,
+		optional: false as const, nullable: false as const,
+		ref: 'User'
 	}
 };
 

src/server/api/endpoints/i/user-group-invites.ts

@@ -29,6 +29,27 @@ export const meta = {
 		untilId: {
 			validator: $.optional.type(ID),
 		},
+	},
+
+	res: {
+		type: 'array' as const,
+		optional: false as const, nullable: false as const,
+		items: {
+			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'
+				},
+				group: {
+					type: 'object' as const,
+					optional: false as const, nullable: false as const,
+					ref: 'UserGroup'
+				}
+			}
+		}
 	}
 };