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

docs(openapi): Use command with file #5349

Merged
merged 1 commit into from
Feb 20, 2024
Merged

docs(openapi): Use command with file #5349

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
8 changes: 3 additions & 5 deletions openapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ You will find the API Specs at runtime at the `/seldon.json` path of your API en

You will need to be running 0.2.4-SNAPSHOT or later for this endpoint to be active.

## Viewing/Testing via Swagger-UI
## Viewing/Testing via Swagger UI

You can view the APIs using the [Swagger UI tool](https://swagger.io/tools/swagger-ui/).

You can run this via Docker with:
You can run this via Docker, from the [`seldon-core/openapi` directory](https://github.com/SeldonIO/seldon-core/tree/master/openapi), with:

```bash
docker run --network host --rm swaggerapi/swagger-editor
docker run -p 8080:8080 --rm -e URL=/custom.yaml -v ./wrapper.oas3.json:/usr/share/nginx/html/custom.yaml swaggerapi/swagger-ui
```

It will be reachable at http://localhost:8080/
Expand All @@ -39,5 +39,3 @@ For using the Swagger "try it out" feature there are some caveats due to Swagger
We welcome contributions to improving these initial API specifications.

We plan to investigate how these APIs can be customized to show the acceptable payloads for a particular machine learning inference graph running under Seldon Core. Suggestions welcome.


Loading