UN-2854 - Initial swagger.json and optional CORS headers #111
Conversation
| @@ -0,0 +1,429 @@ | |||
| { | |||
| "openapi": "3.0.3", | |||
There was a problem hiding this comment.
Manual edit of an OpenAPI v3.0 file that @andreidenissov-cog got from gnostic (?)
Function and Connectivity worked fine, but I had to then manually tweak it and the server to get StreamingChat
working.
There was a problem hiding this comment.
Wow that's very useful. We should probably make it available in the neuro-san-demos docs / tutorials at some point.
There was a problem hiding this comment.
The next step is to be able to generate this automatically when things change.
| @@ -37,7 +37,7 @@ async def stream_out(self, | |||
| :param generator: async gRPC generator | |||
| """ | |||
| # Set up headers for chunked response | |||
| self.set_header("Content-Type", "application/json") | |||
| self.set_header("Content-Type", "application/json-lines") | |||
There was a problem hiding this comment.
OAI/OpenAPI-Specification#3730
Says that json-seq is not yet supported until OpenAPI 3.2, but another issue mentioned that json-lines was supported. Close enough.
| """ | ||
| Implementation of OPTIONS request handler for streaming chat API call. | ||
| """ | ||
| await self.flush() |
There was a problem hiding this comment.
Handle OPTIONS requests for streaming_chat. This allows for swagger-ui container to work w/ CORS fixes.
No idea why. 🤷
| if os.environ.get("AGENT_ALLOW_CORS_HEADERS") is not None: | ||
| self.set_header("Access-Control-Allow-Origin", "*") | ||
| self.set_header("Access-Control-Allow-Methods", "GET, POST, OPTIONS") | ||
| self.set_header("Access-Control-Allow-Headers", "Content-Type, Transfer-Encoding") |
There was a problem hiding this comment.
Put the CORS headers behind an env var that is not on by default.
@sidcog is going to configure these for the externally facing server on the load balancer.
For localhost to work with swagger-ui container though, these need to come from inside the house.
According to all the docs, this "*" is definitely not the right thing to do.
That said, I don't know what the right thing to do is just yet.
Be sure OPTIONS is part of that number as well.
d1donlydfink
changed the title
| @@ -0,0 +1,429 @@ | |||
| { | |||
| "openapi": "3.0.3", | |||
There was a problem hiding this comment.
Wow that's very useful. We should probably make it available in the neuro-san-demos docs / tutorials at some point.
Get enough of a manual swagger.json going so that swagger-ui container can largely do what it needs to.
@andreidenissov-cog reports that Postman largely does better with the streaming.
Will eventually need to push a new release for this for the external-facing server.