Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

FilesUploadRequest

Type: object

UploadRequest is one frame in an upload stream.
Exactly one alternative must match

Type: object

data · required

Type: string

data appends bytes to the current file.
All schema constraints and annotations
{
  "description": "data appends bytes to the current file.",
  "format": "byte",
  "type": "string"
}
All schema constraints and annotations
{
  "properties": {
    "data": {
      "description": "data appends bytes to the current file.",
      "format": "byte",
      "type": "string"
    }
  },
  "required": [
    "data"
  ],
  "title": "data",
  "type": "object"
}

Type: object

header · required

Schema: FileHeader

header starts a new file. The first frame, and the first frame after each completed file, must be this arm.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/FileHeader",
  "description": "header starts a new file. The first frame, and the first frame after each\ncompleted file, must be this arm."
}
All schema constraints and annotations
{
  "properties": {
    "header": {
      "$ref": "#/components/schemas/FileHeader",
      "description": "header starts a new file. The first frame, and the first frame after each\ncompleted file, must be this arm."
    }
  },
  "required": [
    "header"
  ],
  "title": "header",
  "type": "object"
}
All schema constraints and annotations
{
  "description": "UploadRequest is one frame in an upload stream.",
  "oneOf": [
    {
      "properties": {
        "data": {
          "description": "data appends bytes to the current file.",
          "format": "byte",
          "type": "string"
        }
      },
      "required": [
        "data"
      ],
      "title": "data",
      "type": "object"
    },
    {
      "properties": {
        "header": {
          "$ref": "#/components/schemas/FileHeader",
          "description": "header starts a new file. The first frame, and the first frame after each\ncompleted file, must be this arm."
        }
      },
      "required": [
        "header"
      ],
      "title": "header",
      "type": "object"
    }
  ],
  "title": "UploadRequest",
  "type": "object",
  "unevaluatedProperties": false
}