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>
2021-03-06 22:34:11 +09:00
parent 3003100443
commit a07d753da8
100 changed files with 3050 additions and 109 deletions
--- a/src/server/api/endpoints/notes/polls/recommendation.ts
+++ b/src/server/api/endpoints/notes/polls/recommendation.ts
@@ -23,6 +23,16 @@ export const meta = {
 			validator: $.optional.num.min(0),
 			default: 0
 		}
+	},
+
+	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: 'Note'
+		}
 	}
 };

--- a/src/server/api/endpoints/notes/state.ts
+++ b/src/server/api/endpoints/notes/state.ts
@@ -21,6 +21,21 @@ export const meta = {
 				'en-US': 'Target note ID.'
 			}
 		}
+	},
+
+	res: {
+		type: 'object' as const,
+		optional: false as const, nullable: false as const,
+		properties: {
+			isFavorited: {
+				type: 'boolean' as const,
+				optional: false as const, nullable: false as const
+			},
+			isWatching: {
+				type: 'boolean' as const,
+				optional: false as const, nullable: false as const
+			}
+		}
 	}
 };