diff options
| author | yukineko <27853966+hideki0403@users.noreply.github.com> | 2024-02-02 12:47:07 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-02-02 12:47:07 +0900 |
| commit | d8bdbd53ed9366b6578c0f2f2a44c5efa4b887a9 (patch) | |
| tree | 5ba19f76271edc4fecd345d9e1db2529182de399 /packages/backend/src/server/api/openapi/gen-spec.ts | |
| parent | Update deploy-test-environment.yml (#13136) (diff) | |
| download | sharkey-d8bdbd53ed9366b6578c0f2f2a44c5efa4b887a9.tar.gz sharkey-d8bdbd53ed9366b6578c0f2f2a44c5efa4b887a9.tar.bz2 sharkey-d8bdbd53ed9366b6578c0f2f2a44c5efa4b887a9.zip | |
fix: api-docが開けない問題を修正 (#13132)
* refactor: 自己参照を使用している箇所に`selfRef`を持たせるように
* feat: スキーマ生成時に自己参照を含むかどうかを指定できるように
* fix: api.jsonにselfRefが含まれているのを修正
* refactor: 他の箇所と同様にselfRefの除去を行うように
* remove: 不要なimportを削除
Diffstat (limited to 'packages/backend/src/server/api/openapi/gen-spec.ts')
| -rw-r--r-- | packages/backend/src/server/api/openapi/gen-spec.ts | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/packages/backend/src/server/api/openapi/gen-spec.ts b/packages/backend/src/server/api/openapi/gen-spec.ts index 971a6116bf..5dbd4a01e1 100644 --- a/packages/backend/src/server/api/openapi/gen-spec.ts +++ b/packages/backend/src/server/api/openapi/gen-spec.ts @@ -6,9 +6,9 @@ import type { Config } from '@/config.js'; import endpoints, { IEndpoint } from '../endpoints.js'; import { errors as basicErrors } from './errors.js'; -import { schemas, convertSchemaToOpenApiSchema } from './schemas.js'; +import { getSchemas, convertSchemaToOpenApiSchema } from './schemas.js'; -export function genOpenapiSpec(config: Config) { +export function genOpenapiSpec(config: Config, includeSelfRef = false) { const spec = { openapi: '3.1.0', @@ -30,7 +30,7 @@ export function genOpenapiSpec(config: Config) { paths: {} as any, components: { - schemas: schemas, + schemas: getSchemas(includeSelfRef), securitySchemes: { bearerAuth: { @@ -56,7 +56,7 @@ export function genOpenapiSpec(config: Config) { } } - const resSchema = endpoint.meta.res ? convertSchemaToOpenApiSchema(endpoint.meta.res, 'res') : {}; + const resSchema = endpoint.meta.res ? convertSchemaToOpenApiSchema(endpoint.meta.res, 'res', includeSelfRef) : {}; let desc = (endpoint.meta.description ? endpoint.meta.description : 'No description provided.') + '\n\n'; @@ -71,7 +71,7 @@ export function genOpenapiSpec(config: Config) { } const requestType = endpoint.meta.requireFile ? 'multipart/form-data' : 'application/json'; - const schema = { ...convertSchemaToOpenApiSchema(endpoint.params, 'param') }; + const schema = { ...convertSchemaToOpenApiSchema(endpoint.params, 'param', false) }; if (endpoint.meta.requireFile) { schema.properties = { |