@nestia/sdk 2.4.2 → 2.4.3

package/src/generates/SwaggerGenerator.ts

@@ -1,410 +1,372 @@
-import fs from "fs";
-import path from "path";
-import { Singleton } from "tstl/thread/Singleton";
-import ts from "typescript";
-
-import typia, { IJsonApplication, IJsonComponents } from "typia";
-import { MetadataCollection } from "typia/lib/factories/MetadataCollection";
-import { JsonApplicationProgrammer } from "typia/lib/programmers/json/JsonApplicationProgrammer";
-
-import { INestiaConfig } from "../INestiaConfig";
-import { IRoute } from "../structures/IRoute";
-import { ISwagger } from "../structures/ISwagger";
-import { ISwaggerError } from "../structures/ISwaggerError";
-import { ISwaggerInfo } from "../structures/ISwaggerInfo";
-import { ISwaggerLazyProperty } from "../structures/ISwaggerLazyProperty";
-import { ISwaggerLazySchema } from "../structures/ISwaggerLazySchema";
-import { ISwaggerRoute } from "../structures/ISwaggerRoute";
-import { ISwaggerSecurityScheme } from "../structures/ISwaggerSecurityScheme";
-import { FileRetriever } from "../utils/FileRetriever";
-import { MapUtil } from "../utils/MapUtil";
-import { SwaggerSchemaGenerator } from "./internal/SwaggerSchemaGenerator";
-
-export namespace SwaggerGenerator {
-    export interface IProps {
-        config: INestiaConfig.ISwaggerConfig;
-        checker: ts.TypeChecker;
-        collection: MetadataCollection;
-        lazySchemas: Array<ISwaggerLazySchema>;
-        lazyProperties: Array<ISwaggerLazyProperty>;
-        errors: ISwaggerError[];
-    }
-
-    export const generate =
-        (checker: ts.TypeChecker) =>
-        (config: INestiaConfig.ISwaggerConfig) =>
-        async (routeList: IRoute[]): Promise<void> => {
-            console.log("Generating Swagger Documents");
-
-            // VALIDATE SECURITY
-            validate_security(config)(routeList);
-
-            // PREPARE ASSETS
-            const parsed: path.ParsedPath = path.parse(config.output);
-            const directory: string = path.dirname(parsed.dir);
-            if (fs.existsSync(directory) === false)
-                try {
-                    await fs.promises.mkdir(directory);
-                } catch {}
-            if (fs.existsSync(directory) === false)
-                throw new Error(
-                    `Error on NestiaApplication.swagger(): failed to create output directory: ${directory}`,
-                );
-
-            const location: string = !!parsed.ext
-                ? path.resolve(config.output)
-                : path.join(path.resolve(config.output), "swagger.json");
-
-            const collection: MetadataCollection = new MetadataCollection({
-                replace: MetadataCollection.replace,
-            });
-
-            // CONSTRUCT SWAGGER DOCUMENTS
-            const errors: ISwaggerError[] = [];
-            const lazySchemas: Array<ISwaggerLazySchema> = [];
-            const lazyProperties: Array<ISwaggerLazyProperty> = [];
-            const swagger: ISwagger = await initialize(config);
-            const pathDict: Map<
-                string,
-                Record<string, ISwaggerRoute>
-            > = new Map();
-
-            for (const route of routeList) {
-                if (route.jsDocTags.find((tag) => tag.name === "internal"))
-                    continue;
-
-                const path: Record<string, ISwaggerRoute> = MapUtil.take(
-                    pathDict,
-                    get_path(route.path, route.parameters),
-                    () => ({}),
-                );
-                path[route.method.toLowerCase()] = generate_route({
-                    config,
-                    checker,
-                    collection,
-                    lazySchemas,
-                    lazyProperties,
-                    errors,
-                })(route);
-            }
-            swagger.paths = {};
-            for (const [path, routes] of pathDict) swagger.paths[path] = routes;
-
-            // FILL JSON-SCHEMAS
-            const application: IJsonApplication =
-                JsonApplicationProgrammer.write({
-                    purpose: "swagger",
-                })(lazySchemas.map(({ metadata }) => metadata));
-            swagger.components = {
-                ...(swagger.components ?? {}),
-                ...(application.components ?? {}),
-            };
-            lazySchemas.forEach(({ schema }, index) => {
-                Object.assign(schema, application.schemas[index]!);
-            });
-            for (const p of lazyProperties)
-                Object.assign(
-                    p.schema,
-                    (
-                        application.components.schemas?.[
-                            p.object
-                        ] as IJsonComponents.IObject
-                    )?.properties[p.property],
-                );
-
-            // CONFIGURE SECURITY
-            if (config.security) fill_security(config.security, swagger);
-
-            // REPORT ERRORS
-            if (errors.length) {
-                for (const e of errors)
-                    console.error(
-                        `${path.relative(e.route.location, process.cwd())}:${
-                            e.route.symbol.class
-                        }.${e.route.symbol.function}:${
-                            e.from
-                        } - error TS(@nestia/sdk): invalid type detected.\n\n` +
-                            e.messages.map((m) => `  - ${m}`).join("\n"),
-                        "\n\n",
-                    );
-                throw new TypeError("Invalid type detected");
-            }
-
-            // DO GENERATE
-            await fs.promises.writeFile(
-                location,
-                !config.beautify
-                    ? JSON.stringify(swagger)
-                    : JSON.stringify(
-                          swagger,
-                          null,
-                          typeof config.beautify === "number"
-                              ? config.beautify
-                              : 2,
-                      ),
-                "utf8",
-            );
-        };
-
-    const validate_security =
-        (config: INestiaConfig.ISwaggerConfig) =>
-        (routeList: IRoute[]): void | never => {
-            const securityMap: Map<
-                string,
-                { scheme: ISwaggerSecurityScheme; scopes: Set<string> }
-            > = new Map();
-            for (const [key, value] of Object.entries(config.security ?? {}))
-                securityMap.set(key, {
-                    scheme: emend_security(value),
-                    scopes:
-                        value.type === "oauth2"
-                            ? new Set([
-                                  ...Object.keys(
-                                      value.flows.authorizationCode?.scopes ??
-                                          {},
-                                  ),
-                                  ...Object.keys(
-                                      value.flows.implicit?.scopes ?? {},
-                                  ),
-                                  ...Object.keys(
-                                      value.flows.password?.scopes ?? {},
-                                  ),
-                                  ...Object.keys(
-                                      value.flows.clientCredentials?.scopes ??
-                                          {},
-                                  ),
-                              ])
-                            : new Set(),
-                });
-
-            const validate =
-                (reporter: (str: string) => void) =>
-                (key: string, scopes: string[]) => {
-                    const security = securityMap.get(key);
-                    if (security === undefined)
-                        return reporter(
-                            `target security scheme "${key}" does not exists.`,
-                        );
-                    else if (scopes.length === 0) return;
-                    else if (security.scheme.type !== "oauth2")
-                        return reporter(
-                            `target security scheme "${key}" is not "oauth2" type, but you've configured the scopes.`,
-                        );
-                    for (const s of scopes)
-                        if (security.scopes.has(s) === false)
-                            reporter(
-                                `target security scheme "${key}" does not have a specific scope "${s}".`,
-                            );
-                };
-
-            const violations: string[] = [];
-            for (const route of routeList)
-                for (const record of route.security)
-                    for (const [key, scopes] of Object.entries(record))
-                        validate((str) =>
-                            violations.push(
-                                `  - ${str} (${route.symbol} at "${route.location}")`,
-                            ),
-                        )(key, scopes);
-
-            if (violations.length)
-                throw new Error(
-                    `Error on NestiaApplication.swagger(): invalid security specification. Check your "nestia.config.ts" file's "swagger.security" property, or each controller methods.\n` +
-                        `\n` +
-                        `List of violations:\n` +
-                        violations.join("\n"),
-                );
-        };
-
-    /* ---------------------------------------------------------
-        INITIALIZERS
-    --------------------------------------------------------- */
-    const initialize = async (
-        config: INestiaConfig.ISwaggerConfig,
-    ): Promise<ISwagger> => {
-        const pack = new Singleton(
-            async (): Promise<Partial<ISwaggerInfo> | null> => {
-                const location: string | null = await FileRetriever.file(
-                    "package.json",
-                )(process.cwd());
-                if (location === null) return null;
-
-                try {
-                    const content: string = await fs.promises.readFile(
-                        location,
-                        "utf8",
-                    );
-                    const data = typia.json.assertParse<{
-                        name?: string;
-                        version?: string;
-                        description?: string;
-                        license?:
-                            | string
-                            | {
-                                  type: string;
-                                  /**
-                                   * @format url
-                                   */
-                                  url: string;
-                              };
-                    }>(content);
-                    return {
-                        title: data.name,
-                        version: data.version,
-                        description: data.description,
-                        license: data.license
-                            ? typeof data.license === "string"
-                                ? { name: data.license }
-                                : typeof data.license === "object"
-                                ? {
-                                      name: data.license.type,
-                                      url: data.license.url,
-                                  }
-                                : undefined
-                            : undefined,
-                    };
-                } catch {
-                    return null;
-                }
-            },
-        );
-
-        return {
-            openapi: "3.0.1",
-            servers: config.servers ?? [
-                {
-                    url: "https://github.com/samchon/nestia",
-                    description: "insert your server url",
-                },
-            ],
-            info: {
-                ...(config.info ?? {}),
-                version:
-                    config.info?.version ??
-                    (await pack.get())?.version ??
-                    "0.1.0",
-                title:
-                    config.info?.title ??
-                    (await pack.get())?.title ??
-                    "Swagger Documents",
-                description:
-                    config.info?.description ??
-                    (await pack.get())?.description ??
-                    "Generated by nestia - https://github.com/samchon/nestia",
-                license: config.info?.license ?? (await pack.get())?.license,
-            },
-            paths: {},
-            components: {},
-        };
-    };
-
-    function get_path(path: string, parameters: IRoute.IParameter[]): string {
-        const filtered: IRoute.IParameter[] = parameters.filter(
-            (param) => param.category === "param" && !!param.field,
-        );
-        for (const param of filtered)
-            path = path.replace(`:${param.field}`, `{${param.field}}`);
-        return path;
-    }
-
-    const generate_route =
-        (props: IProps) =>
-        (route: IRoute): ISwaggerRoute => {
-            const body = route.parameters.find(
-                (param) => param.category === "body",
-            );
-            const getJsDocTexts = (name: string) =>
-                route.jsDocTags
-                    .filter(
-                        (tag) =>
-                            tag.name === name &&
-                            tag.text &&
-                            tag.text.find(
-                                (elem) =>
-                                    elem.kind === "text" && elem.text.length,
-                            ) !== undefined,
-                    )
-                    .map(
-                        (tag) =>
-                            tag.text!.find((elem) => elem.kind === "text")!
-                                .text,
-                    );
-
-            const description: string | undefined = route.description?.length
-                ? route.description
-                : undefined;
-            const summary: string | undefined = (() => {
-                if (description === undefined) return undefined;
-
-                const [explicit] = getJsDocTexts("summary");
-                if (explicit?.length) return explicit;
-
-                const index: number = description.indexOf(".");
-                if (index <= 0) return undefined;
-
-                const content: string = description.substring(0, index).trim();
-                return content.length ? content : undefined;
-            })();
-            const deprecated = route.jsDocTags.find(
-                (tag) => tag.name === "deprecated",
-            );
-
-            return {
-                deprecated: deprecated ? true : undefined,
-                tags: [
-                    ...route.swaggerTags,
-                    ...new Set([...getJsDocTexts("tag")]),
-                ],
-                operationId:
-                    route.operationId ??
-                    props.config.operationId?.({
-                        class: route.symbol.class,
-                        function: route.symbol.function,
-                        method: route.method as "GET",
-                        path: route.path,
-                    }),
-                parameters: route.parameters
-                    .filter((param) => param.category !== "body")
-                    .map((param) =>
-                        SwaggerSchemaGenerator.parameter(props)(route)(param),
-                    )
-                    .flat(),
-                requestBody: body
-                    ? SwaggerSchemaGenerator.body(props)(route)(body)
-                    : undefined,
-                responses: SwaggerSchemaGenerator.response(props)(route),
-                summary,
-                description,
-                security: route.security.length ? route.security : undefined,
-                "x-nestia-namespace": [
-                    ...route.path
-                        .split("/")
-                        .filter((str) => str.length && str[0] !== ":"),
-                    route.name,
-                ].join("."),
-                "x-nestia-jsDocTags": route.jsDocTags,
-                "x-nestia-method": route.method,
-            };
-        };
-
-    function fill_security(
-        security: Required<INestiaConfig.ISwaggerConfig>["security"],
-        swagger: ISwagger,
-    ): void {
-        swagger.components.securitySchemes = {};
-        for (const [key, value] of Object.entries(security))
-            swagger.components.securitySchemes[key] = emend_security(value);
-    }
-
-    function emend_security(
-        input: ISwaggerSecurityScheme,
-    ): ISwaggerSecurityScheme {
-        if (input.type === "apiKey")
-            return {
-                ...input,
-                in: input.in ?? "header",
-                name: input.name ?? "Authorization",
-            };
-        return input;
-    }
-}
+import fs from "fs";
+import path from "path";
+import { Singleton } from "tstl/thread/Singleton";
+import ts from "typescript";
+import typia, { IJsonApplication, IJsonComponents } from "typia";
+import { MetadataCollection } from "typia/lib/factories/MetadataCollection";
+import { JsonApplicationProgrammer } from "typia/lib/programmers/json/JsonApplicationProgrammer";
+
+import { INestiaConfig } from "../INestiaConfig";
+import { IRoute } from "../structures/IRoute";
+import { ISwagger } from "../structures/ISwagger";
+import { ISwaggerError } from "../structures/ISwaggerError";
+import { ISwaggerInfo } from "../structures/ISwaggerInfo";
+import { ISwaggerLazyProperty } from "../structures/ISwaggerLazyProperty";
+import { ISwaggerLazySchema } from "../structures/ISwaggerLazySchema";
+import { ISwaggerRoute } from "../structures/ISwaggerRoute";
+import { ISwaggerSecurityScheme } from "../structures/ISwaggerSecurityScheme";
+import { FileRetriever } from "../utils/FileRetriever";
+import { MapUtil } from "../utils/MapUtil";
+import { SwaggerSchemaGenerator } from "./internal/SwaggerSchemaGenerator";
+
+export namespace SwaggerGenerator {
+  export interface IProps {
+    config: INestiaConfig.ISwaggerConfig;
+    checker: ts.TypeChecker;
+    collection: MetadataCollection;
+    lazySchemas: Array<ISwaggerLazySchema>;
+    lazyProperties: Array<ISwaggerLazyProperty>;
+    errors: ISwaggerError[];
+  }
+
+  export const generate =
+    (checker: ts.TypeChecker) =>
+    (config: INestiaConfig.ISwaggerConfig) =>
+    async (routeList: IRoute[]): Promise<void> => {
+      console.log("Generating Swagger Documents");
+
+      // VALIDATE SECURITY
+      validate_security(config)(routeList);
+
+      // PREPARE ASSETS
+      const parsed: path.ParsedPath = path.parse(config.output);
+      const directory: string = path.dirname(parsed.dir);
+      if (fs.existsSync(directory) === false)
+        try {
+          await fs.promises.mkdir(directory);
+        } catch {}
+      if (fs.existsSync(directory) === false)
+        throw new Error(
+          `Error on NestiaApplication.swagger(): failed to create output directory: ${directory}`,
+        );
+
+      const location: string = !!parsed.ext
+        ? path.resolve(config.output)
+        : path.join(path.resolve(config.output), "swagger.json");
+
+      const collection: MetadataCollection = new MetadataCollection({
+        replace: MetadataCollection.replace,
+      });
+
+      // CONSTRUCT SWAGGER DOCUMENTS
+      const errors: ISwaggerError[] = [];
+      const lazySchemas: Array<ISwaggerLazySchema> = [];
+      const lazyProperties: Array<ISwaggerLazyProperty> = [];
+      const swagger: ISwagger = await initialize(config);
+      const pathDict: Map<string, Record<string, ISwaggerRoute>> = new Map();
+
+      for (const route of routeList) {
+        if (route.jsDocTags.find((tag) => tag.name === "internal")) continue;
+
+        const path: Record<string, ISwaggerRoute> = MapUtil.take(
+          pathDict,
+          get_path(route.path, route.parameters),
+          () => ({}),
+        );
+        path[route.method.toLowerCase()] = generate_route({
+          config,
+          checker,
+          collection,
+          lazySchemas,
+          lazyProperties,
+          errors,
+        })(route);
+      }
+      swagger.paths = {};
+      for (const [path, routes] of pathDict) swagger.paths[path] = routes;
+
+      // FILL JSON-SCHEMAS
+      const application: IJsonApplication = JsonApplicationProgrammer.write({
+        purpose: "swagger",
+      })(lazySchemas.map(({ metadata }) => metadata));
+      swagger.components = {
+        ...(swagger.components ?? {}),
+        ...(application.components ?? {}),
+      };
+      lazySchemas.forEach(({ schema }, index) => {
+        Object.assign(schema, application.schemas[index]!);
+      });
+      for (const p of lazyProperties)
+        Object.assign(
+          p.schema,
+          (
+            application.components.schemas?.[
+              p.object
+            ] as IJsonComponents.IObject
+          )?.properties[p.property],
+        );
+
+      // CONFIGURE SECURITY
+      if (config.security) fill_security(config.security, swagger);
+
+      // REPORT ERRORS
+      if (errors.length) {
+        for (const e of errors)
+          console.error(
+            `${path.relative(e.route.location, process.cwd())}:${
+              e.route.symbol.class
+            }.${e.route.symbol.function}:${
+              e.from
+            } - error TS(@nestia/sdk): invalid type detected.\n\n` +
+              e.messages.map((m) => `  - ${m}`).join("\n"),
+            "\n\n",
+          );
+        throw new TypeError("Invalid type detected");
+      }
+
+      // DO GENERATE
+      await fs.promises.writeFile(
+        location,
+        !config.beautify
+          ? JSON.stringify(swagger)
+          : JSON.stringify(
+              swagger,
+              null,
+              typeof config.beautify === "number" ? config.beautify : 2,
+            ),
+        "utf8",
+      );
+    };
+
+  const validate_security =
+    (config: INestiaConfig.ISwaggerConfig) =>
+    (routeList: IRoute[]): void | never => {
+      const securityMap: Map<
+        string,
+        { scheme: ISwaggerSecurityScheme; scopes: Set<string> }
+      > = new Map();
+      for (const [key, value] of Object.entries(config.security ?? {}))
+        securityMap.set(key, {
+          scheme: emend_security(value),
+          scopes:
+            value.type === "oauth2"
+              ? new Set([
+                  ...Object.keys(value.flows.authorizationCode?.scopes ?? {}),
+                  ...Object.keys(value.flows.implicit?.scopes ?? {}),
+                  ...Object.keys(value.flows.password?.scopes ?? {}),
+                  ...Object.keys(value.flows.clientCredentials?.scopes ?? {}),
+                ])
+              : new Set(),
+        });
+
+      const validate =
+        (reporter: (str: string) => void) =>
+        (key: string, scopes: string[]) => {
+          const security = securityMap.get(key);
+          if (security === undefined)
+            return reporter(`target security scheme "${key}" does not exists.`);
+          else if (scopes.length === 0) return;
+          else if (security.scheme.type !== "oauth2")
+            return reporter(
+              `target security scheme "${key}" is not "oauth2" type, but you've configured the scopes.`,
+            );
+          for (const s of scopes)
+            if (security.scopes.has(s) === false)
+              reporter(
+                `target security scheme "${key}" does not have a specific scope "${s}".`,
+              );
+        };
+
+      const violations: string[] = [];
+      for (const route of routeList)
+        for (const record of route.security)
+          for (const [key, scopes] of Object.entries(record))
+            validate((str) =>
+              violations.push(
+                `  - ${str} (${route.symbol} at "${route.location}")`,
+              ),
+            )(key, scopes);
+
+      if (violations.length)
+        throw new Error(
+          `Error on NestiaApplication.swagger(): invalid security specification. Check your "nestia.config.ts" file's "swagger.security" property, or each controller methods.\n` +
+            `\n` +
+            `List of violations:\n` +
+            violations.join("\n"),
+        );
+    };
+
+  /* ---------------------------------------------------------
+        INITIALIZERS
+    --------------------------------------------------------- */
+  const initialize = async (
+    config: INestiaConfig.ISwaggerConfig,
+  ): Promise<ISwagger> => {
+    const pack = new Singleton(
+      async (): Promise<Partial<ISwaggerInfo> | null> => {
+        const location: string | null = await FileRetriever.file(
+          "package.json",
+        )(process.cwd());
+        if (location === null) return null;
+
+        try {
+          const content: string = await fs.promises.readFile(location, "utf8");
+          const data = typia.json.assertParse<{
+            name?: string;
+            version?: string;
+            description?: string;
+            license?:
+              | string
+              | {
+                  type: string;
+                  /**
+                   * @format url
+                   */
+                  url: string;
+                };
+          }>(content);
+          return {
+            title: data.name,
+            version: data.version,
+            description: data.description,
+            license: data.license
+              ? typeof data.license === "string"
+                ? { name: data.license }
+                : typeof data.license === "object"
+                ? {
+                    name: data.license.type,
+                    url: data.license.url,
+                  }
+                : undefined
+              : undefined,
+          };
+        } catch {
+          return null;
+        }
+      },
+    );
+
+    return {
+      openapi: "3.0.1",
+      servers: config.servers ?? [
+        {
+          url: "https://github.com/samchon/nestia",
+          description: "insert your server url",
+        },
+      ],
+      info: {
+        ...(config.info ?? {}),
+        version: config.info?.version ?? (await pack.get())?.version ?? "0.1.0",
+        title:
+          config.info?.title ??
+          (await pack.get())?.title ??
+          "Swagger Documents",
+        description:
+          config.info?.description ??
+          (await pack.get())?.description ??
+          "Generated by nestia - https://github.com/samchon/nestia",
+        license: config.info?.license ?? (await pack.get())?.license,
+      },
+      paths: {},
+      components: {},
+    };
+  };
+
+  function get_path(path: string, parameters: IRoute.IParameter[]): string {
+    const filtered: IRoute.IParameter[] = parameters.filter(
+      (param) => param.category === "param" && !!param.field,
+    );
+    for (const param of filtered)
+      path = path.replace(`:${param.field}`, `{${param.field}}`);
+    return path;
+  }
+
+  const generate_route =
+    (props: IProps) =>
+    (route: IRoute): ISwaggerRoute => {
+      const body = route.parameters.find((param) => param.category === "body");
+      const getJsDocTexts = (name: string) =>
+        route.jsDocTags
+          .filter(
+            (tag) =>
+              tag.name === name &&
+              tag.text &&
+              tag.text.find(
+                (elem) => elem.kind === "text" && elem.text.length,
+              ) !== undefined,
+          )
+          .map((tag) => tag.text!.find((elem) => elem.kind === "text")!.text);
+
+      const description: string | undefined = route.description?.length
+        ? route.description
+        : undefined;
+      const summary: string | undefined = (() => {
+        if (description === undefined) return undefined;
+
+        const [explicit] = getJsDocTexts("summary");
+        if (explicit?.length) return explicit;
+
+        const index: number = description.indexOf(".");
+        if (index <= 0) return undefined;
+
+        const content: string = description.substring(0, index).trim();
+        return content.length ? content : undefined;
+      })();
+      const deprecated = route.jsDocTags.find(
+        (tag) => tag.name === "deprecated",
+      );
+
+      return {
+        deprecated: deprecated ? true : undefined,
+        tags: [...route.swaggerTags, ...new Set([...getJsDocTexts("tag")])],
+        operationId:
+          route.operationId ??
+          props.config.operationId?.({
+            class: route.symbol.class,
+            function: route.symbol.function,
+            method: route.method as "GET",
+            path: route.path,
+          }),
+        parameters: route.parameters
+          .filter((param) => param.category !== "body")
+          .map((param) => SwaggerSchemaGenerator.parameter(props)(route)(param))
+          .flat(),
+        requestBody: body
+          ? SwaggerSchemaGenerator.body(props)(route)(body)
+          : undefined,
+        responses: SwaggerSchemaGenerator.response(props)(route),
+        summary,
+        description,
+        security: route.security.length ? route.security : undefined,
+        "x-nestia-namespace": [
+          ...route.path
+            .split("/")
+            .filter((str) => str.length && str[0] !== ":"),
+          route.name,
+        ].join("."),
+        "x-nestia-jsDocTags": route.jsDocTags,
+        "x-nestia-method": route.method,
+      };
+    };
+
+  function fill_security(
+    security: Required<INestiaConfig.ISwaggerConfig>["security"],
+    swagger: ISwagger,
+  ): void {
+    swagger.components.securitySchemes = {};
+    for (const [key, value] of Object.entries(security))
+      swagger.components.securitySchemes[key] = emend_security(value);
+  }
+
+  function emend_security(
+    input: ISwaggerSecurityScheme,
+  ): ISwaggerSecurityScheme {
+    if (input.type === "apiKey")
+      return {
+        ...input,
+        in: input.in ?? "header",
+        name: input.name ?? "Authorization",
+      };
+    return input;
+  }
+}