@linode/validation
Version:
Yup validation schemas for use with the Linode APIv4
678 lines • 20.5 kB
TypeScript
export declare const ConfigProfileInterfaceSchema: import("yup").ObjectSchema<{
purpose: NonNullable<"vpc" | "public" | "vlan">;
label: string | undefined;
ipam_address: string | undefined;
primary: boolean | undefined;
subnet_id: number | undefined;
vpc_id: number | undefined;
ipv4: {};
ipv6: {};
ip_ranges: import("yup").Maybe<string[] | undefined>;
}, import("yup").AnyObject, {
purpose: undefined;
label: undefined;
ipam_address: undefined;
primary: undefined;
subnet_id: undefined;
vpc_id: undefined;
ipv4: {};
ipv6: {};
ip_ranges: "";
}, "">;
export declare const ConfigProfileInterfacesSchema: import("yup").ArraySchema<{
label?: string | undefined;
vpc_id?: number | undefined;
subnet_id?: number | undefined;
ipam_address?: string | undefined;
primary?: boolean | undefined;
ip_ranges?: import("yup").Maybe<string[] | undefined>;
ipv4: {};
ipv6: {};
purpose: NonNullable<"vpc" | "public" | "vlan">;
}[] | undefined, import("yup").AnyObject, "", "">;
export declare const UpdateConfigInterfaceOrderSchema: import("yup").ObjectSchema<{
ids: (number | undefined)[];
}, import("yup").AnyObject, {
ids: "";
}, "">;
export declare const UpdateConfigInterfaceSchema: import("yup").ObjectSchema<{
primary: import("yup").Maybe<boolean | undefined>;
ipv4: {
vpc?: import("yup").Maybe<string | undefined>;
nat_1_1?: import("yup").Maybe<string | undefined>;
} | null | undefined;
ipv6: {
vpc?: import("yup").Maybe<string | undefined>;
} | null | undefined;
ip_ranges: import("yup").Maybe<(string | undefined)[] | undefined>;
}, import("yup").AnyObject, {
primary: undefined;
ipv4: {
vpc: undefined;
nat_1_1: undefined;
};
ipv6: {
vpc: undefined;
};
ip_ranges: "";
}, "">;
export declare const ResizeLinodeDiskSchema: import("yup").ObjectSchema<{
size: number;
}, import("yup").AnyObject, {
size: undefined;
}, "">;
export declare const UpdateLinodePasswordSchema: import("yup").ObjectSchema<{
password: string;
}, import("yup").AnyObject, {
password: undefined;
}, "">;
export declare const UpdateLinodeSchema: import("yup").ObjectSchema<{
label: import("yup").Maybe<string | undefined>;
tags: import("yup").Maybe<(string | undefined)[] | undefined>;
watchdog_enabled: import("yup").Maybe<boolean | undefined>;
alerts: {
cpu?: number | undefined;
network_in?: number | undefined;
network_out?: number | undefined;
transfer_quota?: number | undefined;
io?: number | undefined;
} | null | undefined;
backups: {
enabled?: boolean | undefined;
schedule: {
day?: {} | undefined;
window?: {} | undefined;
};
};
}, import("yup").AnyObject, {
label: undefined;
tags: "";
watchdog_enabled: undefined;
alerts: {
cpu: undefined;
network_in: undefined;
network_out: undefined;
transfer_quota: undefined;
io: undefined;
};
backups: {
schedule: {
day: undefined;
window: undefined;
};
enabled: undefined;
};
}, "">;
export declare const RebuildLinodeSchema: import("yup").ObjectSchema<{
image: string;
root_pass: string;
authorized_keys: string[] | undefined;
authorized_users: string[] | undefined;
stackscript_id: number | undefined;
stackscript_data: {} | null | undefined;
booted: boolean | undefined;
metadata: {
user_data: string | null;
} | undefined;
disk_encryption: "enabled" | "disabled" | undefined;
}, import("yup").AnyObject, {
image: undefined;
root_pass: undefined;
authorized_keys: "";
authorized_users: "";
stackscript_id: undefined;
stackscript_data: {};
booted: undefined;
metadata: undefined;
disk_encryption: undefined;
}, "">;
export declare const RebuildLinodeFromStackScriptSchema: import("yup").ObjectSchema<{
image: string;
root_pass: string;
authorized_keys: string[] | undefined;
authorized_users: string[] | undefined;
stackscript_id: number;
stackscript_data: {} | null | undefined;
booted: boolean | undefined;
metadata: {
user_data: string | null;
} | undefined;
disk_encryption: "enabled" | "disabled" | undefined;
}, import("yup").AnyObject, {
image: undefined;
root_pass: undefined;
authorized_keys: "";
authorized_users: "";
stackscript_id: undefined;
stackscript_data: {};
booted: undefined;
metadata: undefined;
disk_encryption: undefined;
}, "">;
export declare const IPAllocationSchema: import("yup").ObjectSchema<{
type: string;
public: NonNullable<boolean | undefined>;
}, import("yup").AnyObject, {
type: undefined;
public: undefined;
}, "">;
export declare const CreateSnapshotSchema: import("yup").ObjectSchema<{
label: string;
}, import("yup").AnyObject, {
label: undefined;
}, "">;
export declare const CreateLinodeConfigSchema: import("yup").ObjectSchema<{
label: string;
devices: {
sda: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdb: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdc: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdd: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sde: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdf: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdg: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdh: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
};
kernel: string | undefined;
comments: string | undefined;
memory_limit: number | undefined;
run_level: {} | undefined;
virt_mode: {} | undefined;
helpers: {
updatedb_disabled?: boolean | undefined;
distro?: boolean | undefined;
modules_dep?: boolean | undefined;
network?: boolean | undefined;
devtmpfs_automount?: boolean | undefined;
};
root_device: string | undefined;
interfaces: {
label?: string | undefined;
vpc_id?: number | undefined;
subnet_id?: number | undefined;
ipam_address?: string | undefined;
primary?: boolean | undefined;
ip_ranges?: import("yup").Maybe<string[] | undefined>;
ipv4: {};
ipv6: {};
purpose: NonNullable<"vpc" | "public" | "vlan">;
}[] | undefined;
}, import("yup").AnyObject, {
label: undefined;
devices: {
sda: {
disk_id: undefined;
volume_id: undefined;
};
sdb: {
disk_id: undefined;
volume_id: undefined;
};
sdc: {
disk_id: undefined;
volume_id: undefined;
};
sdd: {
disk_id: undefined;
volume_id: undefined;
};
sde: {
disk_id: undefined;
volume_id: undefined;
};
sdf: {
disk_id: undefined;
volume_id: undefined;
};
sdg: {
disk_id: undefined;
volume_id: undefined;
};
sdh: {
disk_id: undefined;
volume_id: undefined;
};
};
kernel: undefined;
comments: undefined;
memory_limit: undefined;
run_level: undefined;
virt_mode: undefined;
helpers: {
updatedb_disabled: undefined;
distro: undefined;
modules_dep: undefined;
network: undefined;
devtmpfs_automount: undefined;
};
root_device: undefined;
interfaces: "";
}, "">;
export declare const UpdateLinodeConfigSchema: import("yup").ObjectSchema<{
label: string | undefined;
devices: {
sda: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdb: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdc: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdd: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sde: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdf: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdg: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
sdh: {
disk_id?: number | null | undefined;
volume_id?: number | null | undefined;
} | null;
};
kernel: string | undefined;
comments: string | undefined;
memory_limit: number | undefined;
run_level: {} | undefined;
virt_mode: {} | undefined;
helpers: {
updatedb_disabled?: boolean | undefined;
distro?: boolean | undefined;
modules_dep?: boolean | undefined;
network?: boolean | undefined;
devtmpfs_automount?: boolean | undefined;
};
root_device: string | undefined;
interfaces: {
label?: string | undefined;
vpc_id?: number | undefined;
subnet_id?: number | undefined;
ipam_address?: string | undefined;
primary?: boolean | undefined;
ip_ranges?: import("yup").Maybe<string[] | undefined>;
ipv4: {};
ipv6: {};
purpose: NonNullable<"vpc" | "public" | "vlan">;
}[] | undefined;
}, import("yup").AnyObject, {
label: undefined;
devices: {
sda: {
disk_id: undefined;
volume_id: undefined;
};
sdb: {
disk_id: undefined;
volume_id: undefined;
};
sdc: {
disk_id: undefined;
volume_id: undefined;
};
sdd: {
disk_id: undefined;
volume_id: undefined;
};
sde: {
disk_id: undefined;
volume_id: undefined;
};
sdf: {
disk_id: undefined;
volume_id: undefined;
};
sdg: {
disk_id: undefined;
volume_id: undefined;
};
sdh: {
disk_id: undefined;
volume_id: undefined;
};
};
kernel: undefined;
comments: undefined;
memory_limit: undefined;
run_level: undefined;
virt_mode: undefined;
helpers: {
updatedb_disabled: undefined;
distro: undefined;
modules_dep: undefined;
network: undefined;
devtmpfs_automount: undefined;
};
root_device: undefined;
interfaces: "";
}, "">;
export declare const CreateLinodeDiskSchema: import("yup").ObjectSchema<{
size: number;
label: string;
filesystem: {} | undefined;
read_only: boolean | undefined;
image: string | undefined;
authorized_keys: (string | undefined)[] | undefined;
authorized_users: (string | undefined)[] | undefined;
root_pass: string | undefined;
stackscript_id: number | undefined;
stackscript_data: {} | null;
}, import("yup").AnyObject, {
size: undefined;
label: undefined;
filesystem: undefined;
read_only: undefined;
image: undefined;
authorized_keys: "";
authorized_users: "";
root_pass: undefined;
stackscript_id: undefined;
stackscript_data: {};
}, "">;
export declare const UpdateLinodeDiskSchema: import("yup").ObjectSchema<{
label: import("yup").Maybe<string | undefined>;
filesystem: import("yup").Maybe<{} | undefined>;
}, import("yup").AnyObject, {
label: undefined;
filesystem: undefined;
}, "">;
export declare const CreateLinodeDiskFromImageSchema: import("yup").ObjectSchema<{
size: number;
label: string;
filesystem: {} | undefined;
read_only: boolean | undefined;
image: string;
authorized_keys: (string | undefined)[] | undefined;
authorized_users: (string | undefined)[] | undefined;
root_pass: string | undefined;
stackscript_id: number | undefined;
stackscript_data: {} | null;
}, import("yup").AnyObject, {
size: undefined;
label: undefined;
filesystem: undefined;
read_only: undefined;
image: undefined;
authorized_keys: "";
authorized_users: "";
root_pass: undefined;
stackscript_id: undefined;
stackscript_data: {};
}, "">;
export declare const UpgradeToLinodeInterfaceSchema: import("yup").ObjectSchema<{
config_id: number | null | undefined;
dry_run: boolean | undefined;
}, import("yup").AnyObject, {
config_id: undefined;
dry_run: undefined;
}, "">;
export declare const UpdateLinodeInterfaceSettingsSchema: import("yup").ObjectSchema<{
network_helper: boolean | null | undefined;
default_route: {
ipv4_interface_id?: number | null | undefined;
ipv6_interface_id?: number | null | undefined;
};
}, import("yup").AnyObject, {
network_helper: undefined;
default_route: {
ipv4_interface_id: undefined;
ipv6_interface_id: undefined;
};
}, "">;
export declare const CreateVPCInterfaceSchema: import("yup").ObjectSchema<{
subnet_id: number;
ipv4: {
addresses?: {
primary?: boolean | undefined;
nat_1_1_address?: string | null | undefined;
address: string;
}[] | undefined;
ranges?: {
range: string;
}[] | undefined;
} | null | undefined;
ipv6: {
slaac?: {
range: string;
}[] | undefined;
ranges?: {
range?: string | undefined;
}[] | undefined;
is_public?: boolean | undefined;
} | null | undefined;
}, import("yup").AnyObject, {
subnet_id: undefined;
ipv4: {
addresses: "";
ranges: "";
};
ipv6: {
slaac: "";
ranges: "";
is_public: undefined;
};
}, "">;
export declare const CreateLinodeInterfaceSchema: import("yup").ObjectSchema<{
firewall_id: number | null | undefined;
default_route: {
ipv4?: boolean | undefined;
ipv6?: boolean | undefined;
} | null;
vpc: {
ipv4?: {
addresses?: {
primary?: boolean | undefined;
nat_1_1_address?: string | null | undefined;
address: string;
}[] | undefined;
ranges?: {
range: string;
}[] | undefined;
} | null | undefined;
ipv6?: {
slaac?: {
range: string;
}[] | undefined;
ranges?: {
range?: string | undefined;
}[] | undefined;
is_public?: boolean | undefined;
} | null | undefined;
subnet_id: number;
} | null;
public: {
ipv4?: {
addresses?: {
primary?: boolean | undefined;
address: string;
}[] | undefined;
} | null | undefined;
ipv6?: {
ranges?: {
range: string | null;
}[] | undefined;
} | null | undefined;
} | null;
vlan: {
ipam_address?: string | null | undefined;
vlan_label: string;
} | null;
}, import("yup").AnyObject, {
firewall_id: undefined;
default_route: null;
vpc: null;
public: null;
vlan: null;
}, "">;
export declare const ModifyLinodeInterfaceSchema: import("yup").ObjectSchema<{
default_route: {
ipv4?: boolean | null | undefined;
ipv6?: boolean | null | undefined;
} | null | undefined;
vpc: {
ipv4?: {
addresses?: import("yup").Maybe<{
address?: string | undefined;
primary?: boolean | null | undefined;
nat_1_1_address?: string | null | undefined;
}[] | undefined>;
ranges?: {
range: string;
}[] | null | undefined;
} | null | undefined;
ipv6?: {
slaac?: import("yup").Maybe<{
range?: import("yup").Maybe<string | undefined>;
}[] | undefined>;
ranges?: import("yup").Maybe<{
range?: import("yup").Maybe<string | undefined>;
}[] | undefined>;
is_public?: import("yup").Maybe<boolean | undefined>;
} | null | undefined;
subnet_id: number;
} | null | undefined;
public: {
ipv4?: {
addresses?: {
primary?: boolean | undefined;
address: string;
}[] | null | undefined;
} | null | undefined;
ipv6?: {
ranges?: {
range: string | null;
}[] | null | undefined;
} | null | undefined;
} | null | undefined;
vlan: {
ipam_address?: string | null | undefined;
vlan_label: string | null;
} | null | undefined;
}, import("yup").AnyObject, {
default_route: {
ipv4: undefined;
ipv6: undefined;
};
vpc: {
subnet_id: undefined;
ipv4: {
addresses: "";
ranges: "";
};
ipv6: {
slaac: "";
ranges: "";
is_public: undefined;
};
};
public: {
ipv4: {
addresses: "";
};
ipv6: {
ranges: "";
};
};
vlan: {
vlan_label: undefined;
ipam_address: undefined;
};
}, "">;
export declare const CreateLinodeSchema: import("yup").ObjectSchema<{
type: string;
region: string;
stackscript_id: import("yup").Maybe<number | null | undefined>;
backup_id: import("yup").Maybe<number | null | undefined>;
swap_size: import("yup").Maybe<number | undefined>;
image: string | undefined;
authorized_keys: import("yup").Maybe<string[] | undefined>;
backups_enabled: import("yup").Maybe<boolean | undefined>;
stackscript_data: {} | null;
booted: import("yup").Maybe<boolean | undefined>;
label: import("yup").Maybe<string | undefined>;
tags: import("yup").Maybe<string[] | undefined>;
private_ip: import("yup").Maybe<boolean | undefined>;
authorized_users: import("yup").Maybe<string[] | undefined>;
root_pass: string | undefined;
interfaces: any[] | undefined;
interface_generation: import("yup").Maybe<"linode" | "legacy_config" | undefined>;
network_helper: boolean | undefined;
ipv4: string[] | undefined;
metadata: {
user_data: string | null;
} | null | undefined;
firewall_id: import("yup").Maybe<number | null | undefined>;
placement_group: {
id: number;
} | null | undefined;
disk_encryption: import("yup").Maybe<"enabled" | "disabled" | undefined>;
maintenance_policy: import("yup").Maybe<"linode/migrate" | "linode/power_off_on" | undefined>;
alerts: {
system: number[];
user: number[];
} | null | undefined;
}, import("yup").AnyObject, {
type: undefined;
region: undefined;
stackscript_id: undefined;
backup_id: undefined;
swap_size: undefined;
image: undefined;
authorized_keys: "";
backups_enabled: undefined;
stackscript_data: {};
booted: undefined;
label: undefined;
tags: "";
private_ip: undefined;
authorized_users: "";
root_pass: undefined;
interfaces: undefined;
interface_generation: undefined;
network_helper: undefined;
ipv4: "";
metadata: undefined;
firewall_id: undefined;
placement_group: undefined;
disk_encryption: undefined;
maintenance_policy: undefined;
alerts: undefined;
}, "">;
//# sourceMappingURL=linodes.schema.d.ts.map