octoprint-open-api/openapi/components/schemas/files/UploadResponse.yaml
2020-10-24 16:41:52 +02:00

24 lines
1.1 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

type: object
properties:
files:
type: object
description: >-
Abridged information regarding the file that was just uploaded. If only uploaded to local this will only contain the local property. If uploaded to SD card, this will contain both local and sdcard properties. Only contained if a file was uploaded, not present if only a new folder was created.
properties:
local:
description: >-
The information regarding the file that was just uploaded to the local storage.
$ref: ./File.yaml
sdcard:
description: >-
The information regarding the file that was just uploaded to the printers SD card.
$ref: ./File.yaml
folder:
description: >-
Abridged information regarding the folder that was just created. Only contained if a folder was created, not present if a file was uploaded.
$ref: ./File.yaml
done:
type: boolean
description: >-
Whether any file processing after upload has already finished (true) or not, e.g. due to first needing to perform a slicing step (false). Clients may use this information to direct progress displays related to the upload.