From 152aad2c8fc70ea70653905c51cfe48ab0d5b4ee Mon Sep 17 00:00:00 2001 From: Brett Jephson Date: Wed, 2 Oct 2024 17:32:55 +0100 Subject: [PATCH] Update comment --- packages/react-openapi/src/OpenAPIServerURL.tsx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/react-openapi/src/OpenAPIServerURL.tsx b/packages/react-openapi/src/OpenAPIServerURL.tsx index 178179795..98b8c7b8a 100644 --- a/packages/react-openapi/src/OpenAPIServerURL.tsx +++ b/packages/react-openapi/src/OpenAPIServerURL.tsx @@ -11,7 +11,9 @@ import { useOpenAPIClientState } from './OpenAPIClientStateContext'; import { parseServerURL } from './utils'; /** - * Show the url of the server with variables replaced by their default values. + * Show the url of the server, where there are variables they are replaced by their default values. + * If a stateContext is provided with an `onUpdate` callback then the variables can be edited and + * if there are multiple servers available they can be selected. */ export function OpenAPIServerURL(props: { servers: OpenAPIV3.ServerObject[];