diff options
| author | syuilo <Syuilotan@yahoo.co.jp> | 2019-02-23 11:20:58 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-02-23 11:20:58 +0900 |
| commit | 52774bbe6402aee076b2e0648bd1f4764924da8a (patch) | |
| tree | a0e3f34ce6d000dd880a6a6c152e98e139076a14 /src/server/api/endpoints.ts | |
| parent | 投稿を削除したときにお気に入りからも削除するように (diff) | |
| download | sharkey-52774bbe6402aee076b2e0648bd1f4764924da8a.tar.gz sharkey-52774bbe6402aee076b2e0648bd1f4764924da8a.tar.bz2 sharkey-52774bbe6402aee076b2e0648bd1f4764924da8a.zip | |
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
Diffstat (limited to 'src/server/api/endpoints.ts')
| -rw-r--r-- | src/server/api/endpoints.ts | 22 |
1 files changed, 17 insertions, 5 deletions
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; }; }; |