@nestia/migrate 0.1.10 → 0.2.0

package/src/structures/ISwagger.ts

@@ -1,9 +1,10 @@
 import { ISwaggerComponents } from "./ISwaggerComponents";
+import { ISwaggerInfo } from "./ISwaggerInfo";
 import { ISwaggerRoute } from "./ISwaggerRoute";
 
 export interface ISwagger {
     openapi: `3.0.${number}`;
-    info: ISwagger.IInfo;
+    info: ISwaggerInfo;
     servers: ISwagger.IServer[];
 
     components: ISwaggerComponents;
@@ -15,10 +16,5 @@ export namespace ISwagger {
         url: string;
         description?: string;
     }
-    export interface IInfo {
-        version: string;
-        title: string;
-        description?: string;
-    }
     export type IPath = Record<string, ISwaggerRoute>;
-}
+}

package/src/structures/ISwaggerInfo.ts

@@ -0,0 +1,80 @@
+/**
+ * Information about the API.
+ *
+ * @author Samchon
+ */
+export interface ISwaggerInfo {
+    /**
+     * The title of the API.
+     */
+    title: string;
+
+    /**
+     * A short description of the API.
+     */
+    description?: string;
+
+    /**
+     * A URL to the Terms of Service for the API.
+     *
+     * @format url
+     */
+    termsOfService?: string;
+
+    /**
+     * The contact information for the exposed API.
+     */
+    contact?: ISwaggerInfo.IContact;
+
+    /**
+     * The license information for the exposed API.
+     */
+    license?: ISwaggerInfo.ILicense;
+
+    /**
+     * Version of the API.
+     */
+    version: string;
+}
+export namespace ISwaggerInfo {
+    /**
+     * Contact information for the exposed API.
+     */
+    export interface IContact {
+        /**
+         * The identifying name of the contact person/organization.
+         */
+        name?: string;
+
+        /**
+         * The URL pointing to the contact information.
+         *
+         * @format url
+         */
+        url?: string;
+
+        /**
+         * The email address of the contact person/organization.
+         *
+         * @format email
+         */
+        email?: string;
+    }
+
+    /**
+     * License information for the exposed API.
+     */
+    export interface ILicense {
+        /**
+         * The license name used for the API.
+         */
+        name: string;
+
+        /**
+         * A URL to the license used for the API.
+         *
+         * @format url
+         */
+        url?: string;
+    }
+}

package/src/structures/ISwaggerRoute.ts

@@ -1,3 +1,5 @@
+import { IJsDocTagInfo } from "typia/lib/metadata/IJsDocTagInfo";
+
 import { ISwaggerSchema } from "./ISwaggeSchema";
 
 export interface ISwaggerRoute {
@@ -9,10 +11,11 @@ export interface ISwaggerRoute {
     deprecated?: boolean;
     security?: Record<string, string[]>[];
     tags?: string[];
+    "x-nestia-jsDocTags"?: IJsDocTagInfo[];
 }
 export namespace ISwaggerRoute {
     export interface IParameter {
-        name: string;
+        name?: string;
         in: "path" | "query" | "header" | "cookie";
         schema: ISwaggerSchema;
         required?: boolean;
@@ -21,7 +24,7 @@ export namespace ISwaggerRoute {
     export interface IRequestBody {
         description?: string;
         content: IContent;
-        required?: true;
+        required?: boolean;
         "x-nestia-encrypted"?: boolean;
     }
     export type IResponseBody = Record<
@@ -34,7 +37,7 @@ export namespace ISwaggerRoute {
     >;
     export interface IContent {
         "text/plain"?: {
-            schema: ISwaggerSchema.IString;
+            schema: ISwaggerSchema;
         };
         "application/json"?: {
             schema: ISwaggerSchema;