From 52774bbe6402aee076b2e0648bd1f4764924da8a Mon Sep 17 00:00:00 2001
From: syuilo <Syuilotan@yahoo.co.jp>
Date: Sat, 23 Feb 2019 11:20:58 +0900
Subject: Introduce OpenAPI specs (#4351)

* wip

* wip

* wip

* Update index.ts

* Update gen-openapi-spec.ts

* Update api.ja-JP.md

* Fix

* Improve doc

* Update gen-openapi-spec.ts

* Update redoc.html

* Improve doc

* Update gen-openapi-spec.ts

* Improve doc

* Update CHANGELOG.md
---
 src/server/api/endpoints.ts | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

(limited to 'src/server/api/endpoints.ts')

diff --git a/src/server/api/endpoints.ts b/src/server/api/endpoints.ts
index 6765a63e9f..2873dd3c1e 100644
--- a/src/server/api/endpoints.ts
+++ b/src/server/api/endpoints.ts
@@ -2,18 +2,30 @@ import { Context } from 'cafy';
 import * as path from 'path';
 import * as glob from 'glob';
 
+export type Param = {
+	validator: Context<any>;
+	transform?: any;
+	default?: any;
+	desc?: { [key: string]: string };
+	ref?: string;
+};
+
 export interface IEndpointMeta {
 	stability?: string; //'deprecated' | 'experimental' | 'stable';
 
 	desc?: { [key: string]: string };
 
+	tags?: string[];
+
 	params?: {
+		[key: string]: Param;
+	};
+
+	errors?: {
 		[key: string]: {
-			validator: Context<any>;
-			transform?: any;
-			default?: any;
-			desc?: { [key: string]: string };
-			ref?: string;
+			message: string;
+			code: string;
+			id: string;
 		};
 	};
 
-- 
cgit v1.2.3-freya