Basepath in servers (#136)

Author: kwasniew

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unleash/proxy",
-  "version": "0.16.2",
+  "version": "0.16.3",
   "description": "The Unleash Proxy (Open-Source)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -38,7 +38,7 @@
   },
   "homepage": "https://github.com/Unleash/unleash-proxy#readme",
   "dependencies": {
-    "@unleash/express-openapi": "^0.2.1-beta.0",
+    "@unleash/express-openapi": "^0.3.0",
     "compression": "^1.7.4",
     "cors": "^2.8.5",
     "express": "^4.18.2",

src/openapi/index.ts

@@ -9,11 +9,13 @@ import { unleashContextSchema } from './spec/unleash-context-schema';
 import { variantSchema } from './spec/variant-schema';
 
 // Create the base OpenAPI schema, with everything except paths.
+
 export const createOpenApiSchema = (
+    serverUrl?: string,
     clientKeysHeaderName: string = 'Authorization',
 ): Omit<OpenAPIV3.Document, 'paths'> => ({
     openapi: '3.0.3',
-    servers: [],
+    servers: serverUrl ? [{ url: serverUrl }] : [],
     info: {
         title: 'Unleash Proxy API',
         version: process.env.npm_package_version || '',

src/openapi/openapi-service.ts

@@ -14,7 +14,10 @@ export class OpenApiService {
         this.config = config;
         this.api = openapi(
             this.docsPath(),
-            createOpenApiSchema(config.clientKeysHeaderName),
+            createOpenApiSchema(
+                config.proxyBasePath,
+                config.clientKeysHeaderName,
+            ),
             { coerce: true },
         );
     }

yarn.lock

@@ -1054,10 +1054,10 @@
     "@typescript-eslint/types" "5.22.0"
     eslint-visitor-keys "^3.0.0"
 
-"@unleash/express-openapi@^0.2.1-beta.0":
-  version "0.2.1-beta.0"
-  resolved "https://registry.yarnpkg.com/@unleash/express-openapi/-/express-openapi-0.2.1-beta.0.tgz#1f5f43c6eb46c490990dc3e4709ab23a48a24e9a"
-  integrity sha512-72pNESnWyIvsLZaYjaBHwPXzO361up/A1tA/Mv+eG1MkntRJMNhRSgPzPvoP5j7pCxKeXqu1FRfXTXLRzGo+HA==
+"@unleash/express-openapi@^0.3.0":
+  version "0.3.0"
+  resolved "https://registry.yarnpkg.com/@unleash/express-openapi/-/express-openapi-0.3.0.tgz#3d65aeafc265732cf83c57b1d18452b5d0904856"
+  integrity sha512-rcbRNoL689knbemaTbL17FOb94hagr5T/vUUUZ1Fb107SGlBbOoQErf0tHlWpeCs6ffkM6uxo5BUnOAaf6CYDA==
   dependencies:
     ajv "^6.10.2"
     http-errors "^1.7.3"