From 52774bbe6402aee076b2e0648bd1f4764924da8a Mon Sep 17 00:00:00 2001 From: syuilo 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/games/reversi/games.ts | 2 ++ src/server/api/endpoints/games/reversi/games/show.ts | 2 ++ src/server/api/endpoints/games/reversi/games/surrender.ts | 2 ++ src/server/api/endpoints/games/reversi/invitations.ts | 2 ++ src/server/api/endpoints/games/reversi/match.ts | 2 ++ src/server/api/endpoints/games/reversi/match/cancel.ts | 2 ++ 6 files changed, 12 insertions(+) (limited to 'src/server/api/endpoints/games') diff --git a/src/server/api/endpoints/games/reversi/games.ts b/src/server/api/endpoints/games/reversi/games.ts index b188ba996d..e3c22c7611 100644 --- a/src/server/api/endpoints/games/reversi/games.ts +++ b/src/server/api/endpoints/games/reversi/games.ts @@ -4,6 +4,8 @@ import ReversiGame, { pack } from '../../../../../models/games/reversi/game'; import define from '../../../define'; export const meta = { + tags: ['games'], + params: { limit: { validator: $.optional.num.range(1, 100), diff --git a/src/server/api/endpoints/games/reversi/games/show.ts b/src/server/api/endpoints/games/reversi/games/show.ts index d70ab8de92..766ca90119 100644 --- a/src/server/api/endpoints/games/reversi/games/show.ts +++ b/src/server/api/endpoints/games/reversi/games/show.ts @@ -6,6 +6,8 @@ import define from '../../../../define'; import { ApiError } from '../../../../error'; export const meta = { + tags: ['games'], + params: { gameId: { validator: $.type(ID), diff --git a/src/server/api/endpoints/games/reversi/games/surrender.ts b/src/server/api/endpoints/games/reversi/games/surrender.ts index 954ae07ebc..446210894d 100644 --- a/src/server/api/endpoints/games/reversi/games/surrender.ts +++ b/src/server/api/endpoints/games/reversi/games/surrender.ts @@ -6,6 +6,8 @@ import define from '../../../../define'; import { ApiError } from '../../../../error'; export const meta = { + tags: ['games'], + desc: { 'ja-JP': '指定したリバーシの対局で投了します。' }, diff --git a/src/server/api/endpoints/games/reversi/invitations.ts b/src/server/api/endpoints/games/reversi/invitations.ts index 034c84bdd5..c204770578 100644 --- a/src/server/api/endpoints/games/reversi/invitations.ts +++ b/src/server/api/endpoints/games/reversi/invitations.ts @@ -2,6 +2,8 @@ import Matching, { pack as packMatching } from '../../../../../models/games/reve import define from '../../../define'; export const meta = { + tags: ['games'], + requireCredential: true }; diff --git a/src/server/api/endpoints/games/reversi/match.ts b/src/server/api/endpoints/games/reversi/match.ts index 6913ee13d5..e66765944d 100644 --- a/src/server/api/endpoints/games/reversi/match.ts +++ b/src/server/api/endpoints/games/reversi/match.ts @@ -9,6 +9,8 @@ import { ApiError } from '../../../error'; import { getUser } from '../../../common/getters'; export const meta = { + tags: ['games'], + requireCredential: true, params: { diff --git a/src/server/api/endpoints/games/reversi/match/cancel.ts b/src/server/api/endpoints/games/reversi/match/cancel.ts index 03b76babd7..fb230032d8 100644 --- a/src/server/api/endpoints/games/reversi/match/cancel.ts +++ b/src/server/api/endpoints/games/reversi/match/cancel.ts @@ -2,6 +2,8 @@ import Matching from '../../../../../../models/games/reversi/matching'; import define from '../../../../define'; export const meta = { + tags: ['games'], + requireCredential: true }; -- cgit v1.2.3-freya