Skip to content

Commit

Permalink
docs(openapi): Use command with file (#5349)
Browse files Browse the repository at this point in the history
  • Loading branch information
jesse-c authored Feb 20, 2024
1 parent 1f32089 commit f6e08c2
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions openapi/README.md
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.


0 comments on commit f6e08c2

Please sign in to comment.