chunk detection based on response format #59
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This introduces `AbstractChunkReader` and adds a few chunk readers with different chunk detection strategies. Also includes some auto selection heuristics based on detected response format and ability to specify a chunk reader at `Ctx` and `Client` levels. Chunk readers available: - `LineChunkReader`: Chunks delimited by newline. This was the only available strategy earlier. It is now the default when the response type is detected to be not of `OpenAPI.APIModel` type. - `JSONChunkReader`: Each chunk is a JSON. Whitespaces between JSONs are ignored. This is now the default when the response type is detected to be a `OpenAPI.APIModel`. - `RFC7464ChunkReader`: A reader based on [RFC 7464](https://www.rfc-editor.org/rfc/rfc7464.html). Available for use by overriding through `Client` or `Ctx`. The `Client` and `Ctx` constructors take an additional `chunk_reader_type` keyword parameter. This can be one of `OpenAPI.Clients.LineChunkReader`, `OpenAPI.Clients.JSONChunkReader` or `OpenAPI.Clients.RFC7464ChunkReader`. If not specified, then the type is automatically determined based on the return type of the API call.
|
Adding this issue on OpenAPI specifications for reference: OAI/OpenAPI-Specification#1576. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This introduces
AbstractChunkReaderand adds a few chunk readers with different chunk detection strategies. Also includes some auto selection heuristics based on detected response format and ability to specify a chunk reader atCtxandClientlevels.Chunk readers available:
LineChunkReader: Chunks delimited by newline. This was the only available strategy earlier. It is now the default when the response type is detected to be not ofOpenAPI.APIModeltype.JSONChunkReader: Each chunk is a JSON. Whitespaces between JSONs are ignored. This is now the default when the response type is detected to be aOpenAPI.APIModel.RFC7464ChunkReader: A reader based on RFC 7464. Available for use by overriding throughClientorCtx.The
ClientandCtxconstructors take an additionalchunk_reader_typekeyword parameter. This can be one ofOpenAPI.Clients.LineChunkReader,OpenAPI.Clients.JSONChunkReaderorOpenAPI.Clients.RFC7464ChunkReader. If not specified, then the type is automatically determined based on the return type of the API call.