Repository navigation
feat: describe a streamed response's items with itemSchema - #9
Open
maxholman[bot] wants to merge 1 commit into
Open
maxholman[bot] wants to merge 1 commit into
maxholman[bot] wants to merge 1 commit into
Conversation
A media type takes either schema or itemSchema, OpenAPI 3.2's schema for each item of a sequential type such as text/event-stream. Api accepts openapi 3.2.0, and the operation, path and content objects are typed against oas32, which 3.1 documents also satisfy. Schema stays on oas31. Co-Authored-By: LLM <noreply@block65.dev>
This file contains hidden or 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
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.
A media type now takes either
schemaoritemSchema.itemSchemais OpenAPI 3.2's schema for each item of a sequential media type, such astext/event-stream,application/jsonlorapplication/json-seq.Apiacceptsopenapi: "3.2.0".oas32, which 3.1 documents also satisfy.Schemastays onoas31.eventconst,dataas a JSON string viacontentMediaType+contentSchema). It's snapshotted and validated against the OAS 3.2 schema-base.This is the first step toward typed stream items: openapi-codegen reads
itemSchemanext, and block65/rest-client#23 carries the item type onstream().