@squonk/data-manager-client 3.3.2 → 4.0.0-rc.2
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.
- package/accounting/accounting.cjs.map +1 -1
- package/accounting/accounting.js.map +1 -1
- package/admin/admin.cjs +10 -10
- package/admin/admin.cjs.map +1 -1
- package/admin/admin.js +10 -10
- package/admin/admin.js.map +1 -1
- package/application/application.cjs.map +1 -1
- package/application/application.js.map +1 -1
- package/configuration/configuration.cjs +44 -1
- package/configuration/configuration.cjs.map +1 -1
- package/configuration/configuration.d.cts +59 -2
- package/configuration/configuration.d.ts +59 -2
- package/configuration/configuration.js +43 -0
- package/configuration/configuration.js.map +1 -1
- package/dataset/dataset.cjs +11 -11
- package/dataset/dataset.cjs.map +1 -1
- package/dataset/dataset.js +11 -11
- package/dataset/dataset.js.map +1 -1
- package/digest/digest.cjs.map +1 -1
- package/digest/digest.js.map +1 -1
- package/exchange-rate/exchange-rate.cjs +10 -10
- package/exchange-rate/exchange-rate.cjs.map +1 -1
- package/exchange-rate/exchange-rate.js +10 -10
- package/exchange-rate/exchange-rate.js.map +1 -1
- package/file-and-path/file-and-path.cjs +10 -10
- package/file-and-path/file-and-path.cjs.map +1 -1
- package/file-and-path/file-and-path.js +10 -10
- package/file-and-path/file-and-path.js.map +1 -1
- package/index.cjs +39 -1
- package/index.cjs.map +1 -1
- package/index.d.cts +355 -18
- package/index.d.ts +355 -18
- package/index.js +38 -0
- package/index.js.map +1 -1
- package/instance/instance.cjs +24 -24
- package/instance/instance.cjs.map +1 -1
- package/instance/instance.js +24 -24
- package/instance/instance.js.map +1 -1
- package/inventory/inventory.cjs.map +1 -1
- package/inventory/inventory.js.map +1 -1
- package/job/job.cjs.map +1 -1
- package/job/job.js.map +1 -1
- package/metadata/metadata.cjs +10 -10
- package/metadata/metadata.cjs.map +1 -1
- package/metadata/metadata.js +10 -10
- package/metadata/metadata.js.map +1 -1
- package/package.json +1 -1
- package/project/project.cjs +11 -11
- package/project/project.cjs.map +1 -1
- package/project/project.js +11 -11
- package/project/project.js.map +1 -1
- package/src/accounting/accounting.ts +2 -2
- package/src/admin/admin.ts +12 -12
- package/src/application/application.ts +2 -2
- package/src/configuration/configuration.ts +144 -2
- package/src/data-manager-api.schemas.ts +399 -17
- package/src/dataset/dataset.ts +13 -13
- package/src/digest/digest.ts +2 -2
- package/src/exchange-rate/exchange-rate.ts +12 -12
- package/src/file-and-path/file-and-path.ts +12 -12
- package/src/instance/instance.ts +26 -26
- package/src/inventory/inventory.ts +2 -2
- package/src/job/job.ts +2 -2
- package/src/metadata/metadata.ts +12 -12
- package/src/project/project.ts +13 -13
- package/src/task/task.ts +2 -2
- package/src/type/type.ts +2 -2
- package/src/user/user.ts +14 -14
- package/src/workflow/workflow.ts +1399 -0
- package/task/task.cjs.map +1 -1
- package/task/task.js.map +1 -1
- package/type/type.cjs.map +1 -1
- package/type/type.js.map +1 -1
- package/user/user.cjs +11 -11
- package/user/user.cjs.map +1 -1
- package/user/user.d.cts +1 -1
- package/user/user.d.ts +1 -1
- package/user/user.js +11 -11
- package/user/user.js.map +1 -1
- package/workflow/package.json +7 -0
- package/workflow/workflow.cjs +489 -0
- package/workflow/workflow.cjs.map +1 -0
- package/workflow/workflow.d.cts +572 -0
- package/workflow/workflow.d.ts +572 -0
- package/workflow/workflow.js +489 -0
- package/workflow/workflow.js.map +1 -0
package/index.d.cts
CHANGED
|
@@ -7,9 +7,9 @@ import { AxiosRequestConfig, AxiosError } from 'axios';
|
|
|
7
7
|
* Dataset Manager API
|
|
8
8
|
* The Dataset Manager API service.
|
|
9
9
|
|
|
10
|
-
A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **
|
|
10
|
+
A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
|
|
11
11
|
|
|
12
|
-
* OpenAPI spec version:
|
|
12
|
+
* OpenAPI spec version: 4.0
|
|
13
13
|
*/
|
|
14
14
|
type GetUserInventoryParams = {
|
|
15
15
|
/**
|
|
@@ -290,7 +290,7 @@ type GetProjectFileWithTokenParams = {
|
|
|
290
290
|
/**
|
|
291
291
|
* A token
|
|
292
292
|
*/
|
|
293
|
-
token
|
|
293
|
+
token: QTokenParameter;
|
|
294
294
|
/**
|
|
295
295
|
* A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
|
|
296
296
|
|
|
@@ -559,6 +559,85 @@ type QCurrentParameter = boolean;
|
|
|
559
559
|
|
|
560
560
|
*/
|
|
561
561
|
type QApplicationIdParameter = string;
|
|
562
|
+
type WorkflowPatchBodyBody = {
|
|
563
|
+
/**
|
|
564
|
+
* A new name for the Workflow
|
|
565
|
+
|
|
566
|
+
* @minLength 2
|
|
567
|
+
* @maxLength 80
|
|
568
|
+
*/
|
|
569
|
+
name?: string;
|
|
570
|
+
/** A replacement workflow definition, a YAML string.
|
|
571
|
+
|
|
572
|
+
You can provide an inline definition as a YAML string or load a `definition_file`. You must provide one or the other.
|
|
573
|
+
*/
|
|
574
|
+
definition?: string;
|
|
575
|
+
/** A workflow definition, a YAML string.
|
|
576
|
+
|
|
577
|
+
You can provide a file or an inline `definition` as a YAML string. You must provide one or the other. */
|
|
578
|
+
definition_file?: Blob;
|
|
579
|
+
};
|
|
580
|
+
type WorkflowVersionPutBodyBody = {
|
|
581
|
+
/** The versions string, anything, but typically a string that complies with the **Semantic Versioning 2.0.0** definition, e.g. `1.0.0-alpha.1`
|
|
582
|
+
*/
|
|
583
|
+
version: string;
|
|
584
|
+
};
|
|
585
|
+
type WorkflowRunPostBodyBody = {
|
|
586
|
+
/**
|
|
587
|
+
* The Project to run the Workflow in
|
|
588
|
+
|
|
589
|
+
* @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
|
|
590
|
+
*/
|
|
591
|
+
project_id: string;
|
|
592
|
+
/**
|
|
593
|
+
* The name to use for the instance
|
|
594
|
+
|
|
595
|
+
* @minLength 2
|
|
596
|
+
* @maxLength 80
|
|
597
|
+
* @pattern ^[A-Za-z0-9]+[A-Za-z0-9-_. ]*[A-Za-z0-9]+$
|
|
598
|
+
*/
|
|
599
|
+
as_name: string;
|
|
600
|
+
/** A JSON string representation of the variables provided to the workflow
|
|
601
|
+
*/
|
|
602
|
+
variables?: string;
|
|
603
|
+
/** A debug value that may be used by the instance.
|
|
604
|
+
*/
|
|
605
|
+
debug?: string;
|
|
606
|
+
};
|
|
607
|
+
/**
|
|
608
|
+
* The scope of the workflow. The default is `GLOBAL`
|
|
609
|
+
|
|
610
|
+
*/
|
|
611
|
+
type WorkflowPostBodyBodyScope = typeof WorkflowPostBodyBodyScope[keyof typeof WorkflowPostBodyBodyScope];
|
|
612
|
+
declare const WorkflowPostBodyBodyScope: {
|
|
613
|
+
readonly GLOBAL: "GLOBAL";
|
|
614
|
+
readonly AS_ORGANISATION: "AS_ORGANISATION";
|
|
615
|
+
readonly AS_PROJECT: "AS_PROJECT";
|
|
616
|
+
};
|
|
617
|
+
type WorkflowPostBodyBody = {
|
|
618
|
+
/**
|
|
619
|
+
* The name to attach to the workflow
|
|
620
|
+
|
|
621
|
+
* @minLength 2
|
|
622
|
+
* @maxLength 80
|
|
623
|
+
*/
|
|
624
|
+
name: string;
|
|
625
|
+
/** The workflow definition, a YAML string. The definition is converted to a YAML object using PyYAML's `SafeLoader`. This limits what is supported but minimises the risk of a User being able to execute arbitrary code from the supplied YAML.
|
|
626
|
+
|
|
627
|
+
You can provide an inline definition as a YAML string or load a `definition_file`. You must provide one or the other.
|
|
628
|
+
*/
|
|
629
|
+
definition?: string;
|
|
630
|
+
/** A workflow definition, a YAML string.
|
|
631
|
+
|
|
632
|
+
You can provide a file or an inline `definition` as a YAML string. You must provide one or the other. */
|
|
633
|
+
definition_file?: Blob;
|
|
634
|
+
/** The scope of the workflow. The default is `GLOBAL`
|
|
635
|
+
*/
|
|
636
|
+
scope: WorkflowPostBodyBodyScope;
|
|
637
|
+
/** If the scope of the Workflow is not `GLOBAL` you need to provide an identity of the chosen scope. This might be the UUID of an Account Server Organisation or Unit ror example.
|
|
638
|
+
*/
|
|
639
|
+
scope_id?: string;
|
|
640
|
+
};
|
|
562
641
|
type UserPatchBodyBody = {
|
|
563
642
|
/** If set to a message the user account is suspended, with the user receiving this message when they try and use the API. A suspended user account can be restored by setting the message to `/restore`
|
|
564
643
|
*/
|
|
@@ -600,7 +679,7 @@ type ProjectPostBodyBody = {
|
|
|
600
679
|
};
|
|
601
680
|
type ProjectPatchBodyBody = {
|
|
602
681
|
private?: boolean;
|
|
603
|
-
/** The new name of the
|
|
682
|
+
/** The new name of the Project
|
|
604
683
|
*/
|
|
605
684
|
name?: string;
|
|
606
685
|
};
|
|
@@ -689,7 +768,7 @@ type InstancePostBodyBody = {
|
|
|
689
768
|
*/
|
|
690
769
|
generate_callback_token?: boolean;
|
|
691
770
|
/**
|
|
692
|
-
* An optional 22-character **
|
|
771
|
+
* 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.
|
|
693
772
|
|
|
694
773
|
See the Python module's `shortuuid.get_alphabet()` for the full list of permitted characters
|
|
695
774
|
|
|
@@ -897,9 +976,9 @@ interface UserDetail {
|
|
|
897
976
|
interface UserAccountDetail {
|
|
898
977
|
user: UserDetail;
|
|
899
978
|
/** Whether the caller has admin privilege */
|
|
900
|
-
caller_has_admin_privilege
|
|
979
|
+
caller_has_admin_privilege?: boolean;
|
|
901
980
|
/** The Data Manager roles the user has */
|
|
902
|
-
data_manager_roles
|
|
981
|
+
data_manager_roles?: string[];
|
|
903
982
|
}
|
|
904
983
|
/**
|
|
905
984
|
* The Schema type (an object)
|
|
@@ -1057,6 +1136,22 @@ interface ServiceErrorSummary {
|
|
|
1057
1136
|
acknowledged_at?: string;
|
|
1058
1137
|
acknowledging_user?: string;
|
|
1059
1138
|
}
|
|
1139
|
+
interface RunningWorkflowProject {
|
|
1140
|
+
/** The Project ID
|
|
1141
|
+
*/
|
|
1142
|
+
id?: string;
|
|
1143
|
+
/** The Project name
|
|
1144
|
+
*/
|
|
1145
|
+
name?: string;
|
|
1146
|
+
}
|
|
1147
|
+
interface RunningWorkflowWorkflow {
|
|
1148
|
+
/** The Workflow ID
|
|
1149
|
+
*/
|
|
1150
|
+
id?: string;
|
|
1151
|
+
/** The Workflow name
|
|
1152
|
+
*/
|
|
1153
|
+
name?: string;
|
|
1154
|
+
}
|
|
1060
1155
|
interface ProjectFileDetail {
|
|
1061
1156
|
/** The code obtained from the Account Server
|
|
1062
1157
|
*/
|
|
@@ -1170,7 +1265,7 @@ interface JobVariables {
|
|
|
1170
1265
|
options?: JobVariablesOptions;
|
|
1171
1266
|
}
|
|
1172
1267
|
/**
|
|
1173
|
-
* The optional container image type. Typically a single-container
|
|
1268
|
+
* The optional 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`)
|
|
1174
1269
|
|
|
1175
1270
|
*/
|
|
1176
1271
|
type JobSummaryImageType = typeof JobSummaryImageType[keyof typeof JobSummaryImageType];
|
|
@@ -1191,7 +1286,7 @@ interface JobSummary {
|
|
|
1191
1286
|
/** The Job version
|
|
1192
1287
|
*/
|
|
1193
1288
|
version: string;
|
|
1194
|
-
/** The optional container image type. Typically a single-container
|
|
1289
|
+
/** The optional 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`)
|
|
1195
1290
|
*/
|
|
1196
1291
|
image_type: JobSummaryImageType;
|
|
1197
1292
|
/** The Job's category
|
|
@@ -1264,7 +1359,7 @@ interface JobApplication {
|
|
|
1264
1359
|
version: string;
|
|
1265
1360
|
}
|
|
1266
1361
|
/**
|
|
1267
|
-
* The Job container image type. Typically a single-container
|
|
1362
|
+
* 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`)
|
|
1268
1363
|
|
|
1269
1364
|
*/
|
|
1270
1365
|
type InstanceSummaryJobImageType = typeof InstanceSummaryJobImageType[keyof typeof InstanceSummaryJobImageType];
|
|
@@ -1332,13 +1427,13 @@ interface InstanceSummary {
|
|
|
1332
1427
|
/** The data and time (UTC) the instance stopped running
|
|
1333
1428
|
*/
|
|
1334
1429
|
stopped?: string;
|
|
1335
|
-
/** The time the instance has spent running in the cluster. It's a string representation of a Python `timedelta
|
|
1430
|
+
/** 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.
|
|
1336
1431
|
*/
|
|
1337
1432
|
run_time: string;
|
|
1338
|
-
/** The application instance owner, the person who launched the application and is the only user
|
|
1433
|
+
/** The application instance owner, the person who launched the application and is the only user that can stop it.
|
|
1339
1434
|
*/
|
|
1340
1435
|
owner: string;
|
|
1341
|
-
/** The Project the instances
|
|
1436
|
+
/** The Project the instances are running in.
|
|
1342
1437
|
*/
|
|
1343
1438
|
project_id: string;
|
|
1344
1439
|
/** The Instance name
|
|
@@ -1362,7 +1457,7 @@ interface InstanceSummary {
|
|
|
1362
1457
|
/** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
|
|
1363
1458
|
*/
|
|
1364
1459
|
job_version?: string;
|
|
1365
|
-
/** The Job container image type. Typically a single-container
|
|
1460
|
+
/** 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`)
|
|
1366
1461
|
*/
|
|
1367
1462
|
job_image_type?: InstanceSummaryJobImageType;
|
|
1368
1463
|
/** The instance's known outputs, a JSON string defining a map of all the outputs. Typically applied only to JOB application types
|
|
@@ -1664,6 +1759,235 @@ interface ModeGetResponse {
|
|
|
1664
1759
|
*/
|
|
1665
1760
|
mode: string;
|
|
1666
1761
|
}
|
|
1762
|
+
type RunningWorkflowStepStatus = typeof RunningWorkflowStepStatus[keyof typeof RunningWorkflowStepStatus];
|
|
1763
|
+
declare const RunningWorkflowStepStatus: {
|
|
1764
|
+
readonly RUNNING: "RUNNING";
|
|
1765
|
+
readonly SUCCESS: "SUCCESS";
|
|
1766
|
+
readonly FAILURE: "FAILURE";
|
|
1767
|
+
};
|
|
1768
|
+
type RunningWorkflowStepVariables = {
|
|
1769
|
+
[key: string]: unknown;
|
|
1770
|
+
};
|
|
1771
|
+
interface RunningWorkflowStep {
|
|
1772
|
+
/** The Running Workflow Step's unique ID */
|
|
1773
|
+
id: string;
|
|
1774
|
+
variables: RunningWorkflowStepVariables;
|
|
1775
|
+
instance_id?: string;
|
|
1776
|
+
task_id?: string;
|
|
1777
|
+
started: string;
|
|
1778
|
+
stopped?: string;
|
|
1779
|
+
status: RunningWorkflowStepStatus;
|
|
1780
|
+
/** The step name */
|
|
1781
|
+
name: string;
|
|
1782
|
+
/** True if the running workflow step has finished */
|
|
1783
|
+
done: boolean;
|
|
1784
|
+
error_num: number;
|
|
1785
|
+
error_msg?: string;
|
|
1786
|
+
/** True if the running workflow step has finished successfully */
|
|
1787
|
+
success?: boolean;
|
|
1788
|
+
running_workflow: RunningWorkflowSummary;
|
|
1789
|
+
prior_running_workflow_step?: PriorRunningWorkflowStep;
|
|
1790
|
+
}
|
|
1791
|
+
interface RunningWorkflowStepsGetResponse {
|
|
1792
|
+
count: number;
|
|
1793
|
+
running_workflow_steps: RunningWorkflowStep[];
|
|
1794
|
+
}
|
|
1795
|
+
/**
|
|
1796
|
+
* The variables provided when the running workflow was created
|
|
1797
|
+
|
|
1798
|
+
*/
|
|
1799
|
+
type RunningWorkflowGetResponseVariables = {
|
|
1800
|
+
[key: string]: unknown;
|
|
1801
|
+
};
|
|
1802
|
+
/**
|
|
1803
|
+
* The status of the running workflow
|
|
1804
|
+
*/
|
|
1805
|
+
type RunningWorkflowGetResponseStatus = typeof RunningWorkflowGetResponseStatus[keyof typeof RunningWorkflowGetResponseStatus];
|
|
1806
|
+
declare const RunningWorkflowGetResponseStatus: {
|
|
1807
|
+
readonly RUNNING: "RUNNING";
|
|
1808
|
+
readonly SUCCESS: "SUCCESS";
|
|
1809
|
+
readonly FAILURE: "FAILURE";
|
|
1810
|
+
readonly USER_STOPPED: "USER_STOPPED";
|
|
1811
|
+
};
|
|
1812
|
+
interface RunningWorkflowGetResponse {
|
|
1813
|
+
/** The Running Workflows's unique ID */
|
|
1814
|
+
id: string;
|
|
1815
|
+
/** The user that started the running workflow */
|
|
1816
|
+
running_user: string;
|
|
1817
|
+
/** The name attached to this running workflow */
|
|
1818
|
+
name: string;
|
|
1819
|
+
error_num: number;
|
|
1820
|
+
error_msg?: string;
|
|
1821
|
+
/** True if the running workflow has finished */
|
|
1822
|
+
done: boolean;
|
|
1823
|
+
/** True if the running workflow has finished successfully */
|
|
1824
|
+
success?: boolean;
|
|
1825
|
+
/** An optional string passed to running instances */
|
|
1826
|
+
debug?: string;
|
|
1827
|
+
/** The status of the running workflow */
|
|
1828
|
+
status: RunningWorkflowGetResponseStatus;
|
|
1829
|
+
/** The date and time the running workflow was started */
|
|
1830
|
+
started: string;
|
|
1831
|
+
/** The date and time the running workflow was stopped
|
|
1832
|
+
*/
|
|
1833
|
+
stopped?: string;
|
|
1834
|
+
/** The variables provided when the running workflow was created
|
|
1835
|
+
*/
|
|
1836
|
+
variables: RunningWorkflowGetResponseVariables;
|
|
1837
|
+
/** The user that stopped the running workflow */
|
|
1838
|
+
stopping_user?: string;
|
|
1839
|
+
workflow: RunningWorkflowWorkflow;
|
|
1840
|
+
project: RunningWorkflowProject;
|
|
1841
|
+
}
|
|
1842
|
+
/**
|
|
1843
|
+
* The status of the running workflow
|
|
1844
|
+
*/
|
|
1845
|
+
type RunningWorkflowSummaryStatus = typeof RunningWorkflowSummaryStatus[keyof typeof RunningWorkflowSummaryStatus];
|
|
1846
|
+
declare const RunningWorkflowSummaryStatus: {
|
|
1847
|
+
readonly RUNNING: "RUNNING";
|
|
1848
|
+
readonly SUCCESS: "SUCCESS";
|
|
1849
|
+
readonly FAILURE: "FAILURE";
|
|
1850
|
+
readonly USER_STOPPED: "USER_STOPPED";
|
|
1851
|
+
};
|
|
1852
|
+
interface RunningWorkflowSummary {
|
|
1853
|
+
/** The Running Workflows's unique ID
|
|
1854
|
+
*/
|
|
1855
|
+
id: string;
|
|
1856
|
+
/** The name attached to this running workflow
|
|
1857
|
+
*/
|
|
1858
|
+
name: string;
|
|
1859
|
+
/** The status of the running workflow */
|
|
1860
|
+
status?: RunningWorkflowSummaryStatus;
|
|
1861
|
+
workflow?: RunningWorkflowWorkflow;
|
|
1862
|
+
}
|
|
1863
|
+
interface PriorRunningWorkflowStep {
|
|
1864
|
+
/** The Running Workflows Step's unique ID that ran prior to this step
|
|
1865
|
+
*/
|
|
1866
|
+
id: string;
|
|
1867
|
+
}
|
|
1868
|
+
interface RunningWorkflowGetAllResponse {
|
|
1869
|
+
/** The number of running workflows in the returned list
|
|
1870
|
+
*/
|
|
1871
|
+
count: number;
|
|
1872
|
+
running_workflows: RunningWorkflowSummary[];
|
|
1873
|
+
}
|
|
1874
|
+
interface WorkflowVersionPutResponse {
|
|
1875
|
+
/** A new workflow ID */
|
|
1876
|
+
id: string;
|
|
1877
|
+
}
|
|
1878
|
+
interface WorkflowStepSummary {
|
|
1879
|
+
/** The name of the step
|
|
1880
|
+
*/
|
|
1881
|
+
name: string;
|
|
1882
|
+
/** The JSON string representation of the step specification
|
|
1883
|
+
*/
|
|
1884
|
+
specification: string;
|
|
1885
|
+
}
|
|
1886
|
+
interface WorkflowRunPostResponse {
|
|
1887
|
+
/** A running workflow ID */
|
|
1888
|
+
id: string;
|
|
1889
|
+
}
|
|
1890
|
+
interface WorkflowDefinitionGetResponse {
|
|
1891
|
+
/** YAML as a string */
|
|
1892
|
+
definition: string;
|
|
1893
|
+
}
|
|
1894
|
+
/**
|
|
1895
|
+
* The scope of the workflow.
|
|
1896
|
+
*/
|
|
1897
|
+
type WorkflowGetResponseScope = typeof WorkflowGetResponseScope[keyof typeof WorkflowGetResponseScope];
|
|
1898
|
+
declare const WorkflowGetResponseScope: {
|
|
1899
|
+
readonly GLOBAL: "GLOBAL";
|
|
1900
|
+
readonly AS_ORGANISATION: "AS_ORGANISATION";
|
|
1901
|
+
readonly AS_UNIT: "AS_UNIT";
|
|
1902
|
+
};
|
|
1903
|
+
interface WorkflowGetResponse {
|
|
1904
|
+
/** The Workflows's unique ID */
|
|
1905
|
+
id: string;
|
|
1906
|
+
/** The creator of Workflows */
|
|
1907
|
+
creating_user?: string;
|
|
1908
|
+
/** The name attached to this workflow definition */
|
|
1909
|
+
name: string;
|
|
1910
|
+
/** The name of the Workflow. Set if the workflow definition contains a name
|
|
1911
|
+
*/
|
|
1912
|
+
workflow_name?: string;
|
|
1913
|
+
/** The description of the Workflow. Set if the workflow definition contains a description
|
|
1914
|
+
*/
|
|
1915
|
+
workflow_description?: string;
|
|
1916
|
+
/** The date and time the workflow was created */
|
|
1917
|
+
created: string;
|
|
1918
|
+
/** The scope of the workflow. */
|
|
1919
|
+
scope: WorkflowGetResponseScope;
|
|
1920
|
+
/** The scope ID of the workflow. Set if the **Scope** is not **GLOBAL**
|
|
1921
|
+
*/
|
|
1922
|
+
scope_id?: string;
|
|
1923
|
+
/** The version of the workflow. Set if the workflow definition version has been set.
|
|
1924
|
+
*/
|
|
1925
|
+
version?: string;
|
|
1926
|
+
/** The parent Workflow ID. Set if this workflow has been versioned.
|
|
1927
|
+
*/
|
|
1928
|
+
source_id?: string;
|
|
1929
|
+
/** True if the workflow has been validated */
|
|
1930
|
+
validated: boolean;
|
|
1931
|
+
/** A non-zero value if there's been a validation error */
|
|
1932
|
+
validation_error_num?: number;
|
|
1933
|
+
/** A list of validation errors. Only present if the workflow has been validated and errors were found.
|
|
1934
|
+
*/
|
|
1935
|
+
validation_error_msg?: string[];
|
|
1936
|
+
/** The steps, if the Workflow has been validated and has no errors.
|
|
1937
|
+
*/
|
|
1938
|
+
steps?: WorkflowStepSummary[];
|
|
1939
|
+
}
|
|
1940
|
+
interface WorkflowPostResponse {
|
|
1941
|
+
id: string;
|
|
1942
|
+
validated: boolean;
|
|
1943
|
+
}
|
|
1944
|
+
interface WorkflowPatchResponse {
|
|
1945
|
+
validated: boolean;
|
|
1946
|
+
}
|
|
1947
|
+
/**
|
|
1948
|
+
* The scope of the workflow.
|
|
1949
|
+
|
|
1950
|
+
*/
|
|
1951
|
+
type WorkflowSummaryScope = typeof WorkflowSummaryScope[keyof typeof WorkflowSummaryScope];
|
|
1952
|
+
declare const WorkflowSummaryScope: {
|
|
1953
|
+
readonly GLOBAL: "GLOBAL";
|
|
1954
|
+
readonly AS_ORGANISATION: "AS_ORGANISATION";
|
|
1955
|
+
readonly AS_UNIT: "AS_UNIT";
|
|
1956
|
+
};
|
|
1957
|
+
interface WorkflowSummary {
|
|
1958
|
+
/** The Workflows's unique ID
|
|
1959
|
+
*/
|
|
1960
|
+
id: string;
|
|
1961
|
+
/** The name attached to this workflow definitions
|
|
1962
|
+
*/
|
|
1963
|
+
name: string;
|
|
1964
|
+
/** The name of the Workflow. Set if the workflow definition contains a description
|
|
1965
|
+
*/
|
|
1966
|
+
workflow_name?: string;
|
|
1967
|
+
/** The description of the workflow. Set if the workflow definition contains a description
|
|
1968
|
+
*/
|
|
1969
|
+
workflow_description?: string;
|
|
1970
|
+
/** The version of the workflow. Set if the workflow definition contains a description
|
|
1971
|
+
*/
|
|
1972
|
+
version?: string;
|
|
1973
|
+
/** True if the workflow has been validated */
|
|
1974
|
+
validated: boolean;
|
|
1975
|
+
/** The source Workflow ID. Set if this workflow has been versioned.
|
|
1976
|
+
*/
|
|
1977
|
+
source_id?: string;
|
|
1978
|
+
/** The scope of the workflow.
|
|
1979
|
+
*/
|
|
1980
|
+
scope: WorkflowSummaryScope;
|
|
1981
|
+
/** The scope ID of the workflow. Set if the **Scope** is not **GLOBAL**
|
|
1982
|
+
*/
|
|
1983
|
+
scope_id?: string;
|
|
1984
|
+
}
|
|
1985
|
+
interface WorkflowGetAllResponse {
|
|
1986
|
+
/** The number of workflows in the returned list
|
|
1987
|
+
*/
|
|
1988
|
+
count: number;
|
|
1989
|
+
workflows: WorkflowSummary[];
|
|
1990
|
+
}
|
|
1667
1991
|
interface VersionGetResponse {
|
|
1668
1992
|
/** The Data Manager version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined
|
|
1669
1993
|
*/
|
|
@@ -1920,7 +2244,7 @@ interface InstancesGetResponse {
|
|
|
1920
2244
|
instances: InstanceSummary[];
|
|
1921
2245
|
}
|
|
1922
2246
|
/**
|
|
1923
|
-
* 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)
|
|
2247
|
+
* 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`)
|
|
1924
2248
|
|
|
1925
2249
|
*/
|
|
1926
2250
|
type InstanceGetResponseJobImageType = typeof InstanceGetResponseJobImageType[keyof typeof InstanceGetResponseJobImageType];
|
|
@@ -1990,7 +2314,7 @@ interface InstanceGetResponse {
|
|
|
1990
2314
|
/** The date and time the instance stopped, an ISO-8601 format string.
|
|
1991
2315
|
*/
|
|
1992
2316
|
stopped?: string;
|
|
1993
|
-
/** 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.
|
|
2317
|
+
/** 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.
|
|
1994
2318
|
*/
|
|
1995
2319
|
run_time: string;
|
|
1996
2320
|
/** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
|
|
@@ -2015,7 +2339,7 @@ interface InstanceGetResponse {
|
|
|
2015
2339
|
/** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
|
|
2016
2340
|
*/
|
|
2017
2341
|
job_version?: string;
|
|
2018
|
-
/** 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)
|
|
2342
|
+
/** 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`)
|
|
2019
2343
|
*/
|
|
2020
2344
|
job_image_type?: InstanceGetResponseJobImageType;
|
|
2021
2345
|
/** The JSON string representation of the JobDefinition's outputs
|
|
@@ -2051,6 +2375,9 @@ interface InstanceGetResponse {
|
|
|
2051
2375
|
/** A list of Project-relative annotation files.
|
|
2052
2376
|
*/
|
|
2053
2377
|
written_job_annotation_files?: string[];
|
|
2378
|
+
/** This is the UUID of the Running Workflow Step responsible for the Instance if this Instance is part of a Workflow (Job)
|
|
2379
|
+
*/
|
|
2380
|
+
running_workflow_step_id?: string;
|
|
2054
2381
|
}
|
|
2055
2382
|
type GetExchangeRatesResponseId = number | string;
|
|
2056
2383
|
interface GetExchangeRatesResponse {
|
|
@@ -2109,6 +2436,16 @@ interface InstancePostResponse {
|
|
|
2109
2436
|
*/
|
|
2110
2437
|
command?: string;
|
|
2111
2438
|
}
|
|
2439
|
+
interface InputHandlerDetail {
|
|
2440
|
+
/** The input type this handler handles */
|
|
2441
|
+
input_type: string;
|
|
2442
|
+
/** A markdown string describing the handler */
|
|
2443
|
+
documentation: string;
|
|
2444
|
+
}
|
|
2445
|
+
interface InputHandlerGetResponse {
|
|
2446
|
+
count: number;
|
|
2447
|
+
input_handlers: InputHandlerDetail[];
|
|
2448
|
+
}
|
|
2112
2449
|
interface InstanceDryRunPostResponse {
|
|
2113
2450
|
/** 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.
|
|
2114
2451
|
*/
|
|
@@ -2315,4 +2652,4 @@ declare const setBaseUrl: (baseUrl: string) => void;
|
|
|
2315
2652
|
declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<TReturn>;
|
|
2316
2653
|
type ErrorType<TError> = AxiosError<TError>;
|
|
2317
2654
|
|
|
2318
|
-
export { AXIOS_INSTANCE, type AccountServerGetNamespaceResponse, type AccountServerGetRegistrationResponse, type AdminDeleteJobManifestParams, type AdminGetServiceErrorsParams, type AdminGetUsersParams, type AdminJobManifestGetResponse, type AdminJobManifestLoadPutResponse, type AdminUserPutResponse, type AdminUsersGetResponse, type ApiLogDetail, ApiLogDetailMethod, type ApplicationExchangeRateSummary, type ApplicationGetResponse, type ApplicationImageVariant, type ApplicationImageVariants, type ApplicationSummary, type ApplicationsGetResponse, type AsAdditionalDataProcessingCharge, type CreatePathParams, type DatasetDetail, type DatasetDigestGetResponse, type DatasetMetaGetResponse, type DatasetMetaPostBodyBody, type DatasetPostBodyBody, type DatasetPutBodyBody, type DatasetPutPostResponse, type DatasetSchemaGetResponse, DatasetSchemaGetResponseType, type DatasetSummary, type DatasetVersionDeleteResponse, type DatasetVersionDetail, type DatasetVersionDetailLabels, DatasetVersionDetailProcessingStage, type DatasetVersionMetaPostBodyBody, type DatasetVersionProjectFile, type DatasetVersionSummary, type DatasetVersionSummaryLabels, DatasetVersionSummaryProcessingStage, type DatasetVersionsGetResponse, type DatasetsGetResponse, type DeleteDatasetParams, type DeletePathParams, type DeleteUnmanagedFileParams, type DmError, type ErrorType, type ExchangeRateDetail, type ExchangeRatePutBodyBody, type FilePathFile, type FilePostBodyBody, type FilePostResponse, type FileStat, type FilesGetResponse, type GetAllApplicationExchangeRatesParams, type GetAllExchangeRatesResponse, type GetAllExchangeRatesResponseExchangeRatesItem, type GetAllJobExchangeRatesParams, type GetApplicationExchangeRatesParams, type GetDatasetsParams, type GetExchangeRatesResponse, type GetExchangeRatesResponseId, type GetFilesParams, type GetInstancesParams, type GetJobByVersionParams, type GetJobExchangeRatesParams, type GetJobParams, type GetJobsParams, type GetProjectFileParams, type GetProjectFileWithTokenParams, type GetProjectsParams, type GetTaskParams, type GetTasksParams, type GetUserAccountParams, type GetUserApiLogParams, type GetUserInventoryParams, type GetVersionsParams, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type InventoryDatasetDetail, type InventoryProjectDetail, type InventoryUserDetail, type InventoryUserDetailDatasets, type InventoryUserDetailProjects, type InventoryUserGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobManifestDetail, type JobManifestPutBodyBody, type JobOrderDetail, type JobReplacement, type JobReplacements, type JobSummary, JobSummaryImageType, type JobVariables, type JobVariablesInputs, type JobVariablesOptions, type JobVariablesOutputs, type JobsGetResponse, type ModeGetResponse, type MoveFileInProjectParams, type MovePathParams, type PatchInstanceParams, type ProjectDeleteResponse, type ProjectDetail, type ProjectFileDetail, type ProjectFilePutBodyBody, type ProjectGetResponse, type ProjectPatchBodyBody, type ProjectPostBodyBody, type ProjectPostResponse, type ProjectsGetResponse, type QActiveDaysParameter, type QApplicationIdParameter, type QCurrentParameter, type QDatasetMimeTypeParameter, type QDoNotImpersonateParameter, type QDstFileParameter, type QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileDstPathParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFileSrcPathParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowledgedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOrgIdParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUnitIdParameter, type QUntilParameter, type QUsernameParameter, type QUsernamesParameter, type ServiceErrorSummary, ServiceErrorSummarySeverity, type ServiceErrorsGetResponse, type TaskEvent, TaskEventLevel, type TaskGetResponse, TaskGetResponsePurpose, type TaskIdentity, type TaskState, TaskStateState, type TaskSummary, TaskSummaryProcessingStage, type TasksGetResponse, type TypeSummary, type TypeSummaryFormatterOptions, TypeSummaryFormatterOptionsType, type TypesGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserAccountPatchBodyBody, type UserActivityDetail, type UserActivityDetailPeriod, type UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, customInstance, setAuthToken, setBaseUrl };
|
|
2655
|
+
export { AXIOS_INSTANCE, type AccountServerGetNamespaceResponse, type AccountServerGetRegistrationResponse, type AdminDeleteJobManifestParams, type AdminGetServiceErrorsParams, type AdminGetUsersParams, type AdminJobManifestGetResponse, type AdminJobManifestLoadPutResponse, type AdminUserPutResponse, type AdminUsersGetResponse, type ApiLogDetail, ApiLogDetailMethod, type ApplicationExchangeRateSummary, type ApplicationGetResponse, type ApplicationImageVariant, type ApplicationImageVariants, type ApplicationSummary, type ApplicationsGetResponse, type AsAdditionalDataProcessingCharge, type CreatePathParams, type DatasetDetail, type DatasetDigestGetResponse, type DatasetMetaGetResponse, type DatasetMetaPostBodyBody, type DatasetPostBodyBody, type DatasetPutBodyBody, type DatasetPutPostResponse, type DatasetSchemaGetResponse, DatasetSchemaGetResponseType, type DatasetSummary, type DatasetVersionDeleteResponse, type DatasetVersionDetail, type DatasetVersionDetailLabels, DatasetVersionDetailProcessingStage, type DatasetVersionMetaPostBodyBody, type DatasetVersionProjectFile, type DatasetVersionSummary, type DatasetVersionSummaryLabels, DatasetVersionSummaryProcessingStage, type DatasetVersionsGetResponse, type DatasetsGetResponse, type DeleteDatasetParams, type DeletePathParams, type DeleteUnmanagedFileParams, type DmError, type ErrorType, type ExchangeRateDetail, type ExchangeRatePutBodyBody, type FilePathFile, type FilePostBodyBody, type FilePostResponse, type FileStat, type FilesGetResponse, type GetAllApplicationExchangeRatesParams, type GetAllExchangeRatesResponse, type GetAllExchangeRatesResponseExchangeRatesItem, type GetAllJobExchangeRatesParams, type GetApplicationExchangeRatesParams, type GetDatasetsParams, type GetExchangeRatesResponse, type GetExchangeRatesResponseId, type GetFilesParams, type GetInstancesParams, type GetJobByVersionParams, type GetJobExchangeRatesParams, type GetJobParams, type GetJobsParams, type GetProjectFileParams, type GetProjectFileWithTokenParams, type GetProjectsParams, type GetTaskParams, type GetTasksParams, type GetUserAccountParams, type GetUserApiLogParams, type GetUserInventoryParams, type GetVersionsParams, type InputHandlerDetail, type InputHandlerGetResponse, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type InventoryDatasetDetail, type InventoryProjectDetail, type InventoryUserDetail, type InventoryUserDetailDatasets, type InventoryUserDetailProjects, type InventoryUserGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobManifestDetail, type JobManifestPutBodyBody, type JobOrderDetail, type JobReplacement, type JobReplacements, type JobSummary, JobSummaryImageType, type JobVariables, type JobVariablesInputs, type JobVariablesOptions, type JobVariablesOutputs, type JobsGetResponse, type ModeGetResponse, type MoveFileInProjectParams, type MovePathParams, type PatchInstanceParams, type PriorRunningWorkflowStep, type ProjectDeleteResponse, type ProjectDetail, type ProjectFileDetail, type ProjectFilePutBodyBody, type ProjectGetResponse, type ProjectPatchBodyBody, type ProjectPostBodyBody, type ProjectPostResponse, type ProjectsGetResponse, type QActiveDaysParameter, type QApplicationIdParameter, type QCurrentParameter, type QDatasetMimeTypeParameter, type QDoNotImpersonateParameter, type QDstFileParameter, type QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileDstPathParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFileSrcPathParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowledgedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOrgIdParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUnitIdParameter, type QUntilParameter, type QUsernameParameter, type QUsernamesParameter, type RunningWorkflowGetAllResponse, type RunningWorkflowGetResponse, RunningWorkflowGetResponseStatus, type RunningWorkflowGetResponseVariables, type RunningWorkflowProject, type RunningWorkflowStep, RunningWorkflowStepStatus, type RunningWorkflowStepVariables, type RunningWorkflowStepsGetResponse, type RunningWorkflowSummary, RunningWorkflowSummaryStatus, type RunningWorkflowWorkflow, type ServiceErrorSummary, ServiceErrorSummarySeverity, type ServiceErrorsGetResponse, type TaskEvent, TaskEventLevel, type TaskGetResponse, TaskGetResponsePurpose, type TaskIdentity, type TaskState, TaskStateState, type TaskSummary, TaskSummaryProcessingStage, type TasksGetResponse, type TypeSummary, type TypeSummaryFormatterOptions, TypeSummaryFormatterOptionsType, type TypesGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserAccountPatchBodyBody, type UserActivityDetail, type UserActivityDetailPeriod, type UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, type WorkflowDefinitionGetResponse, type WorkflowGetAllResponse, type WorkflowGetResponse, WorkflowGetResponseScope, type WorkflowPatchBodyBody, type WorkflowPatchResponse, type WorkflowPostBodyBody, WorkflowPostBodyBodyScope, type WorkflowPostResponse, type WorkflowRunPostBodyBody, type WorkflowRunPostResponse, type WorkflowStepSummary, type WorkflowSummary, WorkflowSummaryScope, type WorkflowVersionPutBodyBody, type WorkflowVersionPutResponse, customInstance, setAuthToken, setBaseUrl };
|