From 6f71ba376d6b9448b860083636af80c81886583d Mon Sep 17 00:00:00 2001
From: syuilo <syuilotan@yahoo.co.jp>
Date: Wed, 27 Feb 2019 05:08:42 +0900
Subject: [PATCH] Improve doc

---
 src/server/api/endpoints/notes/reactions.ts |  7 ++++
 src/server/api/openapi/schemas.ts           | 38 +++++++++++++++++++++
 2 files changed, 45 insertions(+)

diff --git a/src/server/api/endpoints/notes/reactions.ts b/src/server/api/endpoints/notes/reactions.ts
index c67dd6d82b..b28f24249c 100644
--- a/src/server/api/endpoints/notes/reactions.ts
+++ b/src/server/api/endpoints/notes/reactions.ts
@@ -46,6 +46,13 @@ export const meta = {
 		},
 	},
 
+	res: {
+		type: 'array',
+		items: {
+			type: 'Reaction'
+		}
+	},
+
 	errors: {
 		noSuchNote: {
 			message: 'No such note.',
diff --git a/src/server/api/openapi/schemas.ts b/src/server/api/openapi/schemas.ts
index 0a32c8ae51..7b9dc35f27 100644
--- a/src/server/api/openapi/schemas.ts
+++ b/src/server/api/openapi/schemas.ts
@@ -362,6 +362,44 @@ export const schemas = {
 		required: ['id', 'createdAt', 'blockee']
 	},
 
+	Reaction: {
+		type: 'object',
+		properties: {
+			id: {
+				type: 'string',
+				format: 'id',
+				description: 'The unique identifier for this reaction.',
+				example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
+			},
+			createdAt: {
+				type: 'string',
+				format: 'date-time',
+				description: 'The date that the reaction was created.'
+			},
+			user: {
+				$ref: '#/components/schemas/User',
+				description: 'User who performed this reaction.'
+			},
+			type: {
+				type: 'string',
+				enum: [
+					'like',
+					'love',
+					'laugh',
+					'hmm',
+					'surprise',
+					'congrats',
+					'angry',
+					'confused',
+					'rip',
+					'pudding'
+				],
+				description: 'The reaction type.'
+			},
+		},
+		required: ['id', 'createdAt', 'user', 'type']
+	},
+
 	Hashtag: {
 		type: 'object',
 		properties: {