octoprint-open-api/openapi/components/schemas/files/Info.yaml
2020-10-23 21:54:31 +02:00

31 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:
name:
type: string
description: The name of the file without path. E.g. “file.gco” for a file “file.gco” located anywhere in the file system. Currently this will always fit into ASCII.
display:
type: string
description: >-
The name of the file without the path, this time potentially with non-ASCII unicode characters. E.g. “a turtle 🐢.gco” for a file “a_turtle_turtle.gco” located anywhere in the file system.
path:
type: string
description: >-
The path to the file within the location. E.g. “folder/subfolder/file.gco” for a file “file.gco” located within “folder” and “subfolder” relative to the root of the location. Currently this will always fit into ASCII.
type:
type: string
enum:
- model
- machinecode
- folder
description: >-
Type of file. model or machinecode. Or folder if its a folder, in which case the children node will be populated
typePath:
type: array
items:
type: string
oneOf:
- $ref: "./File"
- $ref: "./Folder"
discriminator:
propertyName: type