@squonk/data-manager-client 5.4.0-alpha.3 → 6.1.0

package/src/api/api-schemas/inputHandlerGetResponse.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.21.0 🍺
+ * Generated by orval v8.16.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
-
-A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
-
- * OpenAPI spec version: 5.4
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
  */
 import type { InputHandlerDetail } from "./inputHandlerDetail";
 

package/src/api/api-schemas/instanceDeleteResponse.fetch.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.16.0 🍺
+ * Do not edit manually.
+ * Dataset Manager API
+ * The Dataset Manager API service.
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
+ */
+import type { TaskIdentity } from "./taskIdentity.fetch";
+
+export type InstanceDeleteResponse = TaskIdentity;

package/src/api/api-schemas/instanceDeleteResponse.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.21.0 🍺
+ * Generated by orval v8.16.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
-
-A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
-
- * OpenAPI spec version: 5.4
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
  */
 import type { TaskIdentity } from "./taskIdentity";
 

package/src/api/api-schemas/instanceDryRunPostResponse.fetch.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.16.0 🍺
+ * Do not edit manually.
+ * Dataset Manager API
+ * The Dataset Manager API service.
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
+ */
+
+export interface InstanceDryRunPostResponse {
+  /** A token that can be used to access data in the project without further authentication. The token expires automatically or if the user revokes it. */
+  callback_token?: string;
+  /** The instance expanded command. Applies only to Job instances. */
+  command?: string;
+}

package/src/api/api-schemas/instanceDryRunPostResponse.ts

@@ -1,19 +1,17 @@
 /**
- * Generated by orval v7.21.0 🍺
+ * Generated by orval v8.16.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
-
-A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
-
- * OpenAPI spec version: 5.4
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
  */
 
 export interface InstanceDryRunPostResponse {
-  /** A token that can be used to access data in the project without further authentication. The token expires automatically or if the user revokes it.
-   */
+  /** A token that can be used to access data in the project without further authentication. The token expires automatically or if the user revokes it. */
   callback_token?: string;
-  /** The instance expanded command. Applies only to Job instances.
-   */
+  /** The instance expanded command. Applies only to Job instances. */
   command?: string;
 }

package/src/api/api-schemas/instanceGetResponse.fetch.ts

@@ -0,0 +1,89 @@
+/**
+ * Generated by orval v8.16.0 🍺
+ * Do not edit manually.
+ * Dataset Manager API
+ * The Dataset Manager API service.
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
+ */
+import type { InstanceGetResponseApplicationType } from "./instanceGetResponseApplicationType.fetch";
+import type { InstanceGetResponseJobImageType } from "./instanceGetResponseJobImageType.fetch";
+import type { InstanceGetResponseOutputs } from "./instanceGetResponseOutputs.fetch";
+import type { InstanceGetResponsePhase } from "./instanceGetResponsePhase.fetch";
+import type { InstanceTask } from "./instanceTask.fetch";
+
+export interface InstanceGetResponse {
+  /** The Project the Instance is running in */
+  project_id: string;
+  /** The application name */
+  name: string;
+  /** True if the instance is archived (protected from automatic deletion) */
+  archived: boolean;
+  /** The type of Application, which can be a `job` or an `application` */
+  application_type: InstanceGetResponseApplicationType;
+  /** The application ID */
+  application_id: string;
+  /** The application version */
+  application_version: string;
+  /** The optional application specification. For **Applications** this is returned verbatim. For **Jobs** additional material will be found. */
+  application_specification?: string;
+  /** The code obtained from the Account Server */
+  authorisation_code?: number;
+  /** The application owner, the person who launched the application and is the only user than can stop it. */
+  owner: string;
+  /** The date and time the instance was started, an ISO-8601 format string. */
+  launched: string;
+  /** The date and time the instance started running in the cluster. This is typically close to the launch time but contention may mean the instance starts only when resources are available. */
+  started?: string;
+  /** The date and time the instance stopped, an ISO-8601 format string. */
+  stopped?: string;
+  /** The time the instance has spent running in the cluster. It's a string representation of a Python `timedelta` object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set. */
+  run_time: string;
+  /**
+   * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
+   * The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
+   */
+  phase: InstanceGetResponsePhase;
+  /** The application endpoint */
+  url?: string;
+  /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition. */
+  job_collection?: string;
+  /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition. */
+  job_job?: string;
+  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition. */
+  job_name?: string;
+  /** The Job definition's unique ID */
+  job_id?: number;
+  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition. */
+  job_version?: string;
+  /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`) */
+  job_image_type?: InstanceGetResponseJobImageType;
+  /** A set of instance-relative output files (or directories) defined at the time of launch. These are used by step instances and can be used by jobs too. */
+  outputs: InstanceGetResponseOutputs;
+  /** The JSON string representation of the JobDefinition's outputs */
+  rendered_outputs?: string;
+  /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes. */
+  fix_permissions?: boolean;
+  /** A list of Tasks related to the application. Tasks are responsible for creating and deleting the instance. You should fins at least one, assuming the corresponding task has not been deleted. */
+  tasks: InstanceTask[];
+  /** Set if the instance has a valid callback token. Instances with a valid token allow users to read files form the project without authentication */
+  has_valid_callback_token: boolean;
+  /** The cost exchange rate that applies to the Job at the time of launch. This is a string representation of a Decimal, e.g. `'0.5'` */
+  launch_exchange_rate?: string;
+  /** The accumulated cost accrued by the running Job. Depending on the the Job, this is either known when the Job completes or may change as the Job runs. This is a string representation of a Decimal value, e.g. `'32.8'` */
+  cost?: string;
+  /** The accumulated coins accrued by the running Job. Coins are calculated based on the `cost` multiplied by the `launch_exchange_rate`. This is a string representation of a Decimal value, e.g. `'16.4'` */
+  coins?: string;
+  /** Where available, this is the number of hours that the JOb would take if the collateral Pods had access to only one CPU core. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. A value of `'0.5'` implies the job would have run in 30 minutes on 1 core. The minimum time resolution is 0.001 (3.6 seconds). */
+  collateral_cpu_hours?: string;
+  /** Where available, the number of collateral Pods spawned by the instance, typically used by Job instances. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. For `NEXTFLOW` jobs this is a count of the number of Task pods spawned. */
+  collateral_pod_count?: number;
+  /** An optional error message, used to report underlying problems. */
+  error_message?: string;
+  /** A list of Project-relative annotation files. */
+  written_job_annotation_files?: string[];
+  /** This is the UUID of the Running Workflow Step responsible for the Instance if this Instance is part of a Workflow (Job) */
+  running_workflow_step_id?: string;
+}

package/src/api/api-schemas/instanceGetResponse.ts

@@ -1,120 +1,89 @@
 /**
- * Generated by orval v7.21.0 🍺
+ * Generated by orval v8.16.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
-
-A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
-
- * OpenAPI spec version: 5.4
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
  */
 import type { InstanceGetResponseApplicationType } from "./instanceGetResponseApplicationType";
-import type { InstanceGetResponsePhase } from "./instanceGetResponsePhase";
 import type { InstanceGetResponseJobImageType } from "./instanceGetResponseJobImageType";
 import type { InstanceGetResponseOutputs } from "./instanceGetResponseOutputs";
+import type { InstanceGetResponsePhase } from "./instanceGetResponsePhase";
 import type { InstanceTask } from "./instanceTask";
 
 export interface InstanceGetResponse {
-  /** The Project the Instance is running in
-   */
+  /** The Project the Instance is running in */
   project_id: string;
-  /** The application name
-   */
+  /** The application name */
   name: string;
-  /** True if the instance is archived (protected from automatic deletion)
-   */
+  /** True if the instance is archived (protected from automatic deletion) */
   archived: boolean;
-  /** The type of Application, which can be a `job` or an `application`
-   */
+  /** The type of Application, which can be a `job` or an `application` */
   application_type: InstanceGetResponseApplicationType;
-  /** The application ID
-   */
+  /** The application ID */
   application_id: string;
-  /** The application version
-   */
+  /** The application version */
   application_version: string;
-  /** The optional application specification. For **Applications** this is returned verbatim. For **Jobs** additional material will be found.
-   */
+  /** The optional application specification. For **Applications** this is returned verbatim. For **Jobs** additional material will be found. */
   application_specification?: string;
-  /** The code obtained from the Account Server
-   */
+  /** The code obtained from the Account Server */
   authorisation_code?: number;
-  /** The application owner, the person who launched the application and is the only user than can stop it.
-   */
+  /** The application owner, the person who launched the application and is the only user than can stop it. */
   owner: string;
-  /** The date and time the instance was started, an ISO-8601 format string.
-   */
+  /** The date and time the instance was started, an ISO-8601 format string. */
   launched: string;
-  /** The date and time the instance started running in the cluster. This is typically close to the launch time but contention may mean the instance starts only when resources are available.
-   */
+  /** The date and time the instance started running in the cluster. This is typically close to the launch time but contention may mean the instance starts only when resources are available. */
   started?: string;
-  /** The date and time the instance stopped, an ISO-8601 format string.
-   */
+  /** The date and time the instance stopped, an ISO-8601 format string. */
   stopped?: string;
-  /** The time the instance has spent running in the cluster. It's a string representation of a Python `timedelta` object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set.
-   */
+  /** The time the instance has spent running in the cluster. It's a string representation of a Python `timedelta` object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set. */
   run_time: string;
-  /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
-The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
- */
-  phase: InstanceGetResponsePhase;
-  /** The application endpoint
+  /**
+   * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
+   * The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
    */
+  phase: InstanceGetResponsePhase;
+  /** The application endpoint */
   url?: string;
-  /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
-   */
+  /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition. */
   job_collection?: string;
-  /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
-   */
+  /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition. */
   job_job?: string;
-  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
-   */
+  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition. */
   job_name?: string;
-  /** The Job definition's unique ID
-   */
+  /** The Job definition's unique ID */
   job_id?: number;
-  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
-   */
+  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition. */
   job_version?: string;
-  /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`)
-   */
+  /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`) */
   job_image_type?: InstanceGetResponseJobImageType;
   /** A set of instance-relative output files (or directories) defined at the time of launch. These are used by step instances and can be used by jobs too. */
   outputs: InstanceGetResponseOutputs;
-  /** The JSON string representation of the JobDefinition's outputs
-   */
+  /** The JSON string representation of the JobDefinition's outputs */
   rendered_outputs?: string;
-  /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
-   */
+  /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes. */
   fix_permissions?: boolean;
-  /** A list of Tasks related to the application. Tasks are responsible for creating and deleting the instance. You should fins at least one, assuming the corresponding task has not been deleted.
-   */
+  /** A list of Tasks related to the application. Tasks are responsible for creating and deleting the instance. You should fins at least one, assuming the corresponding task has not been deleted. */
   tasks: InstanceTask[];
-  /** Set if the instance has a valid callback token. Instances with a valid token allow users to read files form the project without authentication
-   */
+  /** Set if the instance has a valid callback token. Instances with a valid token allow users to read files form the project without authentication */
   has_valid_callback_token: boolean;
-  /** The cost exchange rate that applies to the Job at the time of launch. This is a string representation of a Decimal, e.g. `'0.5'`
-   */
+  /** The cost exchange rate that applies to the Job at the time of launch. This is a string representation of a Decimal, e.g. `'0.5'` */
   launch_exchange_rate?: string;
-  /** The accumulated cost accrued by the running Job. Depending on the the Job, this is either known when the Job completes or may change as the Job runs. This is a string representation of a Decimal value, e.g. `'32.8'`
-   */
+  /** The accumulated cost accrued by the running Job. Depending on the the Job, this is either known when the Job completes or may change as the Job runs. This is a string representation of a Decimal value, e.g. `'32.8'` */
   cost?: string;
-  /** The accumulated coins accrued by the running Job. Coins are calculated based on the `cost` multiplied by the `launch_exchange_rate`. This is a string representation of a Decimal value, e.g. `'16.4'`
-   */
+  /** The accumulated coins accrued by the running Job. Coins are calculated based on the `cost` multiplied by the `launch_exchange_rate`. This is a string representation of a Decimal value, e.g. `'16.4'` */
   coins?: string;
-  /** Where available, this is the number of hours that the JOb would take if the collateral Pods had access to only one CPU core. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. A value of `'0.5'` implies the job would have run in 30 minutes on 1 core. The minimum time resolution is 0.001 (3.6 seconds).
-   */
+  /** Where available, this is the number of hours that the JOb would take if the collateral Pods had access to only one CPU core. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. A value of `'0.5'` implies the job would have run in 30 minutes on 1 core. The minimum time resolution is 0.001 (3.6 seconds). */
   collateral_cpu_hours?: string;
-  /** Where available, the number of collateral Pods spawned by the instance, typically used by Job instances. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. For `NEXTFLOW` jobs this is a count of the number of Task pods spawned.
-   */
+  /** Where available, the number of collateral Pods spawned by the instance, typically used by Job instances. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. For `NEXTFLOW` jobs this is a count of the number of Task pods spawned. */
   collateral_pod_count?: number;
-  /** An optional error message, used to report underlying problems.
-   */
+  /** An optional error message, used to report underlying problems. */
   error_message?: string;
-  /** A list of Project-relative annotation files.
-   */
+  /** A list of Project-relative annotation files. */
   written_job_annotation_files?: string[];
-  /** This is the UUID of the Running Workflow Step responsible for the Instance if this Instance is part of a Workflow (Job)
-   */
+  /** This is the UUID of the Running Workflow Step responsible for the Instance if this Instance is part of a Workflow (Job) */
   running_workflow_step_id?: string;
 }

package/src/api/api-schemas/instanceGetResponseApplicationType.fetch.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval v8.16.0 🍺
+ * Do not edit manually.
+ * Dataset Manager API
+ * The Dataset Manager API service.
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
+ */
+
+/**
+ * The type of Application, which can be a `job` or an `application`
+ */
+export type InstanceGetResponseApplicationType =
+  (typeof InstanceGetResponseApplicationType)[keyof typeof InstanceGetResponseApplicationType];
+
+export const InstanceGetResponseApplicationType = {
+  APPLICATION: "APPLICATION",
+  JOB: "JOB",
+} as const;

package/src/api/api-schemas/instanceGetResponseApplicationType.ts

@@ -1,22 +1,20 @@
 /**
- * Generated by orval v7.21.0 🍺
+ * Generated by orval v8.16.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
-
-A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
-
- * OpenAPI spec version: 5.4
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
  */
 
 /**
  * The type of Application, which can be a `job` or an `application`
-
  */
 export type InstanceGetResponseApplicationType =
   (typeof InstanceGetResponseApplicationType)[keyof typeof InstanceGetResponseApplicationType];
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
 export const InstanceGetResponseApplicationType = {
   APPLICATION: "APPLICATION",
   JOB: "JOB",

package/src/api/api-schemas/instanceGetResponseJobImageType.fetch.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.16.0 🍺
+ * Do not edit manually.
+ * Dataset Manager API
+ * The Dataset Manager API service.
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
+ */
+
+/**
+ * The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`)
+ */
+export type InstanceGetResponseJobImageType =
+  (typeof InstanceGetResponseJobImageType)[keyof typeof InstanceGetResponseJobImageType];
+
+export const InstanceGetResponseJobImageType = { SIMPLE: "SIMPLE", NEXTFLOW: "NEXTFLOW" } as const;

package/src/api/api-schemas/instanceGetResponseJobImageType.ts

@@ -1,20 +1,18 @@
 /**
- * Generated by orval v7.21.0 🍺
+ * Generated by orval v8.16.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
-
-A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
-
- * OpenAPI spec version: 5.4
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
  */
 
 /**
  * The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`)
-
  */
 export type InstanceGetResponseJobImageType =
   (typeof InstanceGetResponseJobImageType)[keyof typeof InstanceGetResponseJobImageType];
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
 export const InstanceGetResponseJobImageType = { SIMPLE: "SIMPLE", NEXTFLOW: "NEXTFLOW" } as const;

package/src/api/api-schemas/instanceGetResponseOutputs.fetch.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.16.0 🍺
+ * Do not edit manually.
+ * Dataset Manager API
+ * The Dataset Manager API service.
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
+ */
+
+/**
+ * A set of instance-relative output files (or directories) defined at the time of launch. These are used by step instances and can be used by jobs too.
+ */
+export type InstanceGetResponseOutputs = { [key: string]: unknown };

package/src/api/api-schemas/instanceGetResponseOutputs.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.21.0 🍺
+ * Generated by orval v8.16.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
-
-A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
-
- * OpenAPI spec version: 5.4
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
  */
 
 /**

package/src/api/api-schemas/instanceGetResponsePhase.fetch.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval v8.16.0 🍺
+ * Do not edit manually.
+ * Dataset Manager API
+ * The Dataset Manager API service.
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
+ */
+
+/**
+ * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
+ * The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
+ */
+export type InstanceGetResponsePhase =
+  (typeof InstanceGetResponsePhase)[keyof typeof InstanceGetResponsePhase];
+
+export const InstanceGetResponsePhase = {
+  COMPLETED: "COMPLETED",
+  CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF",
+  FAILED: "FAILED",
+  IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF",
+  PENDING: "PENDING",
+  RUNNING: "RUNNING",
+  SUCCEEDED: "SUCCEEDED",
+  UNKNOWN: "UNKNOWN",
+} as const;

package/src/api/api-schemas/instanceGetResponsePhase.ts

@@ -1,23 +1,21 @@
 /**
- * Generated by orval v7.21.0 🍺
+ * Generated by orval v8.16.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
-
-A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
-
- * OpenAPI spec version: 5.4
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
  */
 
 /**
  * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
-The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
-
+ * The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
  */
 export type InstanceGetResponsePhase =
   (typeof InstanceGetResponsePhase)[keyof typeof InstanceGetResponsePhase];
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
 export const InstanceGetResponsePhase = {
   COMPLETED: "COMPLETED",
   CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF",

package/src/api/api-schemas/instancePostBodyBody.fetch.ts

@@ -0,0 +1,82 @@
+/**
+ * Generated by orval v8.16.0 🍺
+ * Do not edit manually.
+ * Dataset Manager API
+ * The Dataset Manager API service.
+ *
+ * A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+ *
+ * OpenAPI spec version: 6.1
+ */
+
+export type InstancePostBodyBody = {
+  /**
+   * A supported application. Applications instances are managed using pre-deployed Kubernetes **Operators**. The application ID is a combination of the operator _plural_ and _group_.
+   *
+   * Application IDs currently supported include `datamanagerjobs.squonk.it` and `jupyternotebooks.squonk.it`
+   * @minLength 1
+   * @maxLength 80
+   */
+  application_id: string;
+  /**
+   * The project to attach
+   * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+   */
+  project_id: string;
+  /**
+   * The name to use for the instance
+   * @minLength 2
+   * @maxLength 80
+   * @pattern ^[A-Za-z0-9]+[A-Za-z0-9-_. ]*[A-Za-z0-9]+$
+   */
+  as_name: string;
+  /**
+   * A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution.
+   *
+   * The URL must use the `http` or `https` scheme and must not resolve to a loopback, link-local, unspecified or cloud-metadata address. The operator may further restrict permitted callback hosts via an allow-list; a URL that is not permitted is rejected with a `400` when the instance is launched.
+   */
+  callback_url?: string;
+  /**
+   * Used in conjunction with the `callback_url` any value provided here will be passed back in the message payload that's delivered to the callback URL. It can be used by the recipient to provide a context that's meaningful
+   * @minLength 1
+   * @maxLength 256
+   */
+  callback_context?: string;
+  /**
+   * If set a callback token will be provided in the response. The token allows files to be downloaded from the instance project and expires after a pre-configured amount of time after the instance is complete or if the user revokes the token.
+   *
+   * Caution should be taken using this feature. A 3rd party can access the Project's files without authentication, they just need the token and the project identity.
+   *
+   * Tokens should therefore be revoked when they're no longer required
+   */
+  generate_callback_token?: boolean;
+  /**
+   * An optional 22-character **Short UUID** callback token that is supplied by the remote service. If not provided the user can use `generate_callback_token` to have one generated and returned in the response.
+   *
+   * See the Python module's `shortuuid.get_alphabet()` for the full list of permitted characters
+   * @minLength 22
+   * @maxLength 22
+   * @pattern ^[2-9A-HJ-NP-Za-km-z]{22}$
+   */
+  callback_token?: string;
+  /**
+   * A debug value that may be used by the instance.
+   *
+   * For Data Manager **Job** applications setting this to anything other zero ('0') prevents the Job's Pod from being deleted automatically, allowing a developer to inspect the Pod's log for example.
+   *
+   * The behaviour of **Application** instances using this property is undefined. It will depend on whether the application **CRD** handles the Data Manager debug field.
+   */
+  debug?: string;
+  /**
+   * The instance specification. A JSON string that's application-specific and controls the application's behaviour.
+   *
+   * When launching a Data Manager **Job** Application you must identify the Job using the properties `collection`, `job` and `version`, e.g. `{"collection":"im-test","job":"coin-test","version":"1.0.0"}`
+   *
+   * Jobs that offer commands will often advertise a series of **inputs** and **options** where the values can be provided using a **variables** map in the specification. Something like `"variables":{"x":7}`.
+   *
+   * Jobs start in a Job-specific **working directory** but the starting directory for any Job can be adjusted by defining a `sub_path` to the root specification. For example, if you want the Job to start in the path `foo/bar` (inside the Job's built-in working directory) you can add `"sub_path":"foo/bar"` to the specification. You can only use a sub-path for a Job if the Job defines a working directory and `sub-path` cannot begin or end with a path separator (`/`).
+   *
+   * Applications also support `variables`. The Jupyter notebook application supports the definition of the notebook `"image"`, `"cpu"` and `"memory"`. A full Jupyter notebook specification might be `{"variables":{"image":"Tensorflow 2.9","cpu":2,"memory":"4Gi"}}`, where `memory` is limited to `Gi` as a suffix.
+   */
+  specification?: string;
+};