Experimental
Schema
FilesDownloadResponse
Type:
object
DownloadResponse is one frame in a download stream. At most one of data, error, header is set.
data
Type:
string
data carries bytes for the current file.
All schema constraints and annotations
{
"description": "data carries bytes for the current file.",
"format": "byte",
"type": "string"
}error
Schema:
FileError
error reports a path-level failure without aborting the whole stream.
All schema constraints and annotations
{
"$ref": "#/components/schemas/FileError",
"description": "error reports a path-level failure without aborting the whole stream."
}header
Schema:
FileHeader
header starts a downloaded file.
All schema constraints and annotations
{
"$ref": "#/components/schemas/FileHeader",
"description": "header starts a downloaded file."
}All schema constraints and annotations
{
"dependentSchemas": {
"data": {
"not": {
"anyOf": [
{
"required": [
"error"
]
},
{
"required": [
"header"
]
}
]
}
},
"error": {
"not": {
"anyOf": [
{
"required": [
"data"
]
},
{
"required": [
"header"
]
}
]
}
},
"header": {
"not": {
"anyOf": [
{
"required": [
"data"
]
},
{
"required": [
"error"
]
}
]
}
}
},
"description": "DownloadResponse is one frame in a download stream. At most one of data, error, header is set.",
"properties": {
"data": {
"description": "data carries bytes for the current file.",
"format": "byte",
"type": "string"
},
"error": {
"$ref": "#/components/schemas/FileError",
"description": "error reports a path-level failure without aborting the whole stream."
},
"header": {
"$ref": "#/components/schemas/FileHeader",
"description": "header starts a downloaded file."
}
},
"title": "DownloadResponse",
"type": "object",
"unevaluatedProperties": false
}