Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix swagger UI example #432

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix swagger UI example #432

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/get_started/swagger_ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,17 @@ spec:
args: ["--enable_docs_url=True"]
modelFormat:
name: sklearn
runtime: kserve-sklearnserver
storageUri: "gs://kfserving-examples/models/sklearn/1.0/model"
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:
Expand Down