@archildata/api-types 0.0.34 → 0.0.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +37 -13
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -498,6 +498,12 @@ export interface paths {
498
498
  * cold-boot from the saved disk checkpoint. A running source is
499
499
  * resumed after its checkpoint; paused and stopped sources remain
500
500
  * inactive. Forked sandboxes may themselves be forked.
501
+ *
502
+ * Passing `checkpoint` forks that saved state without touching the
503
+ * source, so clients can pause once, wait for the checkpoint, and fork
504
+ * it from any number of places. Without `checkpoint` the server pauses a
505
+ * running source inside the request and resumes it afterwards; that path
506
+ * is kept for older clients and is bounded by the request timeout.
501
507
  */
502
508
  post: operations["forkSandbox"];
503
509
  delete?: never;
@@ -570,13 +576,15 @@ export interface paths {
570
576
  get?: never;
571
577
  put?: never;
572
578
  /**
573
- * Set a sandbox's timeout
574
- * @description Replaces the sandbox's lifetime budget and, while it is running, resets
575
- * its expiration deadline to the requested number of seconds from now.
576
- * The new budget is retained across later stops and starts. For an
577
- * inactive sandbox, it applies to the next powered-on session. Sandboxes
578
- * that are starting or shutting down, or whose timeout changes
579
- * concurrently, return 409.
579
+ * Set a sandbox's timeouts
580
+ * @description Replaces one or both sandbox timeout settings. Updating `timeout` while
581
+ * the sandbox is running resets its hard expiration deadline to that many
582
+ * seconds from now. Updating `idle_ttl_seconds` resets the idle
583
+ * countdown when no direct process connection is active; zero disables
584
+ * idle expiry. Omitted settings remain unchanged. Updates are retained
585
+ * across later stops and starts. For an inactive sandbox, they apply to
586
+ * the next powered-on session. Sandboxes that are starting or shutting
587
+ * down, or whose timeout changes concurrently, return 409.
580
588
  */
581
589
  post: operations["setSandboxTimeout"];
582
590
  delete?: never;
@@ -725,7 +733,9 @@ export interface components {
725
733
  };
726
734
  SandboxTimeoutRequest: {
727
735
  /** @description Seconds from now until a running sandbox expires, and the lifetime budget for its next powered-on session. */
728
- timeout: number;
736
+ timeout?: number;
737
+ /** @description Seconds without a direct process connection before the sandbox pauses. Zero disables idle expiry. */
738
+ idle_ttl_seconds?: number;
729
739
  };
730
740
  Sandbox: {
731
741
  /** Format: uuid */
@@ -737,6 +747,8 @@ export interface components {
737
747
  mem_size_mib: number;
738
748
  /** @description Lifetime budget applied independently to each powered-on session. Expiry pauses the sandbox, preserving memory and processes for resume. Defaults to 24 hours and can be reset with the timeout endpoint. */
739
749
  max_ttl_seconds: number;
750
+ /** @description Seconds without a direct process connection before the sandbox pauses, preserving memory and processes for resume. Zero disables idle expiry. */
751
+ idle_ttl_seconds: number;
740
752
  /** @description Maximum number of concurrently attached process sessions. Detached processes and one-shot process controls do not count. */
741
753
  max_concurrent_execs: number;
742
754
  /** @description OCI reference requested when the sandbox was created. */
@@ -756,12 +768,14 @@ export interface components {
756
768
  finished_at?: string;
757
769
  /** Format: date-time */
758
770
  last_active_at: string;
771
+ exit_reason?: string;
759
772
  /**
760
- * Format: date-time
761
- * @description Current powered-on session deadline; absent while inactive.
773
+ * @description Disk checkpoint the current session leaves behind. Present while
774
+ * pausing, paused, stopping, or stopped, and committed once the
775
+ * sandbox is paused or stopped. Pass it to the fork endpoint to fork
776
+ * exactly this state.
762
777
  */
763
- expires_at?: string;
764
- exit_reason?: string;
778
+ checkpoint?: string;
765
779
  };
766
780
  SandboxEndpoint: {
767
781
  port: number;
@@ -829,12 +843,22 @@ export interface components {
829
843
  * @default 86400
830
844
  */
831
845
  max_ttl_seconds: number;
846
+ /** @description Pause after this many seconds without a direct process connection, preserving memory and processes for resume. Omit or set to zero to disable idle expiry. */
847
+ idle_ttl_seconds?: number;
832
848
  /** @description Maximum number of concurrently attached process sessions. Detached processes and one-shot process controls do not count. */
833
849
  max_concurrent_execs?: number;
834
850
  };
835
851
  ForkSandboxRequest: {
836
852
  /** @description Name for the fork. A random word-list name is generated when omitted. */
837
853
  name?: string;
854
+ /**
855
+ * @description Fork this checkpoint of the source, as returned by pause, stop, or
856
+ * describe, instead of the source's live state. The source is neither
857
+ * paused nor resumed. Only the current session's checkpoint and the
858
+ * one before it are accepted; an uncommitted or superseded checkpoint
859
+ * is rejected with 409.
860
+ */
861
+ checkpoint?: string;
838
862
  };
839
863
  ApiResponse_SandboxList: {
840
864
  /** @example true */
@@ -2805,7 +2829,7 @@ export interface operations {
2805
2829
  };
2806
2830
  };
2807
2831
  responses: {
2808
- /** @description The sandbox timeout was set */
2832
+ /** @description The sandbox timeouts were set */
2809
2833
  200: {
2810
2834
  headers: {
2811
2835
  [name: string]: unknown;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@archildata/api-types",
3
- "version": "0.0.34",
3
+ "version": "0.0.36",
4
4
  "description": "API types for the Archil control plane",
5
5
  "type": "module",
6
6
  "types": "index.d.ts",