Variable: LixFileDescriptorSchema

const LixFileDescriptorSchema: { additionalProperties: false; properties: { directory_id: { description: "Identifier of the directory containing the file. Null indicates the virtual root directory."; nullable: true; type: "string"; }; extension: { description: "File extension without the leading dot. Null when no extension is present."; nullable: true; pattern: "^[^./\\]+$"; type: "string"; }; hidden: { type: "boolean"; x-lix-generated: true; }; id: { type: "string"; x-lix-generated: true; }; metadata: { nullable: true; type: "object"; }; name: { description: "File name without directory segments."; pattern: "^[^/\\]+$"; type: "string"; }; }; required: readonly ["id", "directory_id", "name", "extension"]; type: "object"; x-lix-key: "lix_file_descriptor"; x-lix-primary-key: readonly ["id"]; x-lix-unique: readonly [readonly ["directory_id", "name", "extension"]]; x-lix-version: "1.0"; }

Type Declaration

additionalProperties

readonly additionalProperties: false = false

properties

readonly properties: { directory_id: { description: "Identifier of the directory containing the file. Null indicates the virtual root directory."; nullable: true; type: "string"; }; extension: { description: "File extension without the leading dot. Null when no extension is present."; nullable: true; pattern: "^[^./\\]+$"; type: "string"; }; hidden: { type: "boolean"; x-lix-generated: true; }; id: { type: "string"; x-lix-generated: true; }; metadata: { nullable: true; type: "object"; }; name: { description: "File name without directory segments."; pattern: "^[^/\\]+$"; type: "string"; }; }

properties.directory_id

readonly directory_id: { description: "Identifier of the directory containing the file. Null indicates the virtual root directory."; nullable: true; type: "string"; }

properties.directory_id.description

readonly description: "Identifier of the directory containing the file. Null indicates the virtual root directory." = "Identifier of the directory containing the file. Null indicates the virtual root directory."

properties.directory_id.nullable

readonly nullable: true = true

properties.directory_id.type

readonly type: "string" = "string"

properties.extension

readonly extension: { description: "File extension without the leading dot. Null when no extension is present."; nullable: true; pattern: "^[^./\\]+$"; type: "string"; }

properties.extension.description

readonly description: "File extension without the leading dot. Null when no extension is present." = "File extension without the leading dot. Null when no extension is present."

properties.extension.nullable

readonly nullable: true = true

properties.extension.pattern

readonly pattern: "^[^./\\]+$" = "^[^./\\\\]+$"

properties.extension.type

readonly type: "string" = "string"

properties.hidden

readonly hidden: { type: "boolean"; x-lix-generated: true; }

properties.hidden.type

readonly type: "boolean" = "boolean"

properties.hidden.x-lix-generated

readonly x-lix-generated: true = true

properties.id

readonly id: { type: "string"; x-lix-generated: true; }

properties.id.type

readonly type: "string" = "string"

properties.id.x-lix-generated

readonly x-lix-generated: true = true

properties.metadata

readonly metadata: { nullable: true; type: "object"; }

properties.metadata.nullable

readonly nullable: true = true

properties.metadata.type

readonly type: "object" = "object"

properties.name

readonly name: { description: "File name without directory segments."; pattern: "^[^/\\]+$"; type: "string"; }

properties.name.description

readonly description: "File name without directory segments." = "File name without directory segments."

properties.name.pattern

readonly pattern: "^[^/\\]+$" = "^[^/\\\\]+$"

properties.name.type

readonly type: "string" = "string"

required

readonly required: readonly ["id", "directory_id", "name", "extension"]

type

readonly type: "object" = "object"

x-lix-key

readonly x-lix-key: "lix_file_descriptor" = "lix_file_descriptor"

x-lix-primary-key

readonly x-lix-primary-key: readonly ["id"]

x-lix-unique

readonly x-lix-unique: readonly [readonly ["directory_id", "name", "extension"]]

x-lix-version

readonly x-lix-version: "1.0" = "1.0"