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-default: "false"; }; id: { type: "string"; x-lix-default: "lix_uuid_v7()"; }; 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-override-lixcols: { lixcol_file_id: ""lix""; lixcol_plugin_key: ""lix_sdk""; }; 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-default: "false"; }; id: { type: "string"; x-lix-default: "lix_uuid_v7()"; }; 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-default: "false"; }
properties.hidden.type
readonly type: "boolean" = "boolean"
properties.hidden.x-lix-default
readonly x-lix-default: "false" = "false"
properties.id
readonly id: { type: "string"; x-lix-default: "lix_uuid_v7()"; }
properties.id.type
readonly type: "string" = "string"
properties.id.x-lix-default
readonly x-lix-default: "lix_uuid_v7()" = "lix_uuid_v7()"
readonly metadata: { nullable: true; type: "object"; }
readonly nullable: true = true
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-override-lixcols
readonly x-lix-override-lixcols: { lixcol_file_id: ""lix""; lixcol_plugin_key: ""lix_sdk""; }
x-lix-override-lixcols.lixcol_file_id
readonly lixcol_file_id: ""lix"" = '"lix"'
x-lix-override-lixcols.lixcol_plugin_key
readonly lixcol_plugin_key: ""lix_sdk"" = '"lix_sdk"'
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"