Skip to content

Commit f1d1d2f

Browse files
authored
Return empty string if no server provided (#2878)
1 parent a749c67 commit f1d1d2f

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

.changeset/chatty-apricots-laugh.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@gitbook/react-openapi': patch
3+
---
4+
5+
Return empty string if no server provided

packages/react-openapi/src/util/server.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ describe('#getDefaultServerURL', () => {
5050
expect(result).toBe('https://user.example.com/v1');
5151
});
5252

53-
it('returns null if no servers are provided', () => {
53+
it('returns empty string if no servers are provided', () => {
5454
const servers: OpenAPIV3.ServerObject[] = [];
5555
const result = getDefaultServerURL(servers);
56-
expect(result).toBeNull();
56+
expect(result).toBe('');
5757
});
5858
});

packages/react-openapi/src/util/server.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ import { OpenAPIV3 } from '@gitbook/openapi-parser';
33
/**
44
* Get the default URL for the server.
55
*/
6-
export function getDefaultServerURL(servers: OpenAPIV3.ServerObject[]): null | string {
6+
export function getDefaultServerURL(servers: OpenAPIV3.ServerObject[]): string {
77
const server = servers[0];
88
if (!server) {
9-
return null;
9+
// Return empty string if no server is found to display nothing
10+
return '';
1011
}
1112

1213
return interpolateServerURL(server);

0 commit comments

Comments
 (0)