@zlayer/api-client 0.10.86 → 0.11.7

package/src/models/ContainerRestartKind.ts

@@ -0,0 +1,55 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ZLayer API
+ * Container orchestration API for ZLayer
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Which flavor of container restart policy to apply.
+ * @export
+ */
+export const ContainerRestartKind = {
+    No: 'no',
+    Always: 'always',
+    UnlessStopped: 'unless_stopped',
+    OnFailure: 'on_failure'
+} as const;
+export type ContainerRestartKind = typeof ContainerRestartKind[keyof typeof ContainerRestartKind];
+
+
+export function instanceOfContainerRestartKind(value: any): boolean {
+    for (const key in ContainerRestartKind) {
+        if (Object.prototype.hasOwnProperty.call(ContainerRestartKind, key)) {
+            if (ContainerRestartKind[key as keyof typeof ContainerRestartKind] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ContainerRestartKindFromJSON(json: any): ContainerRestartKind {
+    return ContainerRestartKindFromJSONTyped(json, false);
+}
+
+export function ContainerRestartKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContainerRestartKind {
+    return json as ContainerRestartKind;
+}
+
+export function ContainerRestartKindToJSON(value?: ContainerRestartKind | null): any {
+    return value as any;
+}
+
+export function ContainerRestartKindToJSONTyped(value: any, ignoreDiscriminator: boolean): ContainerRestartKind {
+    return value as ContainerRestartKind;
+}
+

package/src/models/ContainerRestartPolicy.ts

@@ -0,0 +1,100 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ZLayer API
+ * Container orchestration API for ZLayer
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ContainerRestartKind } from './ContainerRestartKind';
+import {
+    ContainerRestartKindFromJSON,
+    ContainerRestartKindFromJSONTyped,
+    ContainerRestartKindToJSON,
+    ContainerRestartKindToJSONTyped,
+} from './ContainerRestartKind';
+
+/**
+ * Container-runtime-level restart policy.
+ * 
+ * Maps onto Docker's `HostConfig.RestartPolicy`. Distinct from
+ * [`PanicPolicy`], which governs what `ZLayer` does in response to an
+ * application panic (it does not set a Docker restart policy).
+ * @export
+ * @interface ContainerRestartPolicy
+ */
+export interface ContainerRestartPolicy {
+    /**
+     * Humantime-formatted delay between restarts (e.g. `"500ms"`,
+     * `"2s"`). Accepted for forward-compatibility but currently ignored
+     * by the Docker backend: bollard's `RestartPolicy` has no per-kind
+     * delay field. When set, the runtime emits a warning.
+     * @type {string}
+     * @memberof ContainerRestartPolicy
+     */
+    delay?: string | null;
+    /**
+     * Which restart policy to apply.
+     * @type {ContainerRestartKind}
+     * @memberof ContainerRestartPolicy
+     */
+    kind: ContainerRestartKind;
+    /**
+     * For `on_failure` only: maximum number of restart attempts before
+     * giving up. Ignored by other kinds. `None` means "retry forever".
+     * @type {number}
+     * @memberof ContainerRestartPolicy
+     */
+    maxAttempts?: number | null;
+}
+
+
+
+/**
+ * Check if a given object implements the ContainerRestartPolicy interface.
+ */
+export function instanceOfContainerRestartPolicy(value: object): value is ContainerRestartPolicy {
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    return true;
+}
+
+export function ContainerRestartPolicyFromJSON(json: any): ContainerRestartPolicy {
+    return ContainerRestartPolicyFromJSONTyped(json, false);
+}
+
+export function ContainerRestartPolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContainerRestartPolicy {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'delay': json['delay'] == null ? undefined : json['delay'],
+        'kind': ContainerRestartKindFromJSON(json['kind']),
+        'maxAttempts': json['max_attempts'] == null ? undefined : json['max_attempts'],
+    };
+}
+
+export function ContainerRestartPolicyToJSON(json: any): ContainerRestartPolicy {
+    return ContainerRestartPolicyToJSONTyped(json, false);
+}
+
+export function ContainerRestartPolicyToJSONTyped(value?: ContainerRestartPolicy | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'delay': value['delay'],
+        'kind': ContainerRestartKindToJSON(value['kind']),
+        'max_attempts': value['maxAttempts'],
+    };
+}
+

package/src/models/ContainerWaitResponse.ts

@@ -14,23 +14,51 @@
 
 import { mapValues } from '../runtime';
 /**
- * Wait response with container exit code
+ * Wait response with container exit code plus optional classification
+ * fields (added in §3.12 of the SDK-fixes spec).
+ * 
+ * The three optional fields (`reason`, `signal`, `finished_at`) are
+ * additive — clients that only read `exit_code` keep working unchanged.
  * @export
  * @interface ContainerWaitResponse
  */
 export interface ContainerWaitResponse {
     /**
-     * Exit code (0 = success)
+     * Exit code (0 = success). When the container was killed by signal
+     * `N`, this is typically `128 + N`.
      * @type {number}
      * @memberof ContainerWaitResponse
      */
     exitCode: number;
+    /**
+     * RFC3339 timestamp of when the container exited, if reported by
+     * the runtime.
+     * @type {string}
+     * @memberof ContainerWaitResponse
+     */
+    finishedAt?: string | null;
     /**
      * Container identifier
      * @type {string}
      * @memberof ContainerWaitResponse
      */
     id: string;
+    /**
+     * Classification of the exit. One of `"exited"`, `"signal"`,
+     * `"oom_killed"`, or `"runtime_error"`. Absent when the runtime
+     * didn't classify the exit.
+     * @type {string}
+     * @memberof ContainerWaitResponse
+     */
+    reason?: string | null;
+    /**
+     * Signal name when `reason == "signal"`, e.g. `"SIGKILL"`. Absent
+     * when the runtime couldn't determine it (or the exit wasn't a
+     * signal death).
+     * @type {string}
+     * @memberof ContainerWaitResponse
+     */
+    signal?: string | null;
 }
 
 /**
@@ -53,7 +81,10 @@ export function ContainerWaitResponseFromJSONTyped(json: any, ignoreDiscriminato
     return {
         
         'exitCode': json['exit_code'],
+        'finishedAt': json['finished_at'] == null ? undefined : json['finished_at'],
         'id': json['id'],
+        'reason': json['reason'] == null ? undefined : json['reason'],
+        'signal': json['signal'] == null ? undefined : json['signal'],
     };
 }
 
@@ -69,7 +100,10 @@ export function ContainerWaitResponseToJSONTyped(value?: ContainerWaitResponse |
     return {
         
         'exit_code': value['exitCode'],
+        'finished_at': value['finishedAt'],
         'id': value['id'],
+        'reason': value['reason'],
+        'signal': value['signal'],
     };
 }
 

package/src/models/CreateBridgeNetworkRequest.ts

@@ -0,0 +1,109 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ZLayer API
+ * Container orchestration API for ZLayer
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { BridgeNetworkDriver } from './BridgeNetworkDriver';
+import {
+    BridgeNetworkDriverFromJSON,
+    BridgeNetworkDriverFromJSONTyped,
+    BridgeNetworkDriverToJSON,
+    BridgeNetworkDriverToJSONTyped,
+} from './BridgeNetworkDriver';
+
+/**
+ * Body for `POST /api/v1/container-networks`.
+ * @export
+ * @interface CreateBridgeNetworkRequest
+ */
+export interface CreateBridgeNetworkRequest {
+    /**
+     * Driver, defaults to `bridge`.
+     * @type {BridgeNetworkDriver}
+     * @memberof CreateBridgeNetworkRequest
+     */
+    driver?: BridgeNetworkDriver | null;
+    /**
+     * Internal-only (no egress) network.
+     * @type {boolean}
+     * @memberof CreateBridgeNetworkRequest
+     */
+    internal?: boolean;
+    /**
+     * Arbitrary labels.
+     * @type {{ [key: string]: string; }}
+     * @memberof CreateBridgeNetworkRequest
+     */
+    labels?: { [key: string]: string; };
+    /**
+     * Network name (must match `^[a-z0-9][a-z0-9_-]{0,63}$`).
+     * @type {string}
+     * @memberof CreateBridgeNetworkRequest
+     */
+    name: string;
+    /**
+     * Subnet CIDR (e.g. `"10.240.0.0/24"`). Validated as
+     * [`ipnetwork::IpNetwork`].
+     * @type {string}
+     * @memberof CreateBridgeNetworkRequest
+     */
+    subnet?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the CreateBridgeNetworkRequest interface.
+ */
+export function instanceOfCreateBridgeNetworkRequest(value: object): value is CreateBridgeNetworkRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function CreateBridgeNetworkRequestFromJSON(json: any): CreateBridgeNetworkRequest {
+    return CreateBridgeNetworkRequestFromJSONTyped(json, false);
+}
+
+export function CreateBridgeNetworkRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateBridgeNetworkRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'driver': json['driver'] == null ? undefined : BridgeNetworkDriverFromJSON(json['driver']),
+        'internal': json['internal'] == null ? undefined : json['internal'],
+        'labels': json['labels'] == null ? undefined : json['labels'],
+        'name': json['name'],
+        'subnet': json['subnet'] == null ? undefined : json['subnet'],
+    };
+}
+
+export function CreateBridgeNetworkRequestToJSON(json: any): CreateBridgeNetworkRequest {
+    return CreateBridgeNetworkRequestToJSONTyped(json, false);
+}
+
+export function CreateBridgeNetworkRequestToJSONTyped(value?: CreateBridgeNetworkRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'driver': BridgeNetworkDriverToJSON(value['driver']),
+        'internal': value['internal'],
+        'labels': value['labels'],
+        'name': value['name'],
+        'subnet': value['subnet'],
+    };
+}
+

package/src/models/CreateContainerRequest.ts

@@ -13,6 +13,20 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ContainerRestartPolicy } from './ContainerRestartPolicy';
+import {
+    ContainerRestartPolicyFromJSON,
+    ContainerRestartPolicyFromJSONTyped,
+    ContainerRestartPolicyToJSON,
+    ContainerRestartPolicyToJSONTyped,
+} from './ContainerRestartPolicy';
+import type { NetworkAttachmentRequest } from './NetworkAttachmentRequest';
+import {
+    NetworkAttachmentRequestFromJSON,
+    NetworkAttachmentRequestFromJSONTyped,
+    NetworkAttachmentRequestToJSON,
+    NetworkAttachmentRequestToJSONTyped,
+} from './NetworkAttachmentRequest';
 import type { VolumeMount } from './VolumeMount';
 import {
     VolumeMountFromJSON,
@@ -20,6 +34,20 @@ import {
     VolumeMountToJSON,
     VolumeMountToJSONTyped,
 } from './VolumeMount';
+import type { HealthCheckRequest } from './HealthCheckRequest';
+import {
+    HealthCheckRequestFromJSON,
+    HealthCheckRequestFromJSONTyped,
+    HealthCheckRequestToJSON,
+    HealthCheckRequestToJSONTyped,
+} from './HealthCheckRequest';
+import type { PortMapping } from './PortMapping';
+import {
+    PortMappingFromJSON,
+    PortMappingFromJSONTyped,
+    PortMappingToJSON,
+    PortMappingToJSONTyped,
+} from './PortMapping';
 import type { ContainerResourceLimits } from './ContainerResourceLimits';
 import {
     ContainerResourceLimitsFromJSON,
@@ -27,6 +55,13 @@ import {
     ContainerResourceLimitsToJSON,
     ContainerResourceLimitsToJSONTyped,
 } from './ContainerResourceLimits';
+import type { RegistryAuth } from './RegistryAuth';
+import {
+    RegistryAuthFromJSON,
+    RegistryAuthFromJSONTyped,
+    RegistryAuthToJSON,
+    RegistryAuthToJSONTyped,
+} from './RegistryAuth';
 
 /**
  * Request to create and start a container
@@ -40,12 +75,41 @@ export interface CreateContainerRequest {
      * @memberof CreateContainerRequest
      */
     command?: Array<string> | null;
+    /**
+     * Additional DNS servers (maps to Docker's `--dns`). Each entry must be
+     * a plausible IPv4 or IPv6 address.
+     * @type {Array<string>}
+     * @memberof CreateContainerRequest
+     */
+    dns?: Array<string>;
     /**
      * Environment variables
      * @type {{ [key: string]: string; }}
      * @memberof CreateContainerRequest
      */
     env?: { [key: string]: string; };
+    /**
+     * Extra `hostname:ip` entries appended to `/etc/hosts` (maps to Docker's
+     * `--add-host`). The special literal `host-gateway` is accepted as the
+     * `ip` half.
+     * @type {Array<string>}
+     * @memberof CreateContainerRequest
+     */
+    extraHosts?: Array<string>;
+    /**
+     * Optional health check. When omitted, the daemon installs a no-op
+     * placeholder (`HealthCheck::Tcp { port: 0 }`) matching the current
+     * default; the health monitor treats `port == 0` as "skip".
+     * @type {HealthCheckRequest}
+     * @memberof CreateContainerRequest
+     */
+    healthCheck?: HealthCheckRequest | null;
+    /**
+     * Optional container hostname (maps to Docker's `--hostname`).
+     * @type {string}
+     * @memberof CreateContainerRequest
+     */
+    hostname?: string | null;
     /**
      * OCI image reference (e.g., "nginx:latest", "ubuntu:22.04")
      * @type {string}
@@ -64,18 +128,61 @@ export interface CreateContainerRequest {
      * @memberof CreateContainerRequest
      */
     name?: string | null;
+    /**
+     * User-defined bridge/overlay networks to attach the newly-created
+     * container to. Each entry references a network by id or name and is
+     * attached after the container is successfully started. If any
+     * attachment fails, the partially-started container is rolled back
+     * (stopped + removed) and the request is failed.
+     * @type {Array<NetworkAttachmentRequest>}
+     * @memberof CreateContainerRequest
+     */
+    networks?: Array<NetworkAttachmentRequest>;
+    /**
+     * Published ports (Docker's `-p host:container/proto`). When omitted,
+     * the container is created without any host port publishing.
+     * @type {Array<PortMapping>}
+     * @memberof CreateContainerRequest
+     */
+    ports?: Array<PortMapping>;
     /**
      * Image pull policy: "always", "`if_not_present`", or "never"
      * @type {string}
      * @memberof CreateContainerRequest
      */
     pullPolicy?: string | null;
+    /**
+     * Inline Docker/OCI registry credentials used for this pull only. Not
+     * persisted, never logged, never echoed back on a response. When both
+     * `registry_credential_id` and `registry_auth` are set, this field
+     * takes precedence.
+     * @type {RegistryAuth}
+     * @memberof CreateContainerRequest
+     */
+    registryAuth?: RegistryAuth | null;
+    /**
+     * Id of a persisted registry credential (from
+     * `POST /api/v1/credentials/registry`) to use when pulling the image.
+     * Ignored when [`Self::registry_auth`] is also supplied (inline auth
+     * wins). Requires the daemon to be configured with a credential store
+     * — otherwise the request is rejected with `400`.
+     * @type {string}
+     * @memberof CreateContainerRequest
+     */
+    registryCredentialId?: string | null;
     /**
      * Resource limits (CPU, memory)
      * @type {ContainerResourceLimits}
      * @memberof CreateContainerRequest
      */
     resources?: ContainerResourceLimits | null;
+    /**
+     * Container restart policy (Docker-style). When omitted, the runtime
+     * applies no explicit restart policy (Docker default: `"no"`).
+     * @type {ContainerRestartPolicy}
+     * @memberof CreateContainerRequest
+     */
+    restartPolicy?: ContainerRestartPolicy | null;
     /**
      * Volume mounts
      * @type {Array<VolumeMount>}
@@ -109,12 +216,21 @@ export function CreateContainerRequestFromJSONTyped(json: any, ignoreDiscriminat
     return {
         
         'command': json['command'] == null ? undefined : json['command'],
+        'dns': json['dns'] == null ? undefined : json['dns'],
         'env': json['env'] == null ? undefined : json['env'],
+        'extraHosts': json['extra_hosts'] == null ? undefined : json['extra_hosts'],
+        'healthCheck': json['health_check'] == null ? undefined : HealthCheckRequestFromJSON(json['health_check']),
+        'hostname': json['hostname'] == null ? undefined : json['hostname'],
         'image': json['image'],
         'labels': json['labels'] == null ? undefined : json['labels'],
         'name': json['name'] == null ? undefined : json['name'],
+        'networks': json['networks'] == null ? undefined : ((json['networks'] as Array<any>).map(NetworkAttachmentRequestFromJSON)),
+        'ports': json['ports'] == null ? undefined : ((json['ports'] as Array<any>).map(PortMappingFromJSON)),
         'pullPolicy': json['pull_policy'] == null ? undefined : json['pull_policy'],
+        'registryAuth': json['registry_auth'] == null ? undefined : RegistryAuthFromJSON(json['registry_auth']),
+        'registryCredentialId': json['registry_credential_id'] == null ? undefined : json['registry_credential_id'],
         'resources': json['resources'] == null ? undefined : ContainerResourceLimitsFromJSON(json['resources']),
+        'restartPolicy': json['restart_policy'] == null ? undefined : ContainerRestartPolicyFromJSON(json['restart_policy']),
         'volumes': json['volumes'] == null ? undefined : ((json['volumes'] as Array<any>).map(VolumeMountFromJSON)),
         'workDir': json['work_dir'] == null ? undefined : json['work_dir'],
     };
@@ -132,12 +248,21 @@ export function CreateContainerRequestToJSONTyped(value?: CreateContainerRequest
     return {
         
         'command': value['command'],
+        'dns': value['dns'],
         'env': value['env'],
+        'extra_hosts': value['extraHosts'],
+        'health_check': HealthCheckRequestToJSON(value['healthCheck']),
+        'hostname': value['hostname'],
         'image': value['image'],
         'labels': value['labels'],
         'name': value['name'],
+        'networks': value['networks'] == null ? undefined : ((value['networks'] as Array<any>).map(NetworkAttachmentRequestToJSON)),
+        'ports': value['ports'] == null ? undefined : ((value['ports'] as Array<any>).map(PortMappingToJSON)),
         'pull_policy': value['pullPolicy'],
+        'registry_auth': RegistryAuthToJSON(value['registryAuth']),
+        'registry_credential_id': value['registryCredentialId'],
         'resources': ContainerResourceLimitsToJSON(value['resources']),
+        'restart_policy': ContainerRestartPolicyToJSON(value['restartPolicy']),
         'volumes': value['volumes'] == null ? undefined : ((value['volumes'] as Array<any>).map(VolumeMountToJSON)),
         'work_dir': value['workDir'],
     };

package/src/models/CreateVolumeRequest.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ZLayer API
+ * Container orchestration API for ZLayer
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Request body for `POST /api/v1/volumes`.
+ * @export
+ * @interface CreateVolumeRequest
+ */
+export interface CreateVolumeRequest {
+    /**
+     * Optional labels to attach to the volume.
+     * @type {{ [key: string]: string; }}
+     * @memberof CreateVolumeRequest
+     */
+    labels?: { [key: string]: string; };
+    /**
+     * Volume name. Required. Must match `^[a-z0-9][a-z0-9_-]{0,63}$`.
+     * @type {string}
+     * @memberof CreateVolumeRequest
+     */
+    name: string;
+    /**
+     * Optional size hint (humansize format: `"512Mi"`, `"10Gi"`).
+     * Recorded in the sidecar for display and future quota enforcement.
+     * @type {string}
+     * @memberof CreateVolumeRequest
+     */
+    size?: string | null;
+    /**
+     * Optional storage tier. Accepts `"local"` (default), `"cached"`,
+     * `"network"`, matching `zlayer_spec::StorageTier`.
+     * @type {string}
+     * @memberof CreateVolumeRequest
+     */
+    tier?: string | null;
+}
+
+/**
+ * Check if a given object implements the CreateVolumeRequest interface.
+ */
+export function instanceOfCreateVolumeRequest(value: object): value is CreateVolumeRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function CreateVolumeRequestFromJSON(json: any): CreateVolumeRequest {
+    return CreateVolumeRequestFromJSONTyped(json, false);
+}
+
+export function CreateVolumeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateVolumeRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'labels': json['labels'] == null ? undefined : json['labels'],
+        'name': json['name'],
+        'size': json['size'] == null ? undefined : json['size'],
+        'tier': json['tier'] == null ? undefined : json['tier'],
+    };
+}
+
+export function CreateVolumeRequestToJSON(json: any): CreateVolumeRequest {
+    return CreateVolumeRequestToJSONTyped(json, false);
+}
+
+export function CreateVolumeRequestToJSONTyped(value?: CreateVolumeRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'labels': value['labels'],
+        'name': value['name'],
+        'size': value['size'],
+        'tier': value['tier'],
+    };
+}
+