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.

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

Clean up openapi #3262

Merged
merged 2 commits into from
Jun 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 0 additions & 17 deletions openapi/Makefile

This file was deleted.

6 changes: 3 additions & 3 deletions openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

We provide initial [OpenAPI](https://www.openapis.org/) 3.0 specifications for our APIs

* [Seldon Core External via Ambassador](https://github.com/SeldonIO/seldon-core/blob/master/openapi/engine.oas3.json)
* [Seldon Core Internal microservice API](https://github.com/SeldonIO/seldon-core/blob/master/openapi/wrapper.oas3.json)
* [Seldon Core External via Ambassador](https://github.com/SeldonIO/seldon-core/blob/master/openapi/engine.oas3.json) <img src="https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/SeldonIO/seldon-core/master/openapi/engine.oas3.json">
* [Seldon Core Internal microservice API](https://github.com/SeldonIO/seldon-core/blob/master/openapi/wrapper.oas3.json) <img src="https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/SeldonIO/seldon-core/master/openapi/wrapper.oas3.json">

You will find the API Specs at runtime at the `/seldon.json` path of your API endpoint.

Expand All @@ -27,7 +27,7 @@ Open one of the two API specificatons referenced above.

For using the Swagger "try it out" feature there are some caveats due to Swagger UI bugs:

* For the [Seldon Core External via API Gateway](https://github.com/SeldonIO/seldon-core/blob/master/openapi/engine.oas3.json)
* For the [Seldon Core External via Ambassador](https://github.com/SeldonIO/seldon-core/blob/master/openapi/engine.oas3.json)
* You will need to use a hardwired host, localhost:8002 is provided for Authorization as currently the Swagger UI can't handle variables in Authorization calls.
* You will need to use the browser network console to get the bearer token from the returned json as this is not displayed by the Swagger UI.
* For the [Seldon Internal API](https://github.com/SeldonIO/seldon-core/blob/master/openapi/wrapper.oas3.json)
Expand Down
34 changes: 0 additions & 34 deletions openapi/base.json

This file was deleted.

Loading