feat(swaggerUI): add displayOperationId option in swaggerUI

nfroidure · Nov 25, 2023 · 5eb1347 · 5eb1347
1 parent 4424695
commit 5eb1347
Show file tree

Hide file tree

Showing 14 changed files with 305 additions and 49 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/whook-aws-lambda/package.json b/packages/whook-aws-lambda/package.json
@@ -61,7 +61,7 @@
     "openapi-types": "^12.1.3",
     "qs": "^6.11.2",
     "strict-qs": "^8.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "uuid": "^9.0.1",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0"

diff --git a/packages/whook-create/src/services/__snapshots__/createWhook.test.ts.snap b/packages/whook-create/src/services/__snapshots__/createWhook.test.ts.snap
@@ -151,7 +151,7 @@ DEV_MODE=1
     "openapi-types": "^12.1.3",
     "pkg-dir": "^8.0.0",
     "strict-qs": "^8.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0"
   },
@@ -491,7 +491,7 @@ DEV_MODE=1
     "openapi-types": "^12.1.3",
     "pkg-dir": "^8.0.0",
     "strict-qs": "^8.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0"
   },
@@ -863,7 +863,7 @@ DEV_MODE=1
     "openapi-types": "^12.1.3",
     "pkg-dir": "^8.0.0",
     "strict-qs": "^8.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0"
   },
@@ -1218,7 +1218,7 @@ DEV_MODE=1
     "openapi-types": "^12.1.3",
     "pkg-dir": "^8.0.0",
     "strict-qs": "^8.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0"
   },

diff --git a/packages/whook-create/src/services/createWhook.test.ts b/packages/whook-create/src/services/createWhook.test.ts
@@ -174,7 +174,7 @@ describe('initCreateWhook', () => {
     "openapi-types": "^12.1.3",
     "pkg-dir": "^8.0.0",
     "strict-qs": "^8.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0",
   },
@@ -396,7 +396,7 @@ describe('initCreateWhook', () => {
     "openapi-types": "^12.1.3",
     "pkg-dir": "^8.0.0",
     "strict-qs": "^8.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0",
   },
@@ -603,7 +603,7 @@ describe('initCreateWhook', () => {
     "openapi-types": "^12.1.3",
     "pkg-dir": "^8.0.0",
     "strict-qs": "^8.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0",
   },

diff --git a/packages/whook-example/package.json b/packages/whook-example/package.json
@@ -95,7 +95,7 @@
     "openapi-types": "^12.1.3",
     "pkg-dir": "^8.0.0",
     "strict-qs": "^8.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0"
   },

diff --git a/packages/whook-example/src/config/common/config.ts b/packages/whook-example/src/config/common/config.ts
@@ -1,6 +1,7 @@
 import { DEFAULT_ERRORS_DESCRIPTORS } from '@whook/http-router';
 import { readFileSync } from 'fs';
 import { NodeEnv } from 'application-services';
+import { DEFAULT_SWAGGER_UI_CONFIG } from '@whook/swagger-ui';
 import type { AppConfig } from 'application-services';
 
 /* Architecture Note #2: Configuration
@@ -67,6 +68,10 @@ const CONFIG: Omit<AppConfig, 'HOST'> = {
       'User-Agent',
     ].join(','),
   },
+  SWAGGER_UI_CONFIG: {
+    ...DEFAULT_SWAGGER_UI_CONFIG,
+    defaultModelRendering: 'model',
+  },
 };
 
 export default CONFIG;
diff --git a/packages/whook-graphql/package.json b/packages/whook-graphql/package.json
@@ -72,7 +72,7 @@
     "common-services": "^15.0.0",
     "knifecycle": "^17.0.1",
     "openapi-types": "^12.1.3",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yhttperror": "^8.0.0"
   },
   "devDependencies": {

diff --git a/packages/whook-http-router/package.json b/packages/whook-http-router/package.json
@@ -73,7 +73,7 @@
     "qs": "^6.11.2",
     "siso": "^6.0.1",
     "strict-qs": "^8.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0"
   },

diff --git a/packages/whook-http-transaction/package.json b/packages/whook-http-transaction/package.json
@@ -59,7 +59,7 @@
     "ms": "^2.1.3",
     "openapi-types": "^12.1.3",
     "statuses": "^2.0.1",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0"
   },

diff --git a/packages/whook-oauth2/package.json b/packages/whook-oauth2/package.json
@@ -51,7 +51,7 @@
     "cookie": "^0.6.0",
     "knifecycle": "^17.0.1",
     "openapi-types": "^12.1.3",
-    "type-fest": "^4.7.1",
+    "type-fest": "^4.8.2",
     "yerror": "^8.0.0",
     "yhttperror": "^8.0.0"
   },

diff --git a/packages/whook-swagger-ui/package.json b/packages/whook-swagger-ui/package.json
@@ -66,13 +66,15 @@
   },
   "homepage": "https://github.com/nfroidure/whook",
   "dependencies": {
+    "@types/swagger-ui": "3.52.4",
     "@whook/http-router": "^14.0.0",
     "@whook/whook": "^14.0.0",
     "axios": "^1.6.1",
     "ecstatic": "^4.1.4",
     "knifecycle": "^17.0.1",
     "openapi-types": "^12.1.3",
-    "swagger-ui-dist": "^5.9.3"
+    "swagger-ui-dist": "^5.9.3",
+    "type-fest": "^4.8.2"
   },
   "devDependencies": {
     "@swc/cli": "^0.1.62",