[http] Slightly stronger types for multipart resolution. #6949
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 PR makes the types returned from
@typespec/http
for multipart payloads slightly more accurate by splitting the tuple and model forms of multipart bodies into separate types with their ownmultipartKind
and stricter subtypes about what kinds of parts they can have inside them, whether or not they can be named, whether or not they are optional, etc.The types of the parts are also split into two
partKind
types:tuple
andmodel
. The guarantees given are as follows:For model-based multipart payloads:
type
is guaranteed to be aModel
.parts
are guaranteed to be only model-based parts.For tuple-based multipart payloads:
type
is guaranteed to be aTuple
.parts
are guaranteed to be only tuple-based parts.For model-based parts:
name
is required.property
is required and refers to the ModelProperty that defined the part (and we remember to set it -- we weren't doing this correctly).For tuple-based parts:
name
is optional.property
is guaranteed to beundefined
.