From d91972461e5fa16c27aed44f1094fd3b0af2148f Mon Sep 17 00:00:00 2001 From: Sivanantham Chinnaiyan Date: Tue, 10 Dec 2024 13:03:29 +0530 Subject: [PATCH] Fix swagger UI example Signed-off-by: Sivanantham Chinnaiyan --- docs/get_started/swagger_ui.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/get_started/swagger_ui.md b/docs/get_started/swagger_ui.md index 722259ffd..1f93e6c27 100644 --- a/docs/get_started/swagger_ui.md +++ b/docs/get_started/swagger_ui.md @@ -29,6 +29,7 @@ spec: args: ["--enable_docs_url=True"] modelFormat: name: sklearn + runtime: kserve-sklearnserver storageUri: "gs://kfserving-examples/models/sklearn/1.0/model" EOF ``` @@ -36,6 +37,9 @@ EOF After the InferenceService becomes ready the Swagger UI will be served at **`/docs`**. In our example above, the Swagger UI will be available at `http://sklearn-iris.kserve-test.example.com/docs`. +!!! note + The Swagger UI may not be exposed or exposed with a different endpoint on other serving runtimes. For example, the MLServer runtime exposes the Swagger UI at `/v2/docs` endpoint. This example is only applicable to the KServe provided runtimes and runtimes that extend the KServe runtime SDK. + ## Interact with InferenceService Click one of the V2 endpoints like `/v2`, it will expand and display the description and response from this API endpoint: