From f1d1d2fd818dc40004f9034c26f5bab6eeeca0bc Mon Sep 17 00:00:00 2001 From: "Nolann B." <100787331+nolannbiron@users.noreply.github.com> Date: Wed, 26 Feb 2025 09:13:27 +0100 Subject: [PATCH] Return empty string if no server provided (#2878) --- .changeset/chatty-apricots-laugh.md | 5 +++++ packages/react-openapi/src/util/server.test.ts | 4 ++-- packages/react-openapi/src/util/server.ts | 5 +++-- 3 files changed, 10 insertions(+), 4 deletions(-) create mode 100644 .changeset/chatty-apricots-laugh.md diff --git a/.changeset/chatty-apricots-laugh.md b/.changeset/chatty-apricots-laugh.md new file mode 100644 index 000000000..9bae79c66 --- /dev/null +++ b/.changeset/chatty-apricots-laugh.md @@ -0,0 +1,5 @@ +--- +'@gitbook/react-openapi': patch +--- + +Return empty string if no server provided diff --git a/packages/react-openapi/src/util/server.test.ts b/packages/react-openapi/src/util/server.test.ts index 4726ca4fc..4cca78d32 100644 --- a/packages/react-openapi/src/util/server.test.ts +++ b/packages/react-openapi/src/util/server.test.ts @@ -50,9 +50,9 @@ describe('#getDefaultServerURL', () => { expect(result).toBe('https://user.example.com/v1'); }); - it('returns null if no servers are provided', () => { + it('returns empty string if no servers are provided', () => { const servers: OpenAPIV3.ServerObject[] = []; const result = getDefaultServerURL(servers); - expect(result).toBeNull(); + expect(result).toBe(''); }); }); diff --git a/packages/react-openapi/src/util/server.ts b/packages/react-openapi/src/util/server.ts index b8ed3a96c..afc958920 100644 --- a/packages/react-openapi/src/util/server.ts +++ b/packages/react-openapi/src/util/server.ts @@ -3,10 +3,11 @@ import { OpenAPIV3 } from '@gitbook/openapi-parser'; /** * Get the default URL for the server. */ -export function getDefaultServerURL(servers: OpenAPIV3.ServerObject[]): null | string { +export function getDefaultServerURL(servers: OpenAPIV3.ServerObject[]): string { const server = servers[0]; if (!server) { - return null; + // Return empty string if no server is found to display nothing + return ''; } return interpolateServerURL(server);