@tsoa/runtime - npm Package Compare versions

Comparing version 4.0.0 to 4.1.0

dist/config.d.ts

@@ -163,2 +163,7 @@ import { Swagger } from './swagger/swagger';
     xEnumVarnames?: boolean;
+    /**
+     * Sets a title for inline objects for responses and requestBodies
+     * This helps to generate more consistent clients
+     */
+    useTitleTagsForInlineObjects?: boolean;
 }
@@ -165,0 +170,0 @@ export interface RoutesConfig {

dist/metadataGeneration/tsoa.d.ts

 import { ExtensionType } from '../decorators/extension';
+import type { Swagger } from '../swagger/swagger';
 export declare namespace Tsoa {
@@ -35,3 +36,5 @@ interface Metadata {
         parameterName: string;
-        example?: unknown[];
+        example?: Array<{
+            [exampleName: string]: Swagger.Example3;
+        }>;
         description?: string;
@@ -73,3 +76,5 @@ in: 'query' | 'header' | 'path' | 'formData' | 'body' | 'body-prop' | 'request' | 'res';
         schema?: Type;
-        examples?: unknown[];
+        examples?: Array<{
+            [exampleName: string]: Swagger.Example3;
+        }>;
         exampleLabels?: Array<string | undefined>;
@@ -76,0 +81,0 @@ headers?: HeaderType;

dist/swagger/swagger.d.ts

@@ -101,7 +101,2 @@ export declare namespace Swagger {
     }
-    export interface Example {
-        examples?: {
-            [exampleName: string]: Swagger.Example3;
-        };
-    }
     export interface Example3 {
@@ -208,3 +203,3 @@ value: unknown;
         content: {
-            [name: string]: MediaType;
+            [requestMediaType: string]: MediaType;
         };
@@ -230,3 +225,7 @@ description?: string;
         };
-        examples?: Example;
+        examples?: {
+            [responseMediaType: string]: {
+                [exampleName: string]: Example3 | string;
+            };
+        };
     }
@@ -236,3 +235,8 @@ export interface Response3 {
         content?: {
-            [name: string]: Schema & Example;
+            [responseMediaType: string]: {
+                schema: Schema3;
+                examples?: {
+                    [name: string]: Example3 | string;
+                };
+            };
         };
@@ -239,0 +243,0 @@ headers?: {

package.json

 {
   "name": "@tsoa/runtime",
   "description": "Build swagger-compliant REST APIs using TypeScript and Node",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "main": "./dist/index.js",
@@ -52,3 +52,3 @@ "typings": "./dist/index.d.ts",
   },
-  "gitHead": "06a159176fd2ef596d8182473fc5734c6ca062c2"
+  "gitHead": "5e9e2f78f14c68d6606b132a2ce6a8fd16acf376"
 }

No alert changes

Improved metrics

Total package byte prevSize

124105

increased by0.42%

Lines of code

2410

increased by0.58%

No dependency changes