diff --git a/clientside-scripts.js b/clientside-scripts.js deleted file mode 100644 index e95cc835e..000000000 --- a/clientside-scripts.js +++ /dev/null @@ -1,26 +0,0 @@ -var allowedHost = 'docs.seqera.io'; -var hotjarAppID = 3836890; - -function canProceed() { - if (typeof window === 'undefined') return false; - if (window.location.hostname !== allowedHost) return false; - return true; -} - -function addScripts() { - - if(!canProceed()) return; - - // HotJar - (function(h,o,t,j,a,r){ - h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)}; - h._hjSettings={hjid:hotjarAppID,hjsv:6}; - a=o.getElementsByTagName('head')[0]; - r=o.createElement('script');r.async=1; - r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv; - a.appendChild(r); - })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv='); - -} - -addScripts(); \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 993998521..866b3a3bc 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -44,34 +44,6 @@ export default async function createConfigAsync() { }, ]; - const docs_platform_api = [ - "@docusaurus/plugin-content-docs", - { - id: "platform-api", - routeBasePath: "/platform-api", - path: "platform-api-docs/docs", - remarkPlugins: [(await require("remark-yaml-to-table")).default], - sidebarPath: "platform-api-docs/docs/sidebar/sidebar.js", - docItemComponent: "@theme/ApiItem", - }, - ]; - const docs_platform_openapi = [ - "docusaurus-plugin-openapi-docs", - { - id: "api", // plugin id - docsPluginId: "classic", // configured for preset-classic - config: { - platform: { - specPath: "platform-api-docs/scripts/specs/seqera-api-1.85-decorated.yml", - outputDir: "platform-api-docs/docs", - sidebarOptions: { - groupPathsBy: "tag", - }, - }, - }, - }, - ]; - const docs_platform_cloud = [ "@docusaurus/plugin-content-docs", { @@ -148,22 +120,6 @@ export default async function createConfigAsync() { }, ]; - console.log( - "\n EXCLUDE_CHANGELOG: " + (process.env.EXCLUDE_CHANGELOG ? true : false), - "\n EXCLUDE_PLATFORM_ENTERPRISE: " + - (process.env.EXCLUDE_PLATFORM_ENTERPRISE ? true : false), - "\n EXCLUDE_PLATFORM_CLOUD: " + - (process.env.EXCLUDE_PLATFORM_CLOUD ? true : false), - "\n EXCLUDE_PLATFORM_API: " + - (process.env.EXCLUDE_PLATFORM_API ? true : false), - "\n EXCLUDE_PLATFORM_OPENAPI: " + - (process.env.EXCLUDE_PLATFORM_OPENAPI ? true : false), - "\n EXCLUDE_MULTIQC: " + (process.env.EXCLUDE_MULTIQC ? true : false), - "\n EXCLUDE_FUSION: " + (process.env.EXCLUDE_FUSION ? true : false), - "\n EXCLUDE_WAVE: " + (process.env.EXCLUDE_WAVE ? true : false), - "\n INCLUDE_NEXT: " + (process.env.INCLUDE_NEXT ? true : false), - ); - return { title: "Seqera Docs", tagline: "Documentation for Seqera products", @@ -223,7 +179,6 @@ export default async function createConfigAsync() { locales: ["en"], }, themes: [ - "docusaurus-theme-openapi-docs", "docusaurus-theme-search-typesense", ], presets: [ @@ -242,7 +197,6 @@ export default async function createConfigAsync() { require.resolve("./src/css/components/checklist.css"), require.resolve("./src/css/components/box.css"), require.resolve("./src/css/theme-colors.css"), - require.resolve("./src/css/api.css"), require.resolve("./src/css/fonts/inter.css"), require.resolve("./src/css/fonts/degular.css"), ], @@ -260,8 +214,6 @@ export default async function createConfigAsync() { plugins: [ process.env.EXCLUDE_PLATFORM_ENTERPRISE ? null : docs_platform_enterprise, process.env.EXCLUDE_PLATFORM_CLOUD ? null : docs_platform_cloud, - process.env.EXCLUDE_PLATFORM_API ? null : docs_platform_api, - process.env.EXCLUDE_PLATFORM_OPENAPI ? null : docs_platform_openapi, process.env.EXCLUDE_MULTIQC ? null : docs_multiqc, process.env.EXCLUDE_FUSION ? null : docs_fusion, process.env.EXCLUDE_WAVE ? null : docs_wave, @@ -492,7 +444,6 @@ export default async function createConfigAsync() { ], }, }, - clientModules: [require.resolve("./clientside-scripts.js")], stylesheets: [ { href: "https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.css", diff --git a/fusion_docs/faq.md b/fusion_docs/faq.md deleted file mode 100644 index 62abc7099..000000000 --- a/fusion_docs/faq.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Frequently asked questions ---- - -### Which cloud object stores does Fusion support? - -Fusion supports AWS S3, Azure Blob, and Google Cloud Storage. Fusion can also be used with local storage solutions that support the AWS S3 API. - -### How does Fusion work? - -Fusion implements a FUSE driver that mounts the cloud storage bucket in the job execution context as -a POSIX file system. This allows the job script to read and write data files in cloud object storage as if they were local files. - -### Why is Fusion faster than other FUSE drivers? - -Fusion is not a general purpose file system. It has been designed to optimize the data transfer of bioinformatics pipelines by taking advantage of the Nextflow data model. - -### Why do I need Wave containers to use Fusion? - -Fusion is designed to work at the job execution level. This means it must run in a containerized job execution context. - -Downloading and installing Fusion manually would require you to rebuild all the containers used by your data pipeline to include the Fusion client each time a new version of the client is released. You would also need to maintain a custom mirror or existing container -collections, such as [BioContainers](https://biocontainers.pro/). - -Wave enables you to add the Fusion client to your pipeline containers at deploy time, without the need to rebuild them or -maintain a separate container image collection. - -### Can Fusion mount more than one bucket in the job's file system? - -Yes. Any access to cloud object storage is automatically detected by Fusion and the corresponding buckets are mounted -on demand. - -### Can Fusion mount buckets of different vendors in the same execution? - -No. Fusion can mount multiple buckets per execution, but all from the same vendor, such as AWS S3 or Google Cloud Storage. - -### I tried Fusion, but I didn't notice any performance improvement. Why? - -If you didn’t notice any performance improvement with Fusion, the bottleneck may lie in other factors, such as network latency or memory limitations. Fusion’s caching strategy relies heavily on NVMe SSD or similar storage technology, so ensure your computing nodes are using the recommended storage. Check your Platform compute environment page for optimal instance and storage configurations: - -- [AWS Batch](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch) -- [Azure Batch](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch) -- [Google Cloud Batch](https://docs.seqera.io/platform-cloud/compute-envs/google-cloud-batch) -- [Amazon Elastic Kubernetes Service](https://docs.seqera.io/platform-cloud/compute-envs/eks) -- [Google Kubernetes Engine](https://docs.seqera.io/platform-cloud/compute-envs/gke) - -### Can I pin a specific Fusion version to use with Nextflow? - -Yes. Add the Fusion version's config URL using the `containerConfigUrl` option in the Fusion block of your Nextflow configuration (replace `v2.4.2` with the version of your choice): - -```groovy -fusion { - enabled = true - containerConfigUrl = 'https://fusionfs.seqera.io/releases/v2.4.2-amd64.json' -} -``` - -:::note -For ARM CPU architectures, use https://fusionfs.seqera.io/releases/v2.4.2-arm64.json. -::: - -### Can I use Fusion with MinIO? - -Yes. [MinIO](https://min.io/) implements an S3-compatible API, therefore it can be used instead of AWS S3. See [Local execution](https://docs.seqera.io/fusion/guide/local/minio) for more information. - -### Can I download Fusion? - -No. Fusion can only be used directly in supported [Seqera Platform compute environments](https://docs.seqera.io/platform-cloud/compute-envs/overview), or by enabling [Wave containers](https://docs.seqera.io/wave) in your Nextflow configuration. diff --git a/fusion_docs/get-started.md b/fusion_docs/get-started.md deleted file mode 100644 index 9cf538091..000000000 --- a/fusion_docs/get-started.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Get started -description: "Use the Fusion v2 file system in Seqera Platform and Nextflow" -date: "23 Aug 2024" -tags: [fusion, storage, compute, file system, posix, client] ---- - -Use Fusion directly in Seqera Platform compute environments, or add Fusion to your Nextflow pipeline configuration. - -### Seqera Platform - -Use Fusion directly in the following Seqera Platform compute environments: -- [AWS Batch](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch) -- [Azure Batch](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch) -- [Google Cloud Batch](https://docs.seqera.io/platform-cloud/compute-envs/google-cloud-batch) -- [Amazon Elastic Kubernetes Service](https://docs.seqera.io/platform-cloud/compute-envs/eks) -- [Google Kubernetes Engine](https://docs.seqera.io/platform-cloud/compute-envs/gke) - -See the Platform compute environment page for your cloud provider for Fusion configuration instructions and optimal compute and storage recommendations. - -### Nextflow - -:::note -Fusion requires Nextflow `22.10.0` or later. -::: - -Fusion integrates with Nextflow directly and does not require any installation or change in pipeline code. It only requires to use of a container runtime or a container computing service such as Kubernetes, AWS Batch, or Google Cloud Batch. - -#### Nextflow installation - -If you already have Nextflow installed, update to the latest version using this command: - -```bash -nextflow -self-update -``` - -Otherwise, install Nextflow with this command: - -```bash -curl get.nextflow.io | bash -``` - -#### Fusion configuration - -To enable Fusion in your Nextflow pipeline, add the following snippet to your `nextflow.config` file: - -```groovy -fusion.enabled = true -wave.enabled = true -tower.accessToken = '' -``` - -Replace `` with your Platform access token. diff --git a/fusion_docs/guide.md b/fusion_docs/guide.md deleted file mode 100644 index dc5b0fb12..000000000 --- a/fusion_docs/guide.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: User guide -description: "Overview of the Fusin v2 file system" -date: "23 Aug 2024" -tags: [fusion, storage, compute, file system, posix, client] ---- - -# User guide - -Fusion is a virtual, lightweight, distributed file system designed to optimise the data access of Nextflow data pipelines. - -Fusion enables seamless filesystem I/O to cloud object stores via a standard POSIX interface resulting in simpler pipeline logic and faster, more efficient pipeline execution. - -:::note -Fusion requires a license for use in Seqera Platform compute environments or directly in Nextflow. See [Fusion licensing](https://seqera.io/contact-us) for more information. -::: - -## Getting started - -Fusion smoothly integrates with Nextflow and does not require any installation or change in pipeline code. It only requires to use of container runtime or a container computing service such as Kubernetes, AWS Batch, or Google Cloud Batch. - -:::note - - This feature requires Nextflow ``22.10.0`` or later. -::: - -### Nextflow installation - -If you have already installed Nextflow, update to the latest version using this command: - -```bash -nextflow -self-update -``` - -If you don't have Nextflow already installed, install it with the command below: - -```bash -curl get.nextflow.io | bash -``` - -### Fusion configuration - -To enable Fusion in your Nextflow pipeline add the following snippet to your `nextflow.config` file: - -```groovy -fusion.enabled = true -wave.enabled = true -tower.accessToken = '' -``` - -Replace `` with your Platform access token. diff --git a/fusion_docs/guide/aws-batch.md b/fusion_docs/guide/aws-batch.md deleted file mode 100644 index 223fea3b3..000000000 --- a/fusion_docs/guide/aws-batch.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: AWS Batch -description: "Use Fusion with AWS Batch and S3 storage" -date created: "2024-08-23" -last updated: "2025-09-09" -tags: [fusion, storage, compute, aws-batch, s3] ---- - -Fusion simplifies and improves the efficiency of Nextflow pipelines in [AWS Batch](https://aws.amazon.com/batch/) in several ways: - -- No need to use the AWS CLI tool for copying data to and from S3 storage. -- No need to create a custom AMI or create custom containers to include the AWS CLI tool. -- Fusion uses an efficient data transfer and caching algorithm that provides much faster throughput compared to AWS CLI and does not require a local copy of data files. -- By replacing the AWS CLI with a native API client, the transfer is much more robust at scale. - -### Platform AWS Batch compute environments - -Seqera Platform supports Fusion in Batch Forge and manual AWS Batch compute environments. - -See [AWS Batch](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch) for compute and storage recommendations and instructions to enable Fusion. - -### Nextflow CLI - -:::tip -Fusion file system implements a lazy download and upload algorithm that runs in the background to transfer files in parallel to and from the object storage and container-local temporary directory (`/tmp`). - -Several AWS EC2 instance types include one or more NVMe SSD volumes. These volumes must be formatted to be used. See [SSD instance storage](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) for details. - -Seqera Platform automatically formats and configures NVMe instance storage with the **Fast instance storage** option when you create an AWS Batch compute environment using **Batch Forge**. -::: - -1. Add the following to your `nextflow.config` file: - - ```groovy - process.executor = 'awsbatch' - process.queue = '' - process.scratch = false - process.containerOptions = '-v :/tmp' // Required for SSD volumes - wave.enabled = true - fusion.enabled = true - tower.accessToken = '' - aws.region = '' - ``` - - Replace the following: - - ``: the path to your AWS Batch queue. - - ``: your SSD path. - - ``: your Platform access token. - - -1. Run the pipeline with the Nextflow run command: - - ``` - nextflow run -w s3:///work - ``` - - Replace the following: - - ``: your pipeline Git repository URI. - - ``: your S3 bucket. - -:::tip -**For small workloads:** You can use an EBS gp3 volume with a throughput of 325 MiB/s (or more) and a size of 100 GiB as an alternative to configuring NVMe storage on your compute node. While slower than NVMe storage, this configuration provides sufficient performance for smaller instances and workloads. - -The scratch space at `/tmp` is shared by all tasks running on the instance. For large instances running many concurrent tasks, insufficient scratch space can cause backpressure and significant performance slowdowns. - -**For production workloads:** Consider these options based on your requirements: -- **Use NVMe storage (recommended):** NVMe disks provide better performance and their capacity scales with instance size. -- **Use larger EBS volumes:** Scale EBS volume size with instance size (400 GiB or more may be required for larger instances hosting many concurrent tasks). -- **Manual compute environments:** Scale EBS volume size proportionally with the number of CPUs via a custom launch template to ensure adequate scratch space per task. -::: - -### IAM permissions - -Configure with the following IAM permissions: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "s3:ListBucket" - ], - "Resource": [ - "arn:aws:s3:::" - ] - }, - { - "Action": [ - "s3:GetObject", - "s3:PutObject", - "s3:PutObjectTagging", - "s3:DeleteObject" - ], - "Resource": [ - "arn:aws:s3:::/*" - ], - "Effect": "Allow" - } - ] -} -``` - -Replace `` with your S3 bucket name. diff --git a/fusion_docs/guide/aws-eks.md b/fusion_docs/guide/aws-eks.md deleted file mode 100644 index fb83960e7..000000000 --- a/fusion_docs/guide/aws-eks.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: Amazon EKS -description: "Use Fusion with AWS Elastic Kubernetes Service and S3 storage" -date: "23 Aug 2024" -tags: [fusion, storage, compute, aws eks, s3] ---- - -Fusion streamlines the deployment of Nextflow pipelines in Kubernetes because it replaces the need to configure -and maintain a shared file system in your cluster. - -### Platform Amazon EKS compute environments - -Seqera Platform supports Fusion in Amazon Elastic Kubernetes Service (Amazon EKS) compute environments. - -See [Amazon EKS](https://docs.seqera.io/platform-cloud/compute-envs/eks) for Platform instructions to enable Fusion. - -### Nextflow CLI - -:::tip -Fusion file system implements a lazy download and upload algorithm that runs in the background to transfer files in -parallel to and from the object storage into the container-local temporary directory (`/tmp`). To achieve optimal performance, set up an SSD volume as the temporary directory. - -Several AWS EC2 instance types include one or more NVMe SSD volumes. These volumes must be formatted to be used. See [SSD instance storage](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) for details. -::: - -To use Fusion directly in Nextflow with an Amazon EKS cluster, you must configure a namespace and service account and update your Nextflow configuration. - -#### Kubernetes configuration - -Create a namespace and a service account in your Kubernetes cluster to run the jobs submitted during pipeline execution. - -1. Create a manifest that includes the following configuration. For example: - - ```yaml - --- - apiVersion: v1 - kind: Namespace - metadata: - name: fusion-demo - --- - apiVersion: v1 - kind: ServiceAccount - metadata: - namespace: fusion-demo - name: fusion-sa - annotations: - eks.amazonaws.com/role-arn: "arn:aws:iam:::role/fusion-demo-role" - --- - apiVersion: rbac.authorization.k8s.io/v1 - kind: Role - metadata: - namespace: fusion-demo - name: fusion-role - rules: - - apiGroups: [""] - resources: ["pods", "pods/status", "pods/log", "pods/exec"] - verbs: ["get", "list", "watch", "create", "delete"] - --- - apiVersion: rbac.authorization.k8s.io/v1 - kind: RoleBinding - metadata: - namespace: fusion-demo - name: fusion-rolebind - roleRef: - apiGroup: rbac.authorization.k8s.io - kind: Role - name: fusion-role - subjects: - - kind: ServiceAccount - name: fusion-sa - ``` - - Replace `` with your account ID. - -1. Configure your AWS IAM role to provide read-write permission to the S3 bucket used as the work directory. For example: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": ["s3:ListBucket"], - "Resource": ["arn:aws:s3:::"] - }, - { - "Action": [ - "s3:GetObject", - "s3:PutObject", - "s3:PutObjectTagging", - "s3:DeleteObject" - ], - "Resource": ["arn:aws:s3:::/*"], - "Effect": "Allow" - } - ] - } - ``` - - Replace `` with your bucket name. - -1. Define a role trust relationship. For example: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Federated": "arn:aws:iam:::oidc-provider/oidc.eks..amazonaws.com/id/" - }, - "Action": "sts:AssumeRoleWithWebIdentity", - "Condition": { - "StringEquals": { - "oidc.eks.eu-west-2.amazonaws.com/id/:aud": "sts.amazonaws.com", - "oidc.eks.eu-west-2.amazonaws.com/id/:sub": "system:serviceaccount:fusion-demo:fusion-sa" - } - } - } - ] - } - ``` - - Replace the following: - - ``: AWS account ID - - ``: AWS region - - ``: cluster ID - -#### Nextflow configuration - -1. Add the following to your `nextflow.config` file: - - ```groovy - process.executor = 'k8s' - wave.enabled = true - fusion.enabled = true - tower.accessToken = '' - k8s.context = '' - k8s.namespace = 'fusion-demo' - k8s.serviceAccount = 'fusion-sa' - ``` - - Replace the following: - - ``: your Platform access token. - - ``: your Kubernetes context. - -1. Run the pipeline with the Nextflow run command: - - ``` - nextflow run -w s3:///work - ``` - - Replace the following: - - ``: your pipeline Git repository URI. - - ``: your S3 bucket. - -:::note -When using Fusion, pods will run as privileged by default. -::: - -To use Fusion without the need for escalating privileges, install the Nextflow [FUSE device plugin](https://github.com/nextflow-io/k8s-fuse-plugin) on your Kubernetes cluster and add set `fusion.privileged` to `false` in your `nextflow.config` file: - -``` -fusion.privileged = false -``` - -To use a custom FUSE device plugin, specify it via the `k8s.fuseDevicePlugin` configuration option. See [Kubernetes](https://www.nextflow.io/docs/latest/reference/config.html#k8s) configuration options for details. diff --git a/fusion_docs/guide/azure-batch.md b/fusion_docs/guide/azure-batch.md deleted file mode 100644 index 26e69d72a..000000000 --- a/fusion_docs/guide/azure-batch.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Azure Batch -description: "Use Fusion with Azure Batch and Azure Blob storage" -date: "23 Aug 2024" -tags: [fusion, storage, compute, azure batch, blob storage] ---- - -Fusion simplifies and improves the efficiency of Nextflow pipelines in [Azure Batch](https://azure.microsoft.com/en-us/products/batch) in several ways: - -- No need to use the Azure CLI tool for copying data to and from Azure Blob Storage. -- No need to install the Azure CLI tool to the node machine -- By replacing the Azure CLI with a native API client, the transfer is much more robust at scale. -- By streaming relevant data and monitoring the virtual machine storage, Fusion can use more data than the capacity of the attached storage drive - -### Platform Azure Batch compute environments - -Seqera Platform supports Fusion in Batch Forge and manual Azure Batch compute environments. - -See [Azure Batch](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch) for compute and storage recommendations and instructions to enable Fusion. - -### Nextflow CLI - -:::tip -We recommend selecting machine types with a local temp storage disk of at least 200 GB and a random read speed of 1000 MBps or more for large and long-lived production pipelines. The suffix `d` after the core number (e.g., `Standard_E16*d*_v5`) denotes a VM with a local temp disk. Select instances with Standard SSDs — Fusion does not support Azure network-attached storage (Premium SSDv2, Ultra Disk, etc.). Larger local storage increases Fusion's throughput and reduces the chance of overloading the machine. See [Sizes for virtual machines in Azure](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview) for more information. -::: - -1. Add the following to your `nextflow.config` file: - - ```groovy - process.executor = 'azure-batch' - wave.enabled = true - fusion.enabled = true - tower.accessToken = '' - ``` - - Replace `` with your Platform access token. - -1. Run the pipeline with the Nextflow run command: - - ``` - nextflow run -w az:///scratch - ``` - - Replace the following: - - ``: your pipeline Git repository URI. - - ``: your Azure Blob Storage. diff --git a/fusion_docs/guide/gcp-batch.md b/fusion_docs/guide/gcp-batch.md deleted file mode 100644 index c9877d694..000000000 --- a/fusion_docs/guide/gcp-batch.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Google Cloud Batch -description: "Use Fusion with Google Cloud Batch and Google Cloud Storage" -date: "23 Aug 2024" -tags: [fusion, storage, compute, gcp batch, gcs, google cloud] ---- - -Fusion simplifies and improves the efficiency of Nextflow pipelines in [Google Cloud Batch](https://cloud.google.com/batch) in several ways: - -- No need to use the gcloud CLI tool for copying data to and from Google Cloud storage. -- No need to create custom containers to include the gcloud CLI tool. -- Fusion uses an efficient data transfer and caching algorithm that provides much faster throughput compared to gcloud CLI and does not require a local copy of data files. -- Replacing the gcloud CLI with a native API client, the transfer is much more robust at scale. - -### Platform Google Cloud Batch compute environments - -Seqera Platform supports Fusion in Google Cloud Batch compute environments. - -See [Google Cloud Batch](https://docs.seqera.io/platform-cloud/compute-envs/google-cloud-batch) for compute and storage recommendations and instructions to enable Fusion. - -### Nextflow CLI - -:::tip -When Fusion v2 is enabled, the following virtual machine settings are applied: - - A 375 GB local NVMe SSD is selected for all compute jobs. - - If you do not specify a machine type, a VM from the following families that support local SSDs will be selected: `n1-*`, `n2-*`, `n2d-*`, `c2-*`, `c2d-*`, `m3-*`. - - Any machine types you specify in the Nextflow config must support local SSDs. - - Local SSDs are only offered in multiples of 375 GB. You can increment the number of SSDs used per process with the `disk` directive to request multiples of 375 GB. - - Fusion v2 can also use persistent disks for caching. Override the disk requested by Fusion using the `disk` directive and the `type: pd-standard`. - - The `machineType` directive can be used to specify a VM instance type, family, or custom machine type in a comma-separated list of patterns. For example, `c2-*`, `n1-standard-1`, `custom-2-4`, `n*`, `m?-standard-*`. -::: - -1. Provide your Google credentials via the `GOOGLE_APPLICATION_CREDENTIALS` environment variable -or with the `gcloud` auth application-default login command. See [Credentials](https://www.nextflow.io/docs/latest/google.html#credentials) for more information. - -1. Add the following to your `nextflow.config` file: - - ```groovy - process.scratch = false - process.executor = 'google-batch' - wave.enabled = true - fusion.enabled = true - tower.accessToken = '' - google.location = '' - ``` - - Replace the following: - - ``: your Platform access token. - - ``: your Google region. - -1. Run the pipeline with the Nextflow run command: - - ``` - nextflow run -w gs:///work - ``` - - Replace the following: - - ``: your pipeline Git repository URI. - - ``: your Google Cloud Storage bucket to which you have read-write access. diff --git a/fusion_docs/guide/gcp-gke.md b/fusion_docs/guide/gcp-gke.md deleted file mode 100644 index 85468dab1..000000000 --- a/fusion_docs/guide/gcp-gke.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: Google Kubernetes Engine -description: "Use Fusion with Google Kubernetes Engine and Google Cloud Storage" -date: "23 Aug 2024" -tags: [fusion, storage, compute, gke, gcs, google cloud, kubernetes] ---- - -Fusion streamlines the deployment of Nextflow pipelines in Kubernetes because it replaces the need to configure -and maintain a shared file system in your cluster. - -### Platform Google Kubernetes Engine compute environments - -Seqera Platform supports Fusion in Google Kubernetes Engine (GKE) compute environments. - -See [Google Kubernetes Engine](https://docs.seqera.io/platform-cloud/compute-envs/gke) for Platform instructions to enable Fusion. - -### Nextflow CLI - -:::note -This feature requires Nextflow 23.02.1-edge or later. -::: - -To use Fusion directly in Nextflow with a GKE cluster, you must configure a cluster, namespace, and service account, and update your Nextflow configuration. - -#### Kubernetes configuration - -1. Create a GKE "standard" cluster ("Autopilot" is not supported). See [Creating a zonal cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster) for more information. -1. Use instance types with 2 or more CPUs and SSD storage (families: `n1`, `n2`, `c2`, `m1`, `m2`, `m3`). -1. Enable the [Workload identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity) feature when creating (or updating) the cluster: - - **Enable Workload Identity** in the cluster **Security** settings. - - **Enable GKE Metadata Server** in the node group **Security** settings. -1. See [Authenticate to Google Cloud APIs from GKE workloads](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity#kubectl) to configure the cluster. -1. Replace the following example values with values corresponding to your environment: - - `CLUSTER_NAME`: the GKE cluster name — `cluster-1` - - `COMPUTE_REGION`: the GKE cluster region — `europe-west1` - - `NAMESPACE`: the GKE namespace — `fusion-demo` - - `KSA_NAME`: the GKE service account name — `fusion-sa` - - `GSA_NAME`: the Google service account — `gsa-demo` - - `GSA_PROJECT`: the Google project id — `my-nf-project-261815` - - `PROJECT_ID`: the Google project id — `my-nf-project-261815` - - `ROLE_NAME`: the role to grant access permissions to the Google Storage bucket — `roles/storage.admin` -1. Create the K8s _role_ and _rolebinding_ required to run Nextflow by applying the following Kubernetes config: - - ```yaml - --- - apiVersion: rbac.authorization.k8s.io/v1 - kind: Role - metadata: - namespace: fusion-demo - name: fusion-role - rules: - - apiGroups: [""] - resources: ["pods", "pods/status", "pods/log", "pods/exec"] - verbs: ["get", "list", "watch", "create", "delete"] - --- - apiVersion: rbac.authorization.k8s.io/v1 - kind: RoleBinding - metadata: - namespace: fusion-demo - name: fusion-rolebind - roleRef: - apiGroup: rbac.authorization.k8s.io - kind: Role - name: fusion-role - subjects: - - kind: ServiceAccount - name: fusion-sa - --- - apiVersion: v1 - kind: Secret - metadata: - namespace: fusion-demo - name: fusion-sa-token - annotations: - kubernetes.io/service-account.name: fusion-sa - type: kubernetes.io/service-account-token - ... - ``` - -#### Nextflow configuration - -1. Add the following to your `nextflow.config` file: - - ``` - process.executor = 'k8s' - process.scratch = false - wave.enabled = true - fusion.enabled = true - tower.accessToken = '' - k8s.context = '' - k8s.namespace = 'fusion-demo' - k8s.serviceAccount = 'fusion-sa' - k8s.pod.nodeSelector = 'iam.gke.io/gke-metadata-server-enabled=true' - ``` - - Replace the following: - - ``: your Platform access token. - - ``: your Kubernetes configuration context name. - -1. Run the pipeline with the Nextflow run command: - - ``` - nextflow run -w gs:///work - ``` - - Replace the following: - - ``: your pipeline Git repository URI. - - ``: your Google Cloud Storage bucket. - -:::note -When using Fusion, pods will run as privileged by default. -::: - -To use Fusion without the need for escalating privileges, install the Nextflow [FUSE device plugin](https://github.com/nextflow-io/k8s-fuse-plugin) on your Kubernetes cluster and add set `fusion.privileged` to `false` in your `nextflow.config` file: - -``` -fusion.privileged = false -``` - -To use a custom FUSE device plugin, specify it via the `k8s.fuseDevicePlugin` configuration option. See [Kubernetes](https://www.nextflow.io/docs/latest/reference/config.html#k8s) configuration options for details. diff --git a/fusion_docs/guide/local/aws-s3.md b/fusion_docs/guide/local/aws-s3.md deleted file mode 100644 index b476521ae..000000000 --- a/fusion_docs/guide/local/aws-s3.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: AWS S3 -description: "Use Fusion with the Nextflow local executor and AWS S3" -date: "13 Feb 2025" -tags: [fusion, storage, compute, local, s3] ---- - -With Fusion, you can run Nextflow pipelines using the local executor and AWS S3. This -is useful to scale your pipeline execution vertically with a large compute instance, without the need to allocate -a large storage volume for temporary pipeline data. - -### Nextflow CLI - -:::tip -This configuration requires Docker or a similar container engine to run pipeline tasks. -::: - -1. Set `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables to grant Nextflow and Fusion access to your storage credentials. See [Credentials](https://www.nextflow.io/docs/latest/google.html#credentials) for more information. - -1. Add the following to your `nextflow.config` file: - - ```groovy - wave.enabled = true - docker.enabled = true - tower.accessToken = '' - fusion.enabled = true - fusion.exportStorageCredentials = true - ``` - - Replace `` with your Platform access token. - -1. Run the pipeline with the Nextflow run command: - - ``` - nextflow run -w s3:///work - ``` - - Replace the following: - - ``: your pipeline Git repository URI. - - ``: your S3 bucket name. - -:::tip -To achieve optimal performance, set up an SSD volume as the temporary directory. -::: - -:::warning -The option `fusion.exportStorageCredentials` leaks credentials on the task launcher script created by Nextflow. -This option should only be used for testing and development purposes. -::: diff --git a/fusion_docs/guide/local/azure-blob.md b/fusion_docs/guide/local/azure-blob.md deleted file mode 100644 index 3ce8f0c60..000000000 --- a/fusion_docs/guide/local/azure-blob.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Azure Blob Storage -description: "Use Fusion with the Nextflow local executor and Azure Blob Storage" -date: "13 Feb 2025" -tags: [fusion, storage, compute, local, azure blob] ---- - -With Fusion, you can run Nextflow pipelines using the local executor and Azure Blob Storage. This -is useful to scale your pipeline execution vertically with a large compute instance, without the need to allocate -a large storage volume for temporary pipeline data. - -### Nextflow CLI - -:::tip -This configuration requires Docker or a similar container engine to run pipeline tasks. -::: - -1. Set `AZURE_STORAGE_ACCOUNT_NAME` and `AZURE_STORAGE_ACCOUNT_KEY` or `AZURE_STORAGE_SAS_TOKEN` environment variables to grant Nextflow and Fusion access to your storage credentials. See [Credentials](https://www.nextflow.io/docs/latest/google.html#credentials) for more information. - -1. Add the following to your `nextflow.config` file: - - ```groovy - wave.enabled = true - docker.enabled = true - tower.accessToken = '' - fusion.enabled = true - fusion.exportStorageCredentials = true - ``` - - Replace `` with your Platform access token. - -1. Run the pipeline with the Nextflow run command: - - ``` - nextflow run -w az:///scratch - ``` - - Replace the following: - - ``: your pipeline Git repository URI. - - ``: your Azure Blob Storage. - -:::tip -To achieve optimal performance, set up an SSD volume as the temporary directory. -::: - -:::warning -The option `fusion.exportStorageCredentials` leaks credentials on the task launcher script created by Nextflow. -This option should only be used for testing and development purposes. -::: diff --git a/fusion_docs/guide/local/google-cloud.md b/fusion_docs/guide/local/google-cloud.md deleted file mode 100644 index 1f977b3b8..000000000 --- a/fusion_docs/guide/local/google-cloud.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Google Cloud Storage -description: "Use Fusion with the Nextflow local executor and Google Cloud Storage" -date: "13 Feb 2025" -tags: [fusion, storage, compute, local, google cloud] ---- - -With Fusion, you can run Nextflow pipelines using the local executor and Google Cloud Storage. This -is useful to scale your pipeline execution vertically with a large compute instance, without the need to allocate -a large storage volume for temporary pipeline data. - -### Nextflow CLI - -:::tip -This configuration requires Docker or a similar container engine to run pipeline tasks. -::: - -1. Set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable with your service account JSON key to grant Nextflow and Fusion access to your storage credentials. See [Credentials](https://www.nextflow.io/docs/latest/google.html#credentials) for more information. - -1. Add the following to your `nextflow.config` file: - - ```groovy - wave.enabled = true - docker.enabled = true - tower.accessToken = '' - fusion.enabled = true - fusion.exportStorageCredentials = true - ``` - - Replace `` with your Platform access token. - -1. Run the pipeline with the Nextflow run command: - - ``` - nextflow run -w gs:///work - ``` - - Replace the following: - - ``: your pipeline Git repository URI. - - ``: your Google Cloud Storage bucket to which you have read-write access. - - -:::tip -To achieve optimal performance, set up an SSD volume as the temporary directory. -::: - -:::warning -The option `fusion.exportStorageCredentials` leaks credentials on the task launcher script created by Nextflow. -This option should only be used for testing and development purposes. -::: diff --git a/fusion_docs/guide/local/minio.md b/fusion_docs/guide/local/minio.md deleted file mode 100644 index 6083d2fbe..000000000 --- a/fusion_docs/guide/local/minio.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: MinIO -description: "Use Fusion with the Nextflow local executor and MinIO" -date: "13 Feb 2025" -tags: [fusion, storage, compute, local, minio] ---- - -With Fusion, you can run Nextflow pipelines using the local executor and MinIO, an open source, enterprise grade, object storage compatible with AWS S3. This -is useful to scale your pipeline execution vertically with a large compute instance, without the need to allocate -a large storage volume for temporary pipeline data. - -### Nextflow CLI - -Nextflow and Fusion can use Minio (or other S3-compatible object storages) as an alternative to AWS S3 in some deployment scenarios. - -:::tip -This configuration requires Docker or a similar container engine to run pipeline tasks. -::: - -1. Run a local instance of MinIO using Docker: - - ``` - docker run -p 9000:9000 \ - --rm -d -p 9001:9001 \ - -e "MINIO_ROOT_USER=admin" \ - -e "MINIO_ROOT_PASSWORD=secret" \ - quay.io/minio/minio server /data --console-address ":9001" - ``` - -1. Open the MinIO console `http://localhost:9001` - -1. Create storage credentials and a bucket. - -1. Set `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables to grant Nextflow and Fusion access to your storage credentials. See [Credentials](https://www.nextflow.io/docs/latest/google.html#credentials) for more information. - -1. Add the following to your `nextflow.config` file: - - ```groovy - wave.enabled = true - docker.enabled = true - tower.accessToken = '' - fusion.enabled = true - fusion.exportStorageCredentials = true - aws.client.endpoint = 'http://localhost:9000' - aws.client.s3PathStyleAccess = true - ``` - - Replace `` with your Platform access token. - -1. Run the pipeline with the Nextflow run command: - - ``` - nextflow run -w s3:///work - ``` - - Replace the following: - - `PIPELINE_SCRIPT`: your pipeline Git repository URI. - - `S3_BUCKET`: your S3 bucket name. - -:::tip -To achieve optimal performance, set up an SSD volume as the temporary directory. -::: - -:::warning -The option `fusion.exportStorageCredentials` leaks credentials on the task launcher script created by Nextflow. -This option should only be used for testing and development purposes. -::: diff --git a/fusion_docs/guide/local/oracle-object.md b/fusion_docs/guide/local/oracle-object.md deleted file mode 100644 index 047a6ee80..000000000 --- a/fusion_docs/guide/local/oracle-object.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Oracle Object Storage -description: "Use Fusion with the Nextflow local executor and Oracle Object Storage" -date: "13 Feb 2025" -tags: [fusion, storage, compute, local, oracle object storage] ---- - -With Fusion, you can run Nextflow pipelines using the local executor and [Oracle Object Storage](https://www.oracle.com/cloud/storage/object-storage/). This -is useful to scale your pipeline execution vertically with a large compute instance, without the need to allocate -a large storage volume for temporary pipeline data. - -### Nextflow CLI - -:::tip -This configuration requires Docker or a similar container engine to run pipeline tasks. -::: - -:::note -[Oracle Object Storage](https://www.oracle.com/cloud/storage/object-storage/) relies on the S3-like API compatibility provided by Oracle storage and not by native Nextflow and Fusion support. -It may not support all Nextflow and Fusion features. -::: - -1. Set `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables to grant Nextflow and Fusion access to your storage credentials. - -1. Add the following to your `nextflow.config` file: - - ```groovy - wave.enabled = true - docker.enabled = true - docker.containerOptions = '-e FUSION_AWS_REGION=' - tower.accessToken = '' - fusion.enabled = true - fusion.exportStorageCredentials = true - aws.region = '' - aws.client.endpoint = 'https://.compat.objectstorage..oraclecloud.com' - aws.client.protocol = 'https' - aws.client.signerOverride = 'AWSS3V4SignerType' - aws.client.s3PathStyleAccess = true - ``` - - Replace the following: - - ``: your Platform access token. - - ``: your AWS region. - - ``: your bucket name. - -1. Run the pipeline with the Nextflow run command: - - ``` - nextflow run -w s3:///work - ``` - - Replace the following: - - `PIPELINE_SCRIPT`: your pipeline Git repository URI. - - `BUCKET`: your bucket. - -:::tip -To achieve optimal performance, set up an SSD volume as the temporary directory. -::: - -:::warning -The option `fusion.exportStorageCredentials` leaks credentials on the task launcher script created by Nextflow. -This option should only be used for testing and development purposes. -::: diff --git a/fusion_docs/guide/snapshots.md b/fusion_docs/guide/snapshots.md deleted file mode 100644 index bf0f4ce55..000000000 --- a/fusion_docs/guide/snapshots.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: Fusion Snapshots for AWS Batch -description: "Overview of the Fusion Snapshots feature for AWS Batch" -date: "23 Aug 2024" -tags: [fusion, storage, compute, file system, snapshot] ---- - -Fusion Snapshots enable you to create a checkpoint of a running Nextflow process and restore it on a different machine. Leveraging the Fusion file system, you can move the task between different instances connected to the same S3 bucket. - -More specifically, the first use case for this feature is for Seqera Platform users to leverage AWS Spot instances without restarting an entire task from scratch if an instance is terminated. When a Spot instance interruption occurs, the task is restored from the last checkpoint on a new AWS instance, saving time and computational resources. - -### Seqera Platform compute environment requirements - -Fusion Snapshots v1 requires the following [Seqera compute environment](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch) configuration: - -- **Provider**: AWS Batch -- **Work directory**: An S3 bucket located in the same region as your AWS Batch compute resources -- **Enable Fusion Snapshots (beta)** -- **Config mode**: Batch Forge -- **Provisioning model**: Spot -- **Instance types**: See recommended instance sizes below - -When Fusion Snapshots are enabled, the Nextflow Spot reclamation retry setting automatically defaults to `aws.batch.maxSpotAttempts = 5`. - -### EC2 instance selection guidelines - -- Choose EC2 Spot instances with sufficient memory and network bandwidth to dump the cache of task intermediate files to S3 storage before AWS terminates an instance. -- Select instances with guaranteed network bandwidth (not instances with bandwidth "up to" a maximum value). -- Maintain a 5:1 ratio between memory (GiB) and network bandwidth (Gbps). -- Recommended instance families: `c6id`, `r6id`, or `m6id` series instances work optimally with Fusion fast instance storage. - -:::info Example -A c6id.8xlarge instance provides 64 GiB memory and 12.5 Gbps guaranteed network bandwidth. This configuration can transfer the entire memory contents to S3 in approximately 70 seconds, well within the 2-minute reclamation window. - -Instances with memory:bandwitdth ratios over 5:1 may not complete transfers before termination, potentially resulting in task failures. -::: - -#### Recommended instance types - -| Instance type | Cores | Memory (GiB) | Network bandwidth (Gbps) | Memory:bandwidth ratio | Est. Snapshot time| -|----------------|-------|--------------|--------------------------|------------------------|-------------------| -| c6id.4xlarge | 16 | 32 | 12.5 | 2.56:1 | ~45 seconds | -| c6id.8xlarge | 32 | 64 | 12.5 | 5.12:1 | ~70 seconds | -| r6id.2xlarge | 8 | 16 | 12.5 | 1.28:1 | ~20 seconds | -| m6id.4xlarge | 16 | 64 | 12.5 | 5.12:1 | ~70 seconds | -| c6id.12xlarge | 48 | 96 | 18.75 | 5.12:1 | ~70 seconds | -| r6id.4xlarge | 16 | 128 | 12.5 | 10.24:1 | ~105 seconds | -| m6id.8xlarge | 32 | 128 | 25 | 5.12:1 | ~70 seconds | - -It's possible for a single job to request more resources than are available on a single instance. In this case, the job will wait indefinitely and never progress to running. To prevent this from occurring, you should set the maximum resources requested to below the size of a single instance listed above. This can be configured using the `process.resourceLimits` directive in your Nextflow configuration. For example, to limit a single process to fit within a c6id.8xlarge machine, you could set the following: - -```groovy -process.resourceLimits = [cpus: 32, memory: '60.GB'] -``` - -Note that if a process requests the maximum CPUs and memory in the table above, it will not be satisfiable by a single instance and therefore fail to be assigned to a machine. - -### (Seqera Enterprise only) Select an Amazon Linux 2023 ECS-optimized AMI - -To obtain sufficient performance, Fusion Snapshots require instances with Amazon Linux 2023 (which ships with Linux Kernel 6.1), with an ECS Container-optimized AMI. - -:::note -Selecting a custom Amazon Linux 2023 ECS-optimized AMI is only required for compute environments in Seqera Enterprise deployments. Seqera Cloud AWS Batch compute environments use Amazon Linux 2023 AMIs by default. -::: - -To find the recommended AL2023 ECS-optimized AMI for your region, run the following (replace `eu-central-1` with your AWS region): - -```bash -export REGION=eu-central-1 -aws ssm get-parameter --name "/aws/service/ecs/optimized-ami/amazon-linux-2023/recommended" --region $REGION -``` - -The result for the `eu-central-1` region is similar to the following: - -```bash -{ - "Parameter": { - "Name": "/aws/service/ecs/optimized-ami/amazon-linux-2023/recommended", - "Type": "String", - "Value": "{\"ecs_agent_version\":\"1.88.0\",\"ecs_runtime_version\":\"Docker version 25.0.6\",\"image_id\":\"ami-0281c9a5cd9de63bd\",\"image_name\":\"al2023-ami-ecs-hvm-2023.0.20241115-kernel-6.1-x86_64\",\"image_version\":\"2023.0.20241115\",\"os\":\"Amazon Linux 2023\",\"schema_version\":1,\"source_image_name\":\"al2023-ami-minimal-2023.6.20241111.0-kernel-6.1-x86_64\"}", - "Version": 61, - "LastModifiedDate": "2024-11-18T17:08:46.926000+01:00", - "ARN": "arn:aws:ssm:eu-central-1::parameter/aws/service/ecs/optimized-ami/amazon-linux-2023/recommended", - "DataType": "text" - } -``` - -Note the `image_id` in your result (in this example, `ami-0281c9a5cd9de63bd`). Specify this ID in the **AMI ID** field under **Advanced options** when you create your Seqera compute environment. diff --git a/fusion_docs/index.md b/fusion_docs/index.md deleted file mode 100644 index 8d4af341e..000000000 --- a/fusion_docs/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Fusion file system -description: "Overview of the Fusion v2 file system" -date: "23 Aug 2024" -tags: [fusion, storage, compute, file system, posix, client] ---- - -Cloud object stores such as AWS S3 are scalable and cost-effective, but they don't present a [POSIX](https://en.wikipedia.org/wiki/POSIX) (Portable Operating System Interface). This means containerized applications must copy data to and from cloud storage for every task — a slow and inefficient process. - -Fusion is a virtual, lightweight, distributed file system that bridges the gap between pipelines and cloud-native -storage. Fusion enables seamless filesystem I/O to cloud object stores via a standard POSIX interface, resulting in -simpler pipeline logic and faster, more efficient pipeline execution. - -:::note -Fusion requires a license for use in Seqera Platform compute environments or directly in Nextflow. See [Fusion licensing](./licensing.md) for more information. -::: - -### Transparent, automated installation - -Traditionally, pipeline developers needed to bundle utilities in containers to copy data in and out of cloud object storage. - -With Fusion, there is nothing to install or manage. The Fusion thin client is automatically installed using [Wave](https://docs.seqera.io/wave)'s container augmentation facilities, enabling containerized applications to read from and write to cloud storage buckets as if they were local storage. - -### No shared file system required - -To share data among pipeline tasks, organizations often turn to shared file systems such as Amazon EFS, Amazon FSx for Lustre, or NFS. - -Fusion removes the need to deploy, manage, and mount shared file systems on every cloud instance by providing the same functionality directly over cloud object storage – significantly reducing cost and complexity. - -### Maximize pipeline performance and efficiency - -Copying data to and from cloud storage adds latency for every task, increasing the time containers and cloud instances are deployed. This translates into longer runtimes and significantly higher costs for pipelines with thousands of tasks. - -Fusion eliminates these bottlenecks and delays, reducing execution time and cloud spending and using compute instances more efficiently. - -### Dramatically reduce data movement - -When pipelines run with cloud storage, tasks typically read data from a bucket, copy it to compute instance storage for processing, and copy the results back to the cloud storage bucket. - -The result is significant overhead for every task. Fusion enables direct file access to cloud object storage, eliminating unnecessary I/O and dramatically reducing data movement and overall runtime. - -### Checkpoint and recover reclaimed Spot instances with Fusion Snapshots - -Running pipelines on AWS Spot instances can lead to interruptions, causing tasks to restart from the beginning which wastes time and compute resources. - -When a Spot instance interruption occurs, Fusion Snapshots checkpoint Nextflow processes mid-task and save their state to S3. The task is restored from the last checkpoint on a new AWS instance, saving time and computational resources. - -### Seamless access to cloud object storage - -While some open-source projects provide a POSIX interface over cloud storage, they require developers to install and configure additional software and add packages to containers or VMs. - -Unlike third-party solutions, Fusion is optimized for Nextflow and handles these tasks automatically. Fusion delivers fast, seamless access to cloud object storage. diff --git a/fusion_docs/licensing.md b/fusion_docs/licensing.md deleted file mode 100644 index fafad479f..000000000 --- a/fusion_docs/licensing.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Fusion licensing -description: "Understand how Fusion licensing works" -date: "20 Feb 2025" -tags: [fusion, storage, compute, file system, license, quotas] ---- - -:::info -Fusion licensing requirements and free tier quotas will be enforced starting June 30th, 2025. [Contact Seqera](https://seqera.io/contact-us) with any questions or licensing requests. -::: - -A Fusion license sets a specific quota for Fusion use, measured by total pipeline throughput per month (defined by [Nextflow’s I/O metrics](https://www.nextflow.io/docs/latest/tutorials/metrics.html#i-o-usage)). - -### For Seqera Cloud - -- Seqera Platform will automatically add and manage a Fusion license on your behalf, up to the allowed usage quota. Seqera will track Fusion use for all pipelines run in Platform. -- By default, Seqera Cloud provides a monthly free tier for Fusion that allows up to 100 TB of throughput. -- Once your quota is met or exceeded, you will be prevented from running additional Nextflow pipelines with Fusion. - -### For Seqera Enterprise instances with connectivity to Seqera’s license server - -- Seqera Platform will automatically add and manage a Fusion license on your behalf, up to the allowed usage quota. Seqera will track Fusion use for all pipelines run in Platform. -- Once your quota is met or exceeded, you will be prevented from running additional Nextflow pipelines with Fusion. - -### For Seqera Enterprise instances without network connectivity, and direct Fusion use with Nextflow - -- Run Fusion using the [`TOWER_ACCESS_TOKEN` environment variable](https://www.nextflow.io/docs/latest/reference/config.html#tower) to allow Nextflow to connect to Seqera Cloud. -- Throughput counts towards the free or paid usage associated with your Cloud organization. diff --git a/fusion_docs/reference.md b/fusion_docs/reference.md deleted file mode 100644 index b11017588..000000000 --- a/fusion_docs/reference.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Reference -tags: [fusion, storage, compute, file system, posix, client] ---- - -# Reference - -## Configuration options - -The following Fusion configuration options are available: - -| Method | Description | -|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `fusion.enabled` | Enable/disable Fusion file system (default: `false`). | -| `fusion.cacheSize` | _New in version 23.11.0-edge_. Fusion client local cache size limit. | -| `fusion.containerConfigUrl` | URL for downloading the container layer provisioning the Fusion client. | -| `fusion.exportStorageCredentials` | _New in version 23.05.0-edge_. Enable access to credentials for the underlying object storage are exported to the task environment (default: `false`). Previously named `fusion.exportAwsAccessKeys`. | -| `fusion.logLevel` | Fusion client log level. | -| `fusion.logOutput` | Log output location. | -| `fusion.privileged` | _New in version 23.10.0_. Enable privileged containers for Fusion (default: `true`). Non-privileged use is supported only on Kubernetes with the k8s-fuse-plugin or a similar FUSE device plugin. | -| `fusion.snapshots` | _New in version 25.03.0-edge_. Enable Fusion snapshotting (preview, default: `false`). Currently only supported for AWS Batch. | -| `fusion.tags` | Pattern for applying tags to files created via the Fusion client (default: `[.command.*\|.exitcode\|.fusion.*](nextflow.io/metadata=true),[*](nextflow.io/temporary=true)`). Set to `false` to disable. | - -:::note -See [Configuration options](https://www.nextflow.io/docs/latest/reference/config.html#configuration-options) for a full list of Nextflow configuration options. -::: \ No newline at end of file diff --git a/fusion_docs/sidebar.json b/fusion_docs/sidebar.json deleted file mode 100644 index d7dd79832..000000000 --- a/fusion_docs/sidebar.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "sidebar": [ - "index", - "get-started", - { - "type": "category", - "label": "User guide", - "collapsed": false, - "items": [ - "guide/aws-batch", - "guide/gcp-batch", - "guide/azure-batch", - "guide/aws-eks", - "guide/gcp-gke", - "guide/snapshots", - { - "type": "category", - "label": "Local execution", - "collapsed": true, - "items": [ - "guide/local/aws-s3", - "guide/local/google-cloud", - "guide/local/azure-blob", - "guide/local/minio", - "guide/local/oracle-object" - ] - } - ] - }, - "licensing", - "reference", - "troubleshooting", - "faq", - { - "type": "link", - "label": "Changelog", - "href": "/changelog/tags/fusion" - } - ] -} diff --git a/fusion_docs/troubleshooting.md b/fusion_docs/troubleshooting.md deleted file mode 100644 index e20c712fa..000000000 --- a/fusion_docs/troubleshooting.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Troubleshooting ---- - -## Too many open files - -If you're experiencing an error about too many open files, increase the `ulimit` for the container. Append the following to your Nextflow configuration: - -```groovy -process.containerOptions = '--ulimit nofile=1048576:1048576' -``` diff --git a/internal/fetch-docs-oss.mjs b/internal/fetch-docs-oss.mjs deleted file mode 100644 index de3993ed0..000000000 --- a/internal/fetch-docs-oss.mjs +++ /dev/null @@ -1,67 +0,0 @@ -import git from "simple-git"; -import fs from "fs-extra"; -import "dotenv/config"; -import path from "path"; -import { fileURLToPath } from "url"; - -const __filename = fileURLToPath(import.meta.url); -const __dirname = path.dirname(__filename); - -const repositories = [ - { - name: "multiqc", - url: "https://github.com/MultiQC/MultiQC.git", - path: path.join(__dirname, "..", "multiqc_docs", "multiqc_repo"), - branch: "main", - }, - { - name: "wave", - url: "https://github.com/seqeralabs/wave.git", - path: path.join(__dirname, "..", "wave_docs", "wave_repo"), - branch: "master", - }, -]; - -// Function to clone or update a repository -async function cloneOrUpdateRepo({ name, url, path: repoPath, branch }) { - const exists = await fs.pathExists(repoPath + "/.git"); - - try { - if (exists) { - console.log( - `${name}: Cloned repo already exists, will pull latest changes`, - ); - // pull and checkout the branch - await git(repoPath).pull("origin", branch); - console.log(`✅ ${name}: Pulled latest changes`); - } else { - console.log(`${name}: Cloning into ${repoPath}`); - await git().clone(url, repoPath, ['--branch', branch]); - console.log(`✅ ${name}: Cloned`); - } - } catch (error) { - console.error(`❌ Error processing ${repoPath}:`); - console.error(error.message); - if (exists) { - console.error(`Try removing the directory: ${repoPath}`); - } - // Exit with error code 1 to stop any subsequent npm scripts - process.exit(1); - } - - return git(repoPath); -} - -// Clone/update all repositories -async function processRepositories() { - for (const repo of repositories) { - try { - await cloneOrUpdateRepo(repo); - } catch (error) { - console.error(`❌ Error processing ${repo.name}:`, error); - } - } -} - -// Execute -processRepositories().catch(console.error); diff --git a/internal/fetch-docs.mjs b/internal/fetch-docs.mjs deleted file mode 100644 index 8612bbf65..000000000 --- a/internal/fetch-docs.mjs +++ /dev/null @@ -1,82 +0,0 @@ -import git from "simple-git"; -import fs from "fs-extra"; -import path from "path"; -import "dotenv/config"; -import { fileURLToPath } from "url"; -import { sanitize } from "./src/sanitization.mjs"; - -// Git config -const owner = "seqeralabs"; -const repoName = "nf-tower-cloud"; -const token = process.env.GITHUB_TOKEN; -const repoUrl = `https://${token}@github.com/${owner}/${repoName}.git`; - -// Paths -const __filename = fileURLToPath(import.meta.url); -const __dirname = path.dirname(__filename); -const destPath = path.join(__dirname, "..", "platform-enterprise_versioned_docs"); -const tmpPath = path.join(__dirname, "tmp"); - -async function fetchAndSaveContents() { - const args = process.argv.slice(2); - const commitArgument = args.find((arg) => arg.startsWith("--commit=")); - const commitID = commitArgument?.split("=")?.[1]; - - if (commitID) console.log(`Specified commit: ${commitID}`); - - // Clone the repository - const tmpExists = await fs.pathExists(tmpPath); - if (tmpExists) { - console.log("Cloned repo already exists"); - } else { - console.log(`Cloning ${repoName} into ./tmp`); - await git().clone(repoUrl, tmpPath); - console.log("✅ Cloned"); - } - - // Initialize and update the submodules - const repo = git(tmpPath); - await repo.submoduleUpdate(["--init", "--recursive"]); - - // Get the release tags - await repo.fetch(["--tags"]); - const tagList = await repo.tag(); - const tags = tagList.split("\n").filter(Boolean); - - // Only include enterprise tags - const regex = /^v\d+\.\d+\.\d+-enterprise$/; - let filteredTags = tags.filter((tag) => regex.test(tag)); - - console.log(`${filteredTags.length} enterprise releases found`); - console.log(`Latest release: ${filteredTags[filteredTags.length - 1]}`); - - // Bypass the tag filtering if a commit ID is provided - if (commitID) filteredTags = [commitID]; - - for (const tag of filteredTags) { - // Checkout the tag - await repo.checkout(tag); - - // Check for docs presence - const docsPath = path.join(tmpPath, "docs"); - const pathExists = await fs.pathExists(docsPath); - if (!pathExists) continue; - - // Create the destination folder - let newDir = tag.replace("-enterprise", ""); - newDir = "version-" + newDir; - const fullDestPath = path.join(destPath, newDir); - await fs.ensureDir(fullDestPath); - - // Copy the 'docs' folder to the destination folder - await fs.copy(docsPath, fullDestPath); - console.log(`Saved contents for release ${tag}`); - - // Sanitize the contents - await sanitize(fullDestPath); - } - - console.log(`Processed ${filteredTags.length} releases`); -} - -fetchAndSaveContents().catch((err) => console.error(err)); diff --git a/multiqc_docs/sidebar.js b/multiqc_docs/sidebar.js deleted file mode 100644 index ef1ca7125..000000000 --- a/multiqc_docs/sidebar.js +++ /dev/null @@ -1,75 +0,0 @@ -export default { - multiqcSidebar: [ - [ - "index", - { - "type": "category", - "label": "Getting started", - "collapsed": true, - "link": { - "type": "generated-index", - }, - "items": [ - "getting_started/quick_start", - "getting_started/installation", - "getting_started/running_multiqc", - "getting_started/config" - ] - }, - { - "type": "category", - "label": "Reports", - "collapsed": true, - "link": { - "type": "generated-index", - }, - "items": [ - "reports/reports", - "reports/customisation" - ] - }, - "custom_content/index", - "ai/index", - { - "type": "category", - "label": "Usage", - "collapsed": true, - "link": { - "type": "generated-index", - }, - "items": [ - "usage/downstream", - "usage/pipelines", - "usage/scripts", - "usage/troubleshooting" - ] - }, - { - "type": "category", - "label": "Development", - "collapsed": true, - "link": {type: "doc", id: "development/index"}, - "items": [ - "development/modules", - "development/plots", - "development/plugins", - "development/templates", - "development/compatibility", - "development/contributing" - ] - }, - { - "type": "category", - "label": "Supported Tools", - "collapsed": true, - "link": {type: "doc", id: "modules"}, - "items": [] - }, - { - "type": "link", - "label": "Changelog", - "href": "/changelog/tags/multiqc" - } - ] - ] -}; diff --git a/package.json b/package.json index 19aea5c17..c381b4dcf 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,6 @@ "private": true, "scripts": { "docusaurus": "docusaurus", - "prestart": "npm run fetch-docs-oss", "start": "docusaurus start", "dev": "npm run start", "prebuild": "npm run fetch-docs-oss", @@ -16,8 +15,6 @@ "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", "typecheck": "tsc", - "fetch-docs": "node internal/fetch-docs.mjs", - "fetch-docs-oss": "node internal/fetch-docs-oss.mjs", "sanitize-existing": "node internal/sanitize-existing.mjs", "markdownlint": "markdownlint-cli2 'platform-enterprise_versioned_docs/**/*.mdx' 'platform-cloud/docs/*.mdx' 'wave_docs/**/*.mdx' 'fusion_docs/**/*.mdx' --config .markdownlint-cli2.cjs" }, diff --git a/platform-api-docs/README.md b/platform-api-docs/README.md deleted file mode 100644 index 558f24f2d..000000000 --- a/platform-api-docs/README.md +++ /dev/null @@ -1,452 +0,0 @@ -# Platform OpenAPI documentation workflow - -## Prerequisites - -### Cloned repos -- **seqeralabs/platform** -- **seqeralabs/docs** - -### Tools -- **Speakeasy CLI**: For overlay comparison and application -- **Node.js/npm**: For Docusaurus commands - -### File Naming Conventions -- Base specs: `seqera-api-{version}.yaml` (e.g., `seqera-api-1.85.0.yaml`) -- Decorated specs: `seqera-api-latest-decorated.yaml` (consistent name for Docusaurus) -- Comparison overlays: `base-{old-version}-to-{new-version}-changes-overlay.yaml` -- Documentation overlays: `{feature}-{type}-overlay-{version}.yaml` - - Types: `operations`, `parameters`, `schemas` - - Example: `datasets-operations-overlay-1.85.yaml` - ---- - -## Workflow - -### Step 1: Get New Base Spec from Platform Repo - -1. In Platform repo, switch to `master` branch and pull from origin: - ```bash - cd /path/to/tower-backend - git checkout master - git pull origin master - ``` - -2. From Platform repo root, run `make update-api-docs`: - ```bash - make update-api-docs - ``` - **IMPORTANT**: When prompted, **DO NOT INCREMENT VERSION** - -3. Copy new base spec from Platform repo: - ```bash - # Base spec will be at: - tower-backend/build/classes/groovy/main/META-INF/swagger/seqera-api-*.yml - ``` - -4. Move new base spec to docs repo: - ```bash - cp tower-backend/build/classes/groovy/main/META-INF/swagger/seqera-api-*.yml \ - /path/to/docs-repo/platform-api-docs/specs/ - ``` - -### Step 2: Generate Base Comparison Overlay - -Compare old and new base specs to identify all changes: - -```bash -cd /path/to/docs-repo/platform-api-docs/specs - -speakeasy overlay compare \ - -o seqera-api-1.66.0.yaml \ - -n seqera-api-1.85.0.yaml \ - > base-1.66-to-1.85-changes-overlay.yaml -``` - -**What this does**: Creates an overlay file showing every difference between the two base specs (new endpoints, changed parameters, added schemas, etc.). - -### Step 3: Analyze Changes - -Review the comparison overlay to identify: -- **New endpoints**: Need complete documentation (operations, parameters, schemas) -- **Modified endpoints**: Need updated descriptions -- **New schemas**: Need property descriptions -- **Deprecated endpoints**: Need deprecation notices - -Group changes by feature area (datasets, data-links, pipelines, compute environments, etc.) for organized overlay creation. - -### Step 4: Create Documentation Overlays - -For each feature area with changes, create separate overlay files in the `specs` folder: - -#### Operations Overlay -Covers endpoint summaries and descriptions. - -**File**: `{feature}-operations-overlay-{version}.yaml` - -**Format**: -```yaml -overlay: 1.0.0 -info: - title: {Feature} operations overlay - version: 0.0.0 -actions: - # ===== {FEATURE} - OPERATIONS ===== - - # ---- {OPERATION NAME} ---- - - - target: "$.paths./{endpoint}.{method}.summary" - update: "{Verb} {entity}" - - - target: "$.paths./{endpoint}.{method}.description" - update: "{Full description with context and usage guidance.}" -``` - -**Conventions**: -- Summaries: Sentence case, verb-entity format (e.g., "List datasets", "Create pipeline") -- Descriptions: Full sentences with periods, include context about user/workspace scope -- Deprecated operations: Lead with "(Deprecated)" in summary, include link to new endpoint - -#### Parameters Overlay -Covers path, query, and request body parameter descriptions. - -**File**: `{feature}-parameters-overlay-{version}.yaml` - -**Format**: -```yaml -overlay: 1.0.0 -info: - title: {Feature} parameters overlay - version: 0.0.0 -actions: - # ===== {FEATURE} PARAMETERS - PATH, QUERY, AND REQUEST BODY ===== - - # ---- PATH PARAMETERS ---- - - - target: "$.paths./{endpoint}.{method}.parameters[?(@.name=='{paramName}')].description" - update: "{Parameter description with type and context.}" - - # ---- QUERY PARAMETERS ---- - - - target: "$.paths./{endpoint}.{method}.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - # ---- REQUEST BODY DESCRIPTIONS ---- - - - target: "$.paths./{endpoint}.{method}.requestBody.description" - update: "{Request body description.}" -``` - -**Conventions**: -- Consistent descriptions for repeated parameters (workspaceId, max, offset, search, etc.) -- Always include defaults in backticks: "Default: `0`" -- Specify accepted values: "Accepts `value1`, `value2`, or `value3`" -- End all descriptions with periods - -#### Schemas Overlay -Covers request/response object property descriptions. - -**File**: `{feature}-schemas-overlay-{version}.yaml` - -**Format**: -```yaml -overlay: 1.0.0 -info: - title: {Feature} schemas overlay - version: 0.0.0 -actions: - # ===== {FEATURE} SCHEMAS - REQUEST/RESPONSE OBJECTS ===== - - # ---- REQUEST SCHEMAS ---- - - - target: "$.components.schemas.{SchemaName}.properties.{propertyName}" - update: - type: string - description: "{Property description with validation rules and constraints.}" - - # ---- RESPONSE SCHEMAS ---- - - - target: "$.components.schemas.{SchemaName}.properties.{propertyName}" - update: - description: "{Property description.}" -``` - -**Conventions**: -- Include validation rules (max length, format requirements, etc.) -- Note nullable fields explicitly -- Describe enum values clearly -- Document array item types - -### Step 5: Engineering Review - -Before applying overlays, raise a **draft PR** for engineering review: - -1. Commit all new overlay files in the `specs` folder to a feature branch -2. Create a draft PR with the overlay files -3. Request review from the appropriate Platform squad: - - **Data team**: data-links, datasets, studios - - **Unified compute team**: compute environments (all platforms) - - **Pipelines team**: pipelines, workflows, launch operations - - **Core team**: admin, organizations, workspaces, users, and everything else -4. **What to review**: Ask engineering to review the overlay files directly for technical accuracy -5. Iterate on feedback and update overlay files as needed -6. Once approved, proceed to Step 6 - -### Step 6: Consolidate Overlays - -After engineering approval, consolidate all individual overlay files into one comprehensive overlay: - -1. Create a new file: `all-changes-overlay-{version}.yaml` -2. Copy contents from all individual overlay files into this single file: - - Keep sections clearly labeled (operations, parameters, schemas) - - Maintain all target paths and updates -3. Move individual overlay files to archive: - ```bash - mv *-overlay-{version}.yaml overlays_archive/ - ``` - **Note**: Keep the individual files in `overlays_archive` for reference and future updates - -### Step 7: Apply Consolidated Overlay - -Apply the single comprehensive overlay to your decorated spec, using the consistent naming convention: - -```bash -cd /path/to/docs-repo/platform-api-docs/specs - -speakeasy overlay apply \ - -s seqera-api-latest-decorated.yaml \ - -o all-changes-overlay-1.85.yaml \ - > seqera-api-latest-decorated-new.yaml - -# Replace old decorated spec with new one -mv seqera-api-latest-decorated-new.yaml seqera-api-latest-decorated.yaml -``` - -**Note**: By keeping the same filename (`seqera-api-latest-decorated.yaml`), Docusaurus config doesn't need updating. - -### Step 8: Validate Output - -Verify the decorated spec: -1. Check that all new endpoints have complete documentation -2. Verify parameter descriptions are consistent -3. Confirm schema properties are documented -4. Test that the spec is valid OpenAPI 3.0/3.1 - -```bash -# Validate with Speakeasy -speakeasy validate openapi -s seqera-api-latest-decorated.yaml -``` - -### Step 9: Update Docusaurus Config and Regenerate Documentation - -Before regenerating docs, verify Docusaurus is pointing to the correct spec: - -1. **Check `docusaurus.config.js`**: - - Open the config file and locate the `docs_platform_openapi` plugin configuration: - - ```javascript - const docs_platform_openapi = [ - "docusaurus-plugin-openapi-docs", - { - id: "api", // plugin id - docsPluginId: "classic", // configured for preset-classic - config: { - platform: { - specPath: "platform-api-docs/scripts/seqera-api-latest-decorated.yaml", - outputDir: "platform-api-docs/docs", - sidebarOptions: { - groupPathsBy: "tag", - }, - }, - }, - }, - ]; - ``` - - **Verify**: The `specPath` should point to `seqera-api-latest-decorated.yaml`. Since we use a consistent filename, this should not require changes. - -2. **Regenerate documentation** from the decorated spec using Docusaurus: - - ```bash - cd /path/to/docs-repo - - # Clean existing API docs - npx docusaurus clean-api-docs all - - # Generate new API docs from decorated spec - npx docusaurus gen-api-docs all - ``` - -This will regenerate documentation tables and "Try it out" functionality based on your updated decorated spec. - -### Step 10: Clean Up and Finalize PR - -After regenerating docs, clean up the `specs` folder and prepare for final review: - -1. Delete old base spec (keep only the latest): - ```bash - cd /path/to/docs-repo/platform-api-docs/specs - rm seqera-api-1.66.0.yaml # Delete old version - ``` - -2. Move all used overlays to archive: - ```bash - mv base-1.66-to-1.85-changes-overlay.yaml overlays_archive/ - mv all-changes-overlay-1.85.yaml overlays_archive/ - ``` - -3. Verify `specs` folder contents: - - ✅ Latest base spec (e.g., `seqera-api-1.85.0.yaml`) - - ✅ Decorated spec with consistent name (`seqera-api-latest-decorated.yaml`) - - ✅ `servers-overlay.yaml` (kept for reuse in future updates) - - ❌ No old specs or temporary overlay files - -4. Push changes to your PR: - ```bash - git add . - git commit -m "Update API docs to version 1.85.0" - git push origin your-feature-branch - ``` - -5. Mark PR as **ready for review** (remove draft status) - ---- - -## Documentation Standards - -### Terminology Consistency - -**Standard terms**: -- "data-links" (not "datalinks" or "data links") -- "resource path" (for bucket URLs, not "bucket path" or "URI") -- "Array of" (not "List of") -- "Workspace numeric identifier" (consistent across all endpoints) -- "Number of results to skip for pagination. Default: `0`." (standard offset description) - -**Cloud provider terms**: -- Use "Azure Blob Storage containers" (not just "containers") -- Distinguish between "simple labels" and "resource labels" - -### Style Guidelines - -Follow **US English** and **Google Developer Style Guide**: -- Sentence case for summaries (not title case) -- Full sentences with periods for descriptions -- Active voice preferred over passive -- Use backticks for code values: `workspaceId`, `default`, `null` -- Use "Accepts X, Y, or Z" for listing options - -### Common Parameter Descriptions - -**Reuse these descriptions for consistency**: - -| Parameter | Description | -|-----------|-------------| -| `workspaceId` (query) | Workspace numeric identifier. | -| `workspaceId` (path) | Workspace numeric identifier. | -| `max` | Maximum number of results to return. Default: `{value}`. | -| `offset` | Number of results to skip for pagination. Default: `0`. | -| `search` | Free-text search filter to match against {field names}. | -| `sortBy` | Field to sort results by. Accepts `{value1}`, `{value2}`, or `{value3}`. Default: `{value}`. | -| `sortDir` | Sort direction for results. Accepts `asc` (ascending) or `desc` (descending). Default: `{value}`. | - ---- - -## Special Cases - -### Deprecated Endpoints - -For deprecated endpoints: - -1. **Update summary**: Prefix with "(Deprecated)" - ```yaml - - target: "$.paths./old-endpoint.get.summary" - update: "(Deprecated) List items" - ``` - -2. **Update description**: Lead with deprecation notice and link to replacement - ```yaml - - target: "$.paths./old-endpoint.get.description" - update: "**This endpoint is deprecated. See [New operation name](https://docs.seqera.io/platform-api/new-operation-slug) for the current endpoint.**\n\n{Original description of what this endpoint does.}" - ``` - -### HPC Compute Configurations - -Properties previously inherited from `AbstractGridConfig` now require explicit descriptions on each scheduler type (LSF, Slurm, Altair PBS, Moab, Univa). Duplicate property descriptions across all five scheduler configs. - -### Discriminator Properties - -When cleaning up schemas: -- Remove incorrect `readOnly` flags from discriminator properties -- Remove unnecessary `description` fields from discriminators -- Preserve the discriminator properties themselves (don't remove entirely) - ---- - -## Quality Checks - -Before finalizing, verify: - -- ✅ All new endpoints have summaries and descriptions -- ✅ All parameters have descriptions with proper formatting -- ✅ All schema properties are documented -- ✅ Consistent terminology throughout -- ✅ All descriptions end with periods -- ✅ Defaults are specified in backticks -- ✅ Deprecated endpoints have proper notices -- ✅ Spec validates successfully -- ✅ Docusaurus config points to correct spec path -- ✅ "Try it out" functionality works (servers block preserved) -- ✅ `specs` folder contains only latest base and decorated specs and `servers-overlay.yaml` -- ✅ Old specs deleted and used overlays moved to `overlays_archive` - ---- - -## Troubleshooting - -### Missing servers block - -If the `servers` block (containing API server URLs) is lost during updates: - -1. Use the existing `servers-overlay.yaml` in the `specs` folder: - ```yaml - overlay: 1.0.0 - info: - title: Servers block preservation - version: 0.0.0 - actions: - - target: "$.servers" - update: - - url: "https://api.platform.example.com" - description: "Platform API endpoint" - ``` - -2. Include it in your consolidated overlay file or apply separately - -**Note**: `servers-overlay.yaml` is kept in `specs` folder (not archived) for reuse in every update. - -### Overlay application errors - -If overlays fail to apply: -- Check JSONPath syntax in `target` fields -- Verify all referenced schemas/paths exist in source spec -- Ensure overlay files are valid YAML -- Review Speakeasy error messages for specific issues - ---- - -## Resources - -- **Speakeasy Documentation**: [https://speakeasy.com/docs](https://speakeasy.com/docs) -- **OpenAPI Specification**: [https://spec.openapis.org/oas/v3.1.0](https://spec.openapis.org/oas/v3.1.0) -- **Google Developer Style Guide**: [https://developers.google.com/style](https://developers.google.com/style) - ---- - -## Revision History - -| Version | Date | Changes | Author | -|---------|------|---------|--------| -| 1.0 | 2025-10-28 | Initial workflow documentation | Llewellyn vd Berg | - ---- \ No newline at end of file diff --git a/platform-api-docs/docs/add-labels-to-actions.api.mdx b/platform-api-docs/docs/add-labels-to-actions.api.mdx deleted file mode 100644 index 793fe6394..000000000 --- a/platform-api-docs/docs/add-labels-to-actions.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: add-labels-to-actions -title: "Add labels to actions" -description: "Adds the given list of labels to the given pipeline actions. Existing labels are preserved." -sidebar_label: "Add labels to actions" -hide_title: true -hide_table_of_contents: true -api: eJy1VcFu2zAM/RVB5zTJtqKHnJYWHVCsWIs2ww5BDozNJEplS5XkpIGRfx8p2Y3TFO0uuxQ19Ug+ko9MLQMsvRxNpYY5ai9nPZmjz5yyQZlSjuQ4z70IKxRLtcFSaOWDMAuR4CKYzptVFrUqUUDGzr4vrl8IrsplCweHwjr06DaY92VPGosOGHyTp1y3ETgx4xSCIBYcFBjQMc1alvRB0K1xT95ChuTYk4qZPlfodvIt/z8tUJRVgU5lQuVYBrVQ6AjssxUWIEe1DDvLgVUZcBmfFsYVEJLp4lzu99Qbh5TFh0uT79jnONVtU2SeiwZHUTJDAcvAaLBWqyyWO1h7dqlP85v5GjN2tI6bExT66JulLvkOFJwDLlgFLLp2Hxz1nAj30lT/zeuDwilQUEEzauy9yRQETANKJT801UYkl64c0jyDqzAavKVRpjq+Ds9PG3f3U5yJX0a0vSKn8+G3d3CtWkRpggCtzZbycFKPWeVU2EWJXCLpzI2rsKLPGY+N9LMyrDBr4lAs8JscNEIdJHkOaHIsCVZno7bKacKtQrB+NBiAVf1Mmyrve3wmKn1lTvT2GF/EvYbAfRRXjBfj+xvJRFqejzz21JEu29dhcMZWnfw9jyCypH9+tBNab0Osn+X0cNDm9QsUlud1JJxpq4xZVxjT4WzPG7QwMX8z56YM5v1ZhdwvlaFvwDxESsrBjrvX7RlpXumosIX5fnggItz6lOdL/+KiP2QbT62AuC/N+tOl6JwgeD0WR0zrw/L95zPWTC3gSxhYDXSOiHWsvm60NpUHks2p7UnWG81ixaIkRF3PweNvp/d7Nqd7xirMlYe55pVagPb4QZmfXLt3eT7h7uSgbkBXjIyi3YBTnD9uE9FFyCkaE0uuVyn92YSjH3xPzt3RJt7fPU5Yz80lLUzOPg62ZOS/lJt/HlLPCBBtNfWuXFawZGyKyeqH4+V5syyRaXv8yl2HITU8IibmCUtqetuLwN9El4L/BQAndPs= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Adds the given list of labels to the given pipeline actions. Existing labels are preserved. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/add-labels-to-pipelines.api.mdx b/platform-api-docs/docs/add-labels-to-pipelines.api.mdx deleted file mode 100644 index 2b4c713c4..000000000 --- a/platform-api-docs/docs/add-labels-to-pipelines.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: add-labels-to-pipelines -title: "Add labels to pipelines" -description: "Adds the given list of labels to the given pipelines. Existing labels are preserved." -sidebar_label: "Add labels to pipelines" -hide_title: true -hide_table_of_contents: true -api: eJy1VcFOGzEQ/RXL57BJW8QhpwZEJVRUIkjVA+IwWU8Sg3dtbG9CtMq/d8a7SzYElUpVL4i1n2fevHkzqWWEZZDje2lgjibIh4FUGHKvXdS2lGM5USqIuEKx1GsshdEhCrsQDVxE27tz2qHRJYZMXL4QTpfLDgcehfMY0K9RZXIgrUMPnOJKNUmuE3Bmp10QAjnwUGBEzwxrWdIHgTfWPwUHOdLTgdRM8rlCv5Vvqf/qgKKsCvQ6F1phGfVCoydwyFdYgBzXMm4dB9ZlxGW6WlhfQGyOzk7lbkeyeKQsIZ5bteU3h6mu2zKVEi2OouSWApaR0eCc0XkqePgY+El9nN/OHzHnh86zPFGTCHTbyXqlQg8M3gOXrCMW4e+KGDRN/uc4FCjqaBg1CcHmGiJ2bWuEuG01SFgWRHukPkdfYToIzpahqe7z6PRYzpvv4kT8sKJTkB6djr68g+tcJEobBRhjN5SHkwbMK6/jNhnnHMl/flLFFX0+cDPJVSvLznM2tcoB38nhq4WHjXGH1FG2Cvu2dWHlDSFXMbowHg7B6Sw3tlJZwGcik2l75MO7dCOmBiJrKS4YLybTK8lUOqZ3bIdGkz7f14Zwxs61/D1PIDpp/vnWdelxE5MCbLPbvWcvX6Bw3LM3hrofPfR9QZ87HqqFTanbNrcVMOWPimOpdI6hBXMHIU8zcChcXy4aA22SwRb26/6CiLDqTZ5P2dlZNuIzblkBaYTajUDro7eQXG+DHHCt9xP5v9Za26uIL3HoDNByIsKp8Lr12L3s82u37kCyz6gRK7YjYep6DgF/erPb8XGz39h9SgeYGx6mBZiAf6jwg+33LtMn3B4t2DWYipHJrGvwmvOnOSK6CIqiMbHm6UWT/mTG0fdvj9bfwQxOb+5m7ON2sxZW8RsPGzrkv5SbfzD4dRqPdFaTduWygiVjm5jsejgcmjdDkph2i6/c9hiS4Akxs09YkuidFpG/iS4F/w1gw3h/ -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Adds the given list of labels to the given pipelines. Existing labels are preserved. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/add-labels-to-workflows.api.mdx b/platform-api-docs/docs/add-labels-to-workflows.api.mdx deleted file mode 100644 index 3b6bb6ec4..000000000 --- a/platform-api-docs/docs/add-labels-to-workflows.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: add-labels-to-workflows -title: "Add labels to workflows" -description: "Adds the given list of labels to the given workflows. Existing labels are preserved." -sidebar_label: "Add labels to workflows" -hide_title: true -hide_table_of_contents: true -api: eJy1VcFOGzEQ/RXL55CEFnHIqQFRCRUVBKk4RDlMdieJwbs2tjchWuXfO+Ndkw1B0EsviLXfzLx58zypZYCll6Op1DBH7eWsJ3P0mVM2KFPKkRznuRdhhWKp1lgKrXwQZiEauAimc7cx7nmhzcb3xdUr4VS5TDhwKKxDj26NeV/2pLHogEtc502RmwicmMeUhEAWHBQY0DHDWpb0QWAu4y1kSKE9qZjkS4VuK99Tf0xAUVYFOpUJlWMZ1EKhI7DPVliAHNUybC0nVmXAZbxaGFdAaI7Oz+RuR7I4pCo+XJh8yzGHpW7aNvNctDjKkhlKWAZGg7VaZbHhwZPnkPq4vpk/YcaB1rE8QaHn2yTrde47YHAOuGUVsOie++BId6Lca0b6b1GftE6JggqaUWPvTaYgYBpS0/Z923HEcvvKIU01uArjgbem9E0v34Znx+Ld/hIn4rcRSS8KOht+/wCXPCNKEwRoIkB1uKjHrHIqbKNNLpDc5sZVWNHnjEdHHloZ9pk1cTAW+E4OkrKDxqUDGh/7gk3aWq5ymoCrEKwfDQZgVT/Tpsr7Hl+IS1+ZI9M9xBtxpyGwlOKS8WJ8dy2ZSSL6wLNvJOnSfZsHV0wW5e95BNFJ88/PNKSnTYgCsKfu9wa9eoXC8sjeuWea7DHrumM6nO34IS1MZNAOu22EmX/VIyumMvQtmOcIWfT9oX5d1cj6SkebLcyP/QURYfGbOqf98/P+kM94cAXEZ9NuAVoZnSW06WyNA671/hX+r1XWjizgaxhYDbSQiHBsvG6dNn2bguylRduT7Daaw4o9SZC6noPHP07vdnzcrDT2YK48zDW/qAVoj580+MXC+5DoM26PduoadMXIaNk1OMX142Miugg5ZWNiTehlU/5kwtn3sUcb7+Ah3t0+TNjN7TItTM4xDlgg/ku1+TeCo+MjiWc1aVcuK1gytsnJ3ofDp/PuqUSmafuV2w5DEjwiJuYZSxI9aRH4m+hS8r9yiXYO -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Adds the given list of labels to the given workflows. Existing labels are preserved. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/apply-labels-to-actions.api.mdx b/platform-api-docs/docs/apply-labels-to-actions.api.mdx deleted file mode 100644 index d5d1b8921..000000000 --- a/platform-api-docs/docs/apply-labels-to-actions.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: apply-labels-to-actions -title: "Replace action labels" -description: "Applies the given list of labels to the given pipeline actions. Existing labels are replaced — include labels to be preserved in `labelIds`." -sidebar_label: "Replace action labels" -hide_title: true -hide_table_of_contents: true -api: eJzNVc1OGzEQfhXL55DQFnHIqQFRCRUVBKl6iCLh7E4Sg9d2bW9CtIrUh+gT9kk6Y3vJhiDosRfEjr/5++abScODWHg+nHAlZqA8n/Z4Cb5w0gZpNB/ykbVKgmdhCWwhV6CZkj4wM2fJgwXTebPSgpIamCjI3/fZxRPCpV60cOGAObBKFFCyP79+M6kLVZfQCTcDZh14cCuESM3u49Nl6e/7vMeNBSco+GWZy9tcRdexGaWkCLLCiQoCOOqt4Ro/ELw27tFbzIyuPS6pvZ81uA1/2fSPFsh0XYGTBZMl6CDnEhyCfbGESvBhw8PGUmCpAyzi09y4SoRkOj3h2y0S6gCz+HBmyg357Ke6yrRQHywjMU5hMKQOhKcnWcSWBw+enJrDCszsAQpytI4ICjiy6FskpnwHKpwT1LIMUHXtPjicE5bc4y3h/+D1RusYKMigCDXy3hRSBEgjSk3f5m4jklqXDnCmwdUQDd7iMFMfH49PDqm7/sqO2DfDWq7Q6eT40yu4VjFMm8CEUmaNeSiph6J2MmyiSM4AtelGdVji55QGhwpaGlKZNXEoVtAbH2RxD5JkB3F2JAtSbFZc7RQilyFYPxwgQvYLZeqy7+EnFtOX5kBzd/GF3SgRiEl2Tng2urnkVEpb6R0NPnHSrfd5HJSxVSh9zyIILemfL+2MHtYhMkCCut3p8+JJVJYmtiedSauNaVcak+PplrZobmL+POncBtX9XofElyzwtiQwjRGTUrB99rqcoeqlihqbm8+7ByyEqE95PvRPT/vHZKO5VSJuTD4Bt+n05PuUj87LSpvd+v1/9y8POsBTGGAYvGLYaCSsyQKd5NlRX88NJpHiAJekZcQ0zUx4+O7UdkvmdAhJuqX0YqZoE+dCeXiDm3fO5KuVPsLm4BKvhKoJGZW+Ek5S/riEWC6IEqNRYcn1PKU/GlP0ne/Bldxb4JvruzEtQT7BlSnJx4k1Gukv5qZflsQaAqKtQfb0ohYLwqaYtDJif+NebFistL2ZetOpEAmPiLF5BI2kt1wE+sZyMfhfD5GfrA== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Applies the given list of labels to the given pipeline actions. Existing labels are replaced — include labels to be preserved in `labelIds`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/apply-labels-to-pipelines.api.mdx b/platform-api-docs/docs/apply-labels-to-pipelines.api.mdx deleted file mode 100644 index 25b7dac20..000000000 --- a/platform-api-docs/docs/apply-labels-to-pipelines.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: apply-labels-to-pipelines -title: "Replace pipeline labels" -description: "Applies the given list of labels to the given pipelines. Existing labels are replaced — include labels to be preserved in `labelIds`." -sidebar_label: "Replace pipeline labels" -hide_title: true -hide_table_of_contents: true -api: eJzNVc1uGjEQfhXLZ7LQNsqBU0mUSlGjBiVUPUSRYnYHcOK1XdsLQSukPkSfsE/SGXsXFoiaSr30grD9zd8338zWPIi558N7rsQUlOcPPV6Az520QRrNh3xkrZLgWVgAm8slaKakD8zMWLJgwXTerLSgpAafscsXxEk9b3HCAXNglcihYL9+/GRS56oqoONnCsw68OCWCJGaPcanq8I/ZrzHjQUnKKuroslrfR1NJ2bchkWYFU6UEMBRWTXXeED4yrhnbzE2Gve4pMq+V+DW/LDeby2Q6aoEJ3MmC9BBziQ4BPt8AaXgw5qHtSXHUgeYx6eZcaUI6erslG82yKUDjOLDuSnWZLMf6rohhiphDRL95AZd6kB4epJ5LLr/5MmoPs7ATJ8gJ0PriKKA3aLXthVIXwcsnBNUtAxQ+r8ro8fbNvybH3QUZFCEGnlvcikCtI1LVNw2HEQsESIdYK+DqyBeeGu0T9W9H5weE3rzmZ2wL4a1DKLR6eDDK7hWSUybwIRSZoVxKKiHvHIyrKN0zgE160ZVWODxgdqJuloYUp81sVVW0Bvvb2XfT2Lux56SXEjLjRIrpxC7CMH6YR8RMsuVqYrMw3dMJ5PmSIt38YWNlQjEJrsgPBuNrzgl0+Z6R4JIrHQz3raEIrbKpfM0gvAm/fnU9ulpFSIHJLTbnW4vX0RpqWsHkrofPHSVgccNDdbMxNBNo5sKKOW3iiOqZI6bJoGphyKPU7BPXJcuHASposRm5uPuARMh1lOcd9nZWTagO2paKeIQNVvhNu2j7dpqdtFhrvVuJv+jfdi0N8BL6KMb3GlYY+SqboR5v+0YlbStLYkTu7cgFSOqrqfCw1enNhu6TouRJFtIL6aKZnAmlIc/0PLG2nw112dYH23mpVAVIaPCl8JJih/HD9MFUaA3SiyZXqTwJxPyvrM92pp7ozu+uZuQ+JuVXJqCbJxY4SX9Ymz61pB1nKl4VyN7el6JOWGTTxoVsT9pB5MVM233pV53MkTCI2JinkEj6S0Xgc6YLjr/DRXiozA= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Applies the given list of labels to the given pipelines. Existing labels are replaced — include labels to be preserved in `labelIds`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/apply-labels-to-workflows.api.mdx b/platform-api-docs/docs/apply-labels-to-workflows.api.mdx deleted file mode 100644 index 2b8010235..000000000 --- a/platform-api-docs/docs/apply-labels-to-workflows.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: apply-labels-to-workflows -title: "Replace workflow labels" -description: "Applies the given list of labels to the given workflows. Existing labels are replaced — include labels to be preserved in `labelIds`." -sidebar_label: "Replace workflow labels" -hide_title: true -hide_table_of_contents: true -api: eJzNVcFuGjEQ/RXLZwK0jXLgVBKlUtSoiRKqHBBSzO4AJl7bsb0kaIXUj+gX9ks6413DAlHSYy9R1n7jefPmzVDxIOaeD8ZciSkozycdnoPPnLRBGs0HfGitkuBZWACbyxVopqQPzMxYHcGCad29GPc0U+bFd9nlK+KknieccMAcWCUyyNmfX7+Z1Jkqc2i9MwVmHXhwK4RIzR7j1VXuH7u8w40FJ4jVVd7wWl/H0JF5SGkRZoUTBQRwVFbFNX4gnIh5i7kxuMMlVfZcglvzw3ofEpDpsgAnMyZz0EHOJDgE+2wBheCDioe1pYelDjCPVzPjChHqo7NTvtmglg4wiw/nJl9TzH6q60YYqoQ1SHwnM/ikDoSnK5nFontLT0HVMQMzXUJGgdaRRAG7RbepFShfCyycE1S0DFC0z31w2Csk3eFJ9H+Ieqd4fCjIoAg19N5kUgRIbaoLv2sqjlgqXzrAzgZXQjzw1mhf1/K5f3os3813dsJ+GJb0wqDT/pc3cMk3TJvAhEICmIeSeshKJ8M6GuUc0KFuWIYFfk6oeeiihSGvWRMbYwXd8V5Stlc7txcbSN4g4za2K51C6CIE6wc9RMhupkyZdz08I5uuNEfGu4837FaJQGKyC8Kz4e0VJy6J6j11vxalTXjbEcqYbErf0wjCk/qfb6lNy5cQJSBX3e1MevkqCktNO/DPOBlk0vbHuD/Z0DDNTGTQtLsphJh/VCMpJjPcLjWYOimy6Px9/dqqofmlikabma+7CyRC4td5PnXPzrp9OqPWFSIOTrMJ7uodtF1Vzf455Frt5vA/2oFNlwO8hh4+g3sMa4xaVY09x9vG8Q7fllZbFJu3ICsjqKqmwsNPpzYbOq53IRk3l15MFQ3iTCgP76jywaZ8k+oTrI+W8UqokpDR5yvhJOWPM4h0QeT4GhGrQy/q9Ccjen0Xe7Qo9+b39uZ+RCPQbOHC5BTjBElEfzE3/bxQdJyseFahenpeijlh6zdpYMT+vB3MV2SalqZetxii4BExMk+gUfSkRaBvpIuP/wWR8aC/ -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Applies the given list of labels to the given workflows. Existing labels are replaced — include labels to be preserved in `labelIds`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/cancel-workflow.api.mdx b/platform-api-docs/docs/cancel-workflow.api.mdx deleted file mode 100644 index 17ba2c2e5..000000000 --- a/platform-api-docs/docs/cancel-workflow.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: cancel-workflow -title: "Cancel workflow" -description: "Cancels the workflow execution identified by the given `workflowId`." -sidebar_label: "Cancel workflow" -hide_title: true -hide_table_of_contents: true -api: eJy1VVFP2zAQ/iuWnzaptN1W8dCnQcUkNGlDhWkPqBJucm0NTmxspxBF+e+7cxzS0KowaXuBxvnu7rvP310q7sXa8ektf9L2YaX0k+OLAU/BJVYaL3XOp3wm8gSUY34DrIUxeIakIACTKeReriSkbFkG0FpuIWd3LfYyvRvyAdcGrKCIy/Ql6e8IwddGWJGBB0t0Kp7jA8K6HAiRxMYIv+GvKbZ5mPNW5uuOk0WohcdCWsCq3hYw4C7ZQCb4tOK+NFSkCeJ1PejVdUYk0BV+LMCWBysHIMuLDKxM+rX3asncwzq8WmmbCd8cnU561fFVAsfrNvox1J8Uv1LCUz7msDoDkl+umPQsEXmuPVsC/cIAhbcUY2YXzFi9xQAbwg6xXWqtQORIbtHoCM6f67QkSKKxldzTT2GMkkm43NG9I37Vfi69vIfEYxUvvaKDi8z4krLNm8RYBUXAMs7o3IGj2M/jCf3r9/7zOzthPzRrGWDQZDzex52LlEXSWPbdfDu/3PIMnBNroKF43QaKh472siHaAg+5quvYWm3nsb/Y7mT85UCH7awwuj2h0NrIh+AOx85KX4YhOQdhwZ4VOBHT2wXdEU7QRtN8GR2aDtMy5aN2jkZVN1H1qPEEXTzYbTt5hVUYsfHeuOloJIwcJkoX6dDBI5IaSr3nxevwpjPhjPDs7OqSE6WW8TUJ3Ii1y/tFL6rYejB4L4DwpPnxrR2X+ycflKCLm3eWvHgWmSGVq5oGZ6VD6ih8ZEiU3iJPUsgEXASTa0QSXNMXZlcONI5UYZJX+mv3AomQqk2dT8PT0+GYzuhqMhFMF+c9DvNTtw17HHdm7V8t46i5h2c/MkrgokFiocEqeqb7JCB82tvD0TZ4txtyGUKraikc/LKqrum4WVlkplQ6sVQ0SyuhHBxp7I1FepDwA5R7u3orVEFITvv0/eX/yz49Qrpd8R3dBT1YSXz/UroP87ixPrKjH8KDdOKhyMtdNrvaxnuvF4jegMD+Ar8GMGtYnNxQmi7B3oal22gizpIEjD+K3V1kVz+vb2gJxK9OplOKsYJsSX8DWR1UCbslnFVciXxdhIXMm5y0MkR/47zaMKGrg3KgvQPiRj9AjhZv1fH0TMLU9R90UjeS -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Cancels the workflow execution identified by the given `workflowId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-action.api.mdx b/platform-api-docs/docs/create-action.api.mdx deleted file mode 100644 index e86ca8635..000000000 --- a/platform-api-docs/docs/create-action.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-action -title: "Create action" -description: "Creates a new pipeline action. Append `?workspaceId` to associate the action with the given workspace." -sidebar_label: "Create action" -hide_title: true -hide_table_of_contents: true -api: eJzFWG1v2zYQ/iuE9qUDIjvNum7Lly1NuyFb2gZximELAoSWTjYbSdRIyq5n+L/vjhQlylZidyi2L20sHu+Nd8+9rCPDZzo6vY14YoQsdXR3FKWgEyUq+h2dRucKuAHNOCthySpRQS5KYI5+xM6qCsqU3f+4lOpBVzyBi/SeGcm41jIReJWZuSdnS2Hm9vdMLAB/+juj6CiSFShOVBdpK/bMXsPDiitegAFFyq6jEn8gUSATaQSp+1cNahVtG/G7J2RlXYASCRMplEZkAhQS62QOBY9O15FZVcRYlAZm9iiTquDGfXr5Itps0EEKUIo2r2S6ojt9UU5lllj9WUOKjBKJPEtDF3hV5SKxto4/arq13lVBTj9CQhcrRZ4xAjSdOstbKm2UKGfRBm2QtUoGjo4iQJvpiWfo/HqKH4xcom1oyKeYzuIFV8RWDxMZYXJoDRtNnByUmPO6TOb7VRbpkFZ9r11aXgydlIlZ7eIgeKMRyUtkUdUG3pSLiwM4njtqBuVCKFkWyCpgyJZzUC4025Beijxnqsagfg0Zr3OjKY7bGGOVEgVXK5YMcc6YLIQxkFpVkcu7wYfa0bLWRhYkldETMAw3qxRJzXK5ZPAJkto6nvh6XfczvvJWKaikFkai4h+uL9kzGM1GR+x+bkylT8dj994jtGlcwidDMmMhx3PIc3n/tRVKurwWar9MyjKWCoVBQOIqjsnu/NyaQ4mlCkgtMGQiJ2DBc3SCQtf1HD/k5mVfwrbXYSG0cPn0tKa/CMM89RGbKo7Bd8TI93xGsmsNlqMGrRtE2sfyXeM91twJg41eVYGuC7zIMo5mp/TkuglrivkrJa07AkFcKU5QJgwUejDnt5CH6JnMWKtKP50qJ8IGmvUw4dDK6oD2qgkgZpkvogCxQz9YfiSo4A9YAhZoOJ+iAvglTLw2yGyafUE1utT9PF2c227Qi5/x7H1fc5SFJ+yZXIBSGAq6IXBB7xLLQuy5/XxAQufcUDGKdQUJhlWyJVFaQhdStlrqwwxogaIrsZil7NfJ+3eUEH+cvb1krgg61gqu63JiGexnfpam2Di4L+hnbho8AyuDHF9msasjngpRlvJQIsFCPlDCtC7GAE4wuUCP2ASA3V4hcnBsPhDgTEwQ6ljou2ce3VKZ6JGGv7CzGCGqVd6HSS7rdOwEj3m6wPyH9Cu0LUZ+secXN/zca9HXL2M6z9DLjGO12TWNzfkCLPblQLj2f1hacHG4mTnaUmIIotZ0z1tMYU5A02L6Kbun81GZ3VshCI5qdViR/L0thnQHnYBVxJVLrC4lok0vSl5PLk8ceNuW6jARREWQ0WsIHIOwHlgQD9lNpcyBlzv83pQWXRw9ccC/DFdmoLCzTGEHQIJzrg3TdUKRkNW5D4omBq4dL96xwIf7zABIOJoUO62+cv/FPPYMKRKaWK/z/JLafnOArVdI3OhPNxgini2A2+5s7exaEvdOpp5iYh3iVZdBlFd4x3ZNtmFCqRQCz7osQrSvVcnSuihW9hVyH9yEk4X4u5009kXG+4D+8f60SdOu6XLtOAulHfpW3mFxeHlMhWQhYLlrxQ1Xs37FfLwlLnisgZAesYXlAl8LXylkhh2Q5fafW4TlGPKL9JDC//h09mgrYLmzi9e6GU3FrKS/APOhC1Dq/YnHHHj6q5yeV/V+qd+c7GJJXUwR31Hq+dUHTTgvE+tv39y3UEWC2Ec5DaW+hQIT4+3030h2d71Eiy2PiaT6W8CMT1eYPaNunMN2xCBMwwHtfkvKcC6aQYOTuyId42aIS9ETbrYfzL3WQKKLMVhgR+wNfkQsLSqH/g54BqbHJfZgbgqn6WDTDbK+nLiZ87qZ0EOKcPnQnW/c5I/TB6puVA2uIFTYdbm+/eT4eHcf8P63Lzf8uy3KEGo9rr3Tj9RHkhdDGr7CiPgXe4rOF7cRvojGELDrgict8IRPGvBGKal2NP9mwLd+ZcRKaWzYL1GfjR3ckloJs7LboleAM6Y6q80cf97RBgf73LmkNRM1QHa9RGfR2G/BiIFa+G1TrXI89FDHKzGysNbh3U6MTuwJ8z07Oyd6dnZ1EZF0r9yEfOn8EqrYuoYk+u2ULYuWCL+4P372ufJx6cKX3ui62029+cSpi+y2Rl2a+WVRt+7pljm0ruko+0uX7nu74eg+dcuJ7lu7OwhutlN6oE83Z4ei+4PxrT+62xpYw4PdOTI8DSe7TlBvDgvsCaao4GtvAAq+98eD7iDspsOlXNv+Bm4IOtbQYa7pJMjpt2buS9s/uZ/bDU7HaLBp6I67Cnx7fLdVBY8H6tPxQM0IakUI9AiNJy/i4+/ikx9unn97+u3z05PvR8ffPf/Txq0oM2nDvsn/JnsoXfYlFqWpwJ6vISbwwhwmZv2kDVMVXSxyW0Mz+VN3gIo0nSuePR+9fDk69mNfwcsgi5xVzUp7W8N1B6D/3eq8wQvaOFDrJUq70yEHrBto6y345wR6+Gm9nnINH1S+2dBntzonwEuFpvEFHy7juYYnTNyzWB9U7AFWO7v7Bc9rorT4uOBKkHyL1i7wKLZQMXf13ImPb4h7d3enXG2O/I0znKkq8yRtWBWu3k9uCGabBX8hU7qj+JKyEf9FPV02kUOpFNK3NWZDOattdYscTwpu3sf0LQy3Vvl2t1wFGuLjWIob+QAlPpD3m6HfqC4y/weXzhlp -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new pipeline action. Append `?workspaceId` to associate the action with the given workspace. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-avatar.api.mdx b/platform-api-docs/docs/create-avatar.api.mdx deleted file mode 100644 index 30844d2b5..000000000 --- a/platform-api-docs/docs/create-avatar.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-avatar -title: "Create the avatar image" -description: "Create the avatar image" -sidebar_label: "Create the avatar image" -hide_title: true -hide_table_of_contents: true -api: eJyVVcFO4zAQ/ZXI57QFdsWhpy1oV6p2JdACp4rDNBlal8Q29gSoqvz7ztgppLQq7M2138y8efMm3SiCRVDjmYJnIPBB3efKOvRA2pppqcbq0iMQTuKzypXHpwYDXdhyrcYbVWIovHaCZuy0hgVmD7rCrMNxRGENoSFB101F2oGn0YP19aDknHIdiiXW8URrh5zHzldYSKzzQoY0BnnVkr4HC+S1WTBMsgFXUHNtwK9V27a5QlPYUt77kR2Z25QAnKt0EXsd2YKQBpwSoZYEksJjcNaEVP3s5GS/46vfux32M66CQL7eXhrBF2Qoo5bw+gfNgpZqfHaWf5CEubO4mGZXHpVMcAPSNUpQBYHuXPk/QRxFmirBdSbhm8ZX+/F9aN9VfzuVVRL9+yGdL6A8bKnjgkuI9tLMTNUYgrjgPv9E3y3waAM/vbf7zL8dcMh2mzJjKYOqsi/MR+ABi8Zr4j2abdQFgkc/aWSes/uWSe6mSYJltMQs+SRLns6ZLi2tbKqzURwHkkONthsthfwz+hDrxMmoJZEL49EInB4WlW3KYcAn5jnUVn2sfBNfsusKSOafXQo+m1xPlbDcNnEjmif9+q28SSgVhUqEyaZGEN+kw6+ts1YvFMXR5sHG8E7vjoWU/YygtKsLDB1YzAJFNMtu8/2W2S9a3qTsj/cHJiLKpTqnw/Pz4YncidI1RK8ZqPHoeHa4vslB+EojV4E2vXVJk9v5Fi9lpny12cwh4J2v2laueRG8+IaPz+A1zEUjtg0HIJSsq4z6EdfCLO3KIH7yBF41QuDQp7jNt0GTokBHPfjemsns35x3fXVzK6Ps/hRqW0qMJI558/djIgm73vjghUi+ewKz7rFgFSLi1j6iYSXyji7Jb6bEW/gPyRtZcA== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Create the avatar image - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-compute-env.api.mdx b/platform-api-docs/docs/create-compute-env.api.mdx deleted file mode 100644 index cba8c2276..000000000 --- a/platform-api-docs/docs/create-compute-env.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-compute-env -title: "Create compute environment" -description: "Creates a new compute environment. Append `?workspaceId` to create the environment in a workspace context." -sidebar_label: "Create compute environment" -hide_title: true -hide_table_of_contents: true -api: eJztfWtz28aS9l9BKbV1pCqR9O24zvrLLkXJPtyINl9RdirrdYkgOaQQgQCDASQxLv33ty8zwOBCEqTkxGYmVUlEADPTc+t+uqe75+tB7M7kwZvPB+Nwvkhi0RDBrTz4cnwwEXIceYvYC4ODNwedSLixkI7rBOLOUd868K0XhcFcBHHTaS8WIpg4w/+6C6MbuXDHojsZOnHojKmsE1/nCjheALWl30KdQSzu4+bB8UG4EJGLDXcnadMdbvIsuIUPFm7kzkUsIqT860EAP+BDo134xkOyf09EtDwoduaXtNEgmYvIGzveBCjypp6Imk536oRzL47F5FiRLqs6zPQnUkQm6XJ8LebuwZuvB/FygUR58GomIng1DaO5G/Oj168OHh5gkCMBFMr4JJwssUxhzCsaVWOpykGt1HYQY2l3sfC9MQ1c6zeJVXwt0xOOfhNjLLiIcJhjT0h8O86GF35h9V4kJrwugqk3gwI0ylDOd2PsSuWTNR+rV9DpDZRAuzgZri9x+lPCZRx5waw0l53sc2MWHWi0ctLcBJYhfMTD1HQuuKfSEfeejKEBZ+yHycQBmm6huqj1737HMUhqOgMhnM+8Js0XXw6v43gh37Rak3Asm1L8Dmu46YUtPQQNd+G1ePoaRrmj5sEDrPholuvsylWDS8adfAh8WC9xlIjicHyIZm7g/UG9q1jdziEWb4RQ/tiRInZGS0cuZSzmTIe5hZ6AmnUbbRMpHlEwd+/PRTCLrw/evHhxXFoL65uv2kCuv7h2N1AzEwEyIDEp0sSMJkfV82fPymTlyfgYeLBbHSxM6xIZYSUH7SUyRmYiYSk64dR53oDacxQfOxNXXh87UEsSwPKU4zCCyq6BH46RHRKVudbzQ/hsM7Wn2S+kYTWx7r03T+aOT3W/cbDuIiXp9i+Q8c8yEQJ6iOzGvZONkRuPr+EZ/k3bEf6eheHMFw3fmwJ9ngjGwC3Sp7qA+qnLuH8kUfaSf+l3N/+SDYM7iZvcz9mNMH8ms9xP6Sewn40HvpyaP10/dr3IfDIP3VGuQDh2/VyVxC+0DDbrWj8etXq+VV83da4wFsWelfv+5/b1EbP8l/W8jLbUhtNfpOKIdpWSpCW80NeSRi7EGLja2OEvk0gJuwEwyXEM4+NMBGI16cAexw0uhQ+iGPidbhChzHoxjZLi1Is2C2iUAc4EZOw4DqOls3Dja+KCEn6ivEXhEs3FxEOBirVO/fDOmXq+UDwkEhdJMKAaN7fWnkwAlfET6Jobg2AX4wQxnMd9DaYN302C8bX+ahF5yJRD+OA2vEGS3gOYIyqgy8BnpNBivw9D5wLGXYQybkRJoKqoIfxpQba44ZY7uXWBgU1+gr41oL6Grq+h6mNpg0+fpuvuFMYYBIlf0TXn2r1lFu8Dop78JT01BIvRTzeKXATvHshfuRnCauG8fpTODCxw60aeO/JZNBMht66f7FoJlaVargFKGJWMwtAXblCeMMDrS5gpT2aVwDLERZpOE1bl/BaO1MYntvBEVWupDrXjTns4zsF+BeB5QI7zPxHDe7EviFMhh4Hx+KSaKQGQysGSSA2CPrUpqxAGAS5FbCdleRv3gId/ur7ZT4MJYruoJy3VOi98RXxn1zWuiW1wXQ2si9f3xEMi517gAtPb3AvNyB38zMkVLqNmVwLfho6lsoKZOdR01Cwh5IcqYtQ2Wr5nNTr/HuQcjBdSiRguJ/KwH2oZ9OBFfqArBAjwnw9TUtifSLSkk3eXlzFKqo19wNMi+od0JMBSGCWcEIXnFdgeIZdz3JEMfZK3KJyQ7RkKmjPHD4lJ0tDfRcCPHHeM3NMKqL+JgNoTPsRf1tpbp+luursWkSE2YGzkE+2enKltIqZu4sckGYaKBQyJarSxva8l3D/Cl6maPRj8G0czYGaI1aIthwRqEE6UpIbZrlf1v+FLqhpq7vYddzKJoAuoIZdrXYRRvNF88vJFqQ2kGMs2nVMejDfO8MWLYYop/l8i6qCTy2tlbFDq++9YrMAU0XA5wTFRrCaHDHhbospgoI4dGq9sGNq8u/agyYW3EL4XMABxgEE7Mhnxamg6HVhYsLzCWxFF3gRWE5pisJq0VF63QULn7j0ROfD+ELsMP5I+V1aNIJmPgFjoBFGXbU+gi8nUeIo7KaEU6H+BCBOJmzqbwOfPnmUz+D/h6AM1J7fiIarFkIumRqRqlIjC1J2BNvXvVQ2uQo2wHcmM5gzztA5pdmA3M8/yeOWYFDTSqauAlRoktEfQU3ccv4MZVYz04fhrQfhvCZU0dmE8icAnhycVNzVU8AIesrrHXuke8M+XB9OQZGDU9i8D5wQfbgSq+blFQ4U7E5f0UdXsAHQYo7U4XVLI6SKx6vSi9PktiM+5kDVWn6qlrGKdDBxVCw71PExgcRwyuwMW1EIx10Lx/KaF50Uu8M+Ifg930k8ev+kiMVPW6Q08EOaMv1UwBIRumESAHpw7D9DiSKgTsYlzKJqzJrCuRDaECxjuuerbduLLXCTcG+bvyHIB+QSIvtWihaK4LoKta85qPL1ovzt7n1q9NIrv+jCVMBnqfV0cKJMFogcxuZLhNL4Dnt1iClsoRm89cXdkkN0NZIx4cfW6zq2wzgtQP7gEq6VV9KeTMH3efHHvu9FM5GcBZMpF6NdoD79y2hfvcYnNIheW8xQWbQP+hP9NnG6758ASnHtSkkSEr1bxFuDwGs7UaxrrjnTz2MuzzsCJXXlTwEVbILKquV/NapXw/VYDtYbH+17fja9rGCgQ6auqsG+d8y6vDt9n7SY16yhmkx4uVuoeVon+WyjRal13FoncBZ6/TyF5p/9RYj9DkqPr17RqtCfmoMv2Rrs0zGV1g7i8V+7fY1x/czFzR8tYnV9YfLlP+BK4GGykswB/1hkH/tL5/AtvP8UOV28wrP3IVB+noHYJViCnCfLwF9s3/pYKmubPle1zG0eGY0yB8hW0BbewYgaMlLcm8P2nnsjQhcLbBgll+tmaFc7eRWGyqOEkhNzqFxLA5+FMgqCEYspHSHXMgdrkPtn6eCYHgbuQ12FcR/0vLJe06IbF0pol3kS0pP78aPPMQYdmonyAzRDpLb4sjKCyfDSdz8Y3dcfM9GxsparhT/TfBpHSMD7RzO8IfcXCObn/aZyT1wxybkUBsTKF7/LEa9ZDCw70Pz9c5vGHMmnJzafu8Qqwrr1nBv0Pl/AT0Dr8d9WPkrtB1wT2TWcIHw0VodJJAjqhjxL4GpdHGDQmYo79NXUCmJohNpGVy5caLMI4+9g5hH6T46SMebWCurMrLuh5AZnsCBWQowSuORjuDWeLc/d+5yaVlXDbJmeLZGvm+K7/0RhlQhQj2YalORi7fh15mVr1UkIlmu3RZoArvCHuFzCb1NbEAy1nTR+c92FML1ye1TsP9IAVe9wz9MvH2DY64XzuNqRAn19Ee75yjkM4difyq5AWMA8SobVBjGVmy3Vb5uRscHn1toubQ/951b/48O7ibDDofjpTW+eq0+63O93LX68+9C+7ve7/np3qN/2Lbues+v2PWXeJP5yiq/UcOZRzDfyKuSAbfmSeC5C7N8zw0gmTmBhiqjPnkEMVxUPijxl7ySrFX8O1NHPZPJPhVTgHKFHLjzgB3DF32r2u0z3FbiSS9XSWuMiwC/zOOAJD2XDuBcl94wVaCxoorubeH8gQsH3W0+ZCxDK3tbQx6x+S2tVuW8pbyzwcw1I+iqIYkQTsY6j6FtCY4aTZnrt/wK9881it6Qqdmc8APeMREGsGi3GdIfrU7+DYYH2BiFGbh6+oApmM4Mljdvm52tXYhqqNlHUZYrdp6DPapxHMlHBhEYbQ84jcYXEISORAUaYJ1l3kxUuCiE9Bmq5QocfuKVE4EWhvQZVc0FdTkPR3qINHCbm54MwjyIxCn3qhZwIPC4Evu1OYcMZE8r6HdtvN8/B2cE+TcE5mZmXtXYSeEjJQUb0jzUI9BgPPlEaobNfjtDXVS6gS5cy7E21+XoRSfAhOgadot+W6Um2CZRieGcbhaxFUB21IVYBXvhi/+Fks+26dE3GcvRuBHoxelB4wG34gJJBOkvHN0+wEN1MrBi+dEder2vOUzrsKZwBCOAHxd7Pr1GXnCcWpYshfH8QcnqbnHUeOQjRlwOAc3j5nHDjyJn0BUwha2Wwn0jU00/BgEXljOox28+Lh2HExmmmRNqb5aCaAuCjbetw4DzKaRURLxxFBSBKBRQY0DhvT85nlJ1GE609iKa4YluJIIP4nD1zm/XR+CvOfkVU4Sv4PVrfFVHIIyjY7RQczYQTX2dtBCbFBpXXEwJmOlCnUARxRV1OTkRUrMDgZLjnD6JAdW2xv/XjyQxRHfWNQ1Z57dYZOoQtcUt+ArJKWcBKG8a4sAMuyPkAcAElO6z82GIIYy7qGEgWx8sqxNqXiIQv2B+Y/De5jJ5XRMtO9dZRhZvUdtkQ8bgEV+G+T6x7yqgIiCSRozxPyz3HaPvyNy5csiPTh3F2i7IBNxkF9c9efwg5G+vDDvFmiQisiq07WgVwHCxPs3sG/hNSA1nmLQRsUbTG6a03ELfAE2P5sVIE+NahSZd9pXsdzX9l33Eg7edTfExdJULa/oofOW67NsIdJXFbj9WY4QuY5RpgpmThycxhxv5lWDuMdVCiQyAawIgIMWeVKqkbz16+23vTti97rV87hu8i99eIwMPeG0R8m67ho4jxmaqrV2l0OT7sbD07zjjK01FIPGbaWTS40uNnmFCEDEX3DjqQO4QtLIwVP+kQdNp659DPP46OySV0d6GeHfMflR+iZkYvdMZwz3tFzhwy1W/pn/OnOC/ascv/PKtedVe/JAYE9mLQHk/t/MAnLFRduHXSek0GqnFZq6jqs5epQnmuGZxoqdZHra980wH41Fn6uTixCsEkJj9VtNFxoZaWLPZadehHomlSjqo1izUcC8yP4ZGlXpjSCgu3xGBW0s7nr+ZupHnAhtFiQWiewGIEf9EliOwbLuJy9ditg1XPRMqtwlR6C4HkD65i40YScAHND4OpBKHizmebQ2jZjUOWU0YDNvGQLZNVCOCqJCfwysDIKHeUoBQBLq3KpEvSp13Q+fxzBcCXO+eUg2wzE25sMnkhxUHyEdkmLWpetUDYmAnaDL39KqI4rmOsjRy2fRTLyMeUBfavc7ZVO2USEhwdNDcFb2FT1XFBVhVg458KNqHOfemvomsCnDV992ridmwT+hLFqV8psDYThTzVypAd0Pp62CyME06JOYXFFAnfVkcpN54M2ch+D0EQu0Qjv8AhuzFqm6qf2EnVvYVyI6ZCGN00oDDqC2oCIRysa+TX8NKd8UCA+Bf0bFfh3O/ktYUm9QEepOq/Xmo4xPwtmXpC5XzSd4WKSbqBhujFwF2HKCbR25/bRP5857060tdDcRn+h2sKs8gnVFjOrgOlSjo9/DKVld+fLzbjfgkkLJv8WYHKT5rc1gGEG8qnHRlaNYAaK+16dvpBXty8VWFwFQekVM8Ga7nDcqi5keMN96mkXODrerXUo7EVxAmBRFclqVcBZJqP081omcqLNLKVrmrsBiPRJl0JL42WdyjAetOFK6c0QGagKVNaneFmitdBCx/fgjzrt9Io1j6motvUXko4p38VfKnNtrWjhPJw5bZCHS6hFGlnzVAvzMPA4n4qu/RI3Rb1zYGWXj1NGihgp1yBbPt3Y7YS+Si5wFkzooGZz9adQDraWLugIVZK9K7TXZb72i8SvNSzFuvHQXY8JVO3Ayo71oDwCj+TF1I2ocChaLXpMy27PXTTPQD1bXg3oZZP/d1U+Bn4crtGe6jlkU/GQTLJmFqSySfbdz2fpCcoWGR5UJT8nI3LJMHIo7i1QspbffbD8orFD1FhpuZXN/j3QLmhSHy/OU0muCVzCXm5gMjKMxERFWcl0Kf2OiGoM6GBw7oxxV5B/GEFBQ6oIHW2lkx2QPo3PTCp5E6eJDEmAbNXPtBTx1zRXVxYWZ6AmpR4OTdg7yNmRtmpaFqxJhoNeRQx6LrXASqoQmT8tSWoGNFDXbBMXr9rn5UFLU4qqj2F1kqtr+ey4noM7rLKfVMMNoy613ji2ouO73rweOOijuUZiitlPpOJTUUYJdDrvStyO7BHKla9YHMeO2hMxun43VKGh8qMkdx1neAFT8gumCAFEtRxqK+FcJ9ZQLZB7Sb1IxR67lGC8orKELNIOaaPFmLq0ojfm6mmlRDNLnHRQIWHEXRi1cALV0ktgW743Xiq+h8ftir8RFMz8kMPgSibUXxKkd+4S/wjELZl61r39Us6med/AahugOdKe3VS/oQ720171iW69UeD5YCHGj/TygDFLw6hXBNBpKy7M+YAEeBgN2QMYfSUB5sK6wBypMUa4xqYfLurv3sRRlDq/tnvnMIs65SGoZRGZY4k3DtHh6s3QNG8/TQ+rnA41p4De/xX9s7aZ/bLNfKs42lpR6X9SIG05jnYvTt0Ly0BhzQwHmurampdfvoO8OdagbJnWFkyrhum07hk75ukyrRLqCLyBYSANOs7mZBb0th7KLVZJfatjjN5oKn9I73konTmZFFaeQFV/YLjRlXIcKZuNjtBi2PGdG1xSs9R2jhCpDDnk8ToiYcI9p5xtq90u1rEudNCvsZs+ymJM6xMd2hb8rsnROhfClW9wvEj6pu2u/vjxSAEEMJJ+kw2cXCp28L+oJLLSK+OVmocn8s2R8vrUBWhRJ2xIHRZh6M6Eyqig7FEym6XRbPK6O8+Hn6zSBFJvaXZj0FFBXDXbtbHqHoD9XRbDKRZ2fPQJdw6fNV7yGo+jMMEcytewVDTN43CxfATRWBx1hyztOqjD/ci7BWDY5lSXNTfFggsZOTIFppkH0XMYhA4IAczQ6cNrqVOSjoS/hRPAxvipVfHC3FAK+vAP3gJp1FjTmnj/HiZeq0D9sAoUdGMqLzGxXI0l+v7twGEtyompCF88wcnAtX1P1VkzZA2rnGc2xXKUmtVb9ktvsY4wVbTJLY9NBhTeuqQw+Sq34DSdNsbzozQJqnwUtcthHGpZY6aejAQsgzkHB+I+hy01SbTLQbrI04Tu5K5Sw7+l30l9W9K9xRkK6lUwSL/lUxPDdxvqNiVDGlQm5sgda2xePaxxmnQ7cqaJ7y8bvyeuz/HEkZiKCO/L4iDoz596huuzaqm2o7Eq2NAF5dExdQizfVA0pn4BVQ3xKGvq3R+bh3UbOQKMg/w7DERN3rWNI0d2ZZbpoorpOX8EB9UnSp+wCv6vzKGwLl/TDmmKOWHsiwoNuJiYeDtPwXICXl1v/LKJ12cl828a64AWsrrJccq5azQhn5Wr/hzPtjhDLVS6cyI3evyTcttrcFx1Q1kwGtQ1eOgdZU7sZLah6rFdzqQ/EpxwgbA3Ur/JRGRVxP1XEfdEWbLaiNVG9l8b+UaJYB8TEeZGIIRiwa4ZRh6KUrY85GSljPWPjiBbWfPOCa9y1yqtit58ZM6ZHMYZ5Q5CdMqZAsDh4LPhbPFyWAhBQ3dphTpyaKsfhbgU21HNg8ZhN19wSMn2dQucucZEZsDlpUQ6XL5E4O4aF77yeVJRdGmyJx26yGGKaeoUSikIrZAnjwjCZHZdTOIPFRqaaB0Ax3qodo7P8rX47lgQvz2UUMwXKv2edoZ9oiR6g4rkeWZqPK0iG/nU9il+sHC1sKGfDfCNvTrRImmLpL9rJG2vTrRXJ9qrE+3VifbqRHt14n5aF/jqRAxSq8KpNpDTAs8fC3jaQE4byLkrSTaQ0wZy2kBOG8hpAzkt3raBnNYP+RsGcgILj10vqlS62vTK6Z8M7AmBVdT2VVHbC4ZgTwjsCYE9IbAnBPaEwJ4Q7KvGwicEvpxWgtXuSc85H7y1SNUiVYtULVK1SNUiVYtULVL9QZBqEnjx2zA6hzbjaodmaIDNpvRNxTjyN5euvLkQZPOr/sZi4v3DxHw/TCkdF19mQI+tt4yFtt8ztK0d6qzuDsndOodxzYkcZtl1+rBVN9fF+ZcW8O0GWYZ3gGGVhTxaJkPQt8ynC5rCR8oH+vnLnE0ojs4JTrYLm7nLb/O3kOmb1HkwCmmknEmCva08QKaCyl9gPQO4nV8u68SFpzfI4Ge5uKRsdMtHzybhqqwJVrILaF7RBTQsLuadgmvNDieVn3opFzDp++UaoB2OsYQBxsEDXq7uojtmzh7hDEtM4EGFywANa05BJbsowLpCoDaLwju+07lwlxz8j0PlnqF2EzhJkMbF45cDfF8/AA+LNDT9ej0bnaSgKE/C9hMfglPBjiM1qqdPdU16UVHniOhVvgowZhPB/ITFqYpvvBCz7uRxGRZ0pCRyAfgqd5FOEez9QXQXbrSOwxsRnGpZuFkJ1VtUaTKD9sChKsyYLc05cqD7hXLx4ZHA3CIfgk7qtVPmDu3cApmYI8/qyZSvQfmO/X7QoaDo98MdQQ5a6v8mbLV6QHAJVoxIdYiuBb37BHptIPpu98P9IPbBLe5BCxKfrlVl2FVlSuFLcl3nc+n6Nb4kbbfkL5m+laZ/0fUeOW4cu+PrzDxhoh1kgscpTkrHs+SGHeZKIXgYpAkDdw0Cpq7pflQGA3M0eCf8IQIsaufr5tyLqTlRaQ+8pNNLiJ0siZJ0PuNVs5EDm3ThvHLQ8rzTMuGvGurZT4wWGpgeynzeMITT5gTRT5DbXtm48fK6C4EOzNBnJay3sM4h+o4w85MLCIwS95J9ToE+JZhf/MuZAFDASeZ9kjp3j4HMViLTFJib87NbGb5PMnxHJiZuquPD2pR8yzn7eWBvC7Rms7+N2cwGmdkgs11JskFmNsjMBpnZIDMbZGZRvg0yKzNjG2Rmbwu0twX+LZnWE94WmJkVaQS2vRUQi5tGDX0z4IZb/+pcHfgtbwb0vSl0xcPrDqRpplH3qOFrR7//3m0sq2YaXuFlj9ucZT+su25wM5sSc+jVqNIp4GGXy/8e1t6B97D+aruHdTfVkZV5i5vnHtZeIfdQ7z64hye4zu1p5MGWoGc3wFKPT625r+ph3c1TVqrtmVTDqpJZ9cHfxwC2loMe0fquIxtFZW3me2oz3wvdzEZR2SgqG0Vlo6hsFJWN999fxPqFUCso2QVHDbSKnOwQ1qSOyS6Xq0IbSmEcyOiilTfUlT7nQ7rHuLefnQzUUR97TdGR4CFzOzzVQynXQun8ppX6g9JvdUj/3ZhHVhvCFArJIlbo+hmQENqdftWVhdtJL3ORcG+YvSPH1cd66cVEE1wXwdY1ZzWeXrTfnb3PLoRVWLDrw1TCZKj3dWFg6pZ4JcNpfAcsu8UUtlCK3nri7sggu/vIqxyr6E8nYfq8+eLeRxNCfhZApFyEfo328Cu6TwiW2CxyYTlP8X7EWcQXMHbbveLtQqtYCzB4jWbqNY11R7p5vhpz4MSuvCnAoi0AWdXcbzyH+lYDtYbF+149nwP8KnVUxstaz7u8OnyflRtPx/goZvNID1WrQ++DDv2tTnXXruk/91D3uHyqa+HlPsFLG0W0IoroFlaMijbZmsD3n3oiQxepW1pKQpl+NmZ9mys098TUxzM5CNyFvA7jOtp/YbmkRTcsltYs8SaiJfXnR5tnbus4d2X4aDqfjW92voKbY7Dovw0ipTKqRkdeC5ninLxmYDrAoRRFpx7Gd3niNeuhBQf6nx8u8/hDWbTk5gj7eAVY1y6Wg/6HS/gJaB3+u+rHlxLiNYF90xnCR0NFqHSSgIJ2ooSPkZ0waEzEHPubuxcWimETWbl8qcEizK50Bz3BRxdZiudR4XtesCsu6HkBWewIFaT3kWLQ3spAc20t3LlJZSTctslH35HLiGIk21uE+qdGvZRQiVZ7tBlQ+L+4X2DmBGyLrq5d0wfnfRjTC5dnlRwxV+xxz9AvHxe6P59j9Bu5ecMQ+56MKToT/anFxClppuoiZERrgxjLzJbrtszJ2eDy6m0XN4f+86p/8eHdxdlg0P10prbOVafdb3e6l79efehfdnvd/z071W/6F93OWfX7H7PuEn84FRi1hxzKuQZ+xVyQDT+yfDv0GGZ46YRJTAzRjALIkEMVxUPijxl7ySol3+G1NHPZPJPhVYjOIXWuGlYuz+1eF6N/jeALlrjIsAv8zjgBQ9lw7gXJfeMFWgsaKK7m3h/IELB91tPmQqhEIHpraWPWPyS1q65YZh0jfzaGpXwURTEiCdjHUPUtuvlnCSZ0MFuueayWYU6+RamvnGbNYDGuM0Sf+h19FbO6+hi+Yv9yun75Mbv8XO1qbEPVRsq6DLHbNPQZ7dMIZkq4sAhD6Hl07Ch1jEQOFFU+7090DbQmTVZcBx3iqSUeRoFKLuirKUj6O9TBo4QStZgXRmMv9EzgWSHwZfSIHzMmkvcrvGqKBL0d3NMknJOZWVl7F6GnhAxUVO9Es1CPwcAzpREq2/U0bU31eDu6uhx91wwzqVRT+T3YUpwahzHLTI0MMztfLZ+/VT6VOHcnyfjmaXZC5nvmDF46I65XtecpnXcVzsA77UH83ex8qX16nlCcKob89UHM4Wl63nHkKERTBgzO4e1zxoEjb9IXMIWglc12Il1DMw0PFhHGpVA2h5x4OMZIKBdto6oxzUczAcRF2dbjxnmQ0SwiWjqOCEKSCCwyoHHYmJ7PLD+JIgqUwVJcMSzFkaA8DvBe8X46PoX5z8gqnCT/hwp4mcoOnXtss1N0BrBA3DlnbwclxAaV1hEDZ/ewQkke5usAjqirqcnIihUYnAyXnGF0yI4ttrd+PPkhis7/YFDVnnt1hk6hC1xS34CskpZwEobxriwAy7I+QBwASU7rPzYYghjLuoaStVFleMiC/cFQxgikD0hymaY8SXXvptNeLEQwyay+w5aIxy2gAv9tct1DXlVAJIGE1A0e3XOctg9/c3Qe7ED6cO5SOjDYZFjGhd/+FHYw0ocf5s0SFVoRWXWyDuQ6WJhg9w7+JaSGMdItBm1QtMXorjURt8ATYPuzUQX61KBKlX2neR3PfWXfcSPt41F/T1wkQUUkEkzDW67NsIepkL61xhzOMWMywkzJxJHDsFa/mVYO4x1UKJDIBrAiAgxZ5UqqRvPXr7be9O2L3utXzuG7yL314jAw94bRHybruGji5Lx7K9TaXQ5PuxsPTvN+MoXMc2SimlxocLPNKUK1A7s6hC8sjRQ8GQnqzKV/SP57YeAvK+K8aqbiyHtjkFn2e4/keCJYt8qMsRLbrbMj7eA+wQfZpqq+ymHCe6RjgK43ftnETD8JZoLIKbOudvUsFDRV0tp6O8U71VTayzq1JuQzZ7FqzDEimU/OodKdDcz0OE3yxfwe6kaKRIO6Bg+9o7THzkegWyXSgnbZwW8kGAiSoEbq7Rm6PUPfk8MpeyhuD8X3/1D8Gx1QPwYSuxEIoVhwQg0DH5es+MjJSp50jz6/Wlnzzoa4XLSHyqZDEuoJdeEcxhnlFGOtChcAzj+fwUNnOFu8HGpDmpepswp15NAW4HNciu2oBqxDzDPs5gsOyQnQzKWeR2bA5aVEOlx2bry7xoWvXFqJ/CRIjVDHGoyQVStV6eioA1ohrU0EYTK7LjoXQoXGiUAdADegL7VZJNMjfXcsiN8eSijmC3UsoFOYPZFxf1Bh1DdN9uqgw7Tz/oXqGCtM30Ids1lcbRbX2oZkm8XVwsU/PYvrV5sPxOYD2USJzQdi84FY1v1N84GU+LB2B+MMkN85H17NOYttqd4x5E4jPw6ZkR+RsmJcsmMY0/HgPnJ9bU5fx47RG6DGlJN1uOzbtj2v3nDIS6pszl8s3+B4kfTNRDD1x49HqtP/mE6OcsElk3i9k4Yef5wdopWITGcheN6Q6jqwxis1D2uE1FrSVTnt3bBOmq2wgKBlYkJllAc4yLRZ6jq3UvyVT5C0JYidCrXRg6tubi0uy16eUNjx8QDaOXzWeMlrHLTgBDohr2GpaJrXSNk6RGNxPDwgzaFZVzBXbYoFFzLyccAiQJXYOQxCUPvQHdD14bXU6U8eKdnrnupxQ6ltHf8o3LhnMwf9TU5sbC7bH/icag3wLU3U24HDCW2dmM1OOFwq8ZhM72FaB5erqpxn6d3LLnEWXO8TuLbHaNW0yS1vsBjQMcaSfPLzF1iIuev5WeouDB5AacLCU9u+VTJD7RoSh1rWmHkuIgHLYM6eiLjPYUtNEs4zZmzK9NCeDhE2U47RD/rEId1bfO5Rr4JB+i0fjOFJjcIGULcpGVIPNjFH7lhj8+phjdMEX5EzTXx/2fg9cX12Xo7EVERokFP3533qGUdQqqVsfRA3bnL2X3KHVFuLFk5LF2zogvLomDqEoUXk+qlfQFVDvFVk6t0fm15AGzkCXq76dxiImrwrVY5NW2zFw7wjn70v3kLxHwOK2/vi7X3x9r54e198HbuOvS/+O77Cy94Xb7Vxq43/Ndr4nlj27H3x3+K++Ewt7J70nPPBW3snhFUn91Wd3BNOaO+EsHdC2Dsh7J0Q9k6IzFKcBF4M+vw5tBlX2wugAT5fp2+qHUnhm0tX3lwIOheu/sYqjfukNOLtE2ZUjZ9EcwuBLQS2ENhCYAuBLQS2ENhC4B8EAltgusfA9OdkRJlyKXDyhwj5tr47f2+kya7Vm7uYW9mcwwHaBbn48eI89eXRBC7DJGrc/Es2EO+g451y75HS74iojqvp4NwZ466Ypkcq+SMWvgRLYy1KnIHPTCpZ/jOcxnPwhTuuwe6MGtJSJAC1k6qBVgypq9Dk0ORdgy39a42miw62FT6HhgjMIZuVVCF7fVqS1AykWfUU4sLFq/Z5edD0fu6oj2F1UpCPV0rpWe80D1bZT6rhhlGXWm987NbxXW9eD3b3Mfm7xAwOnyi9DBVlgEkI1pW4HTkyU6VdqF4cx45O14c3cjRUoaHSZCj5oTO8gCn5BTWUnhsshzrNzlzjetUCRTXUu0Cul0U1KDC+SDukE+aMqUsremOunlZKNLPEifINKbu+9EPAYfwS2BZ6jii+hzEs37XHSz/tVebxwk6IE3RHrhGIty75LoxZervlinvNdGQlzPmABHgYDfliBkxhH3gxrAuoHJEsaBGy7I6nKHV+bffOYRajhHNQydiNKJs08cYhpiB6k3P7f5oeVnmPaU4Bvf8r+mcB9j4BbBvo9wNbAAvLQGHNDAeabi9rXubjItR9LD8PUsCxxUGA1dOsnmb1NKunWT3N6mlWT7N6mtXTrJ5m9TSrp1k97an0tB9WT9qsTlimtXdMq0aSzu0vBaIRYKxbD81eqnvQTaMG9WNjtFydoDY8pF4RdWRSWRmDVP1BVdrgdz+fWYOMNchYg4w1yFiDjDXIWIOMNchYg4w1yFjdxhpkrEHGGmSsQcYyrT/ZIINWFdMqoRIPNjCkquHg9UA7GWrMKrWRZrMNZqMh59saaT4G3q3rYCSMzsNro2etaWZPTTN7AQFs9KyNnrXRszZ61kbP2ujZfYX7hejZNuxJL3L6JwOLTi06tejUolOLTi06tejUolOLTi06/avRaS90RxaXWlxqcanFpRaXWlxqcanFpRaXWlz6l+DS3CfUTnZD2gT2RYcvN6sa6pRD4HeN2KOG80um5Mmorh508GsZu/MF3tQLoi6EIsewKGNkXYw6tRSW8cfF5AlpOIcanYSqXEEGv5xUkiKfmA6JDsxbkaEu1KtcXOtb1Pf9oetmnABr9N1ZnRb586puF9sraS0rv9ReyJ2Ls/Zl9/07+KT9qd09b5+cn8HfZxcXHy7OTuGv7vtP7fPu6UF5ocJibg6YNFzGRZ/ZKCJXWO6qku5VzrLZAByZ7tG1CTveog8oeAEJuXwpKMjPcxHM0K381bP/fF30qibx5M3daFljrk3ZkY3PVW5PX5XYT6diPPLQm3m4Wv8j4de7trEaRrx+xes3xwCxBpweqh3vbiS0L6U3C9KwhjKVZT44Tjt9cGz+MNcN8bJsdPBiNdh35P1376LKRH1o38nsvsiyq33bAYEL0+JTpF3+KtfyaJJzNF3chmBfXf+mbhVtHhiCzCA5lZEH7p3kC8YaY2QoqWg23mBvMxUCL0g7oOAf/MB40fAmpdnv7dKPY9UJvsx0ikwsvThbB2So/tFEaB1QO9sdiKRxB6PeeHFg3I+r1s2g/+ESHsMAs7PxwbMDgqrqF8DDA9MT9EC+1LFOo2R8I+IW3cJecJE7wP1xUPat08+DW+iiulit8BJl5DEuiA4qj+W1YI4gfbJ67PR19dkt49BlGsN2r1trIZACywvhm1FRWGHU5FYrbMOEb5o6HnCOBKUluXrMVbgodzh/MW3dDbhx2PnGd3MLfktajME3G141/uqbNVOQXg2Pk4AYnCYiPw8zWb2F5CKMtbDObSd+VNxMLIOyyduwYXIDtsNqhUpmeK1j3RncuHeekKDyNK7dRpun0dhJW02i4l54heQ6gZayD+Ouyd0E2mY2ll2ZuZaRPQUlJivLml3JzOiTWpNA98znht/9Qw+/koANFaOpN1Mq59L7y//5LHe/t45x2GajgVg6u5HrhRIlAlg1dmrIFM21ZJC4kZsk0HZNGrOEdRvGhz9N5hRc97khHdGq9GkjfpnfZw+q43r5KxWIp5fDdsjEZKfvbtZsXMW7jFDh1DX/aWZ+diNq8M7HtG/yTGhs0zL4djzz+14M2RCvXg0VGTBK41+OSa67FDCnwJql8NjGjXWALW1aB0TN6kWQTTZNrp4inXHhoJQtwV14DX775vWrVy8PjIQJBw385+TsXfe90zm7uOy+7Xbal2f09P+CXz98vLgyHv9fQC/O3p+WPn7KBVQOrz/IiSGKND+oimM3R+SB/zH1aSWPIqAqDCQvtxegfZVW3YefecRjZRImmzejztZvkqOr5PhazN3NhuFswVXd852zcJQ0eaZTbZNXVZSeuBMnUhr/FiSbNgZtu/myKYmMYeRZ3YmzKAqjEuUvK8YYamZrTBCqzAVAzwNFko+TyIuXZHI7EW4konaC0/uZLLtzEV+HuFnwoBaJVFNv5m9I94OkSpLINzYG7IcmgdfsQLV8EEdvnL7aqgpCt/tdssppCgc4oDw4Jp3p+GCLSAp9hnYu+gie8B9vtRnpt7uYeo4Tpew3J+Fkecb2mzLbKrKN1CCp+NmKg4P08SqTS8pjmIVRxgNV6EsWWZjVkz8YNJrFfRmseNxVasZlwZiqKvufcHQR+rk36Wlk8YVxJJp/WFHJ2PcUk0gfGRgqHZmcK4fxPO/oUGqNbTnPKgK8nxUOmD5/Lc2SEk75SjVUTo9diHt9qQ2nV5iA+JUfzt5FIebcMNZOwcPBOAeg6geBu5DXId5Mq1rdYOd6Zli54O/ZIilQIUayndcWjg88Y3UU1h9FvA9i4BpitkTedza4vHrbxTZJUc1vhdvFOP9AJiOQ4YU69U6m0Si8m8r7npJU2VDI+/eF2YNHfN4MfZx4wPik+BDoU4m0q+MXP4tl382vNuJ6JwTUCm3D0JxAb2/SmnkOCgM48iZ9EY1hXRFfxqU2lSxG0oanBRYBD0q94o1ZqJwftudeoTxQFoZxSpgYy4oV40b6/LlQqxvNX7+qbKmaLzyodTYBmQIgYEyL4utD7tDB+DYz539+ht94wTSkJarvxmW+jox8E8tXwESqj1G2umOSrXlxYgoREK8evsNm/zt7gWe7iA+pnefN16+bz7T31NwNDCDKc1eFMovkfs2EvSolHdcJxF3lwYLTXiwEZkf5rxQgdSdDSrbELeKJhIlpvQBqS7+l3FzAHtC2rzY7/kQ3JI+it2lEvipRnB5bsCj+wk42+Pzr15ErxcfIf3jAxyDoIpbysG/UipiCTCue8Zl9/SWlKQAJFXljxyNROPVElHcnGqtRqYLs1D30KtrYsxuBrMYYNYNfExbQJ9wET5h1IwyHTnHRDpPeoGWdlS3hM3SE4BIAkMUiXvutCYP6HwbIAkcAGAilhRMsE7l3eJwG/wU6jw/CzAWEnn2FnRLMEt4+XCcCEDePXwp4xTwDdYOlQSFMLH1xGd6IACZXj1uMv4FcqPz/A+BmBqA= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new compute environment. Append `?workspaceId` to create the environment in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-credentials.api.mdx b/platform-api-docs/docs/create-credentials.api.mdx deleted file mode 100644 index 3b66af5c0..000000000 --- a/platform-api-docs/docs/create-credentials.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-credentials -title: "Create credentials" -description: "Creates new credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context." -sidebar_label: "Create credentials" -hide_title: true -hide_table_of_contents: true -api: eJztWt1T2zgQ/1c8eg6BQofp8HIXchxl6BSG0LmHDnNVbCURsS1XkglpJv/77Ur+thPCge8I8JLE0mq1v/3SytkF0XSsyNF34krmsVBz6ity0yEeU67kkeYiJEekLxnVTDkhmzkFQoeHDnVixaTjilCze911elHEQs/58dtMyKmKqMvOvB+OFrgOeDh6wuosMtqMD+kQETFJUYAzLxOhX5CyQyIqacA0k4hgQUJ4AMrCxkDDUf6fMZNzUkX1V7ZrGAdMctfhhvmIMwnEyp2wgJKjBdHzCBlzEG1spkZCBlTbocOPZLkEjUkGuyh9LLw5rqkpMEOcKCKhB24Gc6hxFY0in7sG9e6twqWLuhxieMtcXBhJ1JHmTOFs0YLwiPw5DKFxjWYM/R1AlGjg9by4h58Bvf/CwrGekKP9/WyJ0pKHY7LsJAov0X3Y22sgLCljUZ/PBKswO6zy6hAGtkJIdIYeQH/FkqXffwN6SeFpLMTYx+Ex15N4aH/4FH8MuR7G7pQhZKUm8Dn9pBIbUB4yuSMZbqNnO3SMRsEpj7kiCLi2jBhNN5QsErhYsZ/gqkATxTqTZsf1RYweqA7IDWAcUsW+Sb+qV9RXRDU4MfoJaVAeuAMbCzmvrWxUtA/x4BWUPBTCZzQk6KDUuwh94KNlzIDYp0p/UyXqTM2Zh3uw+47mxn9qHDwbklQ/hYkRI/KexmTK5urhEPE4+mHAQ6qFbNqswhchVpckHOdfbbYpz3fAQlGEvDBwD55fInAu12VKnbN5YyQpBmlAN852yEyC95aYgedNBnrus57hehLSod/oPqgKDUGEY4ODAXNj4DU/R60vszhrAS0eLmmaqacNqhRk+0a3qWItyH/K9ed4WMVQiOgtwdFDia9Q4kYsSTpsAEN9/2Jkjsznhjmk2p18XYVTARvIqivnzeqNfTfhtiF9VW8VlS2eDB2OcBrqswYjYg73OXtgcmAidyMoWG6UwJygpVPjl4+ylnx5pQ0f48vIe8xhuimXFQzWTxFdJeQp1OyUbgElqDEETkn92YAU68w/eAMz9M0JlQ/m0d7Ymr0UuliOtIEGF4+wtFxhNsnvYG7j4NNiyhpqubVxd/6plqiwBGsB7WPRoNNGEwkV2iMhDQafa2ehLT5bQAUFEH2kfKdGmKqIeRHcgpQbe0Y7h+Ix18cGW0ONwja4Rb2Mo/0Uha0FS+ma8Z+e689adIJK4L59BQmxJ5vug8UUOaumjKce1KXDc2A02rcaraq7cO/bEq/pg8R9I3GD8+P99/WFOwTKF1qv5WetHKIvJwqSFx8tYNzWCh6nRcjeQP57qWXFduTIxsv/20iLrw7lqlpvazyxVuO9qqvQW7nFvh/CWxZ5K1+cvuJ3Za/lBdl2eNjKm9j7y/g39TL+/R1Nq+9oXrgSn+Xf1ZIqSjfeQroptH5UxstNM1dJ04m5LucdItkJoyIRKqu7/b09o8JSH8vFOWmjX6UxFtfjsJIiEKD72CTrMfX+TZNNsW8mAKtBVnu4XyYlXIviREoha5IfNGg57XxyQqEdyBhiBvIsrQMaDzAJ5JjBGSp7MXaDfL9BRwmYngjsloLSxghJcY7suqW2KTjv7tKeqRg7UshE60gd7e7SiHdN20rXvmvuckGqXVM2Hp1Ln2pszXD6SO/0Ls+Mq6YCDlCfVjdFMTP14I4k6bEykWCIYMT++DNt+ridaQMc7XSVd1id3NMgsv+yVNqesHMpj8mkJSx7LkPJhvP+o6SvKGvWyWnyNpx8LO06KWSNfLKQLPLBSl7N3WSJrWojYVRUynxGtQ8ZAU3KQYaE2PwF7BpnLxu4aFbwd45zuO3v+QQIgt5h9/nQPTzs7plCCDwqoCZWEqXaoHTKvlXp9Mqi7v9pIUycDR93Ix/KYkQS2yYsGxu1xscJRg4MLxaJDyyXOGw7CDFi4ExJ0vgIlrA1kB/oL2wUbmrcpdzCeEf9GClNgN1RyXF/E/IgLhxg6LcgmF3at9vvXCP3fG0t5+HhaVfg4RTptbTF1HJ5MbjGCEn6HAOodGFU0hkep/BpmtiEUYftQ8SxBfFpOI5NiiSWJ3o8LSeFShIoVkk0nBckBOMYimu8v4OBUr3Z+/zyBpj/A5Y/F9I= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates new credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-custom-data-link.api.mdx b/platform-api-docs/docs/create-custom-data-link.api.mdx deleted file mode 100644 index f4216c7f4..000000000 --- a/platform-api-docs/docs/create-custom-data-link.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-custom-data-link -title: "Create data-link" -description: "Creates a new data-link in a user context. Append `?workspaceId=` to create the data-link in a workspace context." -sidebar_label: "Create data-link" -hide_title: true -hide_table_of_contents: true -api: eJztWN1u2zYUfhVCVytgK8lS9MLAsKVJOxjoksBpu4uimGiJtthQpMqfOK5hYA+xJ9yT7BxSf5bcOBuKtQN2Y4vk4fk/Hw+5iSxdmmjyLsqopWPB5a2J3o+ijJlU89JyJaNJdK4ZtcwQSiRbkYaScAlTzjBNUiUtu7cxOStLJjOS/LhS+taUNGXT7IeEWEVSz4TYnPU5NKQNm2gUqZJpivKnWaPBuTNWFRew+xVsBqKSalowyzSasIkkDIC4IxpoOFrw0TG9jvp2/doIlq5gmqeEZ0xavuBMA7FJc1bQaLKJ7LpExhy0W/qlhdIFtWHq2dNouwWfaQZSjH2usjXu2RV10Zjs/QCTpKIHbt5saXEXLUvBU09w9MHg1s1QDzX/wFLcWGp0k+XM4Gowv6EyVnO5HBj9RnKQS5CYgBm7AYnJL+BjjIPh8K8WhIoyp5V7RkBo8hGBXU5m4PVUaQhaDlFIMQhxtO1JO6TMRTtCYX1d6D0vXEEEk0ubT8jJ8fFxX1zg33f3a5jdw/DcaQ2OFmtiXFkqbQ1J5i69ZTbBnOvrysBurI1AgnVxP8a58R3V6D+zu2i5FayKNSYoKoEqQpTuILH0UM1zoVxG6vV94bhp9KQrk4xIslRqKRh+0U9Otx+/gV2aNsNxiqxxaNhHqKRUFaWzSE6xPM3pgwaDLBgFUfDhOdb/QVA9CnKwWLpicHy6zyXXtSu2WC9GOZ2yGVscTpRZRUxKavOho0aAJKlwGWz1C29mU+LLhpHvWLyM0Q+nk6OjYj2u4o2uNP0Z+glmaJoqJ22MVUm5ZDp54jOtdHMozbM0ZcbwueiW2lwpwagcAkzOQBvdBz1DAi/IQ9qwi8l0QRKrHQZJerz0YEQFAC+UGcIFh7lAt4BpH/wO2TRLSIHlO2d1TmVe8x2aw74+70gOJB1cjMmsUoSsciZJ0ndLgvZV+oH07TAJApjPKvjbbrcBO5FnNEEHhOQoAYQCsH1/fDysnRvnRX45+OSPcE0L43sc8zOTeGaBZ+bUwC9gWl3aI4J8RxDEJTAKRai7Ke3j9DgAv0Tk7mNbneYhlz26P/nScHzphPCl1/YKhDqrxhmHk+COYU4stCq6B3qbSvF/seb3ny5tFuD6/8fKN3asLB+V68FJgfqz5ZQ4M2bU2PEJ2swcAsZ4BbB1AgkC/ckasVbWdWFU0SBv1Z50CqCjEtWaYjvKLSv8fIt/7xCHKijoxPj96Aug18PA/s8QqF/hD2RlR3q6k6FfOWf2H1FN2PogGp1h9ND+7hFtcwp9M5XViQ5jOAY7FfeiKO3aZ0k4MDsg+m90F2TFba6cHcQr5xmMHyHtLQdGXHCwwlhqnSELQZc7XcuOEoFxOBAytqBOWCLwUnHH2SrIDnz25Rt0CNmVFOvQD0CAhbha+DveIco6b96evZpewPr0MnztyYD4JsjfDi68YWHfBQICDBWfeJ4JXoSSSkACoAoHL1x0m5nQIFFjVMp9W9Bv6TIm4PIaejSAfUOXjyi+F1qD2IrcJxSXd1TwrJtR7Vk9WNqb7xdWYSMGK0/39VrPaTb7+7fVLqjV5h3Esc/6oau298GsahEbxU+Hil/VrwjQUVu4ywq1An089dMh9aWyL6ENyMifv//RaWLAi93IIacFko3I2fWUQPNDocAyfMvAbGn2+XtyWxJY+djHNNu/VVdiYbLUaah0X3HPGeSqPnM2h+F7LJYCcEfhs0ypfEagXTA66rwhIQ99Vz/MOC1gPbe2xPaLljz2WB0HpI65GmT5jV8h14JafGsh4bQGf/tqrfW78e2eN7arZWMvSqwfcjy2eSKYCR8v61ecDyvrnYKOn7XPOC/uaVEGKK6elj5Tk810jaGheeuehtVBttMAt/uG6B/QrHdzawKIz1oL5S2t4lg5DD10yJcYGQ6SKmLf86Y+CXfj1I0O5CEX/r1roX5qF0ARDHKQcxI/exYf+8MM8qKgsuO4cOdry6Gv5Katha/y3FgFDodHpYArAJrh3bGp0rv/RJpj7sPsZoO3vTdabLc4HV4aMelrYIgm/jL8gMEH3iH36nbL1oOnTsB6h5S+RuAywalPJShaUBfOScxDUCxsPQ/ix/460e4d4NB2VO/A9Cztg7RdcLi+unmNpVa9hxYqwz2arrAM4Bf0xGde3B16YJzbRILKpfOwFQWeWJh0t657ddxtDKhcdzSE4HiK1+qWSQhQ7TeLY1AXmP8FvlQEfg== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new data-link in a user context. Append `?workspaceId=` to create the data-link in a workspace context. - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-data-studio.api.mdx b/platform-api-docs/docs/create-data-studio.api.mdx deleted file mode 100644 index 1c50b9a8c..000000000 --- a/platform-api-docs/docs/create-data-studio.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-data-studio -title: "Create Studio" -description: "Creates a new Studio environment, starting it by default. Default behavior can be changed using the query parameter `autoStart=false`." -sidebar_label: "Create Studio" -hide_title: true -hide_table_of_contents: true -api: eJztHGlvG7vxrxD7pS0gbZQDwauBAnVspxXgZwuWnRYwjIjapSTGu+Q+kitFNfzfO0PupT0k2XlAg779Emt5zMW5OAPmyTN0qb2Te0+bNORSew8DL2Q6UDwxXArvxDtTjBqmCSWCbcjULiNMrLmSImbCDIg2VBkuloQbMt+SkC1oGhmfnLsfZM5WdM2lIgEV8EGCFRVLFpJU4yazYuS3lKktSaiiMTNMkRlNjZwi2L8taKTZzPcGnkyYokjUOCzIOqeGOpJgQbEfGXryBHzAwo1UjzqhAYNtA48jSxadV2f0X/lCItKYKR4QHgJ/fMGZgsU6WLGYeidPntkmCJgLw5Z2aiFVTI0b+vjBe34eFNgLRvbjvrY/aBSB+Lim84hZuTjW/gTCBzCAAmiKaCqCFdmsmEB5c00CK4nQb6NxLmXEqACS4FwVA+TafJLhFpe0HXN+vtlSABlIYFMY3ECTJOKBPYI33zTueqpgxC1csRCVKZBxkhp2IdZW6FYWQEBGlJx/YwHCThSeqeFMIwAnsScvpt8vmVialXfyy2jgxVzkn28LENoo0B3vuSbHnc3vRh9+adtQqMwtCOdORRVxlat2OEC4+6ngghtOo7MVCx4TCWrgdh3UFCvfBV+mTrMrezqEtEzSjBwep7F3MhrsR/L+nUXyql0xi6XavmajTIVB06zwQ5WiqPfcsFi3iBy2VZxKmyBoGHJnJZMdkTQOQ6RRhCbknRiVMifjkF7sQj+sKBFfMPAH4p8yVfrFUgAAhhskwiud1NnOYaPe6IniazC8NpsFEuicReNQt8hxl8mmXPd5J08n0rRgbIiunQnrKW4yD/GMi0rbzySuQHJSaHdA70ajLn9TQiWwiuTbXuJ39tuLC2tHrGNaZ6GlRaOqMeQ4s4ZYBNSX/uAwBcErfEex5SrznQ3K9/PlpNOxufXwz430J3XeYGWqgcZaFKCg2BQph5PiEdo+BgNceXVUQODHyqEA2cajQ942k9G3l/M7AD0WC2n9SheKWgzqEPPhUNPq9aLoemHzmRcIq+ILu2hOImpQkq2Tii3bealI5qwg+3wOWuFh0lPTaNADTKAgg9tjV+e89QgwYWlzoAVSi9IDr4ecsMP2pVgiNTdZRGtG8KDz8KhJWwINxisMBvcAGY4Q4krIQpvYJTCAGRku+Q4UcIw5FA0gFTpNEqlwEvj7PkQQwzVVeEz6h2A1ZfUFEmE4xamjH2UFbv5YO7/N5dqnKH/wFAXyZeaCdYsNV4DiuqEB/XSJizZ3SfjyTfau9JJNbLEA2fM1u6zL4ggtoHYnsCwQBmQe+7ShGtqQ1FO7uS2MlT77/zgc1r19RSRHHt6Ojz+tHYXLU63vsgiPyPQO+em8TgFDKhXC/dJGJknlp3O1Skllf81THoVu2v78DNLrdN6/L4KmbZauHBBqumw/4dL2jrcipOyGUd0WA0sBnt1cnI9vp19v7q6+Xt/dwszl+PPFdHJ69fXi35MxzMLQdHJ9+/Xm4uzy9NfT2/H1VRcrBcJ2PzQtjx4TBbpmn1A8XUnUnGo2jrtEEqTAYFyfr1y0DtzDbLRgIVJ3ycXjXjfx8jStXgxCNMMI8BC3oFKH8sk/mMAyGAsJshwSKQhgWMMSNSAId0Bc9jYgVIR4owJ/GDCSULPyuzPCOg3oP4hc2CpUWNDzZ+Yv/QGZp8EjMwQh/cU/mAA32Cu/Ghh8cgWRkYCSlmOu+jUMuQ7kmoHVkIWSMSnuZKSSZ/oue3U837DFYWpuqgKyiHcIGhAugigN80rl3c2Y2Lsny4Ux0+9P3ryJt0MnlRmMLHV9hP4HRmgQoB75eLWlHI5x5qTnCKxfkEstwHmfnKUKr13RlmR5nyazDAGW/rps1i3pcFjlZNUAUcVvEdyz1V6rWy0X+EimYaF7Tcn5ZFrQSTfaykXKZcScPFJV/vgKfClafA4DBI2fmv0Gyp5dkGZOo0HeexkGXPDlUGEsRoj5X4co/3J40C9X0eD3+zaRTHJR7LkgNYrnVkhudac5zVI9BFdohm+RZ5aiwxhumDZvQUHIr3SLRXOR24WWoHu52J3CVwzg2ASGF3XZyhm/LAXpYrkkpsV/vc4D1S18j1ZWsAc7Gvo/1pnn5mSF1oYT9U7x9JD/Cu8gC2psFwVcCWQA8M111eIu4sRsrZYk6TziQcWJOrnZ0VO7mdvrR0sNsNYVWTE4gZptY9vBwQJ3RAtwZMPNSqamcV4rHsL3Edi+cADEIw5cuHyOLCK69Ml4QWZ4UwID2SHCAXYBIes7kYhrQ9acbRzu7rwQLjXhtYi2eQm1UWrpXJnrzZfTyzHmPOMr96tFA/w8aWs01txESwg8c22ymYU5I3CaswzBDJwqBF4jyxHXCaJay4DbtKCqL1QBYBYx2x7alzbWabvA/JRky61CcbGmEQ+rGlXG6sZUq77bko2z3iXE6B/Iog7n+gkTWVbNxbBACNqQgraycCcJb01QJ9meqWGJf1zivYHICj+P4asscx3CbSVm+wCv6QL86FWys3wIJ562z+TZV1einXWFO6e3gJMHXdNjIFYlMqpVFiprXlGvqBzCJUo6K2h2VsC7SidZYyTrYTxbAO9Gb7uaH2Hf5ujbHD9dXadvc/RtjtaQ2rc5+jZH3+bo2xx9m6Nvc/Rtjr7N0bc5+jZH3+bo2xxe3+bo2xx9m6Nvc/Rtjr7N0bc5/phtjg9tbzw+0fDmxx6S5Xp4MGR3K2yFB2vuDcLfNwm/zp8aEiENAYcpN5lr+TD60Fx+Jc1nSHnDgfNS6OfKtB3fPbrwWX01iV4dYS9wH64pdp5OxjiZPQO0z/p+WtH9tSUzkWIBFBoyJGHqaAVvnaVgPyUjtn0UpAqisY2KnxjEE3WaYkHy/gEDWgy5gcRHp4m0qox3KPh6k7+ZRQBqnb87TfHu7q2MSfB+RBPu22TKd6mUb5+q1kKknSGTrFdBXDoNimDDaU7c1N7HLKdVEgtmEaOXvQG1zsIuwoKL/fE59wjfNsZKBKV+Uz4JvfhO48TlStnb1Y6gWQ43X1KWk7sPKMvx1peSo5bqu62vj7KK+aisgY92qtr3OeSHetW6tdpc0lGrKY92qyMuzJTP7+5HD/mruaySzfNqXaZX2RnioR06XlQWDslkttjekwNrFLuqU1WYrJ5p0f69nMAQ5fofMPfW//jRH9kEGPQ0pqJyljvPe+sUPpWG+fM898602rDv5k0SUW6jXurqYs4Adx6tr9A0YejpCQtGoIzPzzjsnlujWeYO1TuxOPaI4MBD8FbCHhlgqb01z5IHz1aRj0f/O70F30Nm9VF6SeQDfiju8ixwfCBTuA/g7ROk5zaeOSKHtmxS7m34cmTY7cBLWGL2rq062Mn1FOut8+yJeixD3KPoBm8n8C/Qif8RQNHEsGNYlBfL1Lp+z8FE/0Z33WPNHVYvQFRsKxSCBtkVt/KRCdCiXGoGv4FcAP5fs22Uvg== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new Studio environment, starting it by default. Default behavior can be changed using the query parameter `autoStart=false`. - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-dataset-v-2.api.mdx b/platform-api-docs/docs/create-dataset-v-2.api.mdx deleted file mode 100644 index 4d30a124f..000000000 --- a/platform-api-docs/docs/create-dataset-v-2.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-dataset-v-2 -title: "Create dataset" -description: "Creates a new dataset in the user context. Include the dataset name and description in your request body. Append `?workspaceId` to create the dataset in a workspace context." -sidebar_label: "Create dataset" -hide_title: true -hide_table_of_contents: true -api: eJzdV0tvGzcQ/isEz4rkpoGB+tL6kQJCi8aI7fYQBMhodyTR5pIMyZWiCvrvneHuSrvSSrGDHNpeDIvz4DffPDi7lhFmQV58kDlECBiD/DiQOYbMKxeVNfJCXnuEiEGAMLgUtZ5QRsQ5ijKgF5k1Eb/EoRibTJc5JkmjaKBAASYXLa9svbKlFx4/lxiimNh8NRSXziEpfvp5af1TcJDhOP8kohVZgtBxSx5AbPW2EORAWoce+JZxvkV/U1n9+ZrkDjxBiug57rVkfKTXupJ0FAdO0PxK7tPx1/ZOUxboVSZUjiaqqUJPDEyFLVSMmA9q1KELuUMYOQ/ZHAuQF2sZV46BKBLN0JNoan0BsTo6fyM3G0pNTdgV8cU2XWh1lA1dtS7fki40kU3AOa2yRNDoMbDd+hCEnTxiFpksz3RGhYGlFVdbrRC9MjO52aPoQE4KUUWN++l4XwEkhU0VmfJIOYu+xHQQnDWhuvn12dlhvO9++36h1Un6uqLKexngvLJgF8YHCQtyypkkBEpzWXFtseYfTCSl8wVXHa+Llss+ZNXlfZIa38mEPZDrsZla1m/3yPOAWT8Do/7etuOzjI5WmYYQHxxlCvOr1f+d7NMtNZAF5gru02lfQxJJVa/1lGsrKtZ7FRVF0+X3+UY5auwaTKzVCKbyOEEdWjLwHnimqohFeGGzfVPNLECX/RKaL/QEZdiPXIUbnEKp41Hxiu5U2THxmMB6ZzUc5eYbUtQqld+Z2ZvJTbTpeEHPWbdSTrwjOy/1IG68HJnS1RzmMU06b/om8RXkzXPzkpHc7t8CQ4DZMxq1UTzZSW+9t/4A+Y89b0izLQhjowCt7ZLwJO2fel7YsgoHBVV9wTH+S6MlYcCs9Cqu0pZzheDRX5ZxTj8/8iZBK9Dc8obkbEqaA5bJ0XYRZA9+0axJpaexJucxunAxGoFTw0zbMh8G/EwEDpU9WJTukkTcUgtwBYpr1heXt2PJ1zfo7pieKtQ2xm20fGOzJqUGSkp0Uv3za1Pbj8uYKGHa3++WpLdfoHAad8vLrsG6aHdzQfEAZgA1uXUcDPxrITJhKqOVr1LmyoAsVUaXvjZp9YuRrv1lJ2j3tPxheH4+POMzTlYBphVP1avNkrkPcb0rz//cIl9XAP8cOQ0qTc1E5Lqu1u5ny5wLmc7W6wmdPXi92fBxtcZzDecqwERzA05BBzxB1Xde8nsjecLVwXdH/VrJ1CIL8Irxpo6l8BBy3jEpkMr0uoL7Ki0BO9uDIbQZNBaXWYYuntRtT4bbd3f33Gn1x0Zhc7bxsKRD/ks4+XOLrVMDp7M1PfpmVqaZJSuf3JfQbeu9Nk5RNSuCWbUQUjKTxr19QkMJbXiL/JvgkvN/AKhmGgo= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new dataset in the user context. Include the dataset name and description in your request body. Append `?workspaceId` to create the dataset in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-dataset.api.mdx b/platform-api-docs/docs/create-dataset.api.mdx deleted file mode 100644 index bfdd64510..000000000 --- a/platform-api-docs/docs/create-dataset.api.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: create-dataset -title: "(Deprecated) Create dataset" -description: "**This endpoint is deprecated. See [Create dataset](https://docs.seqera.io/platform-api/create-dataset-v-2) for the current endpoint.**" -sidebar_label: "(Deprecated) Create dataset" -hide_title: true -hide_table_of_contents: true -api: eJzlV0tv4zYQ/isET0ngR7pdBKhPTeItYLToBnmgB68PtDS2mUiklqTs9Qr6752hJEuyZScb9FC0F0PmvL95cJhxJ5aWj6Y8FE5YcJbPejwEGxiZOKkVH/GLi8eVtAxUmGipHMPvEBIDgXAQDtgDAJveGsB/rFQyO1s5l9jRcBjqwA4sfAUjBlIPk0i4hTZxXyRyGHiZfinTX/c/nDMkMrcCFqTGANqqjA4uLr6oL6owY5lgCjaVNSaVl1nKNSi20ebFJiJAHVo5+OYGbKKCKA3BM1UyCxkBEyrEUJyQkSUlW50aZuBrCtaxuQ63A97jOkHfCYlJiFgUDowLJUhNhBExODCEYcYV/kGunQ8o0+OSQEyEW/F9ZP/a+arSGIwMmAwxarmQYJCZXJEG0K4zKfS4DVYQCz7KuNsmZAeBgaVnJVCFK46uPvI8nxXiGMkNBkIybdNlCKxIQhU1avKoKUcSIkkiGfjgh8+WxLJDH/T8GQIPhSGonARL1AKJHZd1Rqolz/cQOKAjg5Mugn2o70v/cuJo4+IPbKKVLSx/uLw8DPfz7/9caGUJvc4ow04EUospQ0IdxpSLNSqlRKIHMqKiocohzj8JSMzmD5g6XhYNlV2eFca7KKV/JxP2hKonaqGJv9kBb3NMm6VQ8vuu1d4kdLTKImHdUxLShLrZ/tfBPt1SPR5DKMWjP+1qSASp6LWOcm1ERXx9JzGaNr5vFwohgrbAXOsIhCo0ziGyDZowRmwpOQ5i+4PN9q6aWYso7abgfMGrIYBuz6Udw0KkkTtK3qJNGRwjT9BZk+hIHMXmHSlqlMofhOx4PnbaH6/xsmpXyolrpNZSDuJKy5EpXcxhGtPI87FrEt+I8D23TbN/Y7BWLN/QqBXjyU76ZIw2B57/3HGHVJsAU9oxEUV6g/547l86Lti0CAcYVn1MMf5Lo/WNWa1zu1UDcAOTbuu3mhsQBsx1ihvMaDqj1QJXnpWmfSjRtliDiMaHu7Fvh1njCsiHu+2SVJt1tS+lBicgr5ZFXAoHQaTTsN4YD1amB09hd+UiyW6Jn13fTTj5Vbn9QEgWqDSd3wFDFnm5UPle80x4Unz8VrXB88Z59ChD9/U69embiJMI6j2n7sW2t/UIkTSryYEyD2Uc5PhrIRJgEiEtmamIROCLqA1fE7TycvFmf60JzfbnPw2urgaXdEZZjIVqxHM23pXEOWsv9/v+ZnVZ/8+fCmVxkSZyX/rZ7XOUlR0yrRcjaoVR+6HQfIKtqLGQP8vmePZkojynYzRoqClndF0ZKeZUTNhIobT0jS25EJGFEyk6uy9nyzl75fnRGU51OSu6mssbk+PnC2z3Hj75DNlXIELadtHFguO2cKTv15Faw8E4zHuVxHUQQOJO8jYn0t3nh0dq5PLVE+uQZIzY0IMKf7232gPj54M/y3D9UMvUT09e6KS2F+2psTclfFSdeGDSPMejfgGFiavgcfSfgMnzvwGCIlpn -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - -:::caution deprecated - -This endpoint has been deprecated and may be replaced or removed in future versions of the API. - -::: - -**This endpoint is deprecated. See [Create dataset](https://docs.seqera.io/platform-api/create-dataset-v-2) for the current endpoint.** - -Creates a new dataset in the given workspace context. Include the dataset file and details in your request body. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-label.api.mdx b/platform-api-docs/docs/create-label.api.mdx deleted file mode 100644 index 3b44a54fd..000000000 --- a/platform-api-docs/docs/create-label.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-label -title: "Create label" -description: "Creates a new label or returns an existing label based on name/value. By default the operation works in a user context, append `?workspaceId` to create/retrieve a label in a workspace context. Resource labels include `resource: true` and a `value`." -sidebar_label: "Create label" -hide_title: true -hide_table_of_contents: true -api: eJzlVs1uGzcQfpUBz8rKTQMfdGltxwGMFrBhu+ghCCBqd1aizSU3JFeyIAjoQ/QJ+ySdIfdH8qpJCvRQIBfDmt9vvvnh7kSQSy9mH4WWC9RefJqIAn3uVB2UNWImrhzKgB4kGNxAtALrwGFonCGxAXxRPiizbJUL6bEAa8DICqdrqRvM4HILBZay0QHCCsHW6CQngI11zx6UofiNRwe5NQFfwgRkXaMpYP5TtKhljjfFHIKFPAKaEgCncI3kmPLGGL1xFyiDe/S2cSRJFZJdrpsCYe5axQyCa3BOpRQUYR4RzzMxET3Km6In4lcOQrpaOiovoGPydoJrJZsDrGSjmL/PDbqteM3q7z1O01ToVA6qQBNUqdCRsc9XWEkx24mwrTmwomKWUVVaV8mQROfvxH5PHXNIWXy4tMWWfY5T3Tm7puA9T3PGOs/gAcOYgzK29oiwDG6N3r6WwkpG7lu64K8//gRVjgJOeroHZuFae5yArVTo3UtnK9iSJ7S1wIKK4SbEPprAddFIaJXHjkyfPBe3GzNlF0+YB+6Q4/4FhZ61qUG9lafhMUuxn4gI4KSmK+VAubBWozSsVf59GuhTatIHFTQej819Ko3U+9Qz5ZAmi4lK6WprfIL79uxs3MnbX/47PlTxTdM1+Z8Ql6hh5sji3SlyLmXRzc6/YWlow0dRofdyiXwDv0xeZzgu/gD/tXPWjZD/eKKt/TE0NoDU2m4ID5t7zBunwjaemEuUDt1FE1b08xOvPd2fleXTVNtYdC1ZJ6btKWd/t+4uVOM06VYh1H42ncpaZbm2TZF5/EzpM2VHN+ohauBOy8BjAVdsDxd3N4KTd9gemMpEyyHCnhnO2F202OpoRJL0z4du4J42IdbMLbof7tn1i6xqjcMKd1T3AzgIhrnjlTqatHbHlCltxNb2qC2Ra/pa9cylyukhTMY8YDKPA3bM7CGfNGNKx2Uq7c+DgpeH2pLy/JCdn2dnLOMuVtIclJpWIF3c1wB3w4x/z290O2UcZlprqeKJiR3Ztftw+Gmz4kUhyW7HDPzm9H7P4vRG85YUysuF5nNQSn6l/pnzr7zgJ3E943b0kdBNcVyqtXSK88cNJ7goC4rGwJLrVUr/5pGjD76jE7efdB4XeY51+KLt4SW5u3145N1svyQqW7CPkxteL/pLOPm7iL3jykfZjhg2yyZeRJFi8ibL40PwavFjVa1Kmu0BQmpOtHi0z2ioQR1vgX8TXAr+N5O/u/Q= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new label or returns an existing label based on name/value. By default the operation works in a user context, append `?workspaceId` to create/retrieve a label in a workspace context. Resource labels include `resource: true` and a `value`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-managed-credentials.api.mdx b/platform-api-docs/docs/create-managed-credentials.api.mdx deleted file mode 100644 index 3d393a1fd..000000000 --- a/platform-api-docs/docs/create-managed-credentials.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-managed-credentials -title: "Create managed credentials" -description: "Creates new managed credentials for the given `managedIdentityId`. To associate the credentials with a user other than the requester, append the `?userId`." -sidebar_label: "Create managed credentials" -hide_title: true -hide_table_of_contents: true -api: eJztWltT2zoQ/isaP7UzIaGlw3Tycg6knJahLR1CnzrMQbEVR8WWXFkmTTP572dXsuObEsKBdLj0BRJpvdr7rpxv7mkapl7/m8cDJjTXnKXeRccLWOornmguhdf3BopRzVIi2JTEVNCQBcRXzDxBo5SMpSJ6wkjIr5kglznJseU4Ow4uu+RcEpqm0ufAyNBWn59yPSGUZClTRMImcqPCkCn2I2OpZqpDaJIwEZjVy7+QFhl7HU8mTFGU9DhYyvrJijAoDwHChCoaM+CFCs89AV/ggZa0QMlR64Tqidc0Rc6Y5OaaEZHFTHE/XxhzplAmFJvD4V5fq4x1vNSfsJh6/bmnZwmeyoVmIVNACsaLqbZL+2+8xaKzFE2qsBQH7KBmLXlOVUgF/2X0XyHL/zvbGnj94V/RYY5DyUHuqqrTXYGzieNvp0LHE1kU0VHErOkXiwvrDeB1KIMZ8nB7tCqXb4KokKFDuPCjLOAiJImS16ApCAqCEApK0gzEhed864OAacqjFKX2JUgpNB4JsRvlFL3vKZ47byslR9+ZrzFQFca0yUXYLY6sUKZagTBAycD6mL1pOmmn7UFdsproXTLIlILdaEbSLEmk0im5BDaQUgsQvZI4cGwZzt9sfHRKqeDY9fLzAP/G9OdHJkJIqf7r152GInCiDbsa3avdXQdhTcemRRadmrmqzPabvErr0SmWB/orU6z4/y9oryh8C6UMI1wOIVazkf0AAQYfRlyPMv+KocrogI539TbN/U65YGpHMTxGT3cgwoQ2WwHzZRxzbRkxWhyoWCLx4ZT9gHIGNEmml9Ls+JHMMBnTPe8CdBzRlH1VUdOuaC+oWpA06H7PYTwIBRZKNWs96TR0BMUyqBh5JGXEqDD1jQanIprlSdbxIppqKAeBK0iXKRrA6Tuam/hpccBNW7zvwMSIkQR3Y3LFZunNaRlwjMOYC6qlMzcbfFHF5iM5x9lnW3Pr+x3wUJIgLywWe/cvEQSX77M0PWEzZyalDMqAdu52vKmC6K0xw3451LOIHRiuRwKrsCt80BTQO7FEe8O9IfMz4DU7Qasvlnm2BW2xzRRlpl02oFNNpXKGTVPXivzvuf6QjZo6VDL6kehxgBKfocROXfJy6FCGRtHp2MxT963miGp/8nmVnimwgaq6ct88vXHs5tw2pG/arWGy+Z1Vh7GBCn3scCLW8IizGzaHJnM3UgXno5oyR+jpwvn1VralWF7pw9vEMvIOOWy7alnFYYNCo7OcvFB12aW3oCWYUQCn/I7i0BS0vHrHHcwwNidU3VhHD0Lr9lrq4jiyDW3w4TGOlSvcpvg17G2cfFpeMccstzbvTt62ChWOYFvQ9rbaYNAmEwUT2i1VGg4/tHqhHT63oBUMQPSW8r03wjRFLIfgLUi5cWRspykecn1odHPMKGyDm9vDaO3vUdhWstSuGb+1r9/r0AkmyWJ2BgXxQLnug9USOW2WjLs26lrzHBqLDqxFm+au3PseSdQMQOKBkdgR/Hj/fXrpDonykbZn+elWmujDyYL8xccWdHysEzxuS8GeQf17qGPF46iRzsv/8yiLT07LVbPeo4nE1oz3pK5Cz+UW+6cJP7LMW/ni9Am/K3sqL8geR4StvIn9eRn/rF7G/3lHs9V3NA/ciPfy62rNFLUbb6Xc1DBTaxElNciMFGMeZhaJRawNDZQkZpoW18IGtyDg+JFGpCBaQskcaKFuCWi4Hxc1tTsHalLjYcRZygZsMl9DVpIXyGhHAqeX3Zrx2rizT4X6DRs7QWpnFnBk30DUMWRmIU2kSK2ur3d32xY9PfHuDXYUtyF0rfNyvIYT21WEwGbwoJxmDa7rZtSWC/623jnvRu+03NAz1vboGiB/47L+IQ0KyNht3FAFV8WQ2nDyzaCqgnBtNT1SSqqW5HuOuCkglERITaCtyCnIs7BVypQJ02UOGQxaCosAfL3AagK5MZEIu4T51wiJmMm+1yvRpL15C2C56Pm1GgMz03UByswQ1eRNtE7Sfq9HE9410Keu/b2iy2UrEmxNJ18iqjFmyADpycGXY1PuCvmHaG5ruqoWS+vhiV4ONDTV1BDBiv3wTxGN36fa2AXdeFbCCo9+0jixv9SV+LMcFNbA0mG8lxUpR1suv9d1Wy5XmFqw2hIBVtKU2K5yrYAyVVpRuVnpQOVio1lXw6pSyfErF2NpLFhrrsbyN/kIPc5BopzYoAx8kyp1/1e9DtnCI1MPxvLvcgMEweCx57zq7u93d82sDfEIgYcscxPbzHaVqqa48zJ3Hzj0OQ9ezX7qXhLBVQ1Vzyww0KZiDdjd8foutHPVFJAyE0xleHA+z4NsscBlCwHGHIUWmQ8fY3ik2Uar1tsAnexU4crEZAF/vqZRhjRmSNv88N+GTl6jwhJFXepwgV8UtxDlW1nzxVneKV6SDWHoTsnyRSpmVbkKidsBskDE6QQGHiw/ILClG1ixdnBoqvBptTr0mX0CB9dEr6WtdpQvp8NzLHQ5aDuGWzCsKjrFOQ7+GpmlMZPFKOPa3IuoCDPTGT3LE0sVrRf7RnGv3qDqVoEUMBTn+G4P0qAwkn3XB4ZZLP4D/+lfgw== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates new managed credentials for the given `managedIdentityId`. To associate the credentials with a user other than the requester, append the `?userId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-managed-identity.api.mdx b/platform-api-docs/docs/create-managed-identity.api.mdx deleted file mode 100644 index e08c5536b..000000000 --- a/platform-api-docs/docs/create-managed-identity.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-managed-identity -title: "Create managed identity" -description: "Creates a new managed identity in an organization context. Managed identities enable centralized credential management for HPC environments." -sidebar_label: "Create managed identity" -hide_title: true -hide_table_of_contents: true -api: eJztXXlvG0ey/yoNBYuVAB6+Nlj4r0dRspcvosUnyg6yhmEOySY50RzM9IwkxtB3f1XV3TM9B8khJSc23QGSiGQf1Vf1r6rr+HIUO3Nx9PrjkTvlQezGLhdHnxpHUy4mkbuM3TA4en3UjbgTc8EcFvA75juBM+dTpmqsmBswJ2BhNHcC908H67BJGMT8Pm6xfr4wNM944Iw9zibwReR47p/w6yTi9LvjqdZ9+MRmYcT+M+hChVs3CgP8TrSOGkfhkkfUTW+aEqf66SmaoNTSiRyfxzzC4X05CuADlAYqoVbjyMVx/ZHwCIvmR3tpDiRIfB65E0X/zOVRi3WWSx5MWRwi3dB3eUbu3HhRMSthvOARixfwPfzFIg4ECKDwn4JN+cxJvBiHJyYL7jtHr78cxasl0uzCXM55BD/BjPhOLL/6+dXRwwMslWrlNJyusE5+LP0iZYpiVQm7o6UKYqzrLJeeOyFa278LbOBLmZpw/DufxDjBES4E7ZjXen7TUiKO3GBemtv3gQsdMyxMy4vTUJw92DSJiHELCRf+H86Y4y1hzuRKNNjUEYsGTCxLgims7iSMYDMtYLUnuNitowcgzXNinKsqgjg0hBve8WLHjZpp0caRJ2bmRz90xuZn4SWRb36RzHn2sXRocOfqXxkSoQbsivKIkWYY78ydb5/ouzC6OXOj7XP9Dg7gzAvvGNZgUzeC1sJoxUK5+yZeovaegMkDamYunEqxgi99tQRjjlvYGYvQS2DTLJ14AV+YxxXGggUXzi3uKWfavItcKOlMJlyopYj4VRIMia7tNHemU+Ay8hs8KDHj93ySIPNxJdnBrOk5STBZ6FLLyMV5DaHAbXgDjbJ04DBxSAcXLTbknH0cRJzoX4YibkZJoJoQn44XcbwUr9vtaTgRLcH/AAbTcsO2Xr/mxAuTaVt23Hamt04w4dOfYGxNaK+p22uq9k7kyOHbpxm6M4OFglPgVQxNzv0k9JceMLvp3zLSQFHVLW7h9UN18U/HGJDc/olk7LicyIxWajiFUrRV9x2KJrYp22piW3IYsmSts3WWnqY7YOk8GwbMjXii08N6Mxb6bgyr2tD3g8CZGSkWMCKqE8Gjd/WYL5RMOe9w+B+czQCGoSYcGdYCqGBBOOXU9AJWu17T/4GS1DS03BswZzqNYAjIu8utLsMo3nq7vXxR6gMpxrotdiYn4zUbvXghJwF7+L+EJzVIvV6o+weIQ4byB1YrMEUGk0oXvGI1+FO6xPJYQmOKbftLWN49Oq/sGPq8W7jQ5dJdcs8NOPs9HAMHgD0mkrHcDS3WhY0F2yu85VHkTmE3sfGKmklr5Y4TEeo790TkEBDXPtN/TVf1vesnPqKiMRALgyDqsuMJdEkycSDZ7AqoBddtwMNE4KHOFvD5s2fZCv5vOL6k7sROPET1GMqqKa5IqaLtB4Sq+yhcOnPAQP9Z1+E4DD3uBKUe4TjGUcIbbJSndUSrA6dZ8ixX7hyTgma6dExtF5o3oAcIAgDgYbedMYwUMMxbWFHFSIsUDDRnE0s+ATA6KSwzGwKBkzgBcqYcMarQ20twDw469K+ZY77vSgx9JTEiFHyQKBN4HgBunAP6Qixh8BKTvHj2rIw9L395OnTpTuvg4eJ8ldBvBZqn+6sWj3tnMA0Jo6fVSG4T+tyCEb8OEvw1DwDpJsJTIuAjAiac0MjnUxdFA2yVjg1ejBbD/SgYzhCyjXE6UeSghAywxBfbd2S9g3SedcVuncgldQBWJUJuHa/OTVrZCNVNr5MaPL2DIFMKZWkjBeadvz4U/36ipsu3QcZnP8rZ1BPSyH/8ZDBvYhcwHx9UN0jn9skiKCl4rA+lpsXYCIcE7qcuEum7gQNMb/soBjnJPVeZHRNWDwNv1aAJHDuIFmFgKSuX1y20dIIaFix+CaXV3VlFjDpGK4m2C78jdlsukUoomddK4DjUNujDD/mJhorF4wr853JG+jCrZLAX1Hd1QR0IH7JKBqtksEoGq2T4ZpQMD40vhct/R6iksYvEkwh8cnhScVPj3aSAh6zscVCyB/zzCRpz7kRz7MSThYlRO78O2Sl+uRWo5tcWFRXOnF9ToarVAegwQYVMuqWQ00W8N61Z/BauT5+LGrtPtVIWsU6HTLWCU+2HCWyOY8nugAW18Zpr4/X8uo06MQf4Z0SfR3vJJ48/dBGfu1IJt4UHwprJsgqGwKUbJhGgB3bnAlocZ9qwY96at4B1JaLJHcBwz9XYdru+zE0iRyP5O7JcQD4Bom+1aaEq7otg55azFs+uOm/P36VaL43iex4sJSyG+r0uDhTJEtEDn34W4Sy+A57dlhS28Rq9dfndiUF2LxAx4sX1+zq3w7ovQPyQNbIH5SL96SLMnrde3HtONOf5VYA75Sr0avSHpVjn6h1usXnkoEEGbNom/An/m7Jep89gC/quEHQjQql1vAU4vIYz9brGtiPdPY7yvDtksSNuCrhoB0RWtfbrWa26fL/WRG3g8Z47AKZQQ0GBSF81hWPrXvTk7vA8Kd2kah3FbKj5tXK9FaJ/CCFa7evuMhH7wPN3KSTvDt4LHGdI9+jmPa067XMfZNn+eJ+OZV3dIW7vtee3gfvP53NnvIrV+4XFl4eEL4GLwUE6JyvCOvMgS7KPv8rjp9jh+gOGrZ+Y4uMMxC4uBchZgjz8xe6dv6GKpvpzbf+yD6DgSs6XYAXK19AW3MKOGUqkvDOB7z70eYYuFN42SCjTL7VZ4fxtFCbL7Xu6i9zqV7qAL8K5gIsSqtEpTgfGoDVxSLo+uZLDwFmKRRjXEf8L2yWtumWztOeJO+VtoYufbF85GNCclx/tJUR6gz8WZlBpPlrso1Gm7pwpZtAETizaqWj4E/23SaQ0jSKa+Z0wJ4lDn2yPNc7JSwZGYbpFgdkofJcnXrMe2nAg/3nhKo8/lEqL7Is33wPxGrCu7UqHg8tr+AhoHf677kPJWrRnAvsWG0GhkSJUsCSgF/oogdK4PcKgOeU+jteUCWBpRthFVi9fa7gM46wwO4Zxczx9Ipa7FcSdfXFB3w1IZUeoAKbr1sU9h3YRm98Wfed+7y6VlnDXLufLZGfm+Hbw3phlQhRj0YGtOZw4Xp37MtXqpYQKVNujzgB3eJPfL2E1qa+pC1LOhjGwd2FMPzhyVdHUfN0Zdw358jG6jW7o+05TcDSpR7TnpXbZuIfyu5A2sJwkQmvDGOvMV5uOzOn58Przmx4eDv3n58HV5dur8+Gw9+FcHZ3P3c6g0+1d//b5cnDd6/f+e36mfxlc9brn1b9/n22X+MMZejL4yKHYAviV5IJS8SPyXID8EmCFVyxMYmKIqcycQw5VFI+IP2bsJWsUP4020izr5pmM3IU+QIl1mrjcNksAd/is0++x3hkOIxFSTpc3LjLsAr8znsDwbrhwg+S++QK1BU28rnxyLqH+pZzmcx6L3NHSyqx/CupXG9YpezrzcQxreXgVxYgk4BxD07eAxuhulK88Hd/5Ez7lu8dmJczJ9wjsWdATkJQMlpM6U/Rh0MW5wfYCHqM0D6WoAZGM4ZvHnPILdaqxD9UaCesixGHT1Ge0zyJYKe7AJiSnFvLHwCmgKweqSppg30VuvCKI+BSk6QYVeuydEYVTjvoWFMk5lZrBTX+HMniUkJkLrjyCzCj0aBR6JfCxEPiyM4MFl5hI3PdRb7t9Hd4M72kRLkjNrLS9y9BVlww0VO9Js9COwcAzoREa2/c5bUPzAprEe+btqVY/L0PBL4Mz4ClxXjG89VabYh0Jzwzl8IIHlTjNFaqC3Pl88uIXvho4dV7EcfVuOFowulH6wGzYgdCFdJpMbp7mJDiZWDF8ycayXdWfq2TedTgDEMIpXH83+y5d9p5QXCoJ+euDmOOz9L3jhClEUwYM7Pj2ucSBY3c64BG65znzvUjX0EzDg2XkTugx2slfDw3moE/hMu1M89HsApJVpa7HifMgo1VEtPQcEYR0I8grAzqHg+l6kuUnUYT7T2At2TBsxTFH/E820pL30/sprH9GVuEp+R9S3OYzIc2mdzkpE+VJiX6U52+GJcQGjda5Bs7vYYfSfZhvAziibqYmIys2YHAy3HKG0iF7tthd+/HkjyhMlTGo6vhunalT6AK31FcgqyQlnIZhvC8LwLpSHiAOgCSn7TcMhsAnoq6iREGsvHCsVan4yILjgfVPfWelkcp4lcne2v810/qO2jyetIEK/Lcl2x7JXQVEEkjQlidkn8M6HvyN25c0iFTQd1Z4d8AhI3di+OzN4AQjfVgwr5aokIpIq5MNIDfAwgI7d/AvITWg1W9L0AZV2xLdtaf8FngCHH+pVIExNalRpd9pLWLfU/odJ9JGHvXPxFUSlPWvaKHzRrZm6MMEbqvJZjUcIfMcI8yETJw5H2bca6WNw3wHFQIksgFsiABD1ri6VSP/51c7H/rOVf/nV+z4beTcunEYmGfDGI8kq1FUcTYkNdVi7T6Pp72tD6d5QxnaaqmFjNSWTa80uNnlFSEDEQNDj6Qe4QtbIwVP+kUdDp659TPL45OySl096GePfI3yV2iZMQ/DucclUzONM97S94wUtTvaZ/zlxgv2rfLw3yo3vVUfyAOBfZi0D5OH/zAJ2xU3bh10nruDVD0t1NQ1WMu1oSzXDMs0FXdG26YB9qux8XNtYhUd4kXGcVnXR9OBXtaa2GPdmRuBrEktqtYo2MmYx+4EmBVq2pUqjaBgZzJBAe3cd1xvO9VDWQk1FiTWcaxG4AdtkqQeQ95xOX3tTsCq76BmVuEqPQXB8ya2MXWiKRkB5qbA0ZNQsGYz1aG1dcYgyimlgVTzki5QihacqUBB8MnAynjpKEMpAFhalEuFoA/9Fvv4fgzTlbCL62F2GIi3tyR4IsFB8RE6JW3qXbRD0ZxyOA2e+CmhNj7DWp8wtX2WydhD72Mqq8ztlUzZQoSHD01NGR5paop6DoiqnC/ZBXciGtyH/ga6plC06amizVvfJPAn9FX7rNTWQBh+VDNHckD3/VmnMEOwLOoVFnckcFftS95il1rJ3YBLE7lEM7zDJ7iJlDLVOLWVqHML80JMhyS8WUKO6hG0BkQ8WtDI7+GneeWDCvEZyN8owL/dy24Ja+oNOk7Feb3XuuomOg/mbpCZX7TYaDlND9AoPRh4ijDmEWq7c+foX8/Y21OtLTSP0d8otkhW+YRii/MnbJey1NLBr78PoWV/48vtuN+CSQsmfwgwuU3y2xnASAbyoS+VrBrBDBX3/Xz2Qny+fanA4joISj9JJljTHE72qisZ1nAf+toEjp53az0Ku1GcAFhUVbJWFXAWyTgtXktFTrSZtXRLfj5CTJ3G0B+06QjhzoOKeCklWgs9dD0X/qjTTznSIVXVun6AMAv8YZL5KnrhHAOjiKUzqQU1L8I568B9uIJWBOkNqaruwQ8DV8ZT0a1f46Go9w6s9PJxykgRI+U6lJpPJ3a6oaeCC5wHU3qo2d78GdSDo6UrMq5qSusKbXWZb/0q8WpNS7FtfHTXcwJNM9jZsZ6UR+CR/DV1wysMitZfPaZmt+8sW+cgnq0+D+nHlvzf5/Iz8ONwjbZUzyGbii9JJXvDK2M6KLnh7S/n6QvKDhEeVCO/JGMyycBx5MDKAQIlq/k9BM0vKjt4jZ2W29nSvgf6BUnq/dVFepNrAldwlps3/xZN9MREQVnd6UJ4XR7VmNDh8IJN8FSQfRhBQeNW4drbSgc7IHkavzOplIc4DTpGF8hO40xrEX9NY3VlbnEGalLi4ciEvcOcHmmnrkVBm2QY6FX4oOdCC6ylCpH505KkVkADdc02cfOqc16eNH2eu6ow7E4ydS2/HdczcIdd9pPquGm0pfab9K3oeo7r1wMHA1TXCAyj94FEfKoqUQK9zjsCj6O0CJWNr9kcDabORIym301VaaTsKMlch42uYEl+xRAhgKhWI60l9HVgDdUDmZfU81TsS5MS9FdUmpBlOiCttJjQkNaMxtw97ZRoyRKnXRRIJOIuzFo4hWbpR2BbnjtZKb6Hz+2KvxEUzOyQw+CzSGi8dJHeOSv8I+C3pOrZ9OunRmkS7pvYbBMkRzqz29o3xMFBOqoB0a0PCnw/XPLJI608YM5SN+o1DnRaiwtrPqQLPIxG0gIYbSUB5sK+wPDcMXq4xqYdLsrv7pQpStlvnf4FrKIOSgliWUTqWOKNIzS4ej0y1dtPM8Iqo0PNKWD0f8f4rG7msHQzX8uPtpZX+l/kSFv2oz2IV/fCNlBYM8OBpri24cdP30DcHKtQtkxrB6ZVQ3Va940d43SZWgn1BN5EN5AmPWfLYBb0az2UW2ySxlZHGb1VVf6Q5kkpvTmZFFa+QFUXMMzoSjGOlM5Ge2hJ2PGNK1xStdRuhhDpHXIs5+uELhM5corZtt7sYhPrQgP9GqfpvSj6tD7Ro23B7poMrXMuXPkOJ8tkYOru6s+fnCmAAGZYdtSBk0nFHvYXlURWWmW8UuvwRLY5QizOHIAWddyG1GMRuu5MqY5yyh4n83nqzSYWPT/vfrJOEkitpaUZg/YKkk1LvTY23Qewv89mOMPKzEObcHb8rPlS7vE4ChOMobyAraJpnoTL1SOIxuooO2Rh10EcHkTuLQDDjgx1WfNQLGUlI0Ymx0QAcPUcByGDSwAjdHrws9AhScfc28EIYKv/1Dp/YdlRCvrwD3kEUq+xllXx/hgqXitAfbcCFAxjJq4xsFyNLfruzZBJKYrFVEUmnpDBwLV+T7VZ02UNm/QznWLZS83KLYclt1hDmCraxI7PJkNyb12Rm3yVWXAaTjufpLJgo6hNDuNQ3zVm6MmIwzbwpXMgnnM4UtNEmxxkSTx1QHcyV6lh3zLoprYt6dmSEQrqNTBMy8pXE8N2G9o2b4bUqYz7yB1rHF49rXEadDtis8TzVs0/EseT/sQRn/GIB9oJ+uOHvmH6rHqqbWisKjZ1RXHSoAFhtA/yxtQ/QFMjfMqaufcN87FuK0eAeRA/wkTU5F27GHJgaKuyiSqG5/weDFSfKHzCOvi/NobCpnhNe4QplgFjX1RIwMXAxLtZCpYD8Op245ctTJ+V+F/V1wE1ZHWD45Rj12hCPipTfR/ftmSEWmh070Bu9PVPymyvKf2qm0qD0aShwZfuSWbETmobah77lZH0x1wGXCDsjdRvUxFZEfHwRcQDEZasNGKlkcOXRr5SINjHeIQ5EVxCMZemGUYcilK0PORkpYj1j/YgW9vy3gGvcmmV1nlvPjLmTA7jjHMPITrkTAHgSOez0Xz5clRwQUNzaYU6cmhrEIW4FTtRzYfGUS9fcUTB9nUPMnKNicyAywuBdDgyicDdAje+snlSXnRpsCftuijdFNPQKRRSEHohSx4ehMl8UQziDw0akmgdACflUG0cn8Vr8ZwJJ357LKCax1X4PW0M+0RB9IYVwfPM0HhaRDbiqR2S/6DwEri9q6zsh/iLTZ1okbRF0t80krapE23qRJs60aZOtKkTberEw9QuyNSJ6KRWhVOtI6cFnt8X8LSOnNaRc1+SrCOndeS0jpzWkdM6clq8bR05rR3yV3TkBBYeO25UKXR16Cc2OB3aFwIrqB2qoHYQDMG+ENgXAvtCYF8I7AuBfSE4VIlFvhB4YlYJVnunfXYxfGORqkWqFqlapGqRqkWqFqlapPqdINUkcOM3YXQBfcbVBs3QgVSbUpmKeZRlrh1xc8VJ51ddxmLiw8PEMj9MKRyXTGZAX1trGQttv2VoW9vVWeUOyWWdQ7/mRIyy6DoDOKrb25Lxl5ZQdstdhjnAsMlCHC2TIegs8+mGJveR8oN+PpmzCcXROIFlp7CVS36bz0KmM6nLySiEkWLTBEdb+YBMFZW9wGYGcOtfr+r4hacZZLBYzi8pm93y07NJuKprgpUsAc0rSkAjrwu/WzCt2eOl8kM/5QImfb8uANrhHAuYYJw84OUqF11DcvYIV1hgAA+qXAZo2HIKKqWJAuwrBGrzKLyTOZ0LueTgf9JV7hlKNwFLgtQvHksO8ff6DnhYpanp1/vZGCQ5RbkCjh+/DM64NByp0TwV1S3pTUWDI6LX2SrAnE255CfyOlX+jVd83ps+LsKC9pRELgClcol0imDvT6K7kNE6Dm94cKbvwu1CqD6iSpIZdoaMmjB9tjTnyIHuF8rER84Exha5DLqp1U6ZO3RyG2RqzrwUT2YyDco3bPeDBgVFux85EOSgpfFvw1brJwS3YMWMVLvoWtB7SKDXOqLvlx/uO9EP7pAHLUg8SqsqYVeVKkUmyXXYx1L6NZkkbb/gL5m8lYZ/0e2eMCeOnckiU0+YaAeZYCPFSel8lsyww1wtBA/DNGDgvk7ANDQ9jkpnYOkN3g2/CweL2vG6ZezFVJ2opAe5pdMkxCwLoiTYR0w1GzE4pEv2iqHmea9tIks11Xc/SbTQxPBQ5vdN43LaHiD6CWLbKx03Jq+74mjADGNWl/UO2jlE3xFGfnIAgVHgXtLPKdCnLuYX/2ZTAAq4yPKcpMbdEyCznYg0BOb2+Oz2Dj+kO3xPJsZvqv3DOhR8i53/MrTZAq3a7IdRm1knM+tkti9J1snMOplZJzPrZGadzCzKt05mZWZsncxstkCbLfCHZFpPmC0wUyvSDOyaFRCrm0oNnRlwS9a/OqkDv2ZmQM+dwVBcTHcgTDWNyqOGPzP9+7euY1m30vATJnvc5S37YVO6we1sivswqnGlUcDDPsn/HjbmwHvYnNruYVOmOtIy75B57mFjCrmHevngHp4gndvT3Ac7gp79AEs9PrUhX9XDpsxT9lY7sFsNm0rm1Q9/7wM4WgwtonWuI+tFZXXmB6ozPwjZzHpRWS8q60VlvaisF5X19z9cxPqJUCsI2QVDDdSKnO7h1qSeya5X61wbSm4cyOiitRnqSsXlI91jzNvPT4fqqU9aTdGT4LHkdviqh7dcG2/n1+3UHpQ+q0f6b0Y9sl4RplBI5rFC6WfghtDm9OtSFu52e5mbRI5GsnfkuPpZL01MNMV9Eezcctbi2VXn7fm7LCGswoI9D5YSFkP9XhcGpmaJn0U4i++AZbclhW28RW9dfndikN17ZCrHKvrTRZg9b72491CFkF8FuFKuQq9Gf1iK8gnBFptHDmznGeZHnEcyAWOv0y9mF1rHWoDBazRTr2tsO9Ldy9SYQxY74qYAi3YAZFVrv/Ud6mtN1AYW77n1bA6wVGqojMlaL3pyd3ieFG5c7eOjmM0jLVStDH0IMvTXetXduKf/2kfdRvlV18LLQ4KX1otojRfRLewY5W2yM4HvPvR5hi5Ss7SUhDL9Upn1dVJoHoiqT67kMHCWYhHGdaT/wnZJq27ZLO154k55W+jiJ9tXbmc/d6X4aLGPRpm9U3BLHyz6b5NIqfSq0Z7XXKQ4Jy8ZmAZweIuiUY/Ed3niNeuhDQfynxeu8vhDabTEdg/7eA1Y1yaWw8HlNXwEtA7/XffhUwnxmsC+xUZQaKQIFSwJyGknSuQzMguD5pT7ON5cXliohl1k9fK1hsswS+kOcoKHJrLkz6Pc99xgX1zQdwPS2BEqSPORotPeWkdzrS3cu0ulJNy1y0fnyJWIYiw6O7j6p0q9lFCBWnvUGZD7P79fYuQE7ItS124YA3sXxvSDI1eVDDHXnHHXkC8f57rv++j9RmbeMMWeK2LyzkR7aj5lJclUJUJGtDaMsc58tenInJ4Prz+/6eHh0H9+Hlxdvr06Hw57H87V0fnc7Qw63d71b58vB9e9fu+/52f6l8FVr3te/fv32XaJP5xx9NpDDsUWwK8kF5SKH1HODj2BFV6xMImJIZpeABlyqKJ4RPwxYy9Zo2Q7vJFmWTfPZOQuROOQOqmGlclzp99D71/D+ULeuMiwC/zOeAHDu+HCDZL75gvUFjTxuvLdP5EhYP9STvM5V4FA9NHSyqx/CupXpViWMkb+bQxreXgVxYgk4BxD07do5p8FmNDObLnusVkJc/I9Cp1yWkoGy0mdKfow6OpUzCr1MZSS9uWUfvkxp/xCnWrsQ7VGwroIcdg09RntswhWijuwCUMYedRgShyjKweqKpv3J0oDrUkTFemgQ3y1xMcoEMk5lZrBTX+HMniUUKAWM2E0jkKvBL4VAl9Gi/iJxETifo1VTZGgN8N7WoQLUjMrbe8ydNUlAw3Ve9EstGMw8ExohMb2fU3b0DxmR1fJ0feNMJPeaiq+h9QUp8phjDJTI8LM3qnl81nl0xvn7jSZ3DzNSchsz9jwJRvLdlV/rpJ51+EMzGkP19/N3knt0/eE4lJJyF8fxByfpe8dJ0whmjJgYMe3zyUOHLvTAYclBKlsvhfpGpppeLCM0C+FojnkrocGekI5qBtVnWk+ml1AsqrU9ThxHmS0ioiWniOCkG4EeWVA53AwXU+y/CSKyFEGa8mGYSuOOcVxgN8V76fnU1j/jKzCS/I/lMPLTHTp3WOXk6IjgAX8jp2/GZYQGzRa5xo4v4cdSvdhvg3giLqZmoys2IDByXDLGUqH7Nlid+3Hkz+i6PgPBlUd360zdQpd4Jb6CmSVpITTMIz3ZQFYV8oDxAGQ5LT9hsEQ+ETUVZRs9CrDRxYcD7oyRnD7wE0u0pAnqezdYp3lkgfTTOs7avN40gYq8N+WbHskdxUQSSAhNYNH8xzW8eBv6Z0HJ5AK+g6FA4NDhnUc+OzN4AQjfVgwr5aokIpIq5MNIDfAwgI7d/AvITX0kW5L0AZV2xLdtaf8FngCHH+pVIExNalRpd9pLWLfU/odJ9I2HvXPxFUSVHgiwTK8ka0Z+jDl0rdRmSNjzJiMMBMycebQrdVrpY3DfAcVAiSyAWyIAEPWuLpVI//nVzsf+s5V/+dX7Pht5Ny6cRiYZ8MYjySrUVRxyrh7a8TafR5Pe1sfTvN2MoXIc6Siml5pcLPLK0K1Abt6hC9sjRQ8GQHqzK1/TPZ7YeCtKvy8aobiyFtjkFr2W/fkeCJYt06NsRbbbdIj7WE+IR+yTVF9ncGE+0jDAN1u/LKFkX4SjASRE2YdbepZqGiKpLXldvJ3qim0l2VqTchHGcWq6aNHsnw5h0b3VjDT12mQL8nvoW2kiDdpaPCle5KOmL0HulUgLehXGviNuQSCdFEj9fYN3b6hH8jjlH0Ut4/ih/8o/pUeqB8DiZ0ILqGYy4AaBj4uafGRk5Us6R79frW25b0VcTlvDxVNh26oJ5SFcxhnnBOMtShcADj/egZfstF8+XKkFWluJs4q1JFDW4DPcSt2ohqwDjHPqJevOCIjQDOWeh6ZAZcXAulwpHHj3QI3vjJpJfKTIFVCNTQYIa1WKtLRUwf0QlIbD8JkvigaF0KDxotAHQA3pJJaLZLJkZ4z4cRvjwVU87h6FtAhzJ5IuT+sUOqbKnv10GHqef9GcUwKTF9DHLNRXG0U19qKZBvF1cLFvzyK6xcbD8TGA9lGiY0HYuOBWNb9VeOBlPiwNgeTESC/cT68nnMW+1Kjk5A79fw4loz8hIQVI8mOoUzHh/vI8bQ6fRM7RmuAGktO2uGybdvuvHrLIy+Jsjl7sXyHk2UyMAPB1J8/OVPdwft0cZQJLqnE67009GXh7BGtRGS6CsHzplDpwJqv1DpsuKQ2kq7qaeuGTbfZGg0IaiamVEdZgMOdNk9N59Zef+UXJK0JkkaFWukhm27tfF2WrTyhMvPwAZodP2u+lHscpOAEBiEWsFU0zRtu2TpEY3V8PCDJoVX3Yq46FEtZyYjHAZsARWJ2HIQg9qE5oOPBz0KHP3nkzV73VU92lOrW8Y9Cxj0bOegHebGxsWy/43eqDcC3tFBvhkwGtGWxVDvhdKnAYyLNw7QJLlc16Wfh3csmcRZcHxK4ts9o1bSJHTNYDOkZY0U2+fkEFtx3XC8L3YXOA3ibyMtT675VMENtGhKH+q4x41xEHLaBLy0R8ZzDkZomMs6YcSjTR3t6RNhOOXo/6BeH9GzJd496DQzTsvJhDF9qFDaAts2bIbVg4z5yxxqHV09rnAb4itgs8bxV84/E8aTxcsRnPEKFnMqf96FvPEGpnrL9Qdy4JaP/kjmkOlq0cdq6YlNXFCcNGhC6FpHpp/4BmhphVpGZe98wrYC2cgRMrvojTERN3pUKx6YutuLLvCGfzRdvofj3AcVtvnibL97mi7f54uvodWy++G84hZfNF2+lcSuN/z3S+IFo9my++K+RLz4TC3unfXYxfGNzQlhx8lDFyQPhhDYnhM0JYXNC2JwQNidEpilOAjcGef4C+oyr9QXQgXxfpzLVhqRQ5toRN1ec3oWry1ih8ZCERsw+YXrVeEnkWwhsIbCFwBYCWwhsIbCFwBYCfycQ2ALTAwamvyRjipRLjpPfhcu3td35sZGmNK3ePsTczpYxHKBfuBffX12ktjyawFWYRM2bf4sm4h00vFPmPUJ4XR7VMTUdXrAJnopZ+qSSf2KRSbA01qLAGfidSaW8/yWcxnfwpTOpwe6MFtJadAFqI1UDrRi3rkKTI5N3DXe0rzW6LhrYVtgcGldgDtmspQrZ69OSpFYgjaqnEBduXnXOy5Omz3NXFYbdSU4+bimkZ73XPNhlP6mOm0Zbar/JZ7eu57h+Pdg9wODvAiM4fKDwMlRVAkxCsI7A4yg9M1XYherN0WA6XB9m5GiqSiMlyVDwQza6giX5FSWUvhOsRjrMjq9xveqBvBrqJZDrZ14NCowv0wHpgDkTGtKa0Zi7p50SLVniVNmGlE1fBiHgMPkjsC20HFF8D31YvmmLl0E6qsziRRohTtEcuYYj3qbguzBnaXbLNXnNtGclrPmQLvAwGsnEDBjCPnBj2BfQOCJZkCJE2RxPUcp+6/QvYBWjRMagErETUTRp4o0jDEH0Omf2/zQjrLIe05wCRv93jM8C7EMC2NbR7zvWABa2gcKaGQ40zV42/Jj3i1D5WH4ZpoBjh4cAK6dZOc3KaVZOs3KaldOsnGblNCunWTnNymlWTrNy2lPJad+tnLRdnLBM6+CYVo0gnbsnBaIZkFi3Hpq9VnnQTaUGjWOrt1wdpzZ8pF7jdWRSWemDVF2gKmzw21/OrULGKmSsQsYqZKxCxipkrELGKmSsQsYqZKxsYxUyViFjFTJWIWOZ1l+skEGtiqmVUIEHm+hS1WSYHmgvRY3ZpFbSbNfBbFXkfF0lzfvAvXUYesLoOLzWe9aqZg5UNXMQEMB6z1rvWes9a71nrfes9Z49VLhf8J7twJl0IzY4HVp0atGpRacWnVp0atGpRacWnVp0atHp341O+6EztrjU4lKLSy0utbjU4lKLSy0utbjU4tK/BZfmilA/areV7HL1PSoou6o7KTEVY/d2KSVaP5/C54qLJRwQ2XPj6NWzZ2U71lMHU7MCmxC4b9DOXW01OkvSiKv9u5BWG2Ky4L6Df5kT4sNVA90aVqpr9qEuWDYNMUZyHkVhVKL8ZZnyS2hZopUgVObFQM8DmXtOErjJV4TmTzmwh6iToC3xR5p+n8eLcIrHM6RBL8nO+KitUgkhsdo2S1ATSeTB7xruOEu3JdPTppinfFfSL0wvIetiedYZ9I6QAE3fEKdTTo1JZTo72COSQsVwT1Mh+Eb+8UZfGL/fxTRuXKYruZan4XR1fu8gKs04QHZoU5YDvIRU902DCU1SGJnKOkbNnDxhfJ9H29kPRXCa/WLgvezLDE5l32U4yOwPUcyzHPTIfs2jguz7/CX8rHztmQNdc1ERZ4bZdoNZSIulQ9vLNcdF3rYdlLmwUIUpw9iETl1+q5kbjDJ1EzqYhf+T/YCsGe3dqZ/nrZ9/bj3Two/vBMbaSw7Bivm4irR+yXiAqgLohwX8rlQTJULAG2E0dwL3T3kSqe49QMR+vjCcKZXZk03gi8jxYAFMKK5ap3sDAQTCVjNtuJE6FTtAIcMl2yyasC/qDH88Ms7wJ7lx8NsvX8aO4O8j7+EBv4YTEknmAPe5MuuifG4b5uLSHCbgLx4BQ5a9zVwetRhcLDwg6DGpnmmderw4Z4Wk64oZk2ZASR1rB3/DV8hto3lvml5Br4+Ix+jLjZie3Ofo8wRjlpW6cmTNa2w3q1vi+oiBZI0OiEXLeGNZk7kOLofXyKqAERHvpyS+R5FzhzAH/gt0No7CDP3Rd1+AKQTzhC6JI9kmHjUnzxcLfNBU2jjByqAQ1p1KXGPaUFh7PWOURhTIhcb/H+aM8bs= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new managed identity in an organization context. Managed identities enable centralized credential management for HPC environments. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-organization-member.api.mdx b/platform-api-docs/docs/create-organization-member.api.mdx deleted file mode 100644 index 2a3bcfd21..000000000 --- a/platform-api-docs/docs/create-organization-member.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-organization-member -title: "Add organization member" -description: "Adds a new member to the organization identified by the given `orgId`." -sidebar_label: "Add organization member" -hide_title: true -hide_table_of_contents: true -api: eJzNVt9P2zAQ/lcsP21SadmGkNan8WsSmjZQgSeExDW5tobEDrbT0kX533dnJ7SlpbCJh720ie+783fn786ppIexk/1raSz933Rkii6xqvDKaNmXB2nqBAiNM5FjPkQrvBF+goLgoNVvYJxQKWqvRgpTMZwH81hNUYtbQp2mt13ZkaZAG8CnKYU9sggez5Zi/AzRCViAhRw9WmZVSU0v5BACkVUxqQL8RD5nuhxM6DJHq5IFMY5s8aFUFml/b0vsSJdMMAfZr6SfF7yJ0h7HAToyNgcfl/b3ZF3fRHd0/tCkc/ZZ3T3SF5CmKhBowBQqMRRVe3aBoshUEhj27hz7VeskzPAOE3YsLNfMK3RsLR0RW6Cct0qPiVhHeuUzjEcVWQyavWu2riYdFlxhtItRP+/urudy9uP9aEfRvBXH2njDaXRCNf4K/CvIaK18HUlZqGyjZaSs8y/6ZbDFCFPwsOm4qPwm2+BDPEiyoQ1nOqSRt/2QmCyDoaHmMZb783GHoTtTsNwa7k0+rUSoRwa8/7JsomaOh8fevCSnKBjWE9n3NknmENJ/kfxCnNdE3jkYY6D7ilQicGsznFhr1pl/2SD2di4JbbyALDMz4hPQX9fRx2VMBwVmmHOO/2m2ZHSYlFb5eRijhwgW7UFJg7N/fcPjjGbsxPAsLsqwK8/UvuzxNdCrwrite1FQrkdjTXJAO23HcmmpaeTE+8L1ez0oVDfJTJl2HT5QPbvKrM3ni2AR5xl4blFxxHhxcH4qmU1L9oKrFTNfpvyUPO8om9HN78MAopX48L1t/ruZDxXiUxgsBvfJI+RFbMA4UJc6U+mRCTs1RW0IM8PXcuHKqARdA2ZFQBIUsVqn5eo0gyds+21hICJc5LjPp+7+fneX1wrjfA5BUM2NSP25egk/df8K12qhz/e7zJvD8Pjoe0UGdCnzmLVhjkYhNd8THdlvb+5GS/TEaqIjn1BKDKyqITi8slld8zKdlWXN0iPNOAVDPgxSXKocP5NiR5A53JLmh0HTaB/F6x8FG1NpFkHPJbPISn6jx3ucP32L1DcEnCCkLCPiF21HkcXOJUdY+K4NhrrTehwkCRZ+K3a5W8+vLlntzUdIblJ2sTDj7xv6DTRNKEpoorBW0W2lx2UYIzKG5N6A1dZ61kohqY2FoAMLiEtzj5oOra2L53euS13/AXtEkQk= -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Adds a new member to the organization identified by the given `orgId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-organization-team-member.api.mdx b/platform-api-docs/docs/create-organization-team-member.api.mdx deleted file mode 100644 index 799498f8a..000000000 --- a/platform-api-docs/docs/create-organization-team-member.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-organization-team-member -title: "Create team member" -description: "Adds a new member to the team identified by the given `teamId`." -sidebar_label: "Create team member" -hide_title: true -hide_table_of_contents: true -api: eJytVt9PGzkQ/lcsP91JIcv1Kh7yVKCchKorCOgTQupkd0hMd+3t2EvIrfZ/74y9+dWEwCFeoo09M/5m5pvPbnWAidejWx0QKq/vBrpAn5Opg3FWj/RxUXgFyuJMVViNkVRwKkxRib0yBdpg7g0WajyPyxPziFZ9l93z4vtQD7SrkUCinRcc75QQAl7QBKz5Ly7fsOm/MTQb10BQYUASTK22/IedHE3YeaCNIKohTPXvMNcDKttUSCZfoZPIhD8bQ8gYAjU40D6fYgV61Oowr+UQYwNOoum9owpCWjr6qLtusESS8toLRfJ5fwh3yR19OHHFXHx2nJrH4qrekMPkjiPaIOZQ16XJY4GyBy8+7TYAN37AXBxrkrYFg152G4/0lQtwQWcVmHLNwQcydiIl0sGEEpcdXnX1qkfTidFmCeKCr5316ZwPh4fbmV18eb9EEoVfayeEfUVvBrE+/8v4a2TTVhUHGp+pLwcy5MOzfiXs2YRHCEA7t8iVO3wYBxNYVMHNbEyjWgxo7soSxo4n2pGoxdOBmB48AsmE+Ff5LJjCQ3sl56+zJ3Hm8/hzcBvrrEPrlEqkEU6xzcddtDmB4i2DsCLoLSfgPUwwQn6BLslw71ycEblt5H/vIPxCMJV1QUFZuhnjEXOPeUMmzKM2niAQ0nHDEjS6vROBYOGcOhHZ2sWkozyNdMby6bM2imiXRZ3P2iRkXZaa5LUEp8eF7jbEJNTTEGo/yjKozTAvXVMMPf5kbEPjtlTvOu6oyxKCUF6dir06vjzXgmwB/FrqnGq2Dn9ZNjlR98Io/8fRiFfSxz+LYXqYhVgQ6d/VShbPnqCqE6G3JGuN9Mbeu3ho35keu4B9KS0pksnR98ZCK8gjrTZLtl6ofqbjsZ9WGwxE6p3O+Wt4dDQ8lDXpXQWRlf2dkwQ1XbjLmdqA2a74/Q4Xdt+LgE8hq0vgm05Ui6IsJUrdyo0snBktbub0euCF5QW5IBZ3fyp0ZKe2HYPHb1R2nSxz20iozJ8sHwbG0gwmX2G8fDOR76H0uCfXP676af1TvfwA2JlWvwh2rgVF2cg//vyB8+W7Q67/N2F6/iXwBix9Ybs7tpwiFHKNcbHS5mk6/uBGQqyct6ROUkkex3mOddhru64olxfXNzKG/dujcoX4EMzkWcO/EaiL5YjTHddavpbspInKqFNMGVrYnPnfZjxmtbMUTJ9oceN+oGUKLSsj/6UwXfcLo9K3Rg== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Adds a new member to the team identified by the given `teamId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-organization-team.api.mdx b/platform-api-docs/docs/create-organization-team.api.mdx deleted file mode 100644 index 96779d320..000000000 --- a/platform-api-docs/docs/create-organization-team.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-organization-team -title: "Create team" -description: "Creates a new team in the organization identified by the given `orgId`." -sidebar_label: "Create team" -hide_title: true -hide_table_of_contents: true -api: eJzNVttuGzcQ/RWC6EMM6JbENVIBReNLCggtYMN2XqqoDbU7kuhwyQ3Jta1s9987Q+5Kq0ssI8lDX6QleTg8M3OGw5J7MXd8OOYeROb4pMNTcImVuZdG8yE/tyA8OCaYhgdGICY18wtgxs6Fll8EAZlMQXs5k5Cy6TIsz+U9aPYRUaP0Y493uMnBBvAoXdm9bNm4RdsIy4UVGXiwxKrkGgcID2ZwVRKnXPgF3ybaNsV0kYGVyZqWRbyFz4W0gKd7W0CHu2QBmeDDkvtlTodI7WEeoDNjM+Hj1Mkxr6pJ3A7On5l0SXs2TyfyLAk+sRqIZhKDFrUnuMhzJZPArn/naE+5S8BM7yChjbmlaHkJLqxSZPB/7cA4xgVZPb1Tps9xr8N1oZSYKmhCg46kl1ot47jq1GkoeSYe/wQ9x/gPjweULI+ZogD8PRbdL6fdvz58SCcvfhu2Rv+Ou//g1K+tqaOj8mXn9ZvqJ75ywHkr9ZxXW2ndOPHVz4N9eIx5VFPb2Xq95Svhul6iH3v8U8L593n6PUbQipeeYhjUQNTEvfDCjvaYbKMjedpzXSunouVNuYYJlxvtYmZfDQa7Krz848eL7jBq9CyRtUR0KOU76zGO763au5pBNsXr4twU0evD1byZqYvphTdfzUiMOaUEAcf7on4m0m+p+XY1Z+CcmD+joBvgk4J6Z62xO8xf79FLcyUzbTwTSpkH5BPQv+yiL4roDt7xoCAjJ/+n7uKig6Sw0i9DEzkDYcGeFnSJjCd0mWOHWRjqQ7kJWQstZcj72GdcvwzdpurHlki27H3TjwoSIV94n7thvy9y2UuUKdKeg88Yy540O43pJqywKyU8CZGdE56dXo04EWl43lCgotNttiu/6URe9ywaTwMIZ+LH743E7x58CA4l4Hrdsd49iixX0C7surOu7rhN1tvFF5r2elLqmQnG6hzUTpJXh/ynaMoEnxQRTAISSRDQZmzbEUUNSRUKeGberheQCCUmnvOyd3LSG9Ac5TQTuuVkLOjwfNnmV64l/AMfO3XWPDz6fq4EPluQVxEvsKi1Mb1pSF3D5m2zeoEtSJMIKMupcIDXXlXRNCbTkp7x815YGfs1SjKVjr4xQTOhHDzh34vrugiP2OHn0l4X6kmhl5xYqIJG+PkJlqtXWjVB4AKbI5ohfnHtPLLo3pKF9d6dS6PqNDtOkwRy/yS2XclXlze3VA/1+ywzKe2x4oFaNf4GniZEJZRZmCux8+t5Ee4YHm1S9YjN4tsqtuDV3khgxgLi1nwCjVlrAuNpTIGpqv8A+XTulQ== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new team in the organization identified by the given `orgId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-organization.api.mdx b/platform-api-docs/docs/create-organization.api.mdx deleted file mode 100644 index 37b73bef1..000000000 --- a/platform-api-docs/docs/create-organization.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-organization -title: "Create organization" -description: "Creates a new organization." -sidebar_label: "Create organization" -hide_title: true -hide_table_of_contents: true -api: eJzNVm1v4zYM/iuGsA87IG/dFcUWYNja6w0oNqxF2/uyXDcwNpuoJ1s+SW6a8/LfR0pOrCRu2m0YsC+JJT2k+PKQYi0czKwYT4Q29H/XExna1MjSSV2IsXhnEBzaBJICFwlhoJBfgA8Hoid0icYvLrIN9jLCEMTg5wqtO9PZUozrHe0xNkm9eNIIkGiqC4eFYzEoSyVTjxs+WJathU3nmAN/uWWJpE1PHzBlwdKwYU6i5dPYaF7zBdJgxk7fV0r9CjmSUMF/5P9hZTKLLpRk3wwNge61ycGFrZNj1kaKYaoI5UyFHAbILgu1DOtVcx2pyuHpFyxmbi7GxyO6DZxDw7H5fQL9L6f93z5+zO6+/mEcrf6c9P+gre+jrTdv6qPe229XX4mNA9YZWcwEXbVxcvu6o9GoA7yVoF18l4DSKXSjO8ALnFrpvCWtp102Z0SFwKc44M15FG/G9Z30GdyLsQLrPpTZv1FCWpx0nMctsgbHZ/qiQ3Ess18S1w29VwxrqdhYbNCWurCBa9+MRh0l8/N/VxmH0SUs2b0WN9VaIXCRZ1gaTEOcG09I98WraiWqhYPMfYmpB4l5iIgdgs8kNhx9MKrzLMd8iubVTgf4tVYdRvQEFlXuu/Ki8PIB7VPPjUVT29WG29VTn6H9RzAcRfsqmYjR/v7VugCftwNSyDCXKW89gqoosv6cKEK/U7D+iP0lO9Qzhv19JZGlt2zZc/V4Pj13+sXKC7XFpUfA467qOoPsnzxA8ZNCvlqYveIpWQMPNpD3xmizZ/nbjr6wfoqTQrsElNILssejv9tHn1fBHUxQYc4+/k+9pUOLaWWko448qcUZgkFzWvETM7lb3THL3Vzz+FFqnzR6V+hMDP08w9LmEY31whVXrpg7V9rxcAilHKRKV9nA4mcK3kBqsTv+3PiT5EqB4wpO3jE+Ob26EHz12rIbDk1wM7Zv4ynfyKZ4GDdOD2LK+4+f1r3hYeF8ODjk1+3c9P4J8jK0id2OHTpn9KRtGma7t+3RZrttj+3epit2dMNoSxb32rvXpK2JEoflpQByOmRKA2UAM+cg9ZzbTk6cEqKdVL513usf2wMyhDMb7jkanJwMRrzHNMghjk5oBVvD666ddcv+F0beJqUOn9ywVCD9KFCFJyFQrx2l58xIWtc19Takd2O14m1KrGE20yd1RxnGRCIzCdDwQcRgrn7CJdsSrOr75sdwVfHte/W56q0lTtMUS3cQGxfN1eXNLROxGc9znbGMgQWPQvTrpzPto+T57fdqmqyKWeXLWQSdTFvYZv0Oy71XzREUy8hCCo9H3OpPWFCIeo0rjtdkLin/C2jfWLY= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new organization. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-pipeline-secret.api.mdx b/platform-api-docs/docs/create-pipeline-secret.api.mdx deleted file mode 100644 index 2a3f7357a..000000000 --- a/platform-api-docs/docs/create-pipeline-secret.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-pipeline-secret -title: "Create pipeline secret" -description: "Creates a new pipeline secret in the user context. Append `?workspaceId` to create the secret in a workspace context." -sidebar_label: "Create pipeline secret" -hide_title: true -hide_table_of_contents: true -api: eJzFVU1vGjEQ/SuWzwTSNsqBS0uiVIp6CAqpeogqZdgdwImxHdsbglb8987Yu0CAkqqq1AtiPV9v3syzaxlhGmT/XjrlUCuDJwELjzHInx1ZYii8clFZI/vy0iNEDAKEwYVo/UX2F8qIOENRBfSisCbia+yKgXNoSvHweWH9U3BQ4HX5IKIVRcqVIjbxINZu6xSyI61DD4zhulyjGDbVRymYnBx4mGNEz83U0tAHOW+VJR/FXTxX6Jdyt7cf68KmmqNXhVAlmqgmCj05h2KGc5D9Wsal48SK0E2TaWL9HGI+Oj+TqxXx5pGqhHhhyyXHvC013CGuoaKJoYypdRM5EpzTqkjN9x4Dh9f7WOz4EYvEgWeqosLA1kzB2itEr8xUrjryBXR1yEKmqKLG35B82wBcsSOjVR5pINFXmA6Csybk0h9PT/f7vvn273rL1PE+/MlE3usrI+fGyPXsEPYLKP9mQBuW7uUcQ4ApsqyO99Y6Hh3QlffW7yH/dID1VjzC2ChAa7sgPOxOHFZexWXSywWCRz+o4ow+f/IOk5hmlgXnbMgCY5vs7d0TnMm/tMKrvCavWYwu9Hs9cKpbaFuV3YDPBKSr7J70RskihhoiT05csr8YDK8lw2hRjpjUTNA21jVHXLEVKn+PkxOd5D9f2514XMTUPQ/rdiPTq1eYO40b3bSkr+WyJSBlJjaVbobRdMCQ32uOqVIFXaLZmTcJirRJb4nbpouWSem0zhP7ZWNgJRPruc6H7vl595TPeFxzMFud5KXfvbB3odabtf5vN30zS/7sOQ10X1NDiZi62b/D79SMV5RsdT2GgN+9Xq34OF/1vJWlCjDWLMQJ6IBHWn/nITiI8AmXe29NuzVpiV/AK66ftEVwEUrKxsBy6GUuf3LH2Texe5fLqtNGDIoCXTzqu63h4c3ojrXQPEhzW3KMhwUd8i/h5HeWo5PE0lktNZhple4imXOycuCt8HaElrpqTGCWWwhpOMnjzj6hoQG1vEX+JriU/BenB/p4 -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new pipeline secret in the user context. Append `?workspaceId` to create the secret in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-pipeline.api.mdx b/platform-api-docs/docs/create-pipeline.api.mdx deleted file mode 100644 index ff77dcb93..000000000 --- a/platform-api-docs/docs/create-pipeline.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-pipeline -title: "Create pipeline" -description: "Creates a new pipeline in a user context. Append `?workspaceId` to create the pipeline in a workspace context." -sidebar_label: "Create pipeline" -hide_title: true -hide_table_of_contents: true -api: eJzNGmtz27jxr2B4X9IZU35cLtfzl1axfR1d7djjR296Hk8MkSsJMUnwAFCK6vF/7y7AB0hRNp3xpM0HRwQW+8K+ycfA8LkODm+DXOSQiAx0cLcTxKAjJXIjZBYcBkcKuAHNOMtgxSpAJjJcKTQoFsnMwFczYuM8hyxm939bSfWgcx7BJL5nRrLIomBmAZ3zNWCNJNgJZA6KE/FJXJO/KI/hds4VT8GAIsYfgwwfEMwjiTCCGP+zALUOuuL8XpPMihSUiJiIITNiJkCN2GTGZCqMgXin5Fo/JzJi19ECUh4cPgZmnRMnArfmoHBrJlXKjVv68D54ekLdKkC2tPko4zWdafNWSelI4xorwRGZJZkZOsTzPBGRBdj9ounk4yYbcvoFIjqYK1KoEXi3h5W6aihtlMjmG0qqGSHwETsrtGFTYEUmkB22EmaBuqDrrNU+Cp46SAbT8JYtFhG96jiBs5vLU3s24UUWLV5Wg4hfpnBqcdFdz8S8cCbpGwvRi2SaFwZOsuVkAMYjB80gWwolsxRReQjZagGq4yUrkSRMFdmIHcOMF4nR5E+N2+RKpFytWdSHubZlyypi+TTo8o/wtmVKVO31MzTj+q5niVwx+ApRUV9XxesrrkxBLrUwEhnHi2PvYDQf7bD7hTG5PtzdnaN9FdMRyrSboZcRzVDI3QUkibz/iyVKvBwL9TJNcncWC4VGQORybhalnmtxyGFVCrGgGDUTCcU63EclKFRdS/F9al61KXS1DkuhB/nDP4RhFfQOmyqOxrfDSPd8TrQx8FiMGrQug+NLKD+V2mPlGd/Y6FYV6CLFg2zGUeyYrlyXZk02f6GkVYdHiCvFKaYKA6neZKAbA4IxwTM5YzUrbXfKHQlraFbDFNvWlgcKtFeAkdC8CQM2bmuHjwil/AEYX6LgfIoM4IrveLWRWTd7QzYa130dL05t16jFV1x7W9ccaeEOeyeXoBSagi4BnNE7xzJyBerILg9w6IQbSnKhziFCs4o6FKUFdCZl07YeJkAdKJpcT8n3t6vzT+QQ/x6fnTKXXB1qBZdFdmURvIx8HMeYxt0K6pmbMp6BpUGKz2ahyyMVFEZZ8kOJAEv5QA5TqxgNOELnAj1iVwDs9gIjB8ciCAOcCSmEOhT67l0V3WIZ6ZGGP7HIGWFUyysdRoks4l1HeJfHS/R/iH9A2ULEF1b4whKfuy1afRvR+Qy1zDhmm03R2IIvwca+BCiu/S8kTbkYLmaCsmRogsg1naskJjN3BU0Z0w/ZPe2Pstm9JYLBUa2HJcnf62RIZ1AJmEVcusTskmG0aVnJ8dXpgQvetkwbRoKgKGS0CgKHwM8HNoj76KZSJsCzDXwnmY0uDp4w4C/DlelJ7GymsAIgwgnH0k8XEVnCrEgqoyht4NLh4g0KvLhXGkDEUaTQcfWD+y/kYYWQLKG09SJJTqkgNwNkvUDgkn86wTDi2QTYVWctZ1OSuHsyxRQda4hWnQeRX+EZWzXZggmpkgm8a7wIo32hMhYXabq2t5BUxk1xMhX/qZuelyzj3IPfXp+WbtoUXVoWChOPT23oXVUKC/3Du5RIlgJWm1JcczVvZ8ztJXHKQw0U6TG2sETgbeEt+ciwArLYvrtEmI4hmcRDEv/2rm9rKWCxs8mxq3uwQJtn9AvQHxoDpdqfcCyAx7/J6VFevEz1x4PNWFKkU4zvSPXo4kZTnJeR1XdV3NehigixL3LqUz2DFB3jbPotlN3ZiqKNLdtIUv5NYc6na/Qer53DcsRgmIYB5X4NyrAvmkMZJzdJOsRlExejJtyYodf3agEJLkRjgQ2y17iIsTTNXfR3gaene1xhDebGCtQdULklTAJeOnE952Xd9Q/oSCvZWuXi97Rcqth7alZPuvYMp5KOEu5XTkWFZecj1yKqYI7KAYgdbWDAxB63xoOh1uuPsZ/Dei3CXm0Xcz66+6YFigyNIWkOdacrZbZuo3GoSaZ7iuWfMfkl9/3dC42BljwpoBmwBA5JmDdzq36mOkQbHtt208eLR70ZezTdeNDXTnc11Z5fBGuMp2G5FmKTGwqapjU9LJZh2lhb6XaIt0HNGY0QG/u7db8/i/jzfrDTPBwEd0/2n5uJYf+MDBhVgCtpcuwbnF0c7O1tTsrO//l2I7GeAcYLkK0c/Zz/9E/bXpqUbZ2BWdVUdUrvNnW5g7kj4P5StNz8VShtnoU45c8ASDUfzAvCbsXjz3aHYatPbMVJFj0ViTD9eozBtjo99Z8Nrtrc5PEr8sWAGm9oAdWBuzLcFL11FmRFSu53fnE9OZv8cXKMa+Xv8cfTE3y6+TT+13hyap/ummhdxeDzTTJVZhmSV4ZMXr/Jd+pQ2+McriDsvzahy7Zv6/YaaYpo2/aE5oS5TPhWw3h9IeFnyVPS7PH02Ei73ITmbxtnP6fCqhbeosV5f1jyM3rNXMNw1342d7p1gIvygcsC7/vi/EesDL/hHUiTUW4DrMw0loLWwp9VYgX4rOAnSkm1wfmPPRmqeovFMmls+btCfiz0L5vQx4UTBxgGHhor/79KawfQUaFs4LzFqg24AjUuDFYft3f0hisFs5BUTNAgx76vo72gbrg0vTTDLqt6gVeoxCtWeC5GtkFrOreN2unK7rBq+siOCJ6NLyYB0a/YuyL9lKWlx2QtLlGs3t9ZP7ZAuOJ+/Fo565eVsTohvV82b+9OXOnqlXxbWpJ62eX05rkp2sh9m/VOTVav1y9wmiWv2qvX6lcj3smmgKvXvNcIPuluVVdu3XXm8f7G5pjc3/UH1w2h1pjZk8cbEnurrfmut96efjYb/rDQT4j1dM9TgzeQ8xXmZmpUj7YnT26lHg+5x25ubxD1pnTfBOoyee+u0+Tv9bTfez0tsWd3fvrBuvngfbj3c3jwy/X+T4c/7R8e/HW09/P+H+32EOlScstm0rpG6felh5FLveR85MoiAl0CU9DikQ1abcf23Rk1LhKb62fy780G5XY3p8O9/dGHD6O9asid8szztLIP3NZcPTah8/t/vVBGF3qkkZOwhYFVxWMZCjtfWywoTOLi4+MUm7IblTw90bL7eoECZCw0DW7xTmc80fCMsG/9bUOvLA9ArXj7e4uyJAtsAF5yJYhhmxCcEZOdoiTu6JHjN7wm7M3ZjRz3tFOdGEcR5OZZWD/xXJxfXVMcL7+xSGVsO3K+Is/Gv8in80zMajZ/0tojOkU2L2xKDBxOivq8nTQ6ScJKVdXB2drjEG/TQlzLB8jwRiu9GXpGdhH5fwEOYYAX -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new pipeline in a user context. Append `?workspaceId` to create the pipeline in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-token.api.mdx b/platform-api-docs/docs/create-token.api.mdx deleted file mode 100644 index bd035e03c..000000000 --- a/platform-api-docs/docs/create-token.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-token -title: "Create token" -description: "Creates an API access token with the details in the given request body." -sidebar_label: "Create token" -hide_title: true -hide_table_of_contents: true -api: eJzNVU1P4zAQ/SuRz6EtuyzS9sTHshJiJRAfp4qDmwytwbGDPaFUUf77zthJG9oK0IrDXqrG82bmzczzuBYoZ16MJwLtExgv7lORg8+cKlFZI8bi1IFE8Ik0yfHVeSKzDLxPAjpZKJwnOIckB5RK+0SZ8DlTL2R18FyBx2Rq8+VApMKW4CRHPc9XcW85Dtla7AlBxbjeoHDcz5kFvy44uWbWIBhkN1mWWmUhx/DRs28tfDaHQvI/XJZA0ez0ETJ2LB0zQgWerUYW0EN5dMrMRNOkAhVqWDGOZALv65ZDwygmpBxQaegqCAe+tMbH6N9Go+26Li++jn6cywUsd9SQxuGyZc1yEiumeb8feCq9yo4rnG8HZqmUDohxr2yV94CKapuBI+SDdYXEeHR4QAem0lpOubGtYzeAQr7+ATPjhD9GqSiU6T730+3KtPR45yHfxW6VMyeGe6goPnnwRxzlp516IuiN/yNxxPGzOgh3sEsAJzL/FyH3h1hQPjn7xBw74LsSP3POui3m33dIt7vLibGYSK3tgvgE9M9t9K8qlgN5AhoKLvI/LZeMHrLKKaSLNKnFCUgHLsp/ct9Q2gJwbnmBlTZMrZRsE8N2f7K/ewHng3vlNNnmiKUfD4eyVINM2yofeHim/g2UFZvr9iZYkistkZWYnDKeN6/g5B23G25OLLTPcFUrZ2QqAUbf0wCik/jnd6fxxwWGhnDTr9cr+OxVFqWG9VrsXThlHmzI1PawJcwMP6qFO6PogrRgFoDMggDe9qnfHdKA0mFtPNijtYGIcJNjnv3B4eFgxGc8k0KaHvF4L+PbsUmwXmvwC5+5dgQIrzgstVSGiYUC61Ys/cd2ziqik7qmRQt3TjcNH1NIxwqkvy/SqbgoSYDkADKnUbK6nnjbi9NYw94t52W4rjj/1p1q0s6Dt1SJ72L7Qr+6vLll6bRvc2Fz9nFywe82/Y5FeNzZOygynNW0mc2sCldQxJgsNPlWpxu6DFW1JmmWPYbUnoAIq5ValLalxLk29xT8L+eyCPc= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates an API access token with the details in the given request body. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-trace.api.mdx b/platform-api-docs/docs/create-trace.api.mdx deleted file mode 100644 index 6962d6ae1..000000000 --- a/platform-api-docs/docs/create-trace.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-trace -title: "Create workflow execution trace" -description: "Creates a new workflow execution trace." -sidebar_label: "Create workflow execution trace" -hide_title: true -hide_table_of_contents: true -api: eJytVU1PGzEQ/Ssrn9OEtogDpwKiEqpUEKTqAfXgeCeJYdc2Yy8hWu1/74y9m918ACrqJcp6PvzmzbxxLYJceHF6LwJKBeLPSOTgFWoXtDXiVFwgyAA+k5mBVbay+Dgv7CqDF1AVu2QxbixGwjpAyUdX+SZuGpOOhJMoSwiAfFUtDH2QD2fzjjwoYiQ0X/dUAa7FLojfnWNmqhJQq0znYIKea0By9moJpRSntQhrx4m1CbCIprnFUoZ0dHIsmoYKRKBbfDi3+Zpjtq+KiDMV0WetJ+VRllKawP7SuUKrWOnkwXNQvY/Azh5AcaBD5iVo8GwtZGXUkgnaePqA2ixiyQ6B8gJZA1bQUGHgfUvorj9ZsTI/I5EHbHQtA3jVjuCs18Hi+qC56/PBm8kedCigYyu1+rblqmmaRLHGQSUI3lnjEwtfjo72ib/+8f9oLok3uThc+YdKS+C5NvI4PgT/XOYfGZeeqPsNahrRj5Y3wH+JaHEP+dcDxHe6zYwNmSyIG8LTxPFTFeqwjpo9B4mAZ1VY0ucf1hEJemlZ6zRKEaRkm5jEjTBJEmJ1Aj53wq+wII9lCM6fTibS6bEqbJWPPTwRiLG2e9K/i5bsppCBtZxdsH92dnMlGEKH8I4JTeQMcW744Ru7RcHfs+hEJ+nP925LPKxCrJwbdduvicsXWboiEj6QZC/djRL7oy0BDjwHuutPhzM5GFVt5jYW0ba05YKLf48mJl0r2tvJmedRqjiP2y0YEk8jqYu4Kuf2W28gINy/dM/n8cnJ+ChuGGp6KeM4t+s8ieXVN2IXc92r5B9embahAV7CxBWSHg3CEmuq2wHsnjKqOo0gzcmSJ5QsdT2THn5h0TR8nF4bHsxcezkrWIdzWXh4A+o7b9FBfI+w3nvunmVRsWec42eJmu+P0iK4IHPKxsBS6EW6/tOUs/exe7ulGXURZ0qBC2/6DiV8c303ZTm0b2Jpc45BueKZpV/CyS88R0eVxTN+z8yiiqtIpJwsHrmtvR2txapakzTrAUJqTvSY2kcw1KCOt8DfBJeS/wVJ3wL3 -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new workflow execution trace. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-workflow-launch.api.mdx b/platform-api-docs/docs/create-workflow-launch.api.mdx deleted file mode 100644 index 708798b27..000000000 --- a/platform-api-docs/docs/create-workflow-launch.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-workflow-launch -title: "Launch workflow" -description: "Submits a workflow execution." -sidebar_label: "Launch workflow" -hide_title: true -hide_table_of_contents: true -api: eJzFWG1v2zYQ/iuE+iUD/Ja0a7d8WppkQ7q0CeIUxRYECC2dbDaSqJKUXS/wf98dqRfKcmKnCLYviUUe747Hu+deHgLDpzo4vAkWUt3HiVzo4LYXRKBDJXIjZBYcBuNikgqjGWcVEYPvEBa0PQh6gcxBcfo4i5D6WAE38KWkPOdFFs6QKOeKp2BAkbSHIMMPJCaGOuch4NFeIEjatwLUMljX4UtFyLIiBSVCJiLIjIgFKCTW4QxSHhw+BGaZE2ORGZjarViqlBu39PZNsFr1aulaFiqEL7vqMLbkbPG0Kgq+FUIBmiLmiYbn6NYLsiJJ+CRBKqMKWK1uHT/Q5r2MlsSjaxb7IIm1MyuJkVMoUUpm6AjP80SE9oWGXzWde+gqJSdfIaSDuaL3NAI07Tq+2+lE5NFoo0Q27djP+QJDzWIxLZzLeLYbBCtSO80LA6fZ/GwHjseOmkE2F0pmKbLyGLLFDBQwMwOWixwSkeHjiSRhqsgG7ARiXiTo1kZ6T5orkXK1ZOEmzjGTGAgGIqsqcvlk/WirloU2MiWpjByP4atbpTZFE/KtdN3O+LK6lYJcamEkKv756pztwWA66LG7mTG5PhwOp8LMiskA7zTM4LshmX0hhzNIEnn3kxVKupwItV0meRyL0MFDKy7nZlbaub4O+bdKIRKIAywWCSB04D4aAcOibfhNZl60JaxbHeZCC+fET2v6hzCsou6xieLofD1GtudTkl1osBw1aF2C1zaWn0rrsfKM72z0qgp0keJBFnO8dkRPrku3Jp+/VNKawxPEleKENMJAqrsKrNY1OCJ6JmNWq9IOp9yJsI5mLUzBv7Q64H3VGEIF5kUUIHZoB8uPBKX8Hhif48UJwGjFD7zayWyYvaAaTeg+Txdntmu04jOevW1rjrJwh+3JOSiFrqBLAuf0LrCMXIA6tss7BHTCDeWEvs4hRLcK1yRKS+hcyiZUvdsFaqBosjBGKfswvvhEAfHX0cdz5nKRY63gqsjGlsF25kdRhKWBW0E7c1PiGVgZZPgs7pf5qaRClKU4lEgwl/cUMLWJ0YFDDC7QAzYGYDeXiBw8ixgCnOkThDoW+navQrdIhnqg4RsWIQNEtbyyYZjIIho6wUMezTH+IXqFd+sjv37Fr1/yc69Fqy9zdR6jlRnHbNO9GpvxOVjsS4Bw7f+4acrF7tdM8C4ZuiBqTeeqG5ObE9DUmH7I7mh/kMV3VgiCo1ruliTrSsaeQSNgFnHpErNLhmjT8pKT8fmBA29bx+wmgqgIMloFgWPg5wML4j67iZQJ8KzD7zSz6OLoiQP+MlyZDYmdxQorABKccG2YLkLyhLhIKqcofeDK8fIqbXy4ZzpAyPFKfafVK/evz/sVQ/KE0tex1jzHFK3NDne9ROJSfzrBEPFsAlw3Z33PpiRx72SKCQbWLlZ1EURxhWds1WQLJpRKLrDXRBGifaEyFhVpurSvkFTOTTiZin/qpmSbZ1x49I/Xp2WYNkWX6x+YL23Xt6oM1vcPDymRzAUsure45mrazpiPl8Qp72sgpEdsYYnA18JX8plhBWS5/ec3wnQMyVm0S+J/vIF7tBSw3NnZiat7sECbZvQLMB4aB6Xan3jMgEcf5OQ4L7ZLfX3QxZIinSC+o9Tjy8+acF6G1t5VcV9DFQliX+XEl/oRUgyMj5MfkezOVhIttjwmkvJvClM+WWL0lA9AEIHliEGYhh3K/ZqUYV80hRInuyId47KJi9ASbgywMfbqCxJdH50FOmKvcRGxNM0d+jvg2dA9LrAGC52kAbX2gRGGuuegPX+4Kttin8JNNR6jW/mNvO3FbWLIsfpy9fvBaNRtxy/+fLnOuwLsTfi1/R5OU7oIkr7ZpOt79JEfGBc0VrkJ8I00OgVNjJ6+S0X45EVOlZKqo/nrDVau5k0sk8YGwgL1WdlWLiyUMEs7YnoP2HWqo8LM8POWRilY+c4kzaioJLIzKdoLhpWpywxK8yRErWpUVagEiSoQ5LkYWMBrkLA7KLI7rKrm2THRs6PLs4C0qJQck02dfXxVaxORxGq0ZROmJcIV9+P3Koq+Lpxj01tdNcOi0++c6sv2EIfGNE0gtoctzXo92WiWmqFEs1bPDLyTdXferHn9tS+63RDfVFu3a42qv9HtH/1dv6NrBLX6L+8+XvfkrbYaH2+93RY0G34V3ax6Za9nBq9S9Q3mik2CmHZJ5lbqusl9rhc2DaONxUKz3WTem9HtWvYbbchLow25wssRPsAjFB686Y/e9Q9+vd7/+fDn/cODXwajd/t/W68UWSytU1dw5WKDgmFb2FAQCqz1SmKCKB5aiGqHpB+IaGKR2NwZy9+aDVSkrFhxb3/w9u1gVLV7KbcIV46EyxllhQjrOj40QLl1LF6GMY0IqFYSmR3CkOYPJfI0U/egMjc58ozQCTcfHiZcw2eVrFa07IbShEiR0NR5NCPmR3XcMjbfqOI9LDuT+TlPCqIMaHq+u/jdJuZPaLFpQt/ocksfSriBOUK882NyVTSSY3DsdOlfk4zmbCfH0b3ciSNszXLzJK2fSi4vxteEyeV4PpURnVGcnpT+op4uODGr2fxJawTJ2bSwKTFwPClWeDsBrAG+vVVVNWdLT0N0FEtxLe8hQ2eprGfoG9VF5v8ChNMtZA== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Submits a workflow execution. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-workflow-star.api.mdx b/platform-api-docs/docs/create-workflow-star.api.mdx deleted file mode 100644 index b56961b68..000000000 --- a/platform-api-docs/docs/create-workflow-star.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-workflow-star -title: "Star workflow" -description: "Adds the workflow identified by the given `workflowId` to your list of starred workflows." -sidebar_label: "Star workflow" -hide_title: true -hide_table_of_contents: true -api: eJzNVVFr2zAQ/itCTxuEONtKYX5a1m1QBmtpNvZQAlXsc6xWtlRJTmdM/vvuZDtO6pDSh8Gekkjf6fvu7rtLw71YOx7f8idtHzKlnxxfTngKLrHSeKlLHvN5mjrmc2A9hskUSi8zCSlb1eFqLTdQsrsecZneMa9ZrSvLlHSe6Yw5L6zFiB3TlE+4NmAF8VymyHRhQXj43QEWGIAQI6wowIMlnQ0v8QdCByaESJJphM/5c+39W8huZbkelNPLFh4riZJ47G0FE+6SHArB44b72hBJG8S328kBrzMigYH4sQJbH2UOQFZWBViZHHKPuGTpYR2uMm0L4duj8zNkX5JUZ3TpwFHE+9mMPg75rr5jaKLxldLTrTBGySTUNrp3BGnGpHp1D4mnIlvqhJctwV5xjxWDe+kVHO3XTacTYQQ8m304orTvOSu1Z0JhKPYgoM/G6B+IyXRVpq9Jb+jsLS/AObEG8vXprHvgyZS/WqvHWX4c6/5StQLR8aCgINn/aQJ4ifOVa5pAo114l2Yp5lFvhKgZLLGNXDuYDuymn8rKKsTn3hsXR5EwcpooXaVTB4/Y7KnUo/lYhBt2rYQnw7MLwrP59SUnvztIKit9vaCKtNl9BmHBzitStkuQGPtpot+rAMKT9su3fpTun3yogiwzHcK7anQqiPYlgZSuTMB1YGqlSEIrD5PfTxm7KVWY5Ex/Gi5QCFWu5Xk3PT+fzuiMil+I4IRu29BI7Rbmc4XNYKd/uqO7Unv44yOjBO481BpybjqjDH8fCI8PVnPwCjY0J2MhsGlWwsEvq7ZbOm53JzkolU6sFDk+E8rBiVxf2KxH5T5APVreG6EqQgbDbYSVxP9KLW9uukF9y07+1RwV1R2Kst5Xsy+2K+N2iegcRIpvkb4WME8SMH4vdLRSKLHdaF9fLX7iDPwFVCzGSA== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Adds the workflow identified by the given `workflowId` to your list of starred workflows. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-workspace-participant.api.mdx b/platform-api-docs/docs/create-workspace-participant.api.mdx deleted file mode 100644 index b17686a54..000000000 --- a/platform-api-docs/docs/create-workspace-participant.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-workspace-participant -title: "Create workspace participant" -description: "Adds a new participant to the workspace identified by the given `workspaceId`." -sidebar_label: "Create workspace participant" -hide_title: true -hide_table_of_contents: true -api: eJzNVlFv4kgM/ivRPN1JlHB3q0rH00HLStVtj4pltQ9VpTWJC9MmmezMpJRF+e9nzyQkLBRo1Yd9acOM7bE/25+9FhbmRvRvxVLpR5NDhEbcdUSMJtIyt1Jloi8GcWwCCDJcBjloKyOZQ2YDqwK7wGCjGcgYMyvvJcbBbOXu5vIJs+DbRuQq/tYVHaFy1MDGr2Iyf6ERLH6tZW6aJ0iUHoQULWr2ci0y+kEqSs9JtSMku5eDXYiffR7rOWTyh3slyIoUtYwaBzXJa/xeSI3kgdUFdoSJFpiC6K+FXeX8iMwszp3ovdIpWH90/kGUZWfjSSu0g/5swnt/Z+68Oho7VPGKdbafbgEaQBxLB0mlQfYiRaYJa9KDPE9k5DALHwwrr3c9UbMHjFxqNOfRSioZuk0xnaHmhJ7gc0dYhPRk4cKg/o/wHutRCjJpaRmrZTbnjAgrbYK+WlsRT6o4SxbZRtkdmFxlxkfwZ6+3C9743/eDqNU8rxI+GadX5qCGdQ+eJC61sS/eJnDgEl9IUof7dqKSPVqkRH3BRKSWmXPXx+LATxKYKSIMpZmbns9Y9OwJNLegOUmnro1x9f5rC5CFXwx3afJTg4I4JYogR4FMg/tMoMiihS+yzBfCk8TlkUhfZ6gO/2vlKUfkPH3Z4+vR9XA0oYPpaHBN/y7Gnz4NhuPJYDqetE22Wm3KpiqwBk9gQX/R+8uAC++QRLnX/uXs0qqDre6bmXudhD7sa+chxG+hvoY4bqnIjIE5OhCOMKIXPBjfSGuldzz/aw8R1TMzyBTxeJKoJfnjpP/elb4sfDgYYIIpZr9stHRpMCq0tCs34IcImoqjoBHav73j2UbTf6F4T8gLvxDwlQiJSky4dotAGTbbS7huTeQybLGoCWn4CX5OP9XrRMHlJxbW5qYfhpDLbpSoIu4a/E5od6XameOf3U1wk4BlmgguWD4Y3FwJ9rUO5TNj6XFpB7SBhl8U1ZTn3zMnRCf+42NNQA9L6/DjHE2aGT96hjT3jNNQfq/htN6ekdlqP5ndK+dMlZUqJg7iWLgMniSYK2EuKYhcSW1D2QawGgfu2X+aC3KE8+Df+aN7ft7t8VmujE3BVWS1Yvn9sLVn5lsb4pbD66bK339trZJn8dmGecKsy1zmGcyX5S1POEOi/XpDbe3VdLq9LbaL03F6zG22IADY0no9A4NEkGXJx5R8zS1CnzQQJMw4dVTCsTT8TVm/h8TgATx+m1R9/XtwfDveG2t1CNmKhwskBf+iz0dcbZZy3o3f5NORDfkNDrXRLu9IfIEQkzGGzUtceEfO3OhqLOzQIwflNQZRhLk9KNvmrJsvU+7qai9PVcwqGpa88tNf56xyuDiycGdrGuXZvHBkKrxJ5gDYppCfKMMFtRcOqiMnMVWPmFEt1ehY/s24lOX/vifWMw== -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Adds a new participant to the workspace identified by the given `workspaceId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/create-workspace.api.mdx b/platform-api-docs/docs/create-workspace.api.mdx deleted file mode 100644 index 6d5762607..000000000 --- a/platform-api-docs/docs/create-workspace.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-workspace -title: "Create workspace" -description: "Creates a new organization workspace." -sidebar_label: "Create workspace" -hide_title: true -hide_table_of_contents: true -api: eJztVm1v20YM/ivCYR8awC9ymqatgGJz0gwLOiyB47ZAXW84S7R9iaRT705xXE3/feTp3faSbp/6oV8Mi0ceyYcPecyY4SvNvBnbSHWnE+6DZvMeC0D7SiRGyJh57FwBN6Ad7sSwcaRa8Vh85XTo1GYD1mMyAWXFl0Ft9bFSwPOEKx6BAUUeMxbjB+rhfajfY4JcJdys2a7/q7bHOI1ACd8RAcRGLAUo1FfwJRUK0K1RKfSY9tcQceZlzGwTciJiAyurupQq4qYQnZ6wPJ8X5qDNmQy2ZNP1Xmfg+DYjp9TGu3yJ18aGbHiShMK3IQ5vNRlm+1HIxS34ZJgowsoIRBtPaxDpo0llxpZpGP5BKPUKsHrsXmixEKEwWyrT49eK4FsAwKvRC1+EUICXl77QNOIPv0O8wop4Jy6Vz2DtCJI/Z7z/ddz/9PlzMH/2s9f6+nvW/wtFb1qio6Ns1Hv+Kv+J1QFro0S8YuiqzrDrbuS6B5Q7ddnVP2TQQqtBojzuMUAqEcrXk8sP4+kFSm5+G08u3lpkhSFA2IfmBgoAy1/QOjh0YY0s6fWNwLTQKOTavE+C/2KUNwE0/dOW7vTWpGRkTjrdXrACnchYF6Q4dt19il+9+0HmH2T+bshc0JXYjFonhwh7xoP/M4bbdIxAa76Cp5lXKe6l287hQimp9iJ/fqDVqjfSiaVxeBjKDcZjtV/va79Ni3TAgRAiyvE7zRYPNfipsuzEt/0MuAI1TonPszm9sfjwryXtBYm0RbMvvceG+PzrYWaXgHzY2kLoQnVf7QqpClF5bUyiveGQJ2LghzINBhq+IJ4DIfeWhht74lyH3BArnXPSd8bXl4yiqYK9IbSKzNsh18mTR1buE/S9sEooKf78WvH9dmMsQlSFSbNNXDzwKAlhby7SNHOr2dRqn3qANLJuVrW4PQ1aTd9pahz2xyd992X/+PV09MJ7MfKOXw3cl6NPbKeR/12RchLxUlpIyuqXyBKUT4FOJRRYzVKZqMt9S91uQdtlRPaK0E70pfylOaAJiGwo/IwGp6cDl2TEpohb5pdoFuk3m+lukFnTQd+82ZZsMPBghknIcVVF1zaFrCTyjPZYYq1X7bPdjXpNrEetLFtwDe9VmOckRqYo6hj8e8+VKF4u5HsgNP3H2ix5qOGRFJ5NyjY/cp7ekw/mUQp5vCVe8TClL/x7B9t6Pc/nqLgGHuA1FF9xdl5E0Z/SDY3t3ljKe5XF2PchMY/qtmfF9dXNlJqtXMwjGZCN4hva+fHXxiktKraHrSxDcser1E4xVtxJNObdzt7pZJvVQSSwYlZjKu8gxqpVwBj6JmDy/B8k+oK0 -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a new organization workspace. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-action.api.mdx b/platform-api-docs/docs/delete-action.api.mdx deleted file mode 100644 index fb54d6d69..000000000 --- a/platform-api-docs/docs/delete-action.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-action -title: "Delete action" -description: "Deletes the pipeline action identified by the given `actionId`." -sidebar_label: "Delete action" -hide_title: true -hide_table_of_contents: true -api: eJytVE1v2zAM/SuCThuQJdlW9JDT0jUDig1b0XbYoQhQxWZitYqlSnS6wPB/LynZ+WiCFgN2siU+6T1Sj6wlqkWQo1upMtS2DHLakzmEzGvHazmS52AAIQgsQDjtwOgSREILnUOJeq4hF7N1RCz0Ckpxl+IX+V1f9qR14FVab+4bRwAFnfJqSRueVdSypAWBuvME0CzCKSzkS2XpDhHQ63Kx1eIJ6OGx0h6ID30FPRmyApZKjmqJa8cE6ZBsmt6G88n6h+BUBlvaxwr8+oD3TwcUZbUEr7N97gMuXSIsYmhu/VJh2jo9IfYpSw2OCg+BT3wanvBnn+/Xd/FB/LQis3RRibLpyZPh8BB3pnLBiUNA4urQBFPOGZ3FJxjcB8bWOyq3tbqVSwhBLYBd0Iq3s3vI+D7n+R1RJ6Ed8FhFJWo0vDXx3vqrNj+KNFH55yMZdg4RpUWhjLFPpIfhAbLKa1xHc5yB8uDHFXlhdDvl4pFzCsuuyqOrop84Kgetnwd1Z6WGnwb8qnNa5Q3hCkQXRoOBcrqfGVvl/QCPJKav7cG7X8eIuDQK+SHFV8aL8eWFZCmd0msubCrSrt5NnZixcwmvZxFEO+nnW2eR+yeMFdDl3MbjbVFbFUz7lkBOV2fUuwnMjqBq8GX7ye+mTKbQJjp0br9sAySEK5d4PvZPT/tD3nM24FJFQ7VdlNq7HRAvFdZbV/6HudIWFOEvDpxR1LGkKGZWtzbYjrWeHG1mCj1WQbo5XNczFeC3N03D26nf2R25DmpmuCnmygR4JY83psFRkQ+wPhg4K2UqRkYzrZTXzP+PWt5dtb38XrwyHI9KajdVud7V0knd1K6ZErYAldNNrC2Fx1kGDncOHkycvWY9n/yY3EwIrvZb40UrRIKjuujZIuLGPkDZNBuZyGvW2DTPjQJbMA== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the pipeline action identified by the given `actionId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-all-tokens.api.mdx b/platform-api-docs/docs/delete-all-tokens.api.mdx deleted file mode 100644 index 8f8512395..000000000 --- a/platform-api-docs/docs/delete-all-tokens.api.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: delete-all-tokens -title: "Delete all user tokens" -description: "Deletes all API access tokens in the user context." -sidebar_label: "Delete all user tokens" -hide_title: true -hide_table_of_contents: true -api: eJydVMFu2zAM/RVBZzfOtqKHnJauGVBs2Iq1Ow09MDYbK1UkVaLTBYb/faTspEk7YMBOkcUn8j3yMZ0mWCU9+6XJP6JL+r7QNaYqmkDGOz3TV2iRMCmwVs1vrhVUFaakBrgyTlGDqk0YVeUd4W+a6EL7gBEkwXV9SDG39m6oUeiIKXiXkCt3+v30XH5Oy37/os7UNz8kdaT7Qp9Pp29xl1CriE8tJuK8ezTDIARrqkyiXCfBdjpVDW5ATvLERKxF+Yb1wApFOu0CclK/XGMl+UIUJWQGonsgH0dgomjcSvfMjgxZuVrE6OOPUR9H+sz8w18U7nuknCdpr39mPgJPWLXR0I7JdfoSIWKct9Tw533PJDdIjZe+1rmvQhMkqsthKOVwf8YptSSLW4wp52qjZVhDFNKsLCGYSWV9W08SPjGXifH69fRvc0TdWKAHHzfqk+DFB1qY7IneSl+HHh3TPbRJKgqVDOPvZQbxzXD4zJmBh6bXz5QbYNyDz8/Hno4spOy/CIpcww4dwWIIqLIhTsUfS2ZPGIlJ2Y8vASYinRvqvJtcXEymchd8og1kPznIcgZ/5w3Ji0B7m59Q7V7c+X9LNTZTPstgwThhk1V1owMOW1zoIw/woBrmLOGuW0LCn9H2vVzz2kRxGR+3EA0spdtsMn6AUPOExDSPyBA9Z4ZBVmILthUab/brxJpXi6+LuwXD4dQJryafC4whcLuj9Mw0I/JfBrMtRh5ZINfivfoDeJ+eNg== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes all API access tokens in the user context. - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-compute-env.api.mdx b/platform-api-docs/docs/delete-compute-env.api.mdx deleted file mode 100644 index 221213615..000000000 --- a/platform-api-docs/docs/delete-compute-env.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-compute-env -title: "Delete compute environment" -description: "Deletes the compute environment identified by the given `computeEnvId`." -sidebar_label: "Delete compute environment" -hide_title: true -hide_table_of_contents: true -api: eJzNld9v2jAQx/8Vy0+bRIFtVaXxtJYyqdq0VW2nPVRINclB3Dq2azt0KMr/vjsngQDRpkp72AuQ8ze+z/2k5EGsPJ/c88TktghwAnrt+XzAU/CJkzZIo/mEX4KCAJ6FDFijZKiUzugcdGAyxU+5lJCyxSaqVnINmj004pleX6UPQz7gxoITdOtVur13uhWhwAoncjQ6wiq5xgcUdu9BkSQoK0LGD0mnPXRC2UzoIgcnkx2qIxwHz4V0gCzBFTDgPskgF3xS8rCx5NgHJ/WKV9Vgy/Ji3JO3IoEdynMBbnPE8rMVsn7nR86kDrACh0dL43IRatPZKbqfE6u3Rnvw9Mb78Sl97Tv8/oWdsG8GS4QX6cCrAT8dj491FyJlFDn4gL5aNcqEtUomsT6jR0/askO5S9Y9z8F7sQJqlQbeLB4hofusoyIHWYO2wr6U8iCDItPMOeNumvjwpIrkH3oibNuHaUOFVeYFeaL647F6avQS4wnojqXUamT+TwPGQw9J4WTYxMa/AOHAnRfY45P7OdUfpyIzNDUxFIizQqd81B3eUdmdlYraDNy6HafCKXwhC8H6yWgkrBwmyhTp0MMzJnYozVET38YTdq1EoKZkU9Kz8+srTkwt8i3lrI6/C75NAXlsO56eF1GElvrH57bdH19CzJPUSxNfb/LVUJDbvwFSuDLBZVWLqdgiicXeD74bMtZbqjhtS/Npd4AglLnaz7vh2dlwTDZrfMhF7JVmJdR7rG81HuKWu+77h1u1yXKAX2FklcCdhJgx3LJpkoMNP+CTvZWKpcwwKtKV5UJ4+OFUVZG5Xm3UO6n0YqFoGpZCefhDYH9bfL24T7A5Wq5roQpSxl5bCycJ4JUwb26aKX7LXvnn0IvZGIXedPla/L2kVnPUZyBS7HRiriXnSQI2dF4+2kF7w345+zq7m6Fc7E/UwQRFB71sWM+ouDNPoKtqixromRir6jctE8qQ -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the compute environment identified by the given `computeEnvId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-credentials.api.mdx b/platform-api-docs/docs/delete-credentials.api.mdx deleted file mode 100644 index b2a20f981..000000000 --- a/platform-api-docs/docs/delete-credentials.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-credentials -title: "Delete credentials" -description: "Deletes the credentials identified by the given `credentialsId`." -sidebar_label: "Delete credentials" -hide_title: true -hide_table_of_contents: true -api: eJytVl1v2jAU/SuWnzaJAduqSuNp/WAS2rRVbac9VEg1yQ0YjJ3aThlC+e+710kgaSJYpT6V+B7fc+6nu+NezB0fPfDIQgzaS6Ecn/Z4DC6yMvXSaD7i16DAg2N+AawGZDL8SiTEbLYN1rl8Bs0ea6BJ/NjnPW5SsILcTeK9w6saZ4+nwoo1nlrSs+MaPxDZ8IQoSXpS4Rf8pciaN+a8lXp+0GcRbeEpk4jhI28z6HEXLWAt+GjH/TYlquISz/Penn1j7MqlIoID91MGdtsi/1MBmc7WYGXU5G5xSe1hHkyJsWvhi6PzswY7XopWcIJ5kjAHvlGWmLKLVraRSrEZsJky5IiKZDOtKTVLM6N6Co/oFHTMEI4FXHeJnRmjQGjUNqU0utRoB44An4Zn9Kep6Nd39oH9NCwyGKT2PO/xs+GwjbsUMaOigPPIWqERJtJUySh0y2DpCLuriTrU8YGvwTkxB+rYUquZLSEif6mllvOyEFoBu6rNvfSKjsbWGntbxoeWPCj/3BFh1cxMG8+EUmaDegL6Sxt9W095KEUYlX2VTILf0tVL+Jp8HA+8OT/t8ANRgu69q1mFtYJaTXpYu9MkhbXDt+ymLPq7w5BZdbxErcVxVaqvytavDnj+qnuh3HjBQZRZ6bdhB12CsGAvMtw2o4cpdT8uqIWhDRaqB2FtkZUPaoke7BpZz2mmwD5Xmy0EyRfep240GIhU9iNlsrjv4Anbqi9Na8bvgoXdKOFpXbArwrOLmwknTZXkO2qJoiB14ft0EmM13mGsAwhPih/fqkW03PiQc6kTE66XOSxVEO0pgRSujPDFKMDUyyIKvdwMvh4ytrNUYQ8m5uvBgEIocwXPx/75eX9IZ6lxfi3CKJTbsijxiylqyNwdhuotnrQyrR7++kGqBO7oQwcXXdF8Vnt81JxGrN0CwyDcbjcTDn5bled0XKx6apZYOjFTtO0SvARHIjrxBHWqXcG29co9C5URktNL9P/0b/8OHVF8eBkPaqf0YSXJfWXm3t2WT8p7duqfiE5N1dLU27qgvdZGzfMpXliAiNEdqSwwF1EEqa/dbq38xvK5Hv8Y348RLpoT/mKiA0GnOGy3gLg3K9B5vtfq6Zs05vk/MXeD9A== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the credentials identified by the given `credentialsId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-custom-data-link.api.mdx b/platform-api-docs/docs/delete-custom-data-link.api.mdx deleted file mode 100644 index ab62ac6ae..000000000 --- a/platform-api-docs/docs/delete-custom-data-link.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-custom-data-link -title: "Delete data-link" -description: "Deletes the data-link associated with the given `dataLinkId`. The underlying cloud storage resource is not affected." -sidebar_label: "Delete data-link" -hide_title: true -hide_table_of_contents: true -api: eJzNVctu2zAQ/BWCpxZQ7bQ1cvCpeThAgKAJkhQ9BAZCSyuLMS0qJGXXEAT0I/qF/ZLuUk9HRtOe2lMictY7uzuzLLgTS8unDzwSTrxTMl1ZPg94BDY0MnNSp3zKz0GBA8tcAqzFMWGtDqVwELGtdIm/XcoNpOyRQFeIuYweR+wez/M0AqN2Ml2yUOk8YtZpI5bADFidmxCYtCzVjok4hhB/csQDrjMwgihcRi2Jsxwj1+f17yMoE0as8cJQFQVP8QPBHQGESKohEy7hg8LaYqwzRE5GkDoZSzBEwMBzLg1gdmdyCLgNE1gLPi2422WUporiZRm0mbfarGwmQuhSP+dgdoPcXxsgS/M1GBn2k7NrDxOKaAzSytTBEgxexdqshauOjidIZE6sbaZTC5YiPhwd0Z/91Hd5GIK17Of3H6xrQeQbHPEywKjJMOrQABgiWZOQIieH8p2K6BZbCdYh5VAj+9QRSmSZkqEf8fjJErToFdt1/4GvkS7KhaRZ90AvnlAoJABDOnGyqrcBHpoRd9IpOpoZo81ty7osPfGPQ+LXjQIrbSqlt1WDJoca9Fm7C41K931tdcC0YSGWQbMVqlJ5TLCAndxcskhasVDoIRylt1AbGFBkZ7c27n/tIV5aCHMj3c5b8RSEAXOSo++mD3NSJvo00eTlSmrevXTLx932GRedd0sSP5hNY+7cKAQnzmV2Oh6LTI78MhlZeMY5jaQemOzO37AbJRxZhZ355YN958SnoXtH/apq75Nuy6eMjQ/pe+FBeFL9c9GY8GnrfI9kGmsfXveqZkFpXyNI5Uo0Zw2mQYvQD3q/+H7JOGup/A6I9afuAolQ56o870fHx6MjOsu0dWvhdVKvrMrYndRekiw6vf2rp6AehINvbpwpgWsVK/EdKWoN7b1gAZ/2XgCcdIJFE6YoFsLCF6PKko6rzUzSamzIpzGaFH7TgT/f2wdJr2A3eCU2QuWE9KLcCCOJyl/SenNbW/0te+VVO0irPhTprs+nodtrZjlHdAICh+gZVoATfFAy1wsdrKU9/5/Prmb3M4SLfaO9MJZPcJAZztEj7vUK0rJsiTr6Jo5l+QtJIRKZ -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the data-link associated with the given `dataLinkId`. The underlying cloud storage resource is not affected. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-data-link-item.api.mdx b/platform-api-docs/docs/delete-data-link-item.api.mdx deleted file mode 100644 index 1827f3e72..000000000 --- a/platform-api-docs/docs/delete-data-link-item.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-data-link-item -title: "Delete data-link content" -description: "Deletes the content of the data-link associated with the given `dataLinkId`. The data-link itself is preserved, but files and directories within it are removed." -sidebar_label: "Delete data-link content" -hide_title: true -hide_table_of_contents: true -api: eJzVV9tu4zYQ/RVCTy2gtdM22Ac/NRcHCJrLIpuiD0EA09LIZkKJCknFqzUM9CP6hf2SzpCiJfkSZ4Et0L4kFjXknDkzczRcRpbPTDR6iFJu+QcpimcTPcZRCibRorRCFdEoOgcJFgyzc2CJKiwUlqnMPa63MW6MSgS3kLKFsHP3diZeoWATMrpCm8t0MmD3vV3CGpAZE4aVGgzoV0hjNq0sy4REj7xIWSo0JFZpgc90sihwF+MamIZc4YZBFEeqBM0J7mW6Bnwe3FrI0aTkmue4rCneZVTgA5q22NBEULQlt/Noi4I1YmO1KGZMpMiCyARocq/hpUKY6NvqCuLIJHPIeTRaRrYuyY3fFa1W8drzQulnU/IEWtcvFeh6y/cfwZAVVQ5aJF3n7NaZcUkwttwKTNYMNL7KlM659Usfj3tAEgRO53FpDkE5a013EMHuGhoYemMpJYEsQslkWuWYZvGKRdKWgNkJfM3XoycXjD1VaU0WzXH0k5elFInL+/DJEMLl9lFq+oT1QwWgqUos1hG9dQXWMeNacwpYYLWYHUg2qTghe2oDOohR0WCDKDYFHziRQPH2mmTgjhH6u/gNfVG/3zkeZoWV0BQ01b1vFWqRO08zWq22C3pfN4Tc+mSrgjXJYqaERGQ15X93KyNcj9WRgs1fqsL4jPx8dET/+j5vf0OSvlPuA9oLLmSl3y6DlomHViy8ooDWSl+DMXwGpJoHnHY3H4To326ScI+rQXoJ4YCNURFBs8nF5dV4whT9ur06H99NqK36pYSAUUAoDm+CC7TLId+oCsJIvig1XiU263KzJG7QKiBzHYFQMiVT0kc8xIiv8B5d2jz2M+7rHYvqP63xYzRgF2sPJmZcLnht2ORo4tzlIof7hsG3cV9fXo+Z7dBKXmKWcJlU0n3NpjXWLpf1V6rlNQ74goVo8IwBu6mkdIrXoNndaE3N7GskyiaezlEmsSjRba+dXVC9cjsY2JisWe7NmX83pRAW89oLQ2hZ73A/6vN+t7whSa5p9kcRY/YSWaWEArrw9lDW1SYvDyROaHi8SyBOeRok7BuEotve+XtbOd+XhG4ULgFbwH/ZoWxhdmGFwsFGSrVAPM76eNv6RtkLVaGY/v3nX2w9Q1C7db7j7qSMzGJ28ukShdfwqWw+zJT89caYdrbzGD7Q16Td/1/lkjQFkkoLW7tx7hRwItQnFc5uo4dHGhtw1psrmgZ99bkJkN5Gw3b2GC7b+W81DIHS0TiJNoNipSVumltbmtFwyEsxSKSq0oGBF8zbQKht0XJv2CfUD5I3dkb2lIeIcAXYn4k3z0EX/JoG8hhGI3qeOiNc8T8ugnA+LazjivJx145K4y88LyV0Rp2HwOxjGELalRWNfZly7hvOmygI9qEAiS6R4EfdGxOPPHEF0yevSxnWjJBO9zP1a/sCgRDz3s9Pg48fB0e0Vipjc+7qrZlavTh0SrfNXg9sZ2D8P1xkmuRb/L4MS8lxFsfoHYvLpn57d7U4GvVuMCFWTPEcKSPr5XLKDfyu5WpFy36wp8IOohCNMpSMzSGvy9v7byA74T9DvXXfeeWyIsuILiLvR/JvXUDewL15PWqRP9KDFgT9Gwn9IQD9kR24We4EFmbVou7iCYA7BbGixp4Dx7HEIfQGZx7HBzchtQdsiTulxu84SRIo7Zu2XcU9H1+N78ckVc2dLVcp7dJ8QZdl/OvgKseMn7JpbRlJXswq9zWI/KkkbLyvixs66OLaSQgWvrO4V89QYPEHfiw9EzWr1T+vXexV -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the content of the data-link associated with the given `dataLinkId`. The data-link itself is preserved, but files and directories within it are removed. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-data-studio.api.mdx b/platform-api-docs/docs/delete-data-studio.api.mdx deleted file mode 100644 index 85f1d9faa..000000000 --- a/platform-api-docs/docs/delete-data-studio.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-data-studio -title: "Delete Studio" -description: "Deletes the Studio associated with the given Studio session ID." -sidebar_label: "Delete Studio" -hide_title: true -hide_table_of_contents: true -api: eJytVE1v2zAM/SuCThvgJd1W9JDTuiUFig1d0XbYociBsZlYrWO5Ep0sMPzfR8p2nC+sG7BTYvJJ75F8YqUJFl6PHrWnMjHW62mkE/SxMwUZm+uRHmOGhF5Riuo+gBR4b2MDhIlaG0pDamFWmHcAj97zaXU9HuhI2wIdyG3Xyfa+MRA0YAYU4GDJQSdKKp3zBwPbS/hQpI0oKYBSfSjvgDEvl+hMrEyCOZm5QccnHL6UxiGzkysx0j5OcQl6VGnaFIGKnMkXuq6jLfvaumdfQIw9/0uJbnMk4GcHPM19xGVywkVIza1bAjWhi3Nmn4pUX9icq5ETH87O5Wef7/tX9U7dWBVbvignXUf6/OzjCVzXdZVbUpBldo3JoIGfuPbG0pUt8yRS65QHuTNt48MNc8kq6/r85e21JBPjYZaxF7ieEN+2TobfyWRCKIrMxEHT8MkLa7XTnn5Ij3rJ04QFihnbrtnZE8YkXnFiJzJNhzrgqVFqMpRJaOKcdXdtYzlTS9JjXDpDm+C4zwgO3WXJ/ho9TmUObMfUil2TYNdgUsnqYftQhtXWn7WMGd2q82/pMgamRIUfDYdQmEGc2TIZeHzhkQyC5Q9MHDLqNgMSU6gvgpf+atHSSb2XXjV17wreli6MnePkexZAHGn+XHV2e1pT6I/J5zYcb/vUqhDa1wRKuSbmrdCAZcgQhyHvF79bMs/ZZMHtc/upT7AQ6VzD835wcTE4k1hhPS0heKR9kc3iUNutsaew6o32HzZW21DCXzQsMuDXz4pCZVXrg35hRnrUbyqeVsrCJV9VM/D4w2V1LeFmeYg9uveiR3PIPP6hkFdWy0mVz7g52l4ryEpBBjetwBnh/0ctb+7a9/n2sGV/r60NQr7ZFdVp7rtYTxmcIiR8lahs8pdxjAXtnDzaJ3sPdzz5NnmYMBz2X8nBqwgEJ4XxAAPiwT5jXtdbnSTforGufwOjt4Aq -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the Studio associated with the given Studio session ID. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-dataset-v-2.api.mdx b/platform-api-docs/docs/delete-dataset-v-2.api.mdx deleted file mode 100644 index 6273e93f2..000000000 --- a/platform-api-docs/docs/delete-dataset-v-2.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-dataset-v-2 -title: "Delete dataset" -description: "Deletes the dataset identified by the given `datasetId`, including all associated versions." -sidebar_label: "Delete dataset" -hide_title: true -hide_table_of_contents: true -api: eJy1lE1PGzEQhv+K5VMrbZOUIg45FUoqoVYtAtoeUCQc7yQxOGtjz4ZGq/3vzHh380EiUA89Jet57Xlm/I4riWoW5fBW5gpVBIxynMkcog7Go3GFHMpzsIAQBc5BtCphcijQTA3kYrJKkZlZQiHuWsFFfpcJU2hb5qaYCWWtUDE6bRTSliWESGfHnsyk8xAUZ7rI17nOm0N+H1Hcq6AWtBaYspIFfZDuyYWH6JUG2pVJw5iPJYSVfAn/pxOKolxAMHqDHjh91HNYKDmsJK48n2wKhBkECk1dWChslk6OZV1n6/TrKrvkXuF8L3dbhogYuAm7iQM8liYAFY2hhAMgzS5KO2Zx9NQviBw/Ghzzz26un9/EB/HDCe2Iv0BZZ/J4MNjXnalccGqISBCdmmTKe2t0uon+fWRttcW0ob2VC4hRzYCN0qK6yT1oPs8Hvk40DWgnPFATbTVoeWkUggtXbX0UqRP5pwMVdkYRhUN2lHsiHpZH0GUwuEoGOQMVIJyWdB/D2zE3j9wzd2yuPJkreYqjst95vl+tL7RmT0BYdn4rgyXlHNHHYb+vvOlp68q8F+GRcHrG7d36dYqIS6uQHSS+sF6cXl5IhulYr7m1TZu2ided4oydPfl7kkS00vz52nnz/glTD0wxdWl729aWgtO+BcjlGk0D3ojZE0onT+wWv10y2cLYNBpT93kTIJB2tin2sXdy0hvwmncRFypZqh2gZs675+QlYrUx5n9+fdpuI/zFvreKZplwU9lV65KtlzGTw83g013OqSwWVNWEFn8FW9e83DxEbJ7cRDWxPDVTZSO8UuVbz9RBzgdY7T2FS2VLViazLVUwDPCPMO+u2ml/L159wg5CtYuqWG3TdLCb/tVjEs9B5eRqxmvip1qDx62de8/SzkSfj76PbkYkV7vT82JaUoKDYHR1SXHjHqCo6zUn8jcz1vUzRQN2Eg== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the dataset identified by the given `datasetId`, including all associated versions. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-dataset.api.mdx b/platform-api-docs/docs/delete-dataset.api.mdx deleted file mode 100644 index 405480c0e..000000000 --- a/platform-api-docs/docs/delete-dataset.api.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: delete-dataset -title: "(Deprecated) Delete dataset" -description: "**This endpoint is deprecated. See [Delete dataset](https://docs.seqera.io/platform-api/delete-dataset-v-2) for the current endpoint.**" -sidebar_label: "(Deprecated) Delete dataset" -hide_title: true -hide_table_of_contents: true -api: eJzdVcFu2zAM/RVBpzZI7Kwreshp7ZIBxYatWDvskAaoYjOxWsdSJaVdYPjfR8qynaRBi/W4U2TxUXwkH5mSO7G0fDTlqXDCgrN81ucp2MRI7aQq+Ij3ejeZtAyKVCtZOIbnFLSBRDhII3YNwKZjyMEBC4/MjjLntB3FcaoSG1l4BCMiqWKdC7dQZjUQWsap9xkEn8HT4OSYoZG5DFiyNgYwVhM06vVui9uiDmM9JPgxmSJQLiSkbL7xlqV8goLdBcBlehfxPlcaOVBGlynmVD80rhFo1cKIFd4YqkXJC/xA1LMyD1aLBNCnzyUVQwuX8f0K/W5wrFivwMikI2UQbOBxLQ1gXGfW0Oc2yWAl+KjkbqMpDiYISw+l4ghXX52d8qrqt2TadF6lElJi1hlZLP+RR+2EUWcEtloVFizZT4an9LMb6sdXNmDfFUsU0i8cr/r8dDh8ibsQKaPQYKnSDRphQutcJr4p8b0lbLnFqWM75SuwViyBtBmoqvk9JL5zhjrrZE20AR7ICV2ly+lqYowyP0N+aKk8848HMmw0wwrlmMhz9Yx8CN4NQFtMQM1Kt/H6uQBhwJyvsUGj6YzKieLKFCmvVr2XHFl53IrMxuWW4Kq4mci4bFtfcQpknhqdrk2OTzTDhkMVJblap93EvdDHtbewqzCI7DPh2fnVJSeWTRLX1IW6otuptEWliDwIiL7nHoQ39eFLo+L7Z+fLJYuF8u6hA4EFhX2LIKUrsTgBTPIRiZfPbvLbKaOCZO6HaKE+dQYkQpWr43yIzs6iId1pZd1KePWFUTsat+09ZrurbZ9v2Qn6P1mUocUO/jiigasGa+RrXQbNTrvFaNFhtLsm2z8StHQ7C8WVYZ3JuSznePnL5FVF17gYDE0NHp+EkWJOCkFtp9LSGWdmIXILr9T96GdYFcfsjU18MLdwKYoNJwr5mr7w+ACbvf8A2sbvovXaVn4Hp66s1QzBGYgUn6Ki1fbzJAHttjxfbNqdlTSefJvcTBAudqd8b6p9gIPEsKMecaMeoKiqlqejb+JYVX8BSMfqBQ== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - -:::caution deprecated - -This endpoint has been deprecated and may be replaced or removed in future versions of the API. - -::: - -**This endpoint is deprecated. See [Delete dataset](https://docs.seqera.io/platform-api/delete-dataset-v-2) for the current endpoint.** - -Deletes the dataset identified by the given `datasetId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-label.api.mdx b/platform-api-docs/docs/delete-label.api.mdx deleted file mode 100644 index 41aa8e44a..000000000 --- a/platform-api-docs/docs/delete-label.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-label -title: "Delete label" -description: "Deletes the label identified by the given `labelId`." -sidebar_label: "Delete label" -hide_title: true -hide_table_of_contents: true -api: eJydlE1PGzEQhv+K5VMrpUnaIg45FUoqoaIWAVUPKBKOd5I1OGtjz4ZGq/3vzHh380EiED0l63nteWb8jiuJah7l6FZaNQUb5aQnM4g6GI/GFXIkz8ACQhSYg0gaYTIo0MwMZGK6Sutzs4RC3KXweXbXlz3pPATFR5xn60MuOE4xr4Ja0HfgxJUs6IM07W6KG87rFebyJUw6QRTlAoLRG5BAwgCPpQlA2TCU0JNR57BQclRJXHk+3xQI8ySdubBQ2CwdH8m67q0hnlx4iF5p2IA8lhBWeyR/O+FhmvdknzB89K6IEHnHl+ER/+zm+/1TfBK/nNCODipQ1j15NBzu605VJrgVEJFydWqSKe+t0elKBveRtdUW5aZ7t3IBMao5sBVaeDe9B83n+cD3iqYB7YSbKiMGU8y5oxINWl4ah+DCVVsfRepE/vVAhZ1jROFQKGvdE/GwPIIug8FVcsspqADhpCR3jG4n3DyyUu7YZVlyWTIYR+Wg8fSgaq1V88VAWHbGK4MlVY7o42gwUN70tXVl1o/wSCh94/Zu/TpFxKVVyNcovrNenFyeSwbpOK+5rU2LtmnXXeKMnUf4e5pEtNL8+dEZ5P4JU/2mmLm0vW1pS8Fp3wLkco2m8W3E7Aelkx92i98umSxhbPLnzH3bBAiEO9fk+dw/Pu4Pec27iAuV7NTOUDPszWPxErDaWPJ/X5a2iQj/cOCtohklilRN1V78+jHryVH3qtD15ETKwaqaqgh/gq1rXm7mm/2QmaimlodgpmyEV9DfmP6DiA+w2ntglsqWrEz2WapgOP87WT5ctbP7UbzyPB5EahdVsdpm6VC71tUTkuagMjqI0ZroidbgcWvf3gOzM5tn44vxzZjkancWXng/JTiIRbeWFDfuAYq6XlMifzNjXT8DOyVTHQ== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the label identified by the given `labelId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-managed-credentials.api.mdx b/platform-api-docs/docs/delete-managed-credentials.api.mdx deleted file mode 100644 index cbb07ad17..000000000 --- a/platform-api-docs/docs/delete-managed-credentials.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-managed-credentials -title: "Delete managed credentials" -description: "Deletes the managed credentials identified by the given `managedCredentialsId` from the associated `managedIdentityId`. To optionally check whether the deletion will be blocked by running jobs that depend on the managed credentials, append `?checked=true`." -sidebar_label: "Delete managed credentials" -hide_title: true -hide_table_of_contents: true -api: eJztVttu4zYQ/RWCTy3gymkbBKiBos0mKRD0tsimT4EB09LIZkKTCkkl9Rr6986QkiVZSuINij71yRY5wzlz5rrjXqwcn91xmYH20ktwfD7hGbjUysJLo/mMX4ICD475NbCN0GIFGUstBA2hHIu6ucTj5TZIreQTaLaohS9a2etswXJrNkFKOGdSKTzqNaLXEcYW5RJ2a5gJGIRSW5auIX1gz2tAVRv0M8KF1+xZKsWWwJbKpA8RhS21lnrF7s2SgAuP0gXojKH4C35MmCiCyOKnYAuyH70tYZHwCTcFWEG2rrM9Ib8PvEPBQlixwUtLrO64xg9UGHiHkpKoLYRf80O+64drXv2W6XIDVqYt0ZYwWXgsJRrnM4I54Q5RbwSf7bjfFmRVag8rsCiaG7sRPh6dnfKqmhxC68XoKHTdDPi3AU64LpUSSwVRtwvY2FWL8LEEux1A/NOuhJafQ8BewPY+suq8eN36dc4WIXEmbYZKt09OmfeTs5+XsXJGsjNhl5CLUvkZW+T4HfNy4MbSGAVCjzA4p4C4wmiHNY4K352c0s8Bc7+yb9gfhqUG6dCeVxN+enIylPsgMkbhBefRVCONYlhCSqaB+em9I9ldB2SbEXd8A86hk9RuauxmeQ8pvVdYqrfQjFCpEWyddN4ifRQZjvVBLvIra429qf3Dmyog/37Ew6aSmTaeYWcxz4gnSP8wlL7pRipEsN95TI7fGNymKPrN4Ghe3iBgrEQHbAzScJ/vhLJbraEdpqZUWeBgWfsDWUI8IOgcoXrXMSGsFZTo0sPGvQ043g7ChfojuPE4VtfIRWnV62F/qRNf1E40GZE0B/Rqn6dz8i1Q1DjOCgtP9BAGvol08i6zIRFRz0FaWuzkYSZ8AGHBnpfYW2d3c6pLHBhrQ4MlxiGMEbrl03YsT3eDIVJNO1Hd3/fSpKIeAfapmUeBUL72vnCz6VQUMkmVKbPEwSOWRSLNII0+hRv2UQlPjZFdkDw7/3jNCXnj2CdK5Rj8rnv70JHFpl2FNhWE8CT++aVpuffPPhAtdW6Cek14jYLMvgWQ3JUpritRmGpQpKEG+853XcYylCp0/Nz83F4gEGIu2vk2OTtLTuisMM4j2fRkPRdiPoy17UO4u7Yp/L9X7Tu/h7/9tFACp2pb9bEGeqvphM/GVqk+37PRfonJusa40YO73VI4+MuqqqLjOMWpOjLpaGJiJYYJ+0rojtgwRl17gG1nhXkSqiQZTivG8cb/ywXjFS/aZaj1Y04fVsa944sY/eqm3g2+Zkfuv6PQmoGlt11cDeRh8nwZ8yMg316D34+zn8HVHPXWIDJsnMRtFD1PUyh855HBptGbMJdXv13dXqG46Dfog4YcDIxixOIJErfmAXRV7SF7+iaMVfUPdLIH+g== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the managed credentials identified by the given `managedCredentialsId` from the associated `managedIdentityId`. To optionally check whether the deletion will be blocked by running jobs that depend on the managed credentials, append `?checked=true`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-managed-identity.api.mdx b/platform-api-docs/docs/delete-managed-identity.api.mdx deleted file mode 100644 index b9ae36f69..000000000 --- a/platform-api-docs/docs/delete-managed-identity.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-managed-identity -title: "Delete managed identity" -description: "Deletes the managed identity associated with the given `managedIdentityId`. To optionally check whether the deletion will be blocked by running jobs that depend on associated managed credentials, append `?checked=true`." -sidebar_label: "Delete managed identity" -hide_title: true -hide_table_of_contents: true -api: eJzdVl1v2zYU/SsEn1bAk7M1CDADRZsmKWBs3Yo0fQoMmJKuLCY0qZBUMtfQf++9lGRJlpu4fdjDnmyRh7znnvvFLfdi5fjslssUtJdeguOLCU/BJVYWXhrNZ/wSFHhwzOfA1kKLFaSswW+YcM4kUnhce5I+D6CVfATNlg123kDn6TJiN4aZcK9QasOSHJJ79pQDnrLhaEq2cBsvU4rFwGJlknu8PN4wW2ot9YrdmZjICI/oAnTKEN6j0VJMLATLQrkJE0VALt8Gk5C+8baEZcQn3BRgBZmcpztfPw6ZI6oQVqxxx5JaW67xA9EjDxEpSbJC+Jzv6/hxXztdrsHKpFnIJFgiZOGhlMidz4jjhDukvBZ8tuV+U5BVqT2swCI0M3YtfL10dsqrarKjZuyqo/NQgt2M+PxjV0LLr8H573D5OduNxs9bn2dsGYIw6YIu3S7eMhvG+9hQR+wSMlEqP2PLDL/rII/8iI1RIDRu6VIpESuo5a6qBUXAFUY7rAU88PvJKf3sSfcn+5X9bVhiUA/teTXhpycnY9x7kTKKJziPplo0wjAflUyC9NM7R9htj2SXArd8Dc6hk1SWDXcT30FC9xWWkjcULR5qgZ2TzlvUj0LDMd/IRX5lrbHXjX+4UwXmrw942JYF08YzrFbzhHwC+o8x+rofqhDCYTWbDL8xum0J9CrraFFe8L6++aLLBKrnfSlGSbjLdqLYS6O6vySmVGkQIG6cgTQiEZB0hlS965kQ1gpySHpYu5cJ17ujWOH5A7xxua6tAxulVc/HfNDTegJdNE606RC1C3TrUKdz8i1I1DrOCguPdBFGvQ1z9FNmQxbiOQdJaSknqMG+B2HBnpfYRme3CypK7L65oRZdxyH0ZNrl0252TbejjlxR9YN9bDt3UIvn3hduNp2KQkaJMmUaOXjAhI+kGeXI57DDPinhqeexC8Kz809zTrRa1p8pT+vI9rnv4kIW20YUGlAA4Ur950PbTe+efFBR6syE442aDQsy+xJBclcmOLBrMBWYSEKBDZ3vu4w1JlVo5pl5120gEVKutvNbdHYWndBaYZxHpenKpuXXwR49D/a5brty/58/K5qwe/jXTwslcBB2pVon7uDRNeGz8WMC0ytHpQm63cbCwRerqoqW65FK+ZxKR9MLCyNMu2f0PmLcHyR9D5vee+JRqJIwnOb98cb/02n/jBvd06RzZEEfVtaPgB+S9JfrZlC/Ykc+7g5SaweI3vR5tZTHeVEt8FAOIsUGQoRr3HmSQOF7N4zG6aCNXl79dXVzhXAxbFR7jSkYOEgQUzIgbsw96Kra8fX0TRyr6htLOlZp -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the managed identity associated with the given `managedIdentityId`. To optionally check whether the deletion will be blocked by running jobs that depend on associated managed credentials, append `?checked=true`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-organization-member.api.mdx b/platform-api-docs/docs/delete-organization-member.api.mdx deleted file mode 100644 index ef4848217..000000000 --- a/platform-api-docs/docs/delete-organization-member.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-organization-member -title: "Delete member" -description: "Deletes the member identified by the given `memberId`." -sidebar_label: "Delete member" -hide_title: true -hide_table_of_contents: true -api: eJytlE1P3DAQhv+K5VMrpZttizjsqVC2EuoXAnpCK+FNZjeGxDa2A91G+e/MOE72C0FFe0o8Ho+fGb8zDfdi6fjkimuL31nCc3CZlcZLrfiEn0AJHhzzBbAKqjlYJnNQXi4k5Gy+ChtLeQ+KXXf7p/n1iCdcG7CCgpzmQ5ifdimU/BPM34MzOhphRYWbligarnCBB5AGDyZcEoQRvuC7ZJvBmKorsDJbs1FkC3e1tID3e1tDwl1WQCX4pOF+ZegSqTwsg+tC20r4znR4wNs2GUj6rP4eJtbpvzPN6LgzWjlwdOLD+IA+OyRf2Tv2Q7NMYyDleZvwg/F43+9Y5IxgwHm8q/dGN2FMKbOQSXrjyLfZoFzzX2FlnBNLINFEeD2/gYziGUvv72UH2juus3TeSrWkOnMvfUmmqbXansf8cKcN5B+fyLBXFlPaM1GW+gF5yN1BVlvpV0FIxyAs2KMaX2tyNaPiocoKTWrMgxqD9miXp6T9tAmaa9Pu+XDdv3zLKbS97yVa2xIPFd4bN0lTYeQoK3WdjxzcIdlI6j15XIQddlYKT6/KPpM/Ozo75cTVY19QlbuKbcIPRaMbeZQMrefBCS3dz5deLzcPPpRDqoUOx2OFIwVd+xIgpSsz7PvOmeQhsiCP7eQ3U0aFyDLIdaE/rTcQhCrX3fN+dHg4GpPNaOcrEdQVG62bEbF7dgmbtURfP5NiHT389qkpBbYzgoSEmiiFOAYTPukHUFQDmYZJgG9WID65N81cOPhly7YlM/aTJfnh772wUsyp8CiZXDr6R/EtROngmeTenMcOe8tennBPJhSNQq04UZQ1rfD3FlbDYKX59u9Mzw26V6AN9W1n6FuAyDESVa/bPsoyMH7j4N6k2mryk+m36eUU3cV2F+10TbjgSS582uBxqW9Bte2A6WlNjG37CAtpfLo= -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the member identified by the given `memberId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-organization-team-member.api.mdx b/platform-api-docs/docs/delete-organization-team-member.api.mdx deleted file mode 100644 index 656763b4b..000000000 --- a/platform-api-docs/docs/delete-organization-team-member.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-organization-team-member -title: "Delete team member" -description: "Deletes the team member identified by the given `memberId`." -sidebar_label: "Delete team member" -hide_title: true -hide_table_of_contents: true -api: eJy1VU1v2zAM/SuCThuQxdlW9JDT2jUDin0VbXcKAlSxGVutLamS3C4z/N9Hyh9x06wBsu0UmXqkHslHpuJepI5P59yDKBxfjHgCLrbSeKkVn/IzyMGDYz4DRhBWQLEEy2QCysuVhIQt1+E2lQ+g2E1zf57cjPmIawNWUKTzpI/13aZCyV/BfI0RvwYHBBthRYEAS3wqrvADnbRN0XnEJbExwmd8m+IwIFNlAVbGG34U2cJ9KS0gB29LGHEXZ1AIPq24Xxt6RCoPaYCutC2Eb0zHR7yuRz0TSn8PFcrnf1Loivsiiaag/57Ggtyd0cqBI493kyP62WrGZ/aGfdMs1hhIeV6P+NFk8hx3KhJGZMB5fKtDI0wYk8s4NDO6dYStBiw3/OdYDOdECqTZlrxe3kJM8Ywl5XnZEO2Amyydt1KlVFrupc/JNLNW28s2P7ypA/P3OzLsNM2U9kzkuX5EPgR3EJdW+nWQ7ykIC/akxAZN5wsqHmo70zQHSZiDoHi65RFq3EVVUHodhUGMqkZtddS0HA1d7+uo93dgH7pxKW2OoTLvjZtGkTByHOe6TMYO7pHvWOpnOrkKN+wiF556zT4Snp1cnHNi2yVzRbVv6jhMqS8lvchbIdH3MoDQ0hw+dSq6ffShSFKtdHBv696yoGf3EaR0ZYzLqAGTaEQcRPM0+WHKqBuZBxGv9IfNBRKhyjXvvB0fH48nZDPa+UIEzbUT1+ys4erbpllt1PuX27KtqIefPjK5wAlHSiG1qpXKnNahQ+i0W4vN2kZDv51awZBtsC5azWBjM8yRIlXVUjj4YfO6JjOOoiXl4vFBWCmW1B3UVSIdnVG3K5E7eCH5V5ftcL5m+1fyzlxbo1BrTizykr7weAfr/p+AtuFBnP68mw/g0lb7YDIv7egD6PSNrheIzUAkGIm611yfxDEYP3B8tmSf7Kez2ZfZ9Qzh4umob412eGAnL5RWQFzrO1Aor75q9E0c6/o3hrzmUQ== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the team member identified by the given `memberId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-organization-team.api.mdx b/platform-api-docs/docs/delete-organization-team.api.mdx deleted file mode 100644 index 7509206dd..000000000 --- a/platform-api-docs/docs/delete-organization-team.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-organization-team -title: "Delete team" -description: "Deletes the team identified by the given `teamId`." -sidebar_label: "Delete team" -hide_title: true -hide_table_of_contents: true -api: eJytVFFP2zAQ/iuWnzapa7oN8dCnwegktGlDwJ6qSrjJNTEktrEvsC7Kf+fOSdpSGEhoT3HuPt99d/7uGokqD3I6lwiqCnIxkhmE1GuH2ho5lSdQAkIQWIBgiNAZGNQrDZlYrqM513dgxBV7T7OrsRxJ68ArDnCabUL88rky+m80XxKUYE55VZHLM4FGGvohuPU5XRtJzemdwkLuc9oNJUxdgdfplpcnvIfbWnug7OhrGMmQFlApOW0krh0n0QYhj9CV9ZXCznR4INt2tGHSVfQiFa7k/1NY8PXgrAkQ+ManyQF/9rrwXXwQP61ILQUyKNuRPJhMnuKOVSaYDASkXAOaYMq5Uqexi8l1YGyzw3LLfy4rCEHlwOroydvlNaQcz3l+bNQd0QG4rTKg1ybntkrUWLJp5r3153195Gkj88/PVDjISBiLQpWlvSc+DA+Q1l7jOurmGJQHf1TT80znC24eiaqwLL0sSi9Kjb0yIXGFpIkSa5Mo+aTpnrmVHNbfDWqsfUkXCkQXpkminB6npa2zcYBbYjXW9okWLqJHnJUK+UXFV8aLo7NTyZwGyhfc4a5bu8Q3DeOMspcL/y8jiCzd4duglet7jK3QZmXj9b67PQtO+xpBLlenNNwdmKWh0iiNx8Xvlkzq0GWU6sp+2TqICHeuy/NxfHg4nrDN2YCVisrqZ6pbBnGV7PNrtuJ829rpO4jwBxNXKppaohBLaXoBzHm7BIJOhy3TrT0y9MNOL1UQaYY2zVIF+O3LtmUzTZBnwdHxTnmtltxuEkqmA59JbitVBnihqHfn/Uy9F6+vsGeL6Y3KrCWzKGv+o+MNrDebkxfYmzj9e5e9gUvfznZByAJURnG4WZ3zKE3B4c61J6vo0RSfzH7MLmcEV49HZW80YoJnWdFLRsSlvQHTtluS/M8c2/YBCrhnQQ== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the team identified by the given `teamId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-organization.api.mdx b/platform-api-docs/docs/delete-organization.api.mdx deleted file mode 100644 index 224ced7bf..000000000 --- a/platform-api-docs/docs/delete-organization.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-organization -title: "Delete organization" -description: "Deletes the organization identified by the given `orgId`." -sidebar_label: "Delete organization" -hide_title: true -hide_table_of_contents: true -api: eJylVE1v2zAM/SuCThuQJdkW9JDT2jUDgg1b0XanIkAVm4mVKpIq0ekyw/+9pOx8B+thJ0vkE/lIPrqSqOZRDh+kC/SddGQOMQvao3ZWDuU1GECIAgsQhFBW/1XsEjoHi3qmIRfTdXLP9QqseCTUOH/syo50HkICj/NtpF97MQjiVVBLMgemUElLF4KmEOTVzMArLOQxrf0wwpZLCDrbUQqED/Bc6gCUGUMJHRmzApZKDiuJa89JtEWYJ+jMhaXCxnQxkHU94efROxsh8otP/QF/jih8Fx/ETycyR4EsyrojB/3+Ke5K5YLJQETKtUETTHlvdJZK6C0iY6s9ljv+D3IJMao58HRa8m66gIzj+cBdRt0Q3QB3VUYM2s6pJnqq0bBpFIILt2195KkT889nKtzMT1iHQhnjXogPwyNkZdC4TkO7AhUgXJY0puHDhJtHEy0czzxPM09zZq/ssch6VZpvLTlOWG1mXwZDiALRx2Gvp7zuZsaVeTfCM9HoancigrvkETdGIY9QfGW8uLwZSyax4XjHLW3as8902yHOKFt98H2aQGRpDt824li8YKpd25lLz9t2tiw47VsEuVyd0TY1YNaCypIWDovfL5nkoE3S5sx92TmICHeuyfOxe3HR7bPNu4hLlaTU7lKzdge7e8yz2qnyv/a9bSjCH+x5o2h7iVGqrGoF0P5lOnLYrDiNqSDG7KiqqYrwO5i6ZjPtS2B50XGlglZT7jWpJNeRzySumTIR/lHJu9t2g96Lt/8WZ6m3RmXXklmYkm90fIL19idVTwhYgMopDPNrfJdZBh73Xp3s+sGaXI9+jO5HBFeH0jySYkpwlhQ1LyHu3RPYut5yRL4zx7p+BcJSB6Y= -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the organization identified by the given `orgId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-pipeline-secret.api.mdx b/platform-api-docs/docs/delete-pipeline-secret.api.mdx deleted file mode 100644 index 7abdce45c..000000000 --- a/platform-api-docs/docs/delete-pipeline-secret.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-pipeline-secret -title: "Delete secret" -description: "Deletes the pipeline secret identified by the given `secretId`." -sidebar_label: "Delete secret" -hide_title: true -hide_table_of_contents: true -api: eJytlE1v2zAMhv+KoNMGpEm2FT3ktHbNgGLDVrQbdigCVLGZRK0iqRKdLjD830fKdj6NFgV2Siy9Eh9SL1lKVPMoR3fSaw9GWziJkAXAKCc9mUPMgvaonZUjeQkGEKLABYhWLWq10DlY1DMNuZiuk2KuV2DFfb1/ld/3ZU86D0HxbVf55r7r5qbbJCSRV0EtaSMwViktfZC4vYcEmmG8woU8JKzvELZYQtDZFiqQMsBToQNQYAwF9GTMFrBUclRKXHuOoC3CPElnLiwV1ktnp7KqehuMZxceo1cZbEmeCgjrI5Q/rbCb5i3RJwwfvbMRIp/4ODzln/14P7+JE/HDiczRRRZl1ZOnw+Gx7kLlgksBkWvdqkmmvDc6S68zeIisLXcot9W7k0uIUc2BDdLAu+kDZOntAj8x6hq0FW6zjBi0nXNFJWo0vDQOwYWbJj/aqRL5p44MW/MI61AoY9wz8bCcvFEEjevklwtQAcJ5QfYY3U24eGSmhWPD5clwyWK8KweHnh+Urc0qfiMIq9aFRTB0YIHo42gwUF73M+OKvB/hiaj62nV4kXfEtVHILyq+sF6cX19JZmqRb7nCdbV2wTcF44itXfh7mkS0Uv/52nrl4RlTKbSduXS8qW5DwWFfA+R0dUb9XYvZGipL1thPfjdlcoc2yaoz93m7QSBcuTrOh/7ZWX/Ia95FXKrkrKad6hHQDJFDwnJrz/8we5qCIvzFgTeKWpeIUmZl44eOGdiTo83goVdbUAKsK8upivA7mKri5XoCsE1yHdXUcJvMlInwQkKvzIdO2kdYH42glTIFK5OrVipojv9Glnc3TXe/Fy9N0E6mZlHZ9S5My7opXjUh7QJUTjcxXL19nmXgcefg0RDa69/L8ffxrzHJ1X6THDRFCtDJRe+WFL/cI9iq2mAifzNjVf0D58xvog== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the pipeline secret identified by the given `secretId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-pipeline.api.mdx b/platform-api-docs/docs/delete-pipeline.api.mdx deleted file mode 100644 index 76b69e814..000000000 --- a/platform-api-docs/docs/delete-pipeline.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-pipeline -title: "Delete pipeline" -description: "Deletes the pipeline identified by the given `pipelineId`." -sidebar_label: "Delete pipeline" -hide_title: true -hide_table_of_contents: true -api: eJyllFFv2jAQx7+K5adNYsC2qg88rV2ZVG3aqrbTHhBSjXMQt8Z2bYcORfnuu3MSEgpbVe0JYv/t+935f1fyKFaBT2bcKQdaGQh8PuAZBOmVi8oaPuEXoCFCYDEH1sqYysBEtVSQscU2ba3UBgy7axWX2d2QD7h14AVddJntrrpqJLjthBdrXPIEUXKDHyjr7kCJIgYnYs6fg7X3MFOswSvZQXkK7eGxUB4wbvQFDHiQOawFn5Q8bh2FUSbCCjxKl9avRayXTk94VQ12LE/WPwQnZA/msQC/PaD51Qr/gvOa8HOiD86agA+CJz6MT+hnP+CPr+wd+26ZtHiRibwa8JPx+FB3LjJGtYAQMVarRplwTiuZXmd0H0hb9ii78s34GkIQKyBvNPB2cQ+S7nOenjiqGrQVdlmG6JVZUUl5VFHT0tR766+b/HCnSuQfj2TYmocZG5nQ2j4hD8kDyMKruE2uOQfhwZ8VaJHJbE7FQ0vllgyXJcMlo9EuH+18Pio7l1X0POA3rQ0Lr1Gbx+jCZDQSTg2ltkU2DPCIQENlDx7/Ju2wKy0iPSb7THp2dnXJCaelvaHi1oXqM+9qRRFbp9D3Iolwpf7zpbXJ/VNMVVBmadPxprANBYV9CZDSVRK7uhaTK4RMrthPvp8yGkPp5NKl/dRtIAhVro7zfnh6OhzTmrMhrkUyVdNKdffvZshzxrLz5v/NnKaaEX7HkdMCexZxUlpl44P+vBvwSW/e4GvlCE6SslyIAD+9riparrue7JGpIBaaOmMpdIB/pPHSTDhK+gDbg7mzEbogZbLTRnhFAK+EeXPddPRb9sLkPIrVLAqz7fO0uL0SVnNU5yAytC4R1oIzKcHF3tGD6bPXuBfTb9PbKcrFfos8a4kU4CgZvl5S3NoHMFW1A430TYxV9QdhUmff -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the pipeline identified by the given `pipelineId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-token.api.mdx b/platform-api-docs/docs/delete-token.api.mdx deleted file mode 100644 index 78ad69700..000000000 --- a/platform-api-docs/docs/delete-token.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-token -title: "Delete token" -description: "Deletes the given API access token ID." -sidebar_label: "Delete token" -hide_title: true -hide_table_of_contents: true -api: eJyNVE1v2zAM/SuCThuQJdkW9JDT2iUDgg1b0XanIAfFZmK1iqRKdLvA8H8fKStfbdDtZIl8FB/JRzcS1TrK8VyiewAb5aInS4hF0B61s3IsJ2AAIQqsQKz1E1hxeT0TqiggkpGDxGzSlz3pPATFQbNyH3bHfvJ5FdSG7oFTNdLShTApmtA9qTmTV1jJl+nTC8LWGwi6ELoEi3qlIRAwwGOtA1A2DDX0ZCwq2Cg5biRuPb+vLcI6QVcubBR2pouRbNsFh0fvbITIEZ+GI/6c5v71XXwQP50oHD1kUbY9ORoOX+OuVCmYDESkXDs0wZT3RhepKYP7yNjmiOWB/1xuqJtqDdz+TN4t76Hg93zgzqLuiO6AhyojBm3XVBOFajRsmobgwk2ujzxtYv75TIW7mQnrUChj3DPxYXiEog4at2leV6AChMua5jOeL7h5NMzK8ZzLNOc0YvbKQaejQZOH20p+KzztRl8HQ6gK0cfxYKC87hfG1WU/wiNR6Wv3SgG3ySOujUIeo/jKeBahZCI7nrfc1q5Fx2z3XeKMMmuE78sEIkt3+LYTyP0zpvq1XbkUnluaWXDafxHkcjWtRwazHlSR9HBa/HHJJAltkj5X7svBQUS4c12ej/2Li/6Qbd5F3Kgkp7xK3bp1+/iSYHOQ5P9vc24bwh8ceKNoQSlv4t/kUe9/GT1awLzJNJCKuLGzaZYqwu9g2pbNtB2BxUTHJxW0WnJXSQ+ljnwmKa2UifAG9Xc3eV/eizd+Cmd5Z6OyW8npTc03Oj7A9ug31C4IWoEq6SGm1nkvqTcej+JeLfXJPkymP6Z3U4KrU/290FtKcJYW9S0hUo1te8qSObbtX0OO8XQ= -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the given API access token ID. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-user.api.mdx b/platform-api-docs/docs/delete-user.api.mdx deleted file mode 100644 index adf7dccda..000000000 --- a/platform-api-docs/docs/delete-user.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-user -title: "Delete a user entity" -description: "Delete a user entity" -sidebar_label: "Delete a user entity" -hide_title: true -hide_table_of_contents: true -api: eJyFVE1v2zAM/SuCThvgJdlW9JDT2jUDig1b0a6nIgfGZhK1iqRKdLvC8H8fKdv5WFrsZIl6JB/JRzeaYJX09E7XCWPS80L7gBHIeHdZ6am+QIuEt/yoCx0gwoavUTwa7fjCEPFkbKGN41sAWvO5wlRGEyQOG8VfuXqD0ZTKVOjILE0OGfGxNhE5FcUaC53KNW5ATxtNL0GiG0e4ytCljxugznR6ott2Lu4peJcwicenyYl8DlP/+q4+qJ9elZ4DOdJtoU8mk2PcOVRKyGAizjWgGQYhWFPmjozvk2CbPZY7/nd6gynBCqWJPXm/uMdS4oUobSXTER2AuyoTReNWXBO7GrJimsXo43VfH7+0mfnnVyocBqacJwXW+mfmI/CEZR0NveRpnSNEjGc1j2d6N5fmHYbpJq1AyTyVjIgdC+ZKay9KqPJ7VoGE0OOsmHHTjb/Vki4+Ddqoo2XMmiik6XgMwYxK6+tqlPCR2Y6MP9LITX5RVxZIJq2+Cl6dXV1q4TqUciOd77q4X9C2kZJR9zKS+yKD2NIdvg0aun+m3CLjlj67913vWUja/xGUck2JqQeLZKDMkjksfr9kVo2xWcJL/2X3wESkc12ej6PT09FEbMEn2kBWXL9rbwzpgOi2F4R/aBws8F5ysEyq6ac37Huhp/36co/XnE6emmYBCW+jbVsx805EkRAfnyAaWEijeMSVSXJmbSzBJjxisd0h/e6635L36u0/waukeyM4qfIJbC03Pj7gy+7P084ZuUaoOI4Q6x7PyhID7bkdLbLoaivvi9mP2e8Zw+FQUP8IKCd4lRV3LSN++wd0bbslSXIXjm37FxXx2fM= -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Delete a user entity - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-workflow-many.api.mdx b/platform-api-docs/docs/delete-workflow-many.api.mdx deleted file mode 100644 index 709c827d2..000000000 --- a/platform-api-docs/docs/delete-workflow-many.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-workflow-many -title: "Delete workflows" -description: "Deletes the workflow records identified by the given list of `workflowIds`." -sidebar_label: "Delete workflows" -hide_title: true -hide_table_of_contents: true -api: eJytVk1P4zAQ/SuWz6VldxEHTsunVK1WIGDFAVVi6kxagxMb24Gtov73nXGSptCqrBAXROw3M2/efLi1jDAL8uhevlr/lBv7GuRkIDMMymsXtS3lkTxDgxGDiHMUHUx4VNZnQegMy6hzjZmYLhJkpl+wFEaHKGwuHjqLcRYehnIgrUMP7HmcrXzftZjfUC4I4sBDQceemdWypA+CsqPgQCEZDqRmZs8VejZ4y/euA4qyKtBr1ZP0BA5qjgXIo1rGhWPHuow4S1e59QXE5ujwQC6Xg1V0ulK4O+4FQ5IEGWdFhwJZCp0LymslXRDgUYCKpNM2OlNrDUJJ0akSHilWiCc2WzBkW2HWHLdo8qosJVVGtgHnjFZJ8tFjYMN6M6idPqJiQ+e5QFFj4Nu14q2BwXvg9HXEYv08RK/LGRFfDmTU0eBGgcN1yzBhmK72SH0QfYXpIDhbhib29/39zZQvf4k9cY2x8mVSenwWuMt6CeIcolC2MpkobRTTthiYDdo6fJ04OWiD2d3XS9SIwCBCHWyT4QSyzxS7F/xeFhgCzJDHfXeaHXBLEn0O595bv8H8x5YCduOfygOGMiY+DA+oKq/jIs38CdKQ+OMqzulzwpNAC2FueWU4m5J2wHdy1JV+1NSZJwr9S7c7Km8INI/RhaPRCJweKmOrbBjwmXgMtd2Y4pt0I64MRF4H4pTx4vhqLJlFR/KGNW30Wae6kogjdsOdhjqB6KT556JbNI+vMSXPtbruZ/38LxTO4MYI3nfaT5a8inKbQrY1aJkz1Y+SYom0op3egLmBaCGxs7eCrctEPaRN2o25/dlfEBFWu4nzbXh4ONznM65SAan/2g36flu9J1n3ffzFT05bk4h/48gZoBVOBFOiddtG/fuXWKVGomrPudXosq6nEPCPN8slHzfrn9sr0wGmhgcqBxNwR0YfPEpbKT7hYuPdewFTMVLy2/T/4T/3Nu1g1b2HPZ8Jf3jNhNLMknwIGWXHQjVGpw2fvVv229tuLC3OrbE4Vgpd3Ild3w1Xlze3PGTtc1nYjG08cFn5L/HkXyBsnWY3ndXSQDmr0o6TjU8eSXg70e8mOGXVLfv0qnQMqVkS4tY+YUkN0ykW+ZvokvN/g6RMkQ== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the workflow records identified by the given list of `workflowIds`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-workflow-star.api.mdx b/platform-api-docs/docs/delete-workflow-star.api.mdx deleted file mode 100644 index fd90c41ff..000000000 --- a/platform-api-docs/docs/delete-workflow-star.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-workflow-star -title: "Unstar workflow" -description: "Removes the workflow identified by the given `workflowId` from your list of starred workflows." -sidebar_label: "Unstar workflow" -hide_title: true -hide_table_of_contents: true -api: eJy1VMFu2zAM/RVBpw0IkmwrevBpXZsBxYataDfsUBSoYtOxWllSJTmdYeTfR8p2HDdBih52Skw96j2ST2x4ECvPk1v+bNxjrsyz53cTnoFPnbRBGs0Tfg2lWYNnoQDWw5jMQAeZS8jYso5HK7kGze57xGV2z3JnSlabyjElfWAmZz4I5zBnSzflE24sOEFklxnSXYCCAH86wA0mIMQKJ0oMOxLbcI0fCB24ECJJqxWh4C8L6O9Cdif1atBONzt4qiRK4klwFUy4TwsoBU8aHmpLJG0S32wmI15vRQoD8VMFrj7IHIFMVyU4mY6597ikDrCKR7lxpQht6PQE2e9IqrdGe/CU8XE+p58x389vmJoavEUHOhXWKpnG3s4ePEGafVKzfIA0UJMdTSLIlmCnuYeawYMMikLnDsR4XtedToQR8GT+6YDSfuZMm8CEwlScQUSf7KN/ICY3lc7eUt4w2VtegvdiBWTu41X3wKMlL5wz4yrxEO1ZGDJwFg0cTYtmTPis7+SsGXq6mfnW2R7curd15RTiixCsT2YzYeU0VabKph6esFtTafYMdhNP2JUSgRzDzgnPzq4uORnGQ1o5Geob6klb3xcQDtxZRcq2JRJjb0f6XkYQRto/X3svPjyH2AepcxPTu350Koj2NYFUrkxxm7RgGqZI4zDHxe+WjPOUKj6F3HweDlAIda7l+TA9PZ3OKWaND6WIXuie629Nvd7unJcam8FS/3/XdR0P8DfMrBK4O1ByLL3p/DLsYoQnoxUXLYNzLbBEAjbNUnj47dRmQ+F2B5GRMunFUpH1c6E8HCn4lQ11UO4j1HtLcC1URcjou7VwkvjfqOXddfdi37OjK/ugqC4odL2rZlds18bNHaILEBneRfpawFmagg07qXu7hQrbvvGLxffFrwU+hn8huojW -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Removes the workflow identified by the given `workflowId` from your list of starred workflows. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-workflow.api.mdx b/platform-api-docs/docs/delete-workflow.api.mdx deleted file mode 100644 index 006fbaa2b..000000000 --- a/platform-api-docs/docs/delete-workflow.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-workflow -title: "Delete the Workflow entity with the given ID" -description: "Delete the Workflow entity with the given ID" -sidebar_label: "Delete the Workflow entity with the given ID" -hide_title: true -hide_table_of_contents: true -api: eJydVcFu2zAM/RVBpw3Ikmwreshp7ZoCxYataDfsUOSg2EysVpFUiU4XGP73kbKdxEvQrjs1pp70HslHtpKollFO7uSTCw8L456inA2k8xAUamevcjmRF2AA4VcLkAPpVVArCgW+WUlLHwTrXqA7A6ktRbzCgn7nELOgPb9Hwe4dETFouxQ6B4t6oSEQNMBjqQMQK4YSBjJmBayUnFQSN55Jmkuyrgc93uhVBjvixxLC5ihzAgpbriDorM99wKUtwjIdLVxYKWxCpyc9djrK4HneS4YILEDkXEkKCliDFXqRgl3dhI5CZajXcEzM3DkDyhL3jMsUvbMRIgM+jE/4T5/z+xfxTnxzKDJHWViU9UCejMeHwHOVC646RCTaDk0w5b3RWXLB6D4yttpTtWvUnVxBjGoJbJxWrJvfQ8bv+cBWQt0o7YDH2ilRo+HQNAQXbtoE6aROyj8eSbEzqbCUpzJUQtLD8AhZGTRukjvPQQUIZyVZcXI34+r1n2ncnTqxtSa7AjfiSWORDpaa+3V1QRmR7wvHU5F6CWka+Gk56vo4qnaTUHMrIay7USmDIWiB6ONkNFJeDzPjynwY4ZGSGWp3YJ7bdCKujUJ2ofjMeHF2fSU5lS7TW25MU+T9fLd1ZsbOVclNCUSR5sdl5+/7J0wV1Hbh0vW2Ka0Kpn1JIKerM4gtmB1FrubH+snvp0ym0iaN18J92h2QEK5cw/N+eHo6HHPMu4grlQzZDuEre9hLYFsjhN848kbRJBNJElu1zd2tR7o92Vt01IKC1DCiquYqws9g6prDzSrgnuc6qrnhUVkoE+GAfjtzLy2oozofYHOwA9fKlIyUvKf+nf5/9tQzmrrNuFMz44+gWc4rK/Pmpt03b8Wz/z+OymmDym721eyXru1mPSN0ASqnt1hfAzjLMvC4d/VgM3Ji271wMf06/TEluOqP4F8jlwiOKiMjJcQP9wC2rrdCkb9ZY13/AUGIqR0= -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Delete the Workflow entity with the given ID - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-workspace-participant.api.mdx b/platform-api-docs/docs/delete-workspace-participant.api.mdx deleted file mode 100644 index a01135ef0..000000000 --- a/platform-api-docs/docs/delete-workspace-participant.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-workspace-participant -title: "Delete workspace participant" -description: "Deletes the given participant from the given workspace." -sidebar_label: "Delete workspace participant" -hide_title: true -hide_table_of_contents: true -api: eJy1VU1vEzEQ/SuWTyCFbICqh5xoaZAqEFRtEYcoB2d3sut2d+3a3paw8n9nxtnPtCJSgFO89vP4zcybl5o7kVo+X/InZe6tFjFYvprwBGxspHZSlXzOLyAHB5a5DFgqH6FkWhgnY6lF6djGqGJw1AWa8glXGoygKJdJF+dHC7jqgyAUQ4oCjw3RqXmJH3hFmRSvTrgkHlq4jO+T+2ZSUcpf4RVWVgUYGTOZQOnkRoJBvIGHShpABs5UMOE2zqAQfF5zt9X0iCwdpAG6UaYQbrd1esK9n3RMurwO8OnS+59kBvU/QGdQ5H9PaEXXrValRdngjXezE/rZa9Bn9oZ9VSxWGAhb7Sf8ZDZ7jjsXCSMyYEkOLRphQutcxqHB0Z0lbD1g2fNf8gKsFSmQghvyan0HcZCXIS06uSPaAvssrTOyTKnI3EmX09bCGGWum/zwxAfm71/IsFU5K5VjIs/VE/IhuIW4MtJtg6TPQRgwZxV2ab5cUfFQ75miyUjCZIQpoFMeoe5tVAf1+6ifzageyNBHAxng0UgUntPr5rGdp8rkGDdzTtt5FAktp3GuqmRq4QHJT6V6ppybcMKucuGo8ewj4dnZ1SUn6m1mN9SIXVGH+XV1pRd5oyr6XgcQ7uwWn1pJ3T25UDFZblS43jShYUHPHiJI6UosUgMmBYk4KGic/DBlFJHMg6I36kN/gESocrt33k5PT6cz2tPKukIEATaDuLO03vSGzrhPuO5F/ReW2tTVwU8X6Vzg5COxkGDdqGdJrmkROm/dc2DuuDt2sqGG6HRsLdjpDJOmoHW9Fha+m9x72sZBNaRrXD4KI8Wa2oVCS6SlNap6I3ILf6jBq+tmdF+zwyb+YtrNpii3nFjkFX3h8h623X8HueZRnA4Y+RGEhoU/mtZBQz+C2LjnfoUXMhAJhqOO7jBncQzaDW4/s+WRo10svixuFwgXYz/Ym//wwIvkUG4BcavuofS+4+romzh6/xuCewdy -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the given participant from the given workspace. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/delete-workspace.api.mdx b/platform-api-docs/docs/delete-workspace.api.mdx deleted file mode 100644 index 0255dae75..000000000 --- a/platform-api-docs/docs/delete-workspace.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: delete-workspace -title: "Delete workspace" -description: "Deletes the workspace identified by the given `workspaceId`." -sidebar_label: "Delete workspace" -hide_title: true -hide_table_of_contents: true -api: eJytVE1v2zAM/SuCThuQxdlW9JDT2jUDig1b0XbYIQhQxWZstY6kSnK7zNB/Hyl/Ni1aoNvJMvVEPpKPrLkXuePzJb/X9sYZkYLjqwnPwKVWGi+14nN+AiV4cMwXwHockxkoLzcSMrbexbtc3oFiVz3kNLua8gnXBqwgV6dZ7+xXh8F7I6zYos0SkZor/EGctjniJ1wSAyN8wfdp/bC5UPJPdM1UtQUr04GVRbyF20pawLDeVjDhLi1gK/i85n5nKIhUHvII3Wi7Fb4xHR7wECY9k1E+z/Lpc/r/ZFb03BmtHPYHX3yYHdBnrx5f2Tv2XbNUoyPleZjwg9nsMe5YZIzIgPMYq0MjTBhTyjTWM7l2hK1HLAf+S74F50QOJJWWvF5fQ0r+jKV+e9kQ7YBDls5bqXIqMPfSl2RaWKvteZsf3oTI/OMTGXZKYkp7JspS3yMfgjtIKyv9LiroGIQFe1Rhj+bLFRUP5VVoUl8W1RdFR7c8QZm5pI5iC8kwBEk96nrgFMDedQqtbIlPC++NmyeJMHKalrrKpg5ukd9U6kfSuIg37KwUnnrLPhOeHZ2dcmLXkb+gWjd1G6fQl44i8lY49L+OILQ0hy+daq7vfSyKVBsdn7d1bllQ2JcIUroS69CCSSQijSJ5mPw4ZdSJLKNoN/rTcIFEqHJNnPfTw8PpjGxGO78VUWPtnDWbYdgw+yTrQav/upLagnr47RNTCpxpZBQzq1tlLGkBOYTOu0U02pBoHS8FbGGB2dCjul4LBz9tGQKZccgsaRKPd8JKsaY+oIIy6eiMityI0sEzib45b8fuLXt53z2ZVmsUaseJRVnRHx5vYNevWdp2r+L0ws57BaFxYcMK4QWIDJ1R2RrEUZqC8aO3j/bWg5E/WXxbXC4QLh5O0970xABPUsOeRsSlvgEVQs/U0z9xDOEveguCpA== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Deletes the workspace identified by the given `workspaceId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-action.api.mdx b/platform-api-docs/docs/describe-action.api.mdx deleted file mode 100644 index 89f785710..000000000 --- a/platform-api-docs/docs/describe-action.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-action -title: "Describe action" -description: "Retrieves the details of the action identified by the given `actionId`." -sidebar_label: "Describe action" -hide_title: true -hide_table_of_contents: true -api: eJztfVtz20iy5l+pUMc5I8WKpG/TMeunpSXZw23J5hFld8zx8ZogWaQwwoWNAiSzO/TfNy9VQIEASZCSu226HrotCXXJumV+mZWZ9cdB6s3UwcuPB9449eNIHXw6PphINU78Of5+8PLgUqaJL2+lEum1FBOZen6gRDylX7mW8CcySv2pLyditKAPM/9WRmLI33uTYfvg+CCey8Tj36HdU+plJLtUBD7PvcQLZSoTpOePgwh+gWKmBSjgIzlzL70+WKaR2xAKKI1mBTUJFEzkb5mfSOgxTTJ5fKDG1zL0Dl7+cZAu5tgBVzq4vz/O+7yLkxs198ay6Pa3TCaLSr+/moIiykKZ+ONy35W+/CiVM/o0jZPQS/lPP78o9e6lQNEoS6Va33l3MvHxRy8QeRVx6wUZLlUs/GgcZBMJ/9KCJFLNYX2lOBwG3kgGanjUFrC2WRIp4UVChvN0wdXzIi9hWEEwPBL+VMShn6Zy0q4blpckHtLnpzJU1ak9PpAwPbjJuFncY19a+LfWrZfgqFX5Y+qngcyX9b9w9F0zQpiq+0+4rDwc6u7Zkyf4T3l63v0CHY9jmPEoxa/efB74Y9p/nX8rLPJHdSTx6N9ynOJmTHC3pj53wJtwczl/UrOxjmFkWTS+xk/Fbvx4MPFSeZJI+D/usrk/l4EfSRp/g05C78u5jGZwGF4+e3Zc7XMch3OYrrPoFkvjOnojnFQ+BV4QvJvSMbMpgtma+rhetBOh38BLcaPW/mVNYf1p40jG0C8eFy9QvZqZW97wJ0Vx65wJ6FTo0QoZ3fpJHIXwUXgZ7HsoxGuOm51GqoT84qsUGcU4iLOJAJpuobmk88/+ibBIaouBlOIjL5H94dPhdZrO1ctOZxKPVVvJ34Cvtf24Y6ag5c39zpjqtax6R21cmDiZlQa7kifgJvcm76JgYVZtaYMnMy/yf6fR1fAfcYjVWzHUPxZKpsiZ1ULBEWU6bCb3CNSsY4WbSGmwozd1f1K3AYL5tbeBmpmMUCix4LJpYmZcourpkydVsspkvI98YNYCK9O+RM5bszfb4iJTKXyJFGxFFKZPW9B6ieJjMfHU9bGAVrIItqcaxwk0dg1ScoxCkqgs9V6ewiebqT0tfjMCvZ5Y74sfZqEIqO2XAttepiQ//ktk/L1KhJEG3p1qjbx0jPIcf6bjCD/P4ngWyFbgT4E+X0ZjkoT6r6aC/tXU8X7PkuIj/2a+3fxDtSzuJG9Kv85upP1rNiv9qoIMzrP1h0BN7V+9APBQYv8ljL1RqUI89oJSk8Qv9ESX2lo/H41GvtVYNw1uaS6WR1Yd+5871ges8l828gq8NozLlMjFUZulOEnSCrjpG0mj5nIMXG0suGSWaGE3ACY5BnCHiH0uowkgdsaBSgYgioHfmQ4R0a0X0ygpTv1ks4BGGSAmIGPHaZwsBEJ14oIKfiVgDsIlCeXER4GKrU6D+E5M/UBqHpLIyywaUIubewP8KzzBf4GheSkIdjlG3GwwbzRtMfQypeaJj0wZwfFtfIMkvZVfUqIChgx8BgClFvt9mDovgmmKVdpKskg30UD404bscMcdb3LrAQOb/ARja0F7LdNeS7fH0gb/+jhD96YwxyBIgpqhiWvvlll8IBHL/xUjtQRLAw1ixY40wnn9LJ1ZWAAUDR8BMIlmIoRUnR0bobrUyjVACauRURwH0ouqCwbKByrGvioagW2ImzRfJmxK/DsetS34/khNG6kOreNJuz8uwX4N4HlCjsu/WtrYCXEYmI8PupsKAKmdLFJGEfTpQ1mHMAhwaWJPcpa38QwY9dcap8UEsV9U+hZ6ny+VIr6z6x43xLa4rRa2xft74iORoR95wPQ2j8IwcoHFRKlyFTV7Cvg2DCyXFczMoaWjdgUh39cRo4/R4i2bGsrfQc7BfCGViOFKIg/HobfBBXwoT3SNACn0y0cSLfni3ZVljJZq4wDwtEz+poQCWAqzhAui8bwG2yPkcsIbqTggeYvCCdmepaCJEAsSk6Spv0uAHwlvjNzTCagfREDtCR/iko3O1ml+mu6uZWKJDZgb9UinR/RyEyIotnLqZUFKkmGoWcCQqM6UTN42Eu7voWSuZg8G/8TZjJgZYrNoyyGBGsUTLalhtZs1/U8oSU1Dy72+8CaTBIaAGnK11XmcpBvNJ8+fVfpAirFuW5zyZLwUw2fPhjmm+K9MNkEnV9fa2KDV99+w2hJTFBmKDZgTzWpKyICPJaoMFurYofPajqHPu2sfujTGTQIgAhi0UNlIG5TFCWws2F7xrUwSfwK7ydwh5LXKug0SGnpfiMiB/7vcZfqR9FBbNaIsHAGxMAiirjieQBeTafAUD1JBLdD/IhlnCg91sYBPnzwpVvD/xqN3c75T2YaH6B5jrpobkepRIgpTbwba1D9XdbgKNcJxJDOaGJZpHdLqwGlmnuXzzrEpaOVLVwMrc8v9CEbqjdM3sKKakeINR1n4bwmVDHZhPInAp4QnNTe1VPAlPOR0j73SPfAe6N42JFkYtfvrQLzCP24EquW1RUOFN5NXVKhudQA6jOnCxmwp5HSJXHV7USl+C+IzlKrB7itucpb2xKuB0K3gVIdxBpvjkNkdsKAOirkOiueXHbz88oB/JvT7cCf95OGHLpGz8t3ZKh4Ia8ZlNQwBoRtnCaAHcecDWhzRHQyZ6g9le9YG1pWplvQAwz3VY9tOfNmbhEfD/B1ZLiCfCNG33rRQFfdFtHXLRYunl903Z29zq5dB8b0AlhIWQ39vigNVNkf0ICefVTxN74Bnd5jCDorRW1/eHVlk9yKVIl5cva9LO+zkGagfXIPV0jr680WYPm0/+xJ4yUyWVwFkymUcNOgPS4nu5VvcYrPEg+08hU3bgh/hn4nodS8EbMHQV4okIpRaxVuAwxs406xrbDsx3eMoz04GIvXUzRIu2gKR1a39alarhe/Xmqg1PD7w++hJsdlAgUhfN4VjOznv8e4IAtZucrOOZjb55WKt7uGU6B9Cidb7+mSeqV3g+dsckp/03yscZ0xydP2e1p1eyBB02YvRLh1zXdMhbu+V5/cY918oZ95oker7C4cv9wlfAheDg3QW4a9N5oFLio+/8vHT7HD1AcPWj2z1cQpql2QFcpohD3+2feevqaJt/lzZP/dxZDnGLFG+grboFnbMgJHy1gS+/XAhC3Sh8bZFQpV+tmbFszdJnM0bOAkht/qVBPB5PFMgKKGa9hHSAxPQmtonWx+v5CDy5uo6Tpuo/0vbJa+6YbN0Zpk/kR1lih9tXjkY0ExWL7AZIr3Gj0szqC0fbfHRKtN0zsx9O3Bi1clVw5/o/y0ipWUVMczvCH3FYpAL2sm1qhmU3IoiYmUa35WJN6yHNhzof0G8KOMPbdJSm2/d0xVg3XjPDPrvruBXQOvw/1W/VNwNejawb4shFBpqQpXIIrqhTzIojdsjjloTGeJ4bZ0AlmaIXRT1yrUG8zgtCotDGLfE06dS3q2g7uyKCy78iEx2hArIUQL3HEz3hrvF0Puyc5faSrhtl7N5tjVzfNN/b80yIYqR6sLWHIy9oIm8zK16OaHk24s2A9zhLfllDqtJfU180HLWjEG8jVP64PGq3vmgB6w4476lXz7EtnESh6HXUhI9wRHtBdo5DuHYnSzvQtrAPEmE1gYp1pkt1h2ZV2eDq8+ve3g4zI+f+5fv3lyeDQa9D2f66Hw+6fa7J72rf31+17/qXfT+++zUfOlf9k7O6r9/n21X+MMpOuCHyKHENfAr5oJs+FFlLoCibgwrvBBxlhJDzHXmEnKoo3hI/LFgL0Wj+NtwLc1ct8xkeBeGACUa+RFngDtC0b3oid4pDiNTrKezxEWGvcTvrCswlA3nfpR9aT1Da0ELxVXo/44MAftnPS2UMlWlo2WMWX9T1K9x29LeWvblGNYKUBSliCTgHEPTt4DGLCfNbuj9Dr+Vu8dmbVfownwG6BmvgFgzmI+bTNGH/gnODbYXyRS1eShFDahsBH95yCk/16ca+9CtkbKuYhw2TX1B+zSBlZIebMIYRp6QOyxOAYkcqMo0wb5L/HRBEPExSDMNavTYOyUKJxLtLaiSSyo1BUl/hzp4kpGbC648gswkDmgUZiXwshD4sjeFBWdMpL5coN128zq8HnyhRTgnM7O29s5jXwsZaKjZleZSOxYDL5RGaGzX67Q1zStoEuXMm1fG/DyPlXwXnQJPWQqq2CjVJliH4ZllHL6WUS1Og23PFXjny/GzX+Si7zW5EcfVu5Howegn+QWz5QdCAulVNr55nJPgFWrF4LkYcbu6P1/rvKtwBiCEVyD+bnZduuI+YXmpGPI3BzGHp/l9x5HQiKYKGMTh7VPGgSN/0pewhKCVzXYi3UAzAw/miT+my2ivLB6OhQezibZR3Znho4UA4qps6/HSMshoLyNauo6IYpIILDKgcziYfsAsP0sS3H8Ka3HDsBVHEvE/eeAy76f7U1j/gqylq+T/YHVbThWHoGxzUvimRAHzvhNnrwcVxAaNNhEDZyZSZqkN4IimmYaMbLkBi5PhlrOMDsW1xfbWj0e/RBG6jEVVN/SbTJ1GF7ilvgJZFS3hVRynu7IArMv6AHEAJDlv/9hiCHKsmhpKNMQqK8fGlIqXLDgeWP885JOdVEaLQvdui+4cPdcLq++wI9NxB6jA/9rc9pB3FRBJIMF4npB/jugG8DNuX7IgUsHQW6DsgEOGdTz4PZjCCUb6sGDZLFGjFZFVpxhAaYBLC+zdwX+E1IDWsMOgDap2GN11JvIWeAIcfzaqwJha1Ki277Sv0zDQ9h0vMU4ezc/EZRZV7a/oofOaW7PsYQq31Xi9GY6QeYkRFkomzlwIMx6088ZhvqMaBRLZADZEgKFoXEvVJPz5xdaHvnt58fMLcfgm8W79NI7ss2GNh8k6XjZxHjM19WrtLpenvY0Xp2VHGdpquYcMW8smlwbcbHOLUICIvmVH0pfwyyHdBjyZG3U4ePbWLzyPj6omdX2hX1zyHVf/hJ4ZpdgdyznjDf1dkKF2S/+MP915wd1V7v9d5bq76j25IHAXk+5icv8vJmG74sZtgs5LMkjXM0pNU4e1Uhvac83yTEOlLvEC45sG2K/Bxi+1iVUINuUpPFb10fIwm8cqF3usO/UT0DWpRd0axZqPJOZHCMjSrk1pBAW74zEqaGeh5webqR5wJbRYkFonsRqBH/RJYjsGy7iSvXYrYHXhoWVW4yozBdHTFrYx8ZIJOQGWpsAzk7DkzWabQxvbjEGV00YDNvOSLZBVCyl0Yhv4zcLKKHS0oxQALKPK5UrQh4u2+Ph+BNOVifOrQXEYiLe3GTyR4qD5CJ2SDvWuOrFq6Uw8P2XUxmdY6yOht888GwWY8oDKand7rVO2EeHhRVNL8hG2VT0PVFUp5+JcegkN7sPFGromULQV6KKt29Am8CeMVfuszdZAGP6qZ470gJP3p92lGYJl0bewuCOBu5pI5bZ4Z4zcxyA0kUu04ju8ghuzlqnHabxEvVuYF2I6pOFNMwqDTqA1IOLBikZ5Dz/OLR9USE9B/0YF/s1OfktY02zQUa7Om71mYszPopkfFe4XbTGcT/IDNMwPBp4iTDmB1u7SOfr7E/HmlbEW2sfoL1RbmFU+otpiZxWwXcrxz9+H0rK78+Vm3O/ApAOTPwSY3KT5bQ1gmIF8uGAjq0EwA819P58+U59vn2uwuAqC0idmgg3d4bhXU8nyhvtwYVzg6Hq30aWwn6QZgEVdpWhVA2eVjfLijUzkRJtdy7QUehGI9EmPQkvTRZPGMB605SnlzxAZ6AZ01qd0UaF1qYeTwIcfmvRzsdzymKoaW/9S0jHtu/hrba6tFT2cxzPRBXm4gFaUyNN0mR7COPI5n4pp/QoPRbN7YG2XT3NGihip1CFbPr3UO4kDnVzgLJrQRc3m5k+hHhwtU1FIXZO9K4zXZbn1yyxoNC3LbeOlu5kTaFrAzk7NpDwAj5TF1I2scShaLXpsy+6FN2+fgXq2+Dygj23+53P1GvhhuMZ4qpeQTc0fySRrZ0GqmmTf/HKW36BskeFBN/JLNiKXDBxHCazsIVBylt99sPyisUM22Gmlnc3+PdAvaFLvL89zSW4IXMBZbmEyMozEREVZy3SlghOZNJjQweBcjPFUkH8YQUFLqkgTbWWSHZA+jX+zqeRDnCcyJAGy1TjzWsRf81xdRVichZq0eji0Ye+gZEfaqmu1ZE2yHPRqYtBLqQVWUoXI/HFJ0itggLphm7h59TmvTlqeUlQXht1Jrq7Vu+NmDu6wy37SHbestvR+49iKk8Dzw2bgoI/mGoX5cj+Qik9VGSXQ7byn8DiyRyg3vmJzHAt9JlJ0/W7pSkPtR0nuOmJ4CUvyK6YIAUS1GBorYWgSa+geyL2kWaTiBbuUYLyitoTM8wEZo8WYhrRiNPbu6eREM0ucnKBCwoh7adbiCTRLH4FtBf54ofkeXrdr/kZQsPBDjqPPKqPxkiC98xb4QyRvydSz7uunajbNmkzKm1rQArufj6pPdJuDAn8fzOX4gV4eMGd5GPWKADpjxYU1H5AAj5MhewCjryTAXNgXmCM1xQjX1PbDRf3dnwhNqfhX9+Ics3/rlIegliVkjiXeOESHq5dD27z9OCOsczo0nAJG/1eMz9lm9ss287XiaBtFpf9JgbTVONq9uHVf2gYaaxY40FbX1nz89A3kzXEGZce0tmBaDUynTe/YMU+XbZXQV+AtDANp0XU2J7Ogr81Q7nKTNLYmxuiNpnLzMkXNnZNNYe0NVH0By42ukuNI22xMhBbDjm/c4JKbpbZzhMhlyCHP1xEJEx455Wxb7XaxjnWhg36D0/ReLce0PtKl7ZLfNTlal0K4yh2O51nftt01nz+eKYAAVtJvsoGTS8UO/he1RNZ6ZbzQ6/BIvjlKXZ96AC2ahA3pyyIM3ZlQHR2UPcpmszyaTV33wnL4ySpNIPeWZjcGExXETbNdG5u+ALC/y2Y4xcoiQJ9wcfik9Zz3eJrEGeZQvoatYmgex/PFA4jG6qg7FGnXQR3uJ/4tAMMup7pseCjmXMnKkSkxzTyInsMoFiAEMENnAJ+VSUlKD/w0dgLYGD+1Kl6YO8pBH/7ARyCPGms7E++PYeJ1CtR3q0DBMKbqChPLNdiib18PBGtRIqUq/PAEJwM39j3dZsOQNWwyLGyK1Sg1p7fsl97iHGHqaFNbXpsMKLx1QWHydW7BeTptjOdHaRLV+Sgal8M0NrLGTj2ZSNgGIQcH4jmHIzXJjMtBvsnzhO7krtLAv6V/kvu25GeLMxQ0a2CQl+VbE8t3G9q2JUMeVCZD5I4NDq+Z1jRPup2IaRYEi9ZvmRdwPHEipzLB97I4CPrjhwvL9Vn31NjRWFdsmYrq6JgGhNk+KBrTfICmhniVNfW/HNuXdRs5AsyD+hEmoiHv2saRo3gyy3ZRxfSc34OD6iOlT1gF/1fmUFiXr2mHNMWcMPZZjQa8nJh4O0/BagJe0276vI3PZ2XhV411QAtZ0+Q41dw1hpCP2lU/xLstzlALje6cyI3+/JN222txXHVLWzBaNDT4o39UOLGT2Yaax345k/5IcsIFwt5I/SYTkVMR919F3BNlyWkjThvZf23kKyWCfUhEmJeAEEolu2ZYeSgq2fKQk1Uy1j84gmxlyzsnvCo9q7QqevOBOWdKGGdUuggxKWeWAA4Hnw1n8+fDpRA0dJfWqKOEtvpJjFuxmzS8aBz2yhWHlGzf9MCZa2xkBlxeKaTD40cE7q5x42ufJx1Flyd7MqGLHKaYp06hlILQC3nyyCjOZtfLSfyhQUsTbQLgWA81zvFFvpbAG0vit4cKqgVSp98zzrCPlERvUJM8z06NZ1RkK5/aPsUPLj0tbOlnA/zink50SNoh6W8aSbunE93Tie7pRPd0ons60T2duJ/WBX46EYPU6nCqC+R0wPP7Ap4ukNMFcu5KkgvkdIGcLpDTBXK6QE6Ht10gp/ND/oqBnMDCU89PapWuLn0S/VcDd0PgFLV9VdT2giG4GwJ3Q+BuCNwNgbshcDcE+6qx8A1BoKa1YLX36kKcD147pOqQqkOqDqk6pOqQqkOqDql+J0g1i/z0dZycQ59pvUMzdMBmUypTM49c5spTN5eSbH71ZRwm3j9MzO/DVNJx8WMG9GfnLeOg7bcMbRuHOuu3Q0qvzmFcc6aGRXadPhzVzW1x/qU5lN0gy/ANMGxyKY+WzRDMK/P5hqbwkeqFfvkxZxuKo3OCKE5hu/T4bfkVMvOSOk/GUhopMclwtLUXyFRR+wusZwC34dWiSVx4/oIMFivFJRWzW716tgnXdW2wUjxA84IeoGFxEZ4sudbscFP54SLnAjZ9v14DtMM5VjDBOHnAy/VbdMfM2RNcYYUJPKhyFaBhyzmoZBcF2FcI1GZJfMdvOi+9JQf/cKjcE9RuIpFFeVw8lhzg9+YBeFilZeg3+9kaJAVF+QqOn3wXnUp2HGnQPBU1LZlNRYMjolf5KsCcTSTzExanOr7xUs56k4dlWDCRksgFoFTpIZ1lsPc70b30onUa38jo1MjCzUqoOaJakxl0B4KasGO2DOcoge5n2sWHZwJzi7yLTnKvnSp36JY2yMSeeVZPpvwMyjfs94MOBct+PzwQ5KCV8W/CVqsnBLdgzYzUh+g60LtPoNcFou/2Ptx3Yh/c4h20KAvoWVWGXXWmFH4k1xMfK8+v8SNpuyV/KfStPP2LafdIeGnqja8L84SNdpAJHuc4KZ/Piht2XKqF4GGQJwzcNQiYhmbGURsMzNHgJ/F3EWDROF83517MzYlae+AtnT9CLIokSkp8xKdmEwGHdC5eCLQ877RNuFRL/+0nRgstTA9l/71lCafNCaIfIbe9tnHj43WXEh2YYcxaWG9hnUP0nWDmJw8QGCXuJfucBn1aMD/7h5gAUMBF5nOSO3ePgcxOpvIUmJvzszsZvk8yfEcmJm/q48O6lHxLnP0ycK8FOrPZD2M2c0FmLshsV5JckJkLMnNBZi7IzAWZOZTvgsyqzNgFmbnXAt1rgT8k03rE1wILsyLNwLavAmJ126hhXgbc8Opfk6cDv+bLgIE/haH4+NyBss00+h01/CzM92/dxrJqpeETPva4zV32/brnBjezKRnCqEa1TgH3uzz+d7/2Dbz79U/b3a97qY6szFu8PHe/9gm5+2bvwd0/wnNujyMPtgQ9uwGWZnxqzXtV9+tennJSbc+kGjaVzeov/t5HcLQEekSbt45cFJWzme+pzXwvdDMXReWiqFwUlYuiclFULt5/fxHrJ0KtoGQvOWqgVeTVDmFN+prsarEqtKESxoGMLln5Ql2lOF/SPcS9/ezVQF/1sdcUXQkeMrfDWz2Uch2Uzi87uT8o/a4v6b8Z88hqQ5hGIUXECj0/AxLCuNOverJwO+llbxIeDbN35LjmWi9/mGiC+yLauuWixdPL7puzt8WDsBoL9gJYSlgM/b0pDMzdEj+reJreAcvuMIUdlKK3vrw7ssjuPfApxzr680WYPm0/+xKgCaG8CiBSLuOgQX9Yit4Tgi02SzzYzlN8H3GW8AOMve7F8utCq1gLMHiDZpp1jW0npnt+GnMgUk/dLMGiLQBZ3dpvvIf6WhO1hsUHfjOfAyyVOyrjY63nPd4dQcDKjW9ifDSzeaCHqtOh90GH/lq3umv39J97qXtcvdV18HKf4KWLIloRRXQLO0ZHm2xN4NsPF7JAF7lbWk5ClX42Zn2dJzT3xNTHKzmIvLm6jtMm2v/SdsmrbtgsnVnmT2RHmeJHm1du6zh3bfhoi49WmZ2f4OYYLPp/i0ipjaoxkddS5TinrBnYDnAoRdGph/FdmXjDemjDgf4XxIsy/tAWLbU5wj5dAdaNi+Wg/+4KfgW0Dv9f9cunCuK1gX1bDKHQUBOqRBZR0E6S8TWyiKPWRIY43tK7sFANuyjqlWsN5nHxpDvoCQG6yFI8jw7f86NdccGFH5HFjlBB/h4pBu2tDDQ31sKdu9RGwm27fPAbuYwoRqq7Rah/btTLCVVotUebAYX/yy9zzJyAfdHTtWvGIN7GKX3weFXJEXPFGfct/fJhofthiNFv5OYNUxz4KqXoTPSnlhNR0Uz1Q8iI1gYp1pkt1h2ZV2eDq8+ve3g4zI+f+5fv3lyeDQa9D2f66Hw+6fa7J72rf31+17/qXfT+++zUfOlf9k7O6r9/n21X+MOpxKg95FDiGvgVc0E2/Kjq69BjWOGFiLOUGKIdBVAghzqKh8QfC/ZSNEq+w2tp5rplJsO7EJ1Dmjw1rF2euxc9jP61gi9Y4iLDXuJ31g0YyoZzP8q+tJ6htaCF4ir0f0eGgP2znhZKqROBmKNljFl/U9SvfmKZdYzy3RjWClAUpYgk4BxD07fo5l8kmDDBbKXusVmGOeUelXlymjWD+bjJFH3on5inmPXTx1CK/cvp+eWHnPJzfaqxD90aKesqxmHT1Be0TxNYKenBJoxh5Mmx0OoYiRyoqn3eH+kZaEOaqnkOOsZbS7yMApVcUqkpSPo71MGTjBK12A9G4yjMSuBdIfBl9IgfMyZSX1Z41SwT9HrwhRbhnMzM2to7j30tZKChZjeaS+1YDLxQGqGxXW/T1jSPr6Prx9F3zTCTSzWd34MtxblxGLPMNMgws/PT8uVX5XOJc/cqG988zkkofM/E4LkYcbu6P1/rvKtwBr5pD+LvZudH7fP7hOWlYsjfHMQcnub3HUdCI5oqYBCHt08ZB478SV/CEoJWNtuJdAPNDDyYJxiXQtkcSuLhGCOhPLSN6s4MHy0EEFdlW4+XlkFGexnR0nVEFJNEYJEBncPB9ANm+VmSUKAM1uKGYSuOJOVxgO+a99P1Kax/QdbSTfJ/6ICXqTqhe49tTorJABbJO3H2elBBbNBoEzFw9gV2KMnDchvAEU0zDRnZcgMWJ8MtZxkdimuL7a0fj36JYvI/WFR1Q7/J1Gl0gVvqK5BV0RJexXG6KwvAuqwPEAdAkvP2jy2GIMeqqaFkbVQZXrLgeDCUMQHpA5Jc5SlPct27LbrzuYwmhdV32JHpuANU4H9tbnvIuwqIJJCQu8Gje47oBvAzR+fBCaSCoUfpwOCQYR0Pfg+mcIKRPixYNkvUaEVk1SkGUBrg0gJ7d/AfITWMke4waIOqHUZ3nYm8BZ4Ax5+NKjCmFjWq7Tvt6zQMtH3HS4yPR/MzcZlFNZFIsAyvuTXLHqZD+tYaczjHjM0ICyUTZw7DWoN23jjMd1SjQCIbwIYIMBSNa6mahD+/2PrQdy8vfn4hDt8k3q2fxpF9NqzxMFnHyyZOzru3Qq3d5fK0t/HitOwns5R5jkxUk0sDbra5Rah3YNeX8EtbIwdPVoI6e+sfkv9eHAWLmjivhqk4yt4YZJb91iM5HgnWrTJjrMR26+xIO7hP8EW2raqvcpjwH+gYYNpNn7cx00+GmSBKyqxnXD2XKtoqaWO9neKdGirtVZ3aEPKRs1i1QoxI5ptzaHRnAzP9OU/yxfwe2kaKZIuGBn/0j/IRi/dAt06kBf2yg99IMhAkQY3Uuzt0d4e+J5dT7lLcXYrv/6X4V7qgfggk9hIQQqnkhBoWPq5Y8ZGTVTzpHnx/tbLlnQ1xpWgPnU2HJNQj6sIljDMqKcZGFV4COH9/An8Uw9n8+dAY0vxCndWoo4S2AJ/jVuwmDWAdYp5hr1xxSE6Adi71MjIDLq8U0uGxc+PdNW587dJK5GdRboQ6NmCErFq5SkdXHdALaW0yirPZ9bJzITRo3Qg0AXADKmnMIoUeGXhjSfz2UEG1QOprAZPC7JGM+4Mao75tstcXHbad9y9Ux1hh+hrqmMvi6rK4NjYkuyyuDi7+6Vlc/3D5QFw+kE2UuHwgLh+IY91fNR9IhQ8bdzDOAPmN8+HVnHO5Lz06htx55MchM/IjUlasR3YsYzpe3CdeYMzp69gxegM0WHKyDld927bn1RsueUmVLfmLlTscz7O+nQim+fzxTJ303+eLo11wySTe7KbhggsXl2gVIvNViJ62lH4OrPVCr8MaIbWWdF3PeDesk2YrLCBomZhQHe0BDjJtlrvOrRR/1RskYwlip0Jj9OCm21uLy6qXJ1QWAV5Ai8Mnree8x0ELzmAQ6hq2iqF5jZRtQjRWx8sD0hzaTQVz3aGYcyUrHwdsAlSJxWEUg9qH7oBeAJ+VSX/yQMne9FaPO8pt6/jD0ot7LnPQD3Jj43LZfsf3VGuAb2WhXg8EJ7QVKZudcLp04jGVv8O0Di7XNRkW6d2rLnEOXO8TuHbXaPW0qS1fsBjQNcaCfPLLD1jI0PODInUXBg+gNGHhaWzfOpmhcQ1JYyNr7DwXiYRtELInIp5zOFKTjPOMWYcyv7SnS4TNlGP0g7lxyM8W33s0a2CQl+WLMbyp0dgA2rYlQ+7BJkPkjg0Or5nWNE/wlYhpFgSL1m+ZF7DzciKnMkGDnH4/78OFdQWleyr2B3HjNmf/JXdIfbRo43RMxZapqI6OaUAYWkSun+YDNDXEV0Wm/pdj2wtoI0fAx1V/hIloyLty5di2xdb8sezI596Ld1D8+4Di7r149168ey/evRffxK7j3ov/hp/wcu/FO23caeN/jTa+J5Y9917813gvvlALe68uxPngtXsTwqmT+6pO7gkndG9CuDch3JsQ7k0I9yZEYSnOIj8Fff4c+kzr7QXQAd+vU5l6R1Ioc+Wpm0tJ98L1ZZzSuE9KI74+YUfVBFkSOgjsILCDwA4COwjsILCDwA4CfycQ2AHTPQamv2QjypRLgZPfRci38935sZEmu1ZvHmJpZ3MOB+gX5OL7y/Pcl8cQuIizpHXzD9VCvIOOd9q9R6ngRCZNXE0H52KMp2KaX6mUr1j4ESyDtShxBv7NppLlP8NpvAefe+MG7M5qIa9FAtA4qVpoxZK6Gk0Obd412NK/1up62cG2xufQEoElZLOSKmSvj0uSXoE8q55GXLh59TmvTpo5zye6MOxOCvLxKyk9m93mwS77SXfcstrS+42v3U4Czw+bwe4+Jn9XmMHhA6WXoaoMMAnBegqPI0dm6rQL9ZvjWJh0ffgiR0tXGmpNhpIfiuElLMmvqKFceNFiaNLshAbX6x4oqqHZA3IXRVSDBuPzfEAmYc6YhrRiNPbu6eREM0ucaN+QqutLPwYcxh+BbaHniOZ7GMPyTXu89PNRFR4v7IQ4QXfkBoF465Lvwpzlr1uueNfMRFbCmg9IgMfJkB9mwBT2kZ/CvoDGEcmCFqGq7niaUvGv7sU5rGKScQ4qlXoJZZMm3jjEFEQvS27/jzPCOu8xwylg9H/F+BzA3ieA7QL9vmML4NI20FizwIG228uaj+W4CP0eyy+DHHBscRHg9DSnpzk9zelpTk9zeprT05ye5vQ0p6c5Pc3paU5Peyw97bvVkzarE45p7R3TapCkc/tHgWgGGOs2Q7NX+h1026hB49gYLdckqA0vqVdEHdlU1sYg1ReoSxv85pczZ5BxBhlnkHEGGWeQcQYZZ5BxBhlnkHEGGafbOIOMM8g4g4wzyDim9ScbZNCqYlsldOLBFoZUtQQ+D7STocZu0hhpNttgNhpyvq6R5n3k33oCI2FMHl4XPetMM3tqmtkLCOCiZ130rIueddGzLnrWRc/uK9xfip7twpn0E9F/NXDo1KFTh04dOnXo1KFTh04dOnXo1KHTvxqdXsTeyOFSh0sdLnW41OFSh0sdLnW41OFSh0v/ElxaKkL9FC+kTeBcnPDjZnVTnXMILNdKfeq4vGUqnoz66UGBpVXqhXN8qRdEXQxVjmFTpsi6GHUaKazS9/PJI9JwDi2KjJpcQQZ/nNSSoh6ZDoUOzFuRoR/Uq91c63s07/2h62aaAWsMvFmTHrl43bCX+6toLStLGi/kk8uz7lXv7Rso0v3Q7Z13X52fwc9nl5fvLs9O4afe2w/d897pQXWjwmZuD5g03MbLPrNJQq6wPFQt3eucZYsJOLLdoxsTdrzFGFDwAhLy+FFQkJ/nMpqhW/mLJ//752WvahJPfugliwZrbcuOYn4+l8705wNURA8MKlgi4dmTJzUUrPO6S+Str7QHldXQ09qGWLpcAVOrbYuc9Nf4amFYQahWVn8EB8DQ863PGycGtk6yMHDYKv2PusJqfC1Dr6Y0zRXoAgD2cNd+/J//mf/xJvHm1/f/+Z8f/1/n06fiD//roKZhwNVZWCdo8m/nhFn54TR7UM/qtlsWBOf4qOyK9zJUmo1gEld8hI0Nm6HS0/O6jQ2KUdO5443TT2JUzbZ5M1RrQwMJKla6ZUXc9hR5tFNtxJ6h/zuJuup81M28XePKS2ZyxasmW7pi7+ZGnSu/+SurtbRsDw92kuc2Z+PNbALK6mcojm/qngnUn94nNW9Cl9ly9fTSu7J15BphMfPT62x0oNkYyqqagJhqoRzsk9bdHnA/ayVunXg6uep9yAUO/Nvvvh+cndZ1oKWlOVSbsfpGDaMqhSpVjNrBB37pO/Ld+RzbgpJ6hh6dKpi2W3y1eZtTbO26N0QWz6H9fvBd6WA83gwurdoVdlTunZhMJBtZiL8KAcffwRJV9z9/ucJmTIdfY7PlcH4LDvdNnppETmsZIsDo0K99jDX/eLGGn4Lwul5lpcw/nwEeq2fVu0xv3T45o/X/eid5B0oZeKDWXzu5a4+mHs7XZA0/yo7Yj51Q5X/0wbA/RGIDKWvjX+op+rMAH1YayaCJLFixQL7dVz3O/fnFWhi5wsDIatUyHrS0IF9pa/bKzwvo0x+v+twDYpN5HHj1Jp7dVqGEoGFmT0enaVwWoLxDLqWax5GS/Ln4ekq2lZEslyIT4vHBiydP6FCU7C+vvIlAMyXqkgQ3Uy1sySjO0Zidfys2HrB6jD/Zlk0DyT9tStmyGrtbQzhLkjipUP68Svk7aJmNlFGs8wQAPfek4Y6zxE8XxFlfSS+BA5ehSveR7KihTK9joPwAtLcD0urh00HHozlTnT/4h97k/sDEWipqKUOV5MBcX3pzv01XlcUdZvXui76IvrbUixMsL7r9Hh16Q+YAZ5VnyCY2nyTs8UDbJmiPUSH4C//w2mykf9+lNHw/msZU3TyeyFRgt5sI1AHpShemN+zHtB3Kg7eHLJndU7f/p/iAZxMzKlA/T9s//9x+Yuw7oRcV9wv5nhU878s0/lFsyoNLCfsF4KAiI+FEgtIb5DZDrq5fjJ/6bB7FDzMf2KkYmmUdtgsDTSq/pHjz7NOJzVjn5A3x8UBvCCj90tTFPY7Xq/j5jz9GnpKgp97f45/hCCW840Dq6KC/qReoZeuuPZ5fjfUCr+Zk4o8L6pNVRN5I6KWwewBNORM8IJHYvHvrMs5LYWZHaHKlthR7ZoyDbCKNC0eiz6Q4HDLbHx61BaxIlkQKr8xlOE8XXD0v8hIGFgTDI+Hnl+IrZ58HlhOiSuP6hL/oC5Ht5vjwUrOqI8FcUTDTaTDVRqZFC5uWnFKzJ8hYi+YbBKdAG3/ujsdynloVKwy1xIvenF2hN1H55C+ddBsplomCvUglruIbGd3f5zSm+DsSeH///wGM+bcs -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the action identified by the given `actionId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-compute-env.api.mdx b/platform-api-docs/docs/describe-compute-env.api.mdx deleted file mode 100644 index 5c75ce066..000000000 --- a/platform-api-docs/docs/describe-compute-env.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-compute-env -title: "Describe compute environment" -description: "Retrieves the details of the compute environment identified by the given `computeEnvId`." -sidebar_label: "Describe compute environment" -hide_title: true -hide_table_of_contents: true -api: eJztXW1zGrmy/isqb906dpWBvJ2tU/l0MXZyuGsSrnGcOjeVCgIEnvW8sKMZ22zK//12t6QZDTPAgJ3dhOjDZg3opSW1Wk+3ultfDxI+kwevPx2Mo2CeJqIhwlt58Pn4YCLkOPbmiReFB68PLkQSe+JWSJZcCzYRCfd8yaIpfdRVGVT14igMRJgwbwL/elNPTNhoQaVm3q0I2VAXPgtvu5Nh8+D4IJqLmGM33Ql0dErdjkQnKwZF5jzmgUhEjJR+PQjhAxS1W4JCHtI558n1wTLxnQr6uD+/5mEaiNgb58TGSFAs/ki9WAA1SZyK4wM5vhYBP3j99SBZzLFjCXMRzg4eHo4zWu6i+EbO+VjkpPyRinhRouWjKciqOy915oWJmIkYfppGccAT9dWvrwrd8wRIGsEY5fre25OJh39yn2VV2C33U1zYiHnh2E8nAv5PKxYLOY9CKZoMlj+NQ8mGPh8JX74G4n1/yLwpiwIvScSkknQexxxp8BIRyPL8HR8ImAPkPdUqfKH/APa7b+CPjVse4xClVQp+TLzEF/nCAgf8Lw63bYYEc/PwGRdS0U99v3j2DP9XnI/3v0Gn4wimOEzwVz6f+96YuLH1u8QiX8vDika/i3GCbBkj7yae6iBnx81lvUkFOx3r1az4oUB1xe9znyfIHusmmd/JxognY9wf+PfYj1JkVin+gA1otn/W0vHBLIpmvmj43hR690Q4Ju7S32Yt/ZnG+aebf0m7BXFT+Di7KbSfzgofpZ/Ggf2FL6f2R+6D0Inzbz4/0NJNvdnm+cbteerFVdNT3p5sArt/nETxgqE4YdAbk/ARyjPcjXEgJh6HjYOtTv3ojk09X8gmLUQsLtJwQC1u7g22I+NMfQM7jidM3IsxbmOzBcNpw+dpOL42peaxB+TQXr2NbpCkd+I+ISpgyLBEwO5NNhCCferHgvFwwuaRTBpxGuom5OfD6ySZy9et1iQay6Za/6YXtczUKtZoqY5bfHLLYe0nv8DYGtBew7TX0O0dqZHDt08zdD6FOQYB7VcMjV3zW3Xg+ALFzt8xUusYqSHsVnBk9VZfnqUz68QCUejxkQ88AVWJEBLcOzZCdamVa8FtaTSKIl/wsLxgIBrxIPdk3giwITJptkzYFPs9GlG7WqI8UdMGY0DruNMe7GP6k5pNMyHHxY+F8wLFBczHle6mJFsrJ4vORikSsykr8A6NONTEdpal0uo9YE5ja5xYN1WICPvFI2mh+XypFMmdXXncENtQbTWwLcXfEw+JDLyQg9DbPIq+7odhMVaozA5j4IhGFPqLY5rAEZcACGFghjj41oftAS0dKejFJ++htIJeD1XE6G20eKeQT/H344MA5guphJJBxEeNwsmo2aAHPxQnGioub1eQP++nBDef6GjJFu+ueMZEmqn8VILc+4dk8poDW9PiMrmAL4Mm68GPbIRSjvGRjHxkPzqcUOyNoThiSA6QPMCCJCRp6u9ikEeMj1F6ugPqJzmg9kQOqZK19tZptpvurkVsHRswN/KJdg/rZtrOMWjAU576CZ0MQy0ChkR1KkX8rtbh/gFK4klFAHMw+DfOZqiEITb7735HHahhNNEnNax2vab/DSWpaWi522d8MgFdiPT1cqvzKLa3Q7W++fJFqQ+kGOs22amajNds+OLFMMMUoJLVQSeX1wrRGGPCH1htSSiyFI8NmBMtagrIQG1LaMxGHTt0Xtkx9Hl37UGXc28ufC9UAISBgGYyHWndl3WAsYC9olsRx94EuMnYPLJahe1EhAb8nogceH+KXaYfSYc2vCAN0JQwAmJhEERdvj2BLkWmwVNqkBJqgTYViiiVuKnzBXz+7Fm+gv8Tjd5Td5XK+0oZonuMVFXi7tUoEQ9TPgNt6t+rOlyFGmE7kn2GDYu0Dml1YDcrmeUpzrEpaGRLVwErDUhoj2CkfJy8hRXVghQNLsXDf0uoZLCLwpMIfAp4UktTS+ddwkNO99gr3QOtVA/HlmHGwqjtjwN2gl9uBKrFtUVDBZ+JSypUtToAHcaw3SYZS6Gki9FuWa/4LRyfgZA1uG+F+erg7GTAdCs41UGUAnMcKnEHIqiFx1wLj+fXLTTNcZCfMX0e7qSfPH7TxWJWaXgr8RKsmSqrYQgculEaA3pgdx6gRTgiAGzgbLJD0Zw1QXSlsiE4YLjnemzbHV82k6jRKPmOIheQT4joWzMtVEW+CLduOW/x9KL99uxdZvUyKL7rw1LCYujf6+JAmc4RPYjJFxlNkzuQ2S1FYQuP0VtP3B1ZZHdDmSBeXM3XBQ7rvAD1Q9VQamkV/dkiTJ83X9z7PJ6J4irAmXIR+TX6w1KsffEOWWwWc2DnKTBtA/6E/01Yt91jwIKBJyWdiFBqlWwBCW/gTL2use3YdI+jPOsMWMLlzRIu2gKRVa39alGrD99vNVFrZLzv9fG2Z7OBApG+bgrH1jnvKu7wfaXdZGYdLWyo+ZV6vVOifwolWvN1Z57KXeD5uwySd/ofJI4zonN0PU/rTnsiAF22N9qlY1XXdIjsvXL/HiP/BWLGR4tE3184fLlP+BKkGGyksxA/1pkHVZJ9+qi2nxaHqzcYtn5kq49TULuEUiCnKcrwF9t3/oYq2ubPlf2rPo7wfprmS7IlylfQFt4CxwwUUt6awHdXPZGjC423LRLK9CtrVjR7G0fpfDNPd1BafaQD+DyaSTgooRrt4mxgDFqT+2TrUys5CPlcXkdJHfV/iV2yqhuYpTVLvYloSVP8aPPKwYBmouw7oCDSG/xxaQa15aPJPlll6s6Z7YfTylTDX+jfBpHSsIoY4XfEeJpEcC5oD52yZlBwfglJlGl8VyTeiB5iOND//GhRxB/apCWbG3XRZAVYNx4Jg/77S/gIaB3+XfWh5IrUtYF9kw2h0FATKlka0g19nEJpZI8obExEgOO1dQJYmiF2kdcr1hrMoyQvzA5h3AJ3n0wUt4K6sysu6HkhmewIFcB03XrIczDdG+4WA36/c5faSrhtl7N5urVwfNv/YM0yIYqRbANrDsbcr3NeZla9jFCJZnu0GSCHN8T9HFaT+pp4oOWsGQN7B6uIP3C1qnce6AEr9rhn6ZePsW10oiDgDSnQYw3Rnu/JBEEgwrE7UeRCYmA1SYTWBgnWmS3WbZmTs8Hllzdd3Bzmzy/9i/dvL84Gg+7Vmd46XzrtfrvTvfzPl/f9y26v+39np+aX/kW3c1b9+4/Zdkk+nKKjYIASil2DvFJSUBl+ZFEK4FE3hhVesChNSCBmOnMBOVRRPCT5mIuXvFH8NFxLs6pbFDKKCwOAEqsscQU2SwF3BKzd67LuKQ4jlUpPVycuCuwleWddgeHZcO6F6X3jBVoLGnhcBd6fKBCwf6WnBUIksrC1jDHrH5L6lXMx9qbaWa54OYa1fDyKEkQSsI+h6VtAY3Q2qluedsD/hE/F7rFZBXOKPYJ4lnQFpDSD+bjOFF31Ozg32F4oEtTmoRQ1INMRfPOYXX6udzX2oVsjZV1GOGya+pz2aQwrJTgwYQQjj4+ZVsfoyIGqiibgu9hLFgQRn4I006BGj91TonAi0N6CKrmgUlM46e9QB49TcnPBlUeQGUc+jcKsBF4WglzmU1hwhYnkfQ/ttpvX4c3gnhbhnMzM2to7jzx9yEBD9a40l9qxBHiuNEJju16nrWleQpN4zrw9MebneSTF+/AUZMqSR+bGU22CdRQ8s4zD1yKsdqKWuoLifDF+8ZtY9HmdG3FcvRuBHoxenF0wW34gdCCdpOObp9kJPFcrBi/ZSLWr+/O0zrsKZwBCOIHj72bXpcvvE5aXSkH++iDm8DS77zhiGtGUAQM7vH2ucODIm/QFLCFoZbOdSDfQzMCDeeyN6TKaF4+HY8ZhNtE2qjszcjQ/gFRVZevhSRFkNJcRLV1HhBGdCOrIgM5hY3q+EvlpHCP/SaylGgZWHAnE//i7lv10fwrrn5O1dJX8X0rdFlPZoXuPbXaKuimRILzv2NmbQQmxQaN1joGze+BQOg+LbYBENM3UFGTLDViSDFnOMjrk1xbbWz+e/BKF6TIWVe3AqzN1Gl0gS30DskpawkkUJbuKAKyr9AGSAEhy1v6xJRDEWNY1lGiIVVSOjSkVL1lwPLD+WWiKclIZLXLdu8na87kIJ7nVd9gSybgFVOB/TdX2UHEVEEkgwXiekH8Oa/vwN7IvWRCpYMAXeHbAJsM6HD77U9jBSB8WLJolKrQisurkAygMcGmB+R38R0gNaA1aCrRB1ZZCd62JuAWZANtfGVVgTA1qVNt3mtdJ4Gv7Do+Nk0f9PXGRhmX7K3rovFGtWfYwiWw1Xm+GI2ReEIS5kokzF8CM+82scZjvsEKBRDGADRFgyBvXp2oc/Ppq603fvuj9+oodvo35rZdEob03rPEoso6XTZzHippqtXaXy9PuxovToqMMsVrmIaOsZZMLA262uUXIQUTfsiPpS/jleDQDnsyNOmw8m/Vzz+OjskldX+jnl3zH5a/QM0PHuqhIGcs54y19z8hQu6V/xl/uvODuKvf/rnLdXfWeXBC4i0l3Mbn/F5PArsi4ddB54QzS9YxSU9dhrdCG9lyzPNNQqYu5b3zTAPvVYPxCm1iFYFMWUbyqjwaHXla62GPdqReDrkkt6tYohnskEm8Mwgot7dqURlCwPR6jgnYWcM/fTPVAVUKLBal1AqsR+EGfJGXHUGdcwV67FbDqcbTMalxlpiB83sA2JjyekBNgYQq4mYQlbzbbHFrbZgyqnDYaKDMv2QKVaiGYDsKHTxZWxkNHO0oBwDKqXKYEXfWa7NOHEUxXys4vB/lmINneVOCJFActR2iXtKh32YpkQ6cR+CWlNr7AWh8xzT7zdORjbDyV1e72WqdsIsLDi6aGUFvYVvU4qKpCzNm54DEN7qq3hq4JFG34umjjNrAJ/AVj1b5oszUQhh/1zJEe0Plw2l6aIVgWfQuLHAnSVSE2JPm9MXIfw6GJUqIR3eEV3FhpmXqcxkuU38K8kNAhDW+aJil5kwKpUjxa0Sjy8NPc8kGF5BT0b1Tg3+7kt4Q1DYOOMnXe8JpJ4XAWzrwwd79osuF8km2gYbYxcBelobJ2F/bRP5+xtyfGWmhvo79RbVGi8gnVFhWTX9Ja2vj1j6G07O58uRn3OzDpwORPASY3aX5bAxglQK56yshqEMxAS98vpy/kl9uXGiyugqD0kxKCNd3hVK+mkuUNd9UzLnB0vVvrUtiLkxTAoq6St6qBs0xHWfFaJnKiza5lWgp4CEf6pEuhpcmiTmMYD9rgUnozRAa6AZ0eKFmUaF3qoeN78EedfnrLLY+pqrH1A4S5xh/GeayiH80+WgmONvZwHs1YG87DBbQiWZYbyfQQRKGn8qmY1i9xU9S7B9Z2+SQTpIiRCh0qyydPeCfydXKBs3BCFzWbmz+FerC1TEUmdE3lXWG8LoutX6R+rWlZbhsv3c2cQNMMODsxk/IIPFI8pm5EhUPR6qPHtuz2+Lx5BurZ4suAfmyq/30pXwM/DtcYT/UCsqn4kkyydg6hskn27W9n2Q3KFhkedCO/pSNyycBxFMDKHgIlZ/ndB8svGjtEDU4rcLby74F+QZP6cHGeneSGwAXs5Qam8sJITFSU9Zkupd8RcY0JHQzO2Rh3BfmHERS0ThVhoq1MsgPSp/E7m0q1idUBjxng8ADZapxZLZKvWa6uPCzOQk1aPRzasHdQsCNt1bVcsiZZDnoVMeiF1AIrqUJk/rQk6RUwQN2ITWRevc/Lk2b2c0cXBu4kV9fy3XE9B3fgsl90xw2rLc1vKrai43MvqAcO+miukZjN74pUfKqqUALdznOJ21F5hKrGVzDHMdN7IkHX74auNNR+lOSuw4YXsCQfMUUIIKrF0FgJA5NYQ/dA7iX1IhV7yqUE4xW1JWSeDcgYLcY0pBWjsbmnlRGtROKkgwqJQtxLsxZNoFn6EcSW740XWu7hdbuWbwQFcz/kKPwiUxovHaR3fIF/hOKWTD3rfv18XJqEilyPm1rQB3Y/G1Wf6DYbBb4fzMX4kV4eMGdZGPWKADpjxYU1H9ABHsVD5QGMvpIAc4EvoHFMJQEg0vbDRf3dmzBNKftPu3cOqxinY7L1gVoWkzmWZOMQHa5eD23z9tOMsMrp0EgKGP3fMT5nm9kv28y3iqOtFZX+FwXSluNo9+LWfYkNNNbMcaCtrq358fN3kDfHGZSd0NpCaNUwnda9Y8c8XbZVQl+BNzAMpEHX2SqZBf1aD+UuN0ljq2OM3mgqN3mzK+6cbAorb6CqC1hudKUcR9pmYyK0FOz4zg0umVlqO0eI7Aw5VPN1RIeJGjnlbFvtdrFOdKGDfo3d9EEux7Q+0aXtkt81OVoXQriKHY7nad+23dWfPzVTAAGyxdE2cHKp2MH/opLISq+MV3odnsg3R8rrUw7Qok7YkL4swtCdCdXRQdmjdDbLotnkdTcohp+s0gQyb2nlxmCiglTTyq6NTfcA7O/CDKdYmfnoE84OnzVeKh5P4ijFHMrXwCqG5nE0XzyCaKyOukOedh3U4X7s3QIwbKtUlzU3xVxVsnJkAhOglZodhhGDQwAzdPrwszQpSekJgtpOABvjp1bFC6uOMtCHf6gtkEWNNZ2J9+cw8ToF6odVoGAYU3mJieVqsOi7NwOmtCiWUBX18IRKBm7se7rNmiFr2GSQ2xTLUWpOb9kvvcU5wlTRJre8NhlQeOuCwuSr3IKzdNoYz4+nSVjlo2hcDpPInDV26slYABsEKjgQ9zlsqUlqXA4yJs8SupO7Sg3/ln4n823J9pbKUFCvgUFWVt2aWL7b0LZ9MmRBZSJA6Vhj85ppTbKk2zGbpr6/aPyRcl/FE8diKmJ8akgFQX+66lmuz7qn2o7GumLDVJRHxzQgzPZB0ZjmB2hqiFdZU+/+2L6s2ygRYB7kzzARNWXXNo4c+RNUtosqpuf8ERxUnyh9wir4vzKHwrp8TTukKVYJY19UaMDLiYm38xQsJ+A17SYvm/h8Vhp801gHtJDVTY5Tzl1jCPmkXfUDvNtSGWqh0Z0TudHXv2i3vYaKq25oC0aDhgZfeke5EzuZbah57Fdl0h8JlXCBsDdSv8lE5FTE/VcR90RZctqI00b2Xxv5RolgHxMRxmM4hBKhXDOsPBSlbHkoyUoZ6x8dQbay5Z0TXhWeVVoVvfnInDMFjDMqXISYlDNLAEcFnw1n85fDpRA0dJfWqKOAtvpxhKzYjmteNA67xYpDSrZvelCZa2xkBlJeSqSDq0cE7q6R8bXPk46iy5I9mdBFFaaYpU6hlILQC3nyiDBKZ9fLSfyhQUsTrQPglB5qnOPzfC0+HwuSt4cSqvlCp98zzrBPlERvUJE8z06NZ1RkK5/aPsUPLr3Ea+lnA/zFPZ3okLRD0t81knZPJ7qnE93Tie7pRPd0ons6cT+tC+rpRAxSq8KpLpDTAc8fC3i6QE4XyLkrSS6Q0wVyukBOF8jpAjkd3naBnM4P+RsGcoIIT7gXVypdbfqJ9U8G7obAKWr7qqjthUBwNwTuhsDdELgbAndD4G4I9lVjUTcEvpxWgtXuSY+dD944pOqQqkOqDqk6pOqQqkOqDqn+IEg1Db3kTRSfQ59JtUMzdKDMplSmYh5VmUsuby4E2fyqyzhMvH+YWL0PU0rHpR4zoK+dt4yDtt8ztK0d6qzfDim8Oodxzakc5tl1+rBVN7el8i/NoeyGswzfAMMml/Jo2QLBvDKfMTSFj5Qv9IuPOdtQHJ0TWL4Lm4XHb4uvkJmX1NVkLKWRYpMUR1t5gUwVtb/AegFwG1wu6sSFZy/IYLFCXFI+u+WrZ5twXdcGK/kDNK/oARp1XASdJdeaHW4qr3qZFLDp+3gN0A7nWMIE4+SBLNdv0R0ryR7jCktM4EGVywANW85ApXJRAL5CoDaLozv1pvPSW3LwPxUq9wy1m5ClYRYXjyUH+Hv9ADys0jD0G362BklBUZ6E7Sfeh6dCOY7UaJ6KmpYMU9HgiOhVvgowZxOh5Ik6TnV844WYdSePy7BgIiVRCkCpwkM6y2DvT6J76UXrJLoR4ak5CzcroWaLak1m0B4wasKO2TKSowC6X2gXHzUTmFvkfdjJvHbK0qFdYJCJPfNKPZmqZ1C+Y78fdChY9vtRA0EJWhr/Jmy1ekKQBStmpDpE14HefQK9LhB9t/fhfhD74BbvoIWpT8+qKthVZUpRj+Ry9qn0/Jp6JG235C+5vpWlfzHtHjGeJHx8nZsnbLSDQvA4w0nZfJbcsKNCLQQPgyxh4K5BwDQ0M47KYGAVDd6JfogAi9r5ulXuxcycqLUHxdLZI8QsT6Ik2Sd8ajZmsEnn7BVDy/NObKJKNfR3vyi00MD0UPb3Detw2pwg+gly22sbNz5edyHQgRnGrA/rLaxziL5jzPzEAYFR4l6yz2nQpw/mF/9iEwAKuMhqn2TO3WMgs5XKLAXm5vzs7gzfpzN8RyEmbqrjw9qUfIud/TZwrwU6s9lPYzZzQWYuyGxXklyQmQsyc0FmLsjMBZk5lO+CzMrC2AWZudcC3WuBP6XQesLXAnOzIs3Atq8CYnXbqGFeBtzw6l+dpwO/5cuAvjeFoXj43IG0zTT6HTX8mZnfv3cby6qVhp/wscdt7rIf1j03uFlMiQBGNap0CnjY5fG/h7Vv4D2sf9ruYd1LdWRl3uLluYe1T8g91HsP7uEJnnN7mvNgS9CzG2CpJ6fWvFf1sO7lKXeq7dmphk2ls+qLvw8hbC2GHtHmrSMXReVs5ntqM98L3cxFUbkoKhdF5aKoXBSVi/ffX8T6mVArKNlLjhpoFTnZIaxJX5NdLlaFNpTCOFDQxStfqCsVV5d0j3FvPzsZ6Ks+5TVFV4KHStrhrR6eci08nV+3Mn9Q+qwv6b8b88hqQ5hGIXnECj0/AyeEcadf9WThdqeXzSRqNEq8o8Q113rZw0QT5Itw65bzFk8v2m/P3uUPwmos2PVhKWEx9O91YWDmlvhFRtPkDkR2S1HYwlP01hN3RxbZ3Uc+5VhFf7YI0+fNF/c+mhCKqwBHykXk1+gPS9F7QsBis5gDO0/xfcRZrB5g7LZ7y68LrRItIOANmqnXNbYdm+7V05gDlnB5swSLtgBkVWu/8R7qW03UGhHve/V8DrBU5qiMj7WedxV3+L5SbjwT46OFzSM9VJ0OvQ869Le61V3L03/tpe5x+VbXwct9gpcuimhFFNEtcIyONtmawHdXPZGji8wtLSOhTL8yZn2bJzT3xNSnVnIQ8rm8jpI62v8Su2RVNzBLa5Z6E9GSpvjR5pXbOs5dGz6a7JNVZucnuFUMFv3bIFIqo2pM5LWQGc4paga2AxyeoujUo/BdkXgjeojhQP/zo0URf2iLltwcYZ+sAOvGxXLQf38JHwGtw7+rPnwuIV4b2DfZEAoNNaGSpSEF7cSpukZmUdiYiADHW3gXFqphF3m9Yq3BPMqfdAc9wUcXWYrn0eF7XrgrLuh5IVnsCBVk75Fi0N7KQHNjLdy5S20k3LbLR7+RqxDFSLa3CPXPjHoZoRKt9mgzoPB/cT/HzAnYFz1du2YM7F2U0A9crSo5Yq7Y456lXz4udD8IMPqN3Lxhin1PJhSdif7UYsJKmql+CBnR2iDBOrPFui1zcja4/PKmi5vD/Pmlf/H+7cXZYNC9OtNb50un3W93upf/+fK+f9ntdf/v7NT80r/ods6qf/8x2y7Jh1OBUXsoodg1yCslBZXhR5Zfhx7DCi9YlCYkEO0ogBw5VFE8JPmYi5e8UfIdXkuzqlsUMooL0TmkzlPD2uW53eti9K8VfKFOXBTYS/LOugHDs+HcC9P7xgu0FjTwuAq8P1EgYP9KTwuE0IlAzNYyxqx/SOpXP7GsdIzi3RjW8vEoShBJwD6Gpm/RzT9PMGGC2QrdY7MK5hR7lObJaaUZzMd1puiq3zFPMeunj6GU8i+n55cfs8vP9a7GPnRrpKzLCIdNU5/TPo1hpQQHJoxg5PEx0+oYHTlQVfu8P9Ez0IY0WfEcdIS3lngZBSq5oFJTOOnvUAePU0rUYj8YjaMwK4F3hSCX0SN+rDCRvF/hVbNM0JvBPS3COZmZtbV3Hnn6kIGG6t1oLrVjCfBcaYTGdr1NW9M8vo6uH0ffNcNMdqrp/B7KUpwZhzHLTI0MMzs/LV98VT47ce5O0vHN0+yE3PeMDV6ykWpX9+dpnXcVzsA37eH4u9n5UfvsPmF5qRTkrw9iDk+z+44jphFNGTCww9vnCgeOvElfwBKCVjbbiXQDzQw8mMcYl0LZHArHwzFGQnG0jerOjBzNDyBVVdl6eFIEGc1lREvXEWFEJ4I6MqBz2Jier0R+GscUKIO1VMPAiiNBeRzgdy376foU1j8na+km+b90wMtUdujeY5udYjKAheKOnb0ZlBAbNFrnGDi7Bw6l87DYBkhE00xNQbbcgCXJkOUso0N+bbG99ePJL1FM/geLqnbg1Zk6jS6Qpb4BWSUt4SSKkl1FANZV+gBJACQ5a//YEghiLOsaStZGleElC44HQxljOH3gJJdZypNM926y9nwuwklu9R22RDJuARX4X1O1PVRcBUQSSMjc4NE9h7V9+FtF58EOpIIBp3RgsMmwDofP/hR2MNKHBYtmiQqtiKw6+QAKA1xaYH4H/xFSwxjplgJtULWl0F1rIm5BJsD2V0YVGFODGtX2neZ1EvjavsNj4+NRf09cpGFFJBIswxvVmmUP0yF9a405KseMLQhzJRNnDsNa/WbWOMx3WKFAohjAhggw5I3rUzUOfn219aZvX/R+fcUO38b81kui0N4b1ngUWcfLJk6Vd2+FWrvL5Wl348Vp0U9mKfMcmagmFwbcbHOLUO3Ari/hl1gjA09Wgjqb9Q/Jfy8K/UVFnFfNVBxFbwwyy37vkRxPBOtWmTFWYrt1dqQd3CfURbatqq9ymPAe6Rhg2k1eNjHTT4qZIArKLDeunksVbZW0tt5O8U41lfayTm0I+aSyWDUCjEhWN+fQ6M4GZvo6S/Kl5D20jRSJBg0NvvSOshGzD0C3TqQF/SoHv5FQQJAOaqTe3aG7O/Q9uZxyl+LuUnz/L8W/0QX1YyAxj+EQSoRKqGHh45IVHyVZyZPu0fdXK1ve2RBXiPbQ2XTohHpCXbiAcUYFxdiowksA55/P4Es2nM1fDo0hzcvVWY06CmgL8DmyYjuuAesQ8wy7xYpDcgK0c6kXkRlIeSmRDq6cG++ukfG1SyuRn4aZEerYgBGyamUqHV11QC+ktYkwSmfXy86F0KB1I1AHwA2opDGL5Hqkz8eC5O2hhGq+0NcCJoXZExn3BxVGfdtkry86bDvv36iOKYXpW6hjLoury+Ja25Dssrg6uPiXZ3H96vKBuHwgmyhx+UBcPhAnur9pPpCSHDbuYCoD5Hcuh1dLzuW+9OgU5M4iPw6VID8iZcV6ZMcypuPFfcx9Y05fJ47RG6DGkpN1uOzbtr2s3nDJS6pswV+s2OF4nvbtRDD150/NVKf/IVsc7YJLJvF6Nw09VTi/RCsRma1C+Lwh9XNgjVd6HdYcUmtJ1/WMd8O602yFBQQtExOqoz3A4UybZa5zK4+/8g2SsQQpp0Jj9FBNN7c+LstenlCZ+XgBzQ6fNV4qHgctOIVByGtgFUPzmlO2DtFYHS8PSHNo1j2YqzbFXFWy8nEAE6BKzA7DCNQ+dAfkPvwsTfqTR57sdW/1VEeZbR3/WHpxz2UO+klubFwu2x/4nmoN8C0t1JsBUwltWaLMTjhdOvGYzN5hWgeXq5oM8vTuZZc4B673CVy7a7Rq2uSWL1gM6BpjQT75xQcsRMA9P0/dhcEDeJqow9PYvnUyQ+MakkTmrLHzXMQC2CBQnoi4z2FLTVKVZ8zalNmlPV0ibKYcox/MjUO2t9S9R70GBllZdTGGNzUaG0Db9smQebCJAKVjjc1rpjXJEnzFbJr6/qLxR8p95bwci6mI0SCn38+76llXULqnnD9IGjdV9l9yh9RbixinZSo2TEV5dEwDwtAicv00P0BTQ3xVZOrdH9teQBslAj6u+jNMRE3ZlSnHti224suiI597L95B8R8Dirv34t178e69ePdefB27jnsv/jt+wsu9F++0caeN/z3a+J5Y9tx78d/ivfhcLeye9Nj54I17E8Kpk/uqTu6JJHRvQrg3IdybEO5NCPcmRG4pTkMvAX3+HPpMqu0F0IG6X6cy1Y6kUOaSy5sLQffC1WWc0rhPSiO+PmFH1fhpHDgI7CCwg8AOAjsI7CCwg8AOAv8gENgB0z0Gpr+lI8qUS4GTP0TIt/Pd+bmRpnKt3jzEAmerHA7QL5yLHy7OM18eQ+AiSuPGzb9kA/EOOt5p9x4p/Y6I67iaDs7ZGHfFNLtSKV6xqEewDNaixBn4nU2lOv8VnMZ78Dkf1xB3VgtZLToAjZOqhVasU1ejyaEtuwZb+tdaXS872Fb4HFpHYAHZrKQKxevTkqRXIMuqpxEXMq/e5+VJM/u5owsDd1KQj1dK6VnvNg+47BfdccNqS/Obunbr+NwL6sHuPiZ/l5jB4YrSy1BVBTAJwXKJ21FFZuq0C9XMccxMuj58kaOhKw21JkPJD9nwApbkI2ooPR4uhibNTmBwve6BohrqPSDXy6MaNBifZwMyCXPGNKQVo7G5p5URrUTiRPuGlF1f+hHgMPUjiC30HNFyD2NYvmuPl342qtzjRTkhTtAduUYg3rrkuzBn2euWK941M5GVsOYDOsCjeKgeZsAU9qGXAF9A44hkQYuQZXc8TSn7T7t3DqsYpyoHlUx4TNmkSTYOMQXR64Lb/9OMsMp7zEgKGP3fMT4HsPcJYLtAvx/YArjEBhpr5jjQdntZ82MxLkK/x/LbIAMcW1wEOD3N6WlOT3N6mtPTnJ7m9DSnpzk9zelpTk9zeprT055KT/th9aTN6oQTWnsntGok6dz+USCaAYV166HZS/0Oum3UoHFsjJarE9SGl9Qroo5sKitjkKoLVKUNfvvbmTPIOIOMM8g4g4wzyDiDjDPIOIOMM8g4g4zTbZxBxhlknEHGGWSc0PqLDTJoVbGtEjrxYANDqhoMnwfayVBjN2mMNJttMBsNOd/WSPMh9G45w0gYk4fXRc8608yemmb2AgK46FkXPeuiZ130rIueddGz+wr3l6Jn27AnvZj1TwYOnTp06tCpQ6cOnTp06tCpQ6cOnTp0+nej017ERw6XOlzqcKnDpQ6XOlzqcKnDpQ6XOlz6t+DSQhHqJ38hbQL7oqMeN6ua6kxCYLlG4ikPBp/L5MN8skMluU0N/axctYeETHiSVkqNIkfnzrCdi7P2ZffdWyjSvmp3z9sn52fw99nFxfuLs1P4q/vuqn3ePT0ozxfMaXOgOkS5Cgcdn1WwJgkbL+DxoppmCwdUvXL0UHoRaUWpKJ4VfqmW6L++OtAuVeRfX7uGz0fCr/Nw34q979XtqFpIrN75tCvUA4DV8+tJfcys/HkBfXrjVT93gdh4Hvl8JdftsF0sgX+OM3s6Ok0i3JlVXHYh5BwOGKGK5CVOSaKMRLkk7fHjg1fPnpU9xk84PoIMB7LEVcKIEi3U6dRS7pKt36Xyj5LjaxFw/MsWPYbXP2+KqVq9KaxhnMVxFJcof1mm/D20rPSCMNKO/EDPAzlWj1PAzAvSm08EHMRxO0Wv/U8k6AKRXEdA+cFMEI3k0H9QjGb4Os5msTt5yLwiJTWZxj5UMIoGn3tN9TB0pm2UUSr9wvr6TGUdLM/a/e4BEmToHeD0qqmyqc5mC3tEUqgYMh0Vgm/UH28MZ/1+l9A8eOE0ourmmQNFBXa7iUDtOi51YXptbkx8URy8PWR6tZ027zT67/wH3KwY+0D9PG/++mvzmVGEQZTlSCBj4Cpf9mWCv+asenAhgIvErVCvsU5EAmRIA+QrnyMl0Unvf2uEPPNuAS4P7UUfWu/iJnAGowbp0QanGfiq+ebTgc03UOW13QjuCdSXsNzXryMuxYfYf3jAr2HLxYpDAb5pLz56vm/NSD8aQY1YW8TeOB9KvJLcGwHdFGR8Jj0PCEzW79+C1zyBSR/hzFJbUtlaQGGZCGOUifUmxqcLkzQGED5U58Zrhk/1DZmXqbIbiM86kwXaP+MHDWO2m8hD/Zji5Ih1KhiE+/NrvsUUm0MwXNj0GeoLDIE2QAKcGOsHNKsibVDu54lVuSR9C4Lr7dnlAb0LbEuHJWlgGw2LhAEjUolLfLb24SGjk56xRQIfHv4fpdmXUg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the compute environment identified by the given `computeEnvId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-credentials.api.mdx b/platform-api-docs/docs/describe-credentials.api.mdx deleted file mode 100644 index 27c3b324a..000000000 --- a/platform-api-docs/docs/describe-credentials.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-credentials -title: "Describe credentials" -description: "Retrieves the details of the credentials identified by the given `credentialsId`." -sidebar_label: "Describe credentials" -hide_title: true -hide_table_of_contents: true -api: eJztWt1v2kgQ/1esfbqTSEiTKqp4OkJzaZSqqaDVPUTRdbEHs8F43d01lCL+95tZ2+AvAlHCKSR5ScA7O/Obz501M2eG+5q1bpirwIPQCB5odttgHmhXicgIGbIW64JRAiagHTMExwPDRaAdObBfczsdYT8NBHhOf2ZXfTGB0PmRI7r0fhyyBpMRKE78Lz2U8NHK60MnB6PBIq74GAwogjhnIX5B2gIvpBIEMeJmyMq4c9wcjSqE/gqhQmoFP2OBNKxlVAwNpt0hjDlrzZmZRSQq2cQWi8ZS+lSqkY64CyvZP2NQs4rwfzJCJ4zHoIRblF2RJUIDvl0aSDXmJnl0+h6l3xJUHclQg6Ydx0dH9K8o7/oKt7oSuYSGVnkUBcK1Jm7eaSKZV4XK/h24hkytyCFGJALy0YBfV3a6Scxg6Seoj6JguZ+X8OjvmP/6DKGPTmodHzfK9m2k1i3QvTs6qiEsKF1xVA5YidlpmVeDATqGVOJTCjb+O1aQ/f8XtVccv/lS+gE99oUZxv3kQ8DpQ1+YfuyOgFTWmqJv9EGnPuAiBHWggMSY6QH3ySm05IErx2NhEkbAM4EKIkmbNfzEvECaKDZLNAduIGMKN33CblHHPtfwXQVlu5K9MA8wXygeWI3xMBzAlxis5Z21hg4w9byckftSBsBDmzjcuw6DWZI4SBxwbb7rAvXSzMtw9lD6gRE2fiocaBHzlZvHMLEwIu9xTEYw05tTxBMUh2MRciNVnbASX1KxvCXlOPuSlJbiegM9FEXEixL35OkRYXC5Lmh9BbPaTNKAZcDUrjbYVGH0FphRBe6ZWQBty/U85P2gNnzIFAaTiJ71TnrgxshrdkVWXyzzbAfaxhoTIy0z1bLBtcbSXhs2ZV1z+C+E+RT3yzrkMnpP9GgT4i4hrtUlLYc1yvAguB7Y0/mp1exz4w6/rNNTIxusqmvX7e6tYzfltiV92W4lk80frToe4Tw0lzVOpBoeCNiw2LOZu5Uq1FsUlDknT2fOLx5lO4rltT58SCwTb1/gcl0tyzmsk2nUTckzVZen9A60RDOGyCltdms0pabyo6hhRrE55GpjHW37idsLqUvtyC60oc0Dai3XuE2JCa5tnXxGjqCml7s3764+VAoVtWA70Pah2lDQRkOFHdoDVer1PlXOwqT53IFW2ADV3HPuP+osmDLEVRO8A5RbR8ZuDsUzYc6sbjU9Cmxxi3oeR/sFga0kS+Ga8b+e60/adKJJ8HLdxYLYVnX3wXyJnJZLxmMP6sLh2bMW7SQWLZs7d+/bk6jpIOKORVwT/HT/fXnpjonymVd7+elODtHnkwXpi48d6LivHTwtyxBeQf17rm3FftTI2sv/6yiLL07Ldb3e3kRipcd7UVeh13KLfTuE9yzz1r44fcHvyl7KC7L9iLC1N7G3l/Gv6mX82zuanb6jeeZGfJJfVwumKNx4c+UmN/qRf14zodNNZ1LoxoyU7+umUs6459D4COhk/mHL8ZT8xMkY9cV6sHnSJCO8N8TOlZKqgvykivw6G1ByQmkczDU5RTyLxHXWdjb1zgBPH9WOaY7i5pZMPAYzlDTU5NvREDuZ1GLN3ExNc16YYVow4qkm2ZxTTKMdbGhMpFvNJo/EoZ3/OExe2h4KycqzRklgO18DbmjGwekQvdP+eml9nuHtkXkTU+VRL61FElk6mWRDyhLhk+TD39n0xN3UWDuIcCDt9kJ6WbGbAJK6AgM5Jba/M7o2LorK51XG0BC0RmL/Wi0gELJcIufd4enp4ZE9baU2Y27DKp3cyiI4P7FWBjpfhehOpt5SSxv4ZZpRgM0VQY2TUZ4kUIqjeA3WKo67oTuHqBnRzefpHNBiQY+TKTSKHyxVaXUY4Ca4R8UNM2q1aEdUskpjcBMexERpw23ClSD5D8TyRzfN+T+dTXN7tbjShzyc5QFleItWXNAU1RALNs2JIcqEhkprZHK7KzWqkN4X59/oEC7mUCln8qdzERl6z1J8o3vjYrEEmtwjEeBi8R92t6ii -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the credentials identified by the given `credentialsId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-data-link.api.mdx b/platform-api-docs/docs/describe-data-link.api.mdx deleted file mode 100644 index f53b4d792..000000000 --- a/platform-api-docs/docs/describe-data-link.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-data-link -title: "Describe data-link" -description: "Retrieves the details of the data-link associated with the given `dataLinkId`, including provider information, credentials, and access status." -sidebar_label: "Describe data-link" -hide_title: true -hide_table_of_contents: true -api: eJzNWFFv2zYQ/iuEnlpAVtq1yIOfliZtYaxLiiTtHopgpqWzzYQWFZKy6xoC9iP2C/dLdkdKFmW5cTIUWF8SUzzxvrv77ninTWT5zETDL1HGLR9Ikd+Z6CaOMjCpFoUVKo+G0SVYLWAJhtk5sAwsF9IwNfXL5kXGjVGp4BYythJ27nZnYgk5G5PQB5QZZeOYiTyVZSbyGSu0WooMND6aKr3gpC9mqYYMciu4NDHjecZ4moIxzFhuS5NEcaQK0E54lCG8Mwd2Ame1EhQouOYLsKDJtk2U4wIFWxQoIsiygtt5tGvu2dYig3YjTOHgTAVoUq7hvhQIMRpaXUIcmXQOCx4NN5FdF6TGvxVVVbzVvFL6zhQ8hVb1fQl63dP9RyPI8nIBWqShcnbhxLgkGD21IrcwA41b3pf+0fHrDpDAt4egnLaiexzBLms3MNRWR8iHVCyRAi0tzF6wWx/dkENNoXIDhvZ/efGC/nWhXPyGZ6QKDcwt7fKikCJ1DDi6NSSy6atQk1tILZFBE1+s8AoaEhyWFFkf8FO4wt5DTjxFH024wb8q3zI+ZnRuzDTMHOeJ5ugHVWoMPbEyiaq4DtohDOco1c/GZ5DMkphNyvQOLKOTnrszO+8eNK9d9TQk7LyU0oW/DTbjpVWDTJhULcGxQ6sF29I/zG2HprH5EqaH0VyGDnKKO4DCykIbny5HzLECGmeMzavh0dFiPfBewVo0npndJ/wbPkFCqzK3CZGOCwzj2HvPA9zlZ8sC2k/Yaak1WinXzJRFobQ1bFwroGzYtRIw16kGexGqv18H9Gyw5JoCZ7qbVlgJtVZi8jUdVzn2Om718Z1KVWZtte15LmFXW5x8ZZxflJpJ8P4odfvjT7RL8+1ykNLRtDRwj2RP1aIoLYkTo9HfDxqMunDlVeEPd2Lz3ytqVl4PVZJQDa1f7XPJx8YVjmKzR3HdO8lLfzedxqUZADd28JJshpIKxmAFxr5EgrDf+ZpNqHTXeWEUcq9xuyd8kAABJK41pwosLCzc8/aS+UJ1qC4FQYxv4h9QvR4u8f+tAu1m+AOsDLSnHYb+z5yp+psB1l4RjU4oemR/YDv6gluW8rzpXuxcmDDj3i4Ku3YsKcoJ3madG5P85p6e+It1IsMoTJSSwPN+8zAHjMBObjNU68/CcsS3x7kWTZW2F6+5yHD9CG2fBR4kpEArfGfGppLPEjaasjF1RpggHRD+YH8hZDDlpbRMCmPZUsDK6/bn7OObBp5d5HLdNF1cyoup6+0OSTa8+XzyYXSG+6Nz/2sPA5Irr7/qdcB+Y88VeIoBxowfuzPHDKM5rhWMsajixWtV+4St5uiAoE0O+cI1tdYSm9bM+QLLvuGzRyTfW61RbS3uCCXyJZciCxnV3tW9rb18P7PqgV7HlxxWX45UNrDZ5nTm/tMu6w4PN2n79b4e7w3PqKXEUvqUXi+sk43HDpbG77o2xO7c2gP+ak9z2gwjLFeWITHVCvE46dd96XNl32FnkbF//vo76IswMCEZ6KQpicXs5OOIYT/FMWez7c29fTFmYfvVvvez+pCSHNJSY9Vw2fsGkPf6pMQxbPjlhhIPmTRXNNbNwGmlCW0YHbWEPdq0c1zlqrteNoNeqSUKz60tqK3jhUjcHZD4GyARfVJfuR32UXJLYxPzXQA63VWBBuuVayOd4SHire2ksRlzXM10QvjE/3jXDGS3K+scRPOue712VI2C1B4CSOYKrOK1sMvB1EW5a3xoMgZaSDcPTtWv7QYCIc95PS+T4+Pkhbt5lLEL7khST43NhN0ybRfmpqXbz/e5oA6Sha/2qJBYschK561Nza/O9484GgZfCpAFc3QIyWw2NMd90rKq6LEfm4l2TX5GwymigAd88/j5fi/oO1j3viZgQS9JMqIx//FIfuR4/wDW3Q8OLdobWmjBXW/zJCc+a8A9Zwe+1ewF1vTc+TrE0wAOQl/dUD+E/QR1r4jQC1BLVtjg1V517ZSx92+vqSHt1oud+hA2Ml1YSDknca3uIK+qLUpLawJYVf8CjjHhxg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the data-link associated with the given `dataLinkId`, including provider information, credentials, and access status. - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-data-studio.api.mdx b/platform-api-docs/docs/describe-data-studio.api.mdx deleted file mode 100644 index 1d34d16f9..000000000 --- a/platform-api-docs/docs/describe-data-studio.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-data-studio -title: "Describe Studio" -description: "Retrieves the details of the Studio session identified by the given `sessionId`." -sidebar_label: "Describe Studio" -hide_title: true -hide_table_of_contents: true -api: eJztG9tu2zj2Vwg9zQC2kqZBscjTepx01thMYthJZ4CiiGmJttlIokpSdj2B/33PIXWzLr50ZrHAQk+2eEie+4U84Juj6VI5N58dpROfC+V86Tk+U57kseYicm6cCdOSszVTRK8Y8ZmmPFBELMzn1KwiiikFswn3WaT5gjOfzLdmwpKvWURm6YSRP3OdniNiJqk234Dg1qCbs1uqqd0PpsRU0pBpJpG4NyeCD5iabwMzOBIXU71yqhRXiIqSkEnuFcRJWCHZt4RLBvi1TFjPUd6KhdS5eXP0NjaogOto6ex2vRz7RshXFVOPFfi/JUxuawT8nk1sxl3DxSPNlga0EDKk2g59uAbsX5BUFYsIuMEVV5eX+LOP7/HfsNQTsEukEUrjOOCekfDFV4VT3upIxfwr8zSKWqI+NLcIChHXZdHbE8Ep9BtFAlXDFfNeY8EtfYcp8PK5JyMpljwYVTVQfpgva/0tiwGuuQ5wqLDRWy3ccZU3mJkooBH2KAzss0PXsAwpBw3wAG0HDQhnGoyg48MS4afKId+yiUeLvAmS0neQ82fYehQtBM6P2lDsmWWrmJ9lMxmeCONEs7to3WQkNAgeFyYYnCGsYvNWmuOAapRkI1CyZTMvJckMc7Jv52AVDkaMikWDHaD/00Ad8Ktb3qgCDAF18yshNSgdzULkhB33L8liobgWELiaSOFeq/KoTlQdBJYFYQ7tXDJQYcgin/kmJsYwACThB/sOFHCAaYoOkEQqiWMhEQj8fe/jFv01lagm9Zf2qsvqE2QR0OLU0o+yEqLJAhv9/CmTqzHQaMGXic1dxwW9jBP8CXnEQxTQZe+wD7+/Mkh+aFXIwlSh5y4USaSR3RI/VEqKWY2DUTUoHAXFojWXIgpZc0Snvs9RSDQY74mk7pZJENA5yhzzsJWxT+/2dw/p93sWLSHV31xdXv+jV98m4AvIkjT6l0ikOlsKjYof7ikbgxtYwVAyY4QNTpBvivP6GuzTEEaVfo798xeBtcqzFrHFAmQP5dZ9VRYnWAE1K4HlCPeAauOQNZRTG5I6MIub0lgRs/+P02E12pdEcqLy9mL8oKIKg9bGXoPweAV3NE4rtC07JJMosv+UFnFc+mtDrZRCmn/zhAe+BZu/H0F6rcH770VQ980ilANCRZfNGi5873QvQsomjKqmHFgIcDi5ux09TV8mzw8vj89PALkffbybjgcPL3d/jEcAhaHp+PHpZXI3vB/8NngaPT60sZIjbI5D00L1WCjQNfsFxdNWRM2pYqOwTSReAgyGVfgc8iGjJshxNZZ8vS+yEthkC+Yjdfc8ej0YJs4v06rnKETTDwAPsRNKxyiX/MoiPEXiURNY9gmc9ADDGqbIHsF9e8RWbz1CIx/+K4iHcCTDI6PbXhFWacD4kZ12/Zyen5i7dHtknnivTBPc6Wf3aAFcY6/4qmFwyQNkRgJGWowpQhMt+j5Xnlgz8BqykCIk+ZmMlOpM11avlucJWxynZlIWkEG8R1CP8MgLEvRQA3iejIg5U7JMGDP1/ubiItz2rVRmMLJU1RH6J4xQz0M7cvHISjmocWalZwmsnm4LK0C4S4aJxGNXsCVp3afILEWAlwttPmuntASsAlh2QDTxJ9xuZ6zX2FadvmEgEj+3vbrkXDLN6aQbZeQixDJgVh6JLP68AF+S5p99D7fGT8W+gbGnB6SZtWiQ90GGARd8WVSYi3HH7Nciyr4sHozLZTT4/b5JJONMFAcOSFXrskKys1vdaZaoPoRC3X+HPLMEA0Z/w5R+BwZCfqNbMscrldQvlADby8RuDb7kAKcWMKb2MKGgpOPzSpA2lgtiGuLXj0WgqocfsMoSdm/PQv/HNrOrA0u01oKoM0DtIf8l3kEWVBOPRgRCCVQA8M1V2ePuwlhvjZXEyTzgXimIWrmZ0YFZzM3xo5btapd6KwYaqPg2AbR2LwhHNN+ObLheiUTX9LXiPnyfgO0Th414wIELW8+RRUCXLhktyAxPSuAge0TYjW1C8NmCJoEmAVearDnbWNztdSEcavzHKNhml6G1q5bWmZndfBrcj7DmGT3Yfw0W4GZFW+2G2QIaUuAQFAwePzN7zghoc5YimEFQhcSrRTFCNisQAFVKeNyUBWV7oRKvrgMG4+7BsrFK2x3WpySdbgyKR2sacL9sUUWuroEa7d1c2VjvXUKO/gtV1PFaP2ZRWlXzqJ8jBGtIwFqZv1eENxao43TNVLPYPa3w3kBmhb+n8FVccx3DbSQW0DlrjO379wg/VoUeOkq2Xh+CxpNmSFZ9tRXat9ZNW8FbwMm9NvAIiJWxCCo3C6U5P3BfUVLCPUo6vdBsvQFHEMCuLq/qCQiDawy4e9YxS90iCFcLpr0VZsT0QGFchtgil9vJc+q9LiWAfbfrbnTdja670XU3uu5G193ouhtdd6PrbnTdja670XU3uu5G193ouhtdd6PrbnTdja670XU3uu5G193ouhtdd+Pv7W5cX76vJ6DH7AkLiYQmEFLEJnW+68vr+vQHoT9iK6OxGYI7LBCKMSCHD8YjBEI9jJr388orL4jPaouUi4LMuI/WAe1eUBKZiSGT9I2KEZnpR3iJhPBuwuwvDAKUHCR4w/X5C0bIEJKNwLc/S2aw4iueG+cifYN08Za3M3YmBct19g4owXOhs9I6xtqbxtw1idq1ado1T4cq4ddAyDi9Bye2VAPhmlCd0Tk1tb5hukxtzjdidNKXO8YQzSQ8zJs/HzNr+7rRRjg8u8tIhZRSgWiPEYjscki16WRzivCMhveZL7Oc3vYYtP8sAOjA9nYYYO/cDx/cS1MeCKVDagwkfdmUPcEi+furylEvt7P/xnOwVMaafdcXcQBHJnO7ZW8ArGkUz9N6zk3R6wIFroAXhL+94Tn5WQa7HQ7bd1loMZn/ODcLSJXsAGdHXm01UvnKAEvlYVgaMx1jYHAM4zZyn0XLT5PUX3+uyvR02rIcEm3LRGU0F1LcfcHSDUofLLSBSgu37dvSylp82XPkX+/wnojue03FS8o11z5VoD0z40m8smi3y4nU+I0E7nb/AUe4mwk= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the Studio session identified by the given `sessionId`. - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-dataset-v-2.api.mdx b/platform-api-docs/docs/describe-dataset-v-2.api.mdx deleted file mode 100644 index ace515b17..000000000 --- a/platform-api-docs/docs/describe-dataset-v-2.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-dataset-v-2 -title: "Describe dataset" -description: "Retrieves the metadata of the dataset identified by the given `datasetId`. Append `?attributes=labels` to include label information in response." -sidebar_label: "Describe dataset" -hide_title: true -hide_table_of_contents: true -api: eJzdVt9v2zYQ/lcIPnWAa2dtkQcDw5bUXWG0aIs02R6CADlJZ5sJLTIk5dQT/L/vjpJsKZbzo0/DnmzxPvK++3i8u1IGmHs5vpQZBPAYvLwayAx96pQNyuRyLM8wOIUr9CIsUCwxAGOFmcXvep9QGeZBzRRmIllHy1ytMBfXNWCaXQ/FibWYZ+L6dwh0ZlIE9L9pSFD7axGMUHmqiwxFXKKvmXFLYBb0Xzj01uQeh3IgjUUXDdOMCE4i3QQnlae/3hDCggOiio6DK2VOH4S8N+7WW0iR9g2k4ujuCnRr+TDmvxugyIslOpXu4nNMwKcLXIIclzKsLZ+s8oBzdGSqSFdLx+/kZjPYut9K0Ti3EBZ7vuswhCeJ8vkDxw7vCuWQwg6uwB4i1S5ye8XgSjLP9jdHR/zT9fX1E52ZGiKfB7aCtVqlUdrRjWdIue/CJDeYBhbZ8UUEVTmoo3saqLIevgNZeNKPDLsQLyWs6FBWlRgozbKxdoz8wpJSjC9wdfiOWkf2Mauc91lqfj3yEzMVNC9d0NFTymXGtxPwecSMm0Ou/tlm+7M25Yci0eDDhaWbwux0/X8Xu5PqPectMVNwHld7rCzSe4cs1b69FRXjXgdF0XT1ff6mDDV2NyTGaIS8OpHLY8sGzgEXLBVw6V/42H4qZ1agi34L1RdTuBT7mSs/wRkUOhw0r8mnSg+Zp0TWWaPhoDY/cUWtVPnMyk6SSTBxeUW9opspj9X07Sl1tW5O2S53e9JZXYkJw6h3fbX4FDLBzxF9eElRbr/gJXoP82c81Qb46Fv64Jxxe8zf9nSRph2L3AQBWpt74sNwj2nhVFjHJnyK4NCdFNTzxpdX3KCoQy8Mt/A5Ro7cDsdy1Mwio3LbMTejZvDg7otu1XT2wlGxkIsQrB+PRmDVMNWmyIYe74jUUJm9/vo9WsQ3Siy+V/Ge8eLk21QypYbxdxa4EqvNe6sXe2wGgZiWEUQr1Z8/m4y5uQ9RCZ5m4vZa3JoFu32KIIerUpq/KjBnBqQxM7rBt0Ouq2h0+8fO0M5z+evw+Hh4xGvW+LCEmFj1qNLkbzPfPSRZ7hL0vzgg1pcU8EcYWQ0qlouoVllnWWviHchxezLbJhplw4KEYWxZJmS/cHqz4eVqaOT0y5SHRPPrm4H2+IhKT42UvZRvcb03ttb1WMZ0XYFTTOCFZF6d1VXjF/HouNlLqmlE+brNpiG7k3JzReAFQsZzHdGr7Cdpija0du6Vt05l+PjhnLDQfXwPHls8vZcV3VtEnJtbzOnuGpKBv5ngZvMv+956Lg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the metadata of the dataset identified by the given `datasetId`. Append `?attributes=labels` to include label information in response. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-dataset.api.mdx b/platform-api-docs/docs/describe-dataset.api.mdx deleted file mode 100644 index 6b80bcdda..000000000 --- a/platform-api-docs/docs/describe-dataset.api.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: describe-dataset -title: "(Deprecated) Describe dataset" -description: "**This endpoint is deprecated. See [Describe dataset](https://docs.seqera.io/platform-api/describe-dataset-v-2) for the current endpoint.**" -sidebar_label: "(Deprecated) Describe dataset" -hide_title: true -hide_table_of_contents: true -api: eJzdVktz4zYM/iscnpKMbaXbnRx8arLedjzttDt5TA9ezywtwjYTWdSSlFOvRv+9AE3Jki07j+OeLBMA8eEDCKDgTiwsH064FE5YcJZPe1yCjY3KnNIpH/KLi/ulsgxSmWmVOobfEjIDsXAgB+wOgE1G3mIGLFwzPVs6l9lhFEkd24GF72DEQOkoS4Sba7Pqi0xFMlj1g1V/3f9wzlDM3BJYnBsD6K9yPLi4+Jp+TW/BGQVrsF5pBU6QNdNz/z/cxJREUzVXINls4yULtYaUfQsKY/ltwHtcZ4iL4hxLjLSKYrTVQXkmjEAXYIijgqf4B/WetXmymYgBrXpcEUmZcEu+z9y/lR5L8xUYFe9gGVQ28D1XBtCzMzn0uI2XsBJ8WHC3ycgPBg0Lr0qUCbc9uvrIy7JXg6kDOgklhMQskpcu3ohja4Rep6RsM51asCT/cHlJP21X//yJd8YasaeOpCLLEhV7lqNHSyrFoQs9e4TYM24oJ05tHYTgXlZUsgNvj+cWI0TBLsQJF2u8lOJGBCoh1og60vybGMUY3+DqeIoaV3Yh2zrvkgR8HfQjMuUSOnrAq8fpXJN+sxpfB0ybhUjVj7rwX2WUHoskEdY9ZJK6wc3mZye7Veod961AKnHvTzukRNInA0TVobwRFen1ncJo2vy+3khCAm2DmdYJiHR74wwS25AJY8SGkuNgZd/42N5VM2uR5N0S7C86NzF0I1d2BHORJ+6oeIM+VXxMPEawJtOJOMrNO1LUKJW/iNnRbOS0P17j4GhXyqmWXt8SmnV1S33cHk+3oROjDml97OrFN0Iyeo5g3VuacvMFr8BasXjFU60UT76lz8Zoc4D8144pUk1mlmrHRJLoZ8RT+tKulo96YAHuCspt/Iy+AWHAXOc4BIeTKY0sHOBLTfN9EWY6iXhU900bFY0eWkbVKhQV9Wwto2rR4OTOrKuNIDfYV3i17OBSM4gTncvdxnMwie+8hH0JixD7RPrs+suYE9YqlDvKxZbXZkA1teSRh1HtK9gr4cn24/equB6fnSdNUf8i85CHgILcvgSQwlXIUlCmIhKxL6J28M2QQ8P1bn/bCZpPgv8yuLoaXNJZpq1bCV+DYak5G9VJPmf7y+U+4mJX2D/1shpS7+A/R9CU71c+B0Uo6sluGbBoMGwvqvWKj5Lm1liXNtbfElNB9xTFDOUPJilLOsYOYuh5Tal1GyVmVERY/lJZ+sbHNReJhROJObsNPeWcvbAWd4ZZDaqUxlSYHhw/n2Czt5DTavwuWKdW5Hdg2jFcTlF5CULSLoqkbeXXcQyZa1getORW7/rj8z3qinYX2Hv1/vZOVJhOr3GvnyDFlFYgHf0ngGX5P3QR13E= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - -:::caution deprecated - -This endpoint has been deprecated and may be replaced or removed in future versions of the API. - -::: - -**This endpoint is deprecated. See [Describe dataset](https://docs.seqera.io/platform-api/describe-dataset-v-2) for the current endpoint.** - -Retrieves the metadata of the dataset identified by the given `datasetId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-launch.api.mdx b/platform-api-docs/docs/describe-launch.api.mdx deleted file mode 100644 index 067169c4e..000000000 --- a/platform-api-docs/docs/describe-launch.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-launch -title: "Describe Launch record" -description: "Retrieves the details of the launch identified by the given `launchId`." -sidebar_label: "Describe Launch record" -hide_title: true -hide_table_of_contents: true -api: eJztfXtzGkmy71ep0MSeleIIkGXvxF7/dRGSvZwRNkfIcuzx8RUNFKhH/WC6uiUxDn33m5lV1V39ABokj21cG7EeAfXIemX+Misz68te7MzE3utPe56TBOObvc+HexMuxpE7j90w2Hu9d8HjyOV3XLD4hrMJjx3XEyyc0kdZibkTHsTu1OUTNlrQDzP3jgdsKH/vTobNvcO9cM4jB1vtTqDdU+plxM9lv4d7cydyfB7zCMn5shfAByimW4ACLpIzd2IsnKdRtsEEUBrMMmoiKBjxPxI34tBjHCX8cE+Mb7jv7L3+shcv5tiBrLT3+HiY9nkfRrdi7ox51u0fCY8WpX4/6oIsSHweueN836W+3CDmM/ppGka+E8uvfn0FvX9GUsU8DAQXWOP46Aj/k+/v/W9QdRxCK0GMvzrzueeOaU5bvwss8qXcaTj6nY9jnOAIVyB2ZQdqveGvbIo+7U2cmHciDv/i0OfunHtuwHFXrG7NneC/vvNwzoMZrNDr4+PD4gwj6f48iflZcIelg8TznJHH9dI4nvd+SmtvUgTDnboz6JAWB/r1nBhnr/KbFYXVT2tHMoZ+cQ0dT3Qn5X1S3AKdrLix+Aw6ZWq0jAd3bhQGPvzInAROBxSSi9ZkF3KkgvEHV8S4e8demEwY0HQHzUWtf/U7zCCpyQacs09yicwfPu/fxPFcvG61JuFYNAX/Aw5b0w1begoaztxtjalew6h30MSFCaNZbrBLNyruUmfyPvAWetUKOzSaOYH7J42u4lCwfazeCKH+IRM8RnYhFiLmvqTDPHnPQM2q87mOlBo7el33naoN4M1vnDXUzHiAnFJyU5MmyZ9yVL04OiqTlSfjQ+AC+2JYmfYl8ueKvdlkvUTE8EsgYCsih3/RgNZzFB+yiSNuDhm0kgSwPcU4jKCxG2DdY+TcRGWu9/wUHq2n9jT7pKVMNbHOg+snPvOo7dcM2y5Skh7/Ahn/KBPBYYTIbpx70Rg5MUkk/JuOI/w9C8OZxxueOwX6XB6MgVuk3+oK6qOu4/yZRNmP8pP+7fafomFwJ36b+zi75ebHZJb7KLwEzrPxhSem5kfHAyEdmd/4oTPKVQjHjpdrkviFmuhcW6vno9bINxrrusEV5qI4svLY/9qxPmGVv9nIS5hPMy5dIhVHTSnFSZKW0ElfSxox52PgamMmSyaREnYDYJLjGOYHYOScBxOAkQEdcME9EMXA73SHCBdXi2mUFKdutF5AowxgE5Cx4ziMFgzxI3FBAR8JLYJwiXw+cVGgYqtTL7xnU9fjiodE/CIJBtTi+t7akwlzmPwGhubEINj5GOYS0IEcazBtKNSsSs0jF5lyCAXuwlsk6R1/iIkKGDLwGUCESuz3YeqcAKYpFHEjSgLVRA3hTxuyJTtuOZM7BxjY5BcYWwPaa+j2Gqo9KW3w2+cZujOFOQZB4lUMjd04d5LFewD+J99kpIZgMcbpRJGDmN8F+SvWA2otnFfP0pmBBe6cyEUATKKZCLlzvGTbRqgutXIDUMJoZBSGHneC8oKB9oDamiuyRmAb4iZNlwmbYr+Ho6YB35+paS3VoXU8aY+HOdivALyckMP8R8TwboyKA3Aq5DAwH1eqmxIAqZwsgdQg6FOHsgphEOBSxHZSlrf2DLj4p+OZ4zSYIPaLWttC7fNCKeI72+5xTWxDttXAtuT+nrhIpO8GDjC99aPQjJxhMZarXEbNjgC+DQNLZYVk5tDSQbOEkB+riFHHaPFOat/530HOwXwhlYjhciIPx6G2QQ9+yE90hQDJ9MtnEi3p4t3nZYySamMP8DSP/i6YAFgKs4QLovC8Atsj5HLMGYnQI3mLwgnZnqGgMR8LEpOkqb+PgB8xZ4zc0wqon0RA7QgfkiVrna3T9DTd3/DIEBswN+KZTg/rTlnouzGsKii2fOokXkySYahYwJCoTgSP3tUS7h+gZKpmDwb/wtkMJDPEZtGWQwI1CCdKUsNq12v6X1CSmoaWu33mTCYRDAE15HKr8zCK15pPXh6X+kCKsW6TncrJeM2Gx8fDFFP8d8LroJPLG2VsUOr7H1itwBRZgmID5kSxmhwykMcSVQYDdWzReWXH0Of9jQtdauMmARAGDJqJZCR3Q5N1YGPB9grveBS5E9hN2rCd1srrNkio7zwQkQP3T77N9CPpvrJqBIk/AmJhEERddjyBLkmmxlNykAJqgf4X8DAReKizBXxxdJSt4H+Fo/fUndiIh6geQ1k1NSJVo0QUps4MtKl/LetwGWqE40hmNDbM0zqk1YHTLHmWK3eOSUEjXboKWKlBQnsEI3XG8VtYUcVI0eifF/4bQiWNXSSeROCTw5OKmxoqeAEPWd1jp3QP+N/nR9OQZGDU9scBO8Ev1wLV/NqiocKZ8UsqVLU6AB3GdGGjtxRyuogvu70oFb8D8elzUWP3ZTc5hT1xMmCqFZxqP0xgc+xLdgcsqIViroXi+XULb68c4J8RfR5upZ88/dBFfKas02t4IKyZLKtgCAjdMIkAPbB7F9DiiO5gyFS/z5uzJrCuRDS4AxjuhRrbZuLL3CRyNJK/I8sF5BMg+labFqrivgg2bjlr8fSi/fbsXWr10ii+68FSwmKo3+viQJHMET3wybUIp/E98OyWpLCFYvTO5fcHBtndQMSIF5fv69wO6xyD+iFrSLW0iv50EaYvmscPnhPNeH4VQKZchF6N/rAUa1+8wy02ixzYzlPYtA34E/4zYd12j8EW9F0hSCJCqWW8BTi8hjP1usa2I909jvKsM2CxI24LuGgDRFa19stZrRK+X2uiVvB4z+3j9f56AwUifdUUjq1z3pW7w/OkdpOadRSzSS8XK3UPq0T/FEq02tedeSK2gefvUkje6X8QOM6Q5OjqPa067XEfdNneaJuOZV3dIW7vpef3EPefz2fOaBGr+wuLL3cJXwIXg4N0FuDHOvMgS7JPH+XxU+xw+QHD1g9M9XEKaheXCuQ0QR5+vHnnb6iiaf5c2r/s48BwjClQvoS24A52zEAi5Y0JfHfV4xm6UHjbIKFMv7RmhbO3UZjMazgJIbf6SAL4PJwJEJRQTfkIqYExaE3skq1PruQgcObiJozrqP+F7ZJWXbNZWrPEnfCW0MUP1q8cDGjGyxfYEiK9wR8LM6gsH032yShTd870fTtwYtFKVcNf6N8GkdIwimjmd4C+YiHIBeV5WdYMcm5FAbEyhe/yxGvWQxsO9D8vXOTxhzJpifW37vESsK69Zwb995fwEdA6/LvsQ8ndoGsC+yYbQqGhIlSwJKAb+iiB0rg9wqAx4T6O19QJYGmG2EVWL19rMA/jrDDbh3FzPH0ilrsV1J1tcUHPDchkR6iAHCVwz8F0r7lb9J2HrbtUVsJNu5zNk42Z49v+B2OWCVGMRBu25mDseHXkZWrVSwkVaLZHmwHu8AZ/mMNqUl8TF7ScFWNg78KYfnDkqt67oAcsOeOuoV8+xbbRCX3faQiO7smI9jzlHIdw7J7ndyFtYDlJhNYGMdaZLVYdmZOzweX1my4eDv3ndf/i/duLs8Gge3Wmjs51p91vd7qX/75+37/s9rr/c3aqf+lfdDtn1b//mG2X+MMpeoX7yKHYDfAryQWl4UfkuQCKujGs8IKFSUwMMdWZc8ihiuIh8ceMvWSN4qfhSppl3TyTkbvQByhRy484Adzhs3avy7qnOIxESD1dSlxk2AV+Z1yBoWw4d4PkoXGM1oIGiivf/RMZAvYv9TSf81jkjpY2Zv1dUL/abUt5a5mXY9LXH0RRjEgCzjE0fQdozHDSbPvOn/Ap3z02a7pCZ+YzQM94BSQ1g/m4zhRd9Ts4N9hewGPU5qEUNSCSEXzzlFN+rk419qFaI2VdhDhsmvqM9mkEK8Ud2IQhjDwid1icAhI5UFXSBPsucuMFQcTnIE03qNBj95QonHC0t6BKzqnUFCT9PergUUJuLrjyCDKj0KNR6JXAy0Lgy84UFlxiIvHQQ7vt+nV4M3igRTgnM7Oy9s5DVwkZaKjelWahHYOBZ0ojNLbtddqK5gU0iXLm7Yk2P89Dwd8Hp8BTtNtyXak2wToSnhnG4RseVOI02Paygtz5fHz8G1/0nTo34rh6txw9GN0ovWA2/EBIIJ0k49vnOQlOplYMXrKRbFf15yqddxnOAIRwAuLvdtuly+4TikslIX99ELN/mt53HDCFaMqAge3fvZA4cORO+hyWELSy2Vaka2im4cE8csd0Ge3kxcMhc2A20TaqOtN8NBNAsqq09ThxHmQ0i4iWriOCkCSCFBnQORxM15MsP4ki3H8Ca8mGYSuOOOJ/8sCVvJ/uT2H9M7IKV8l/k+o2nwoZgrLJSZE3JQKY9z07ezMoITZotI4YONORMoU2gCPqZmoysmIDBifDLWcYHbJri82tH89+icJUGYOqtu/WmTqFLnBLfQWySlrCSRjG27IArCv1AeIASHLa/qHBEPhY1DWUKIiVV461KRUvWXA8sP5pHKJ0UhktMt27ydpz9FzPrL7DFo/HLaAC/9+UbQ/lrgIiCSRozxPyz2FtD/7G7UsWRCroOwuUHXDIsI4Dn70pnGCkDwvmzRIVWhFZdbIB5AZYWGDnHv5PSA1o9VsStEHVlkR3rQm/A54Ax18aVWBMDWpU2XeaN7HvKfuOE2knj/pn4iIJyvZX9NB5I1sz7GECt9V4tRmOkHmOEWZKJs6cDzPuNdPGYb6DCgUS2QA2RIAha1xJ1cj/9dXGh7590fv1Fdt/Gzl3bhwG5tkwxiPJOiyaOA8lNdVq7TaXp921F6d5RxnaaqmHjLSWTS40uNnkFiEDEX3DjqQu4Ytxxho86Rt1OHjm1s88jw/KJnV1oZ9d8h2Wv0LPjFzsjuGc8Za+Z2So3dA/4y93XrB3lbt/V7nqrnpHLgjsxaS9mNz9i0nYrrhx66DznAxS9bRSU9dhLdeG8lwzPNNQqYscT/umAfarsfFzbWIVgk1KeCzvo+FAL0td7LHu1I1A16QWVWsUaz7imB/BI0u7MqURFGyPx6ignfmO662neiArocWC1DqO1Qj8oE+StGNIGZez124ErHoOWmYVrtJTELxoYBsTJ5qQE2BuChw9CQVvNtMcWttmDKqcMhpIMy/ZAqVqwZnKtgKfDKyMQkc5SgHA0qpcqgRd9Zrs04cRTFfCzi8H2WEg3t6U4IkUB8VH6JS0qHfRCkVDpYf5JaE2rmGtD5jaPvNk5GHKAyqr3O2VTtlEhIcXTQ0uj7Cp6jmgqnI+Z+fciWhwV70VdE2gaMNTRRt3vkngLxirdq3M1kAYflQzR3pA58NpuzBDsCzqFhZ3JHBXHancZO+1kfsQhCZyiUZ4j1dwY6llqnFqL1HnDuaFmA5peNOEwqAjaA2IeLKikd/Dz3PLBxXiU9C/UYF/u5XfEtbUG3SUqvN6r+kY87Ng5gaZ+0WTDeeT9AAN04OBpwhTTqC1O3eO/nHE3p5oa6F5jL6h2iJZ5TOqLWZWAdOlHL/+MZSW7Z0v1+N+CyYtmPwpwOQ6zW9jACMZyFVPGlk1ghko7nt9eiyu714qsLgMgtJPkgnWdIeTvepKhjfcVU+7wNH1bq1LYTeKEwCLqkrWqgLOIhmlxWuZyIk2s5ZuyXcCEOmTLoWWxos6jWE8aMMRwp0hMlANqKxP8aJEa6GHjufCH3X66RVbHlNVbesvJB1TvosfK3NtLenhPJyxNsjDBbQiWJqmS/fgh4Er86no1i/xUNS7B1Z2+ThlpIiRch1Ky6cTO53QU8kFzoIJXdSsb/4U6sHR0hUZVzWld4X2usy3fpF4taal2DZeuus5gaYZ7OxYT8oT8EheTN3yCoei5aLHtOz2nHnzDNSzxfWAfmzK/1yXr4Gfhmu0p3oO2VR8SSZZMwtS2ST79rez9AZlgwwPqpHfkhG5ZOA4cmBlB4GStfzuguUXjR28xk7L7Wzp3wP9gib14eI8leSawAWc5QYmI8NITFSUlUwXwuvwqMaEDgbnbIyngvzDCAoaUoXraCud7ID0afzOpFIe4jSRIQmQjcaZ1iL+mubqysLiDNSk1MOhCXsHOTvSRl2LgjXJcNCriEHPpRZYShUi8+clSa2ABuqabeLmVee8PGlpSlFVGHYnubqW747rObjDLvtFddww2lL7TcZWdDzH9euBgz6aawQmvL0iFZ+qSpRAt/OOwOMoPUJl40s2xyFTZyJG1++GqjRUfpTkrsOGF7AkHzFFCCCqxVBbCX2dWEP1QO4l9SIVe9KlBOMVlSVkng5IGy3GNKQlozF3TyslWrLESQcVEom4C7MWTqBZ+hHYlueOF4rv4XW74m8EBTM/5DC4FgmNlwTpvbPAPwJ+R6aeVb9+LmfTfGhgsw3QHOnMrmvfUAf76aj6RLc+KPD9YM7HT/TygDlLw6iXBNBpKy6s+YAEeBgNpQcw+koCzIV9gTlSY4xwjU0/XNTf3QlTlLJ/t3vnmJJapTwEtSwicyzxxiE6XL0emubt5xlhldOh5hQw+m8xPmub2S3bzNeKo60Vlf4XBdKW42h34ta9sA0U1sxwoKmurfjx83eQN8calC3T2oBp1TCd1r1jxzxdplVCXYE3MAykQdfZMpkF/VoP5RabpLHVMUavNZU/qqclKu6cTAorb6CqCxhudKUcR8pmoyO0JOz4zg0uqVlqM0eIVIbsy/k6IGEiR04525a7XaxiXeigX+M0fRDFmNZnurQt+F2To3UuhCvf4Xie9E3bXf35kzMFEMBI+k02cHKp2ML/opLISq+MV2odnsk3R4ibUwegRZ2wIXVZhKE7E6qjgrJHyWyWRrOJm66fDz9Zpgmk3tLSjUFHBcmmpV0bm+4B2N9mM5xiZeahTzjbP2q8lHs8jsIEcyjfwFbRNI/D+eIJRGN11B2ytOugDvcj9w6AYVumuqx5KOaykpEjk2OaeRA9+0HIQAhghk4PfhY6JemIexs4AayNn1oWLyw7SkEf/iGPQBo11rQm3p/DxGsVqB9WgYJhTMUlJparsUXfvRkwqUWxmKrIhydkMnBt31Nt1gxZwyb9zKZYjlKzestu6S3WEaaKNrHhtcmAwlsXFCZf5RacptPGeH6UJkGVj6J2OYxDLWvM1JMRh23gy+BAPOdwpCaJdjlIN3ma0J3cVWr4t/Q7qW9LerZkhoJ6DQzSsvLWxPDdhrZNyZAGlXEfuWONw6unNU6TbkdsmnjeovFH4ngynjjiUx7he1kyCPrTVc9wfVY91XY0VhUbuqI4OKQBYbYPisbUP0BTQ7zKmroPh+Zl3VqOAPMgfoaJqMm7NnHkyJ7MMl1UMT3nj+Cg+kzpE5bB/6U5FFbla9oiTbFMGHtcoQEXExNv5ilYTsCr241fNvH5rMT/qrEOaCGrmxynnLtGE/JJuer7eLclM9RCo1sncqOvf1Fuew0ZV91QFowGDQ2+dA8yJ3Yy21Dz2K/MpD/iMuECYW+kfp2JyKqIu68i7oiyZLURq43svjbylRLBPiUizIlACMVcumYYeShK2fKQk5Uy1j85gmxpy1snvMo9q7QsevOJOWdyGGeUuwjRKWcKAEcGnw1n85fDQggauksr1JFDW/0oxK3YjmpeNA67+YpDSrave5CZa0xkBlxeCKTDkY8I3N/gxlc+TyqKLk32pEMXZZhimjqFUgpCL+TJw4Mwmd0Uk/hDg4YmWgfAST1UO8dn+Vo8Z8yJ3+4LqOZxlX5PO8M+UxK9QUXyPDM1nlaRjXxquxQ/WHha2NDPBviLfTrRImmLpL9rJG2fTrRPJ9qnE+3TifbpRPt04m5aF+TTiRikVoVTbSCnBZ4/FvC0gZw2kHNbkmwgpw3ktIGcNpDTBnJavG0DOa0f8lcM5AQWHjtuVKl0tekn1j8Z2BsCq6jtqqK2EwzB3hDYGwJ7Q2BvCOwNgb0h2FWNRd4QeGJaCVa7Jz12PnhjkapFqhapWqRqkapFqhapWqT6gyDVJHDjN2F0Dn3G1Q7N0IE0m1KZinmUZS4dcXvByeZXXcZi4t3DxPJ9mFI6LvmYAX1tvWUstP2eoW3tUGf1dkju1TmMa07EMMuu04ejur4tmX9pDmXXyDJ8AwybLOTRMhmCfmU+3dAUPlK+0M8/5mxCcXROYNkpbOYev82/QqZfUpeTUUgjxSYJjrbyApkqKn+B1Qzgzr9c1IkLT1+QwWK5uKRsdstXzybhqq4JVrIHaF7RAzRSXPidgmvNFjeVV72UC5j0fbwBaIdzLGCCcfKAl6u36A4lZ49whQUm8KDKZYCGLaegUroowL5CoDaLwnv5pnPhLTn4jwyVO0LtJmBJkMbFY8kB/l4/AA+rNDT9ej8bg6SgKFfA8ePvg1MuHUdqNE9FdUt6U9HgiOhlvgowZxMu+YkUpyq+8YLPupOnZVjQkZLIBaBU7iGdItj7k+guvGgdh7c8ONWycL0Sqo+o0mQG7QGjJsyYLc05cqD7WLn4yJnA3CLvg07qtVPmDu3cBpmYMy/Vk6l8BuU79vtBh4Ki348cCHLQ0vjXYavlE4JbsGJGqkN0LejdJdBrA9G3ex/uB7EPbvAOWpB49KyqhF1VphT5SK7DPpWeX5OPpG2X/CXTt9L0L7rdA+bEsTO+ycwTJtpBJniY4qR0Pktu2GGuFoKHQZowcNsgYBqaHkdlMLCMBu+EP0SARe183TL3YmpOVNqD3NLpI8QsS6Ik2Cd8ajZicEjn7BVDy/NW20SWaqjvfpFooYHpoczvG4ZwWp8g+hly2ysbNz5ed8HRgRnGrIT1BtY5RN8RZn5yAIFR4l6yzynQpwTz8T/ZBIACLrI8J6lz9xjIbCUiTYG5Pj+7leG7JMO3ZGL8tjo+rE3Jt9jZbwP7WqA1m/00ZjMbZGaDzLYlyQaZ2SAzG2Rmg8xskJlF+TbIrMyMbZCZfS3Qvhb4UzKtZ3wtMDMr0gxs+iogVjeNGvplwDWv/tV5OvBrvgzouVMYiovPHQjTTKPeUcOfmf79e7exLFtp+Akfe9zkLvtx1XOD69kU92FUo0qngMdtHv97XPkG3uPqp+0eV71UR1bmDV6ee1z5hNxjvffgHp/hObfnkQcbgp7tAEs9PrXivarHVS9PWam2Y1INm0pm1Rd/HwI4Wgw9ovVbRzaKytrMd9RmvhO6mY2islFUNorKRlHZKCob77+7iPUzoVZQsguOGmgVOdkirEldk10uloU2lMI4kNFFS1+oKxWXl3RPcW8/Oxmoqz7pNUVXgvuS2+GtHkq5Fkrn163UH5Q+q0v678Y8stwQplBIFrFCz8+AhNDu9MueLNxMepmbRI5GsnfkuPpaL32YaIL7Iti45azF04v227N32YOwCgt2PVhKWAz1e10YmLolXotwGt8Dy25JClsoRe9cfn9gkN194lOOVfSnizB90Tx+8NCEkF8FECkXoVejPyxF7wnBFptFDmznKb6POIvkA4zddq/4utAy1gIMXqOZel1j25HuXj6NOWCxI24LsGgDQFa19mvvob7WRK1g8Z5bz+cAS6WOyvhY63lX7g7Pk8qNq2N8FLN5ooeq1aF3QYf+Wre6K/f0X3upe1i+1bXwcpfgpY0iWhJFdAc7RkWbbEzgu6sez9BF6paWklCmXxqzvs4Tmjti6pMrOQicubgJ4zraf2G7pFXXbJbWLHEnvCV08YP1K7dxnLsyfDTZJ6PM1k9wyxgs+rdBpFRG1ejIay5SnJPXDEwHOJSi6NQj8V2eeM16aMOB/ueFizz+UBYtsT7CPl4C1rWL5aD//hI+AlqHf5d9+FxCvCawb7IhFBoqQgVLAgraiRJ5jczCoDHhPo439y4sVMMusnr5WoN5mD3pDnqChy6yFM+jwvfcYFtc0HMDstgRKkjfI8WgvaWB5tpauHWXyki4aZdPfiNXIoqRaG8Q6p8a9VJCBVrt0WZA4f/8YY6ZE7Averp2xRjYuzCmHxy5quSIueSMu4Z++bTQfd/H6Ddy84Yp9lwRU3Qm+lPzCStppuohZERrgxjrzBarjszJ2eDy+k0XD4f+87p/8f7txdlg0L06U0fnutPutzvdy39fv+9fdnvd/zk71b/0L7qds+rff8y2S/zhlGPUHnIodgP8SnJBafgR5dehx7DCCxYmMTFEMwogQw5VFA+JP2bsJWuUfIdX0izr5pmM3IXoHFLnqWHl8tzudTH61wi+kBIXGXaB3xk3YCgbzt0geWgco7WggeLKd/9EhoD9Sz3N51wlAtFHSxuz/i6oX/XEstQx8ndjWMtDURQjkoBzDE3foZt/lmBCB7PlusdmJczJ9yj0k9NSM5iP60zRVb+jn2JWTx9DKelfTs8vP+WUn6tTjX2o1khZFyEOm6Y+o30awUpxBzZhCCOPDplSx0jkQFXl8/5Mz0Br0kTFc9Ah3lriZRSo5JxKTUHS36MOHiWUqMV8MBpHoVcC7wqBL6NH/FhiIvGwxKumSNCbwQMtwjmZmZW1dx66SshAQ/VuNAvtGAw8UxqhsW1v01Y0j6+jq8fRt80wk0o1ld9DWopT4zBmmamRYWbrp+Xzr8qnEuf+JBnfPs9JyHzP2OAlG8l2VX+u0nmX4Qx80x7E3+3Wj9qn9wnFpZKQvz6I2T9N7zsOmEI0ZcDA9u9eSBw4cid9DksIWtlsK9I1NNPwYB5hXAplc8iJh0OMhHLQNqo603w0E0CyqrT1OHEeZDSLiJauI4KQJIIUGdA5HEzXkyw/iSIKlMFasmHYiiNOeRzgd8X76foU1j8jq3CT/DcV8DIVHbr32OSk6AxgAb9nZ28GJcQGjdYRA2cPsENJHubbAI6om6nJyIoNGJwMt5xhdMiuLTa3fjz7JYrO/2BQ1fbdOlOn0AVuqa9AVklLOAnDeFsWgHWlPkAcAElO2z80GAIfi7qGkpVRZXjJguPBUMYIpA9IcpGmPEl17yZrz+c8mGRW32GLx+MWUIH/b8q2h3JXAZEEElI3eHTPYW0P/pbReXACqaDvUDowOGRYx4HP3hROMNKHBfNmiQqtiKw62QByAywssHMP/yekhjHSLQnaoGpLorvWhN8BT4DjL40qMKYGNarsO82b2PeUfceJtI9H/TNxkQQVkUiwDG9ka4Y9TIX0rTTmyBwzJiPMlEycOQxr9Zpp4zDfQYUCiWwAGyLAkDWupGrk//pq40Pfvuj9+ortv42cOzcOA/NsGOORZB0WTZwy794StXaby9Pu2ovTvJ9MIfMcmagmFxrcbHKLUO3Ari7hC1sjBU9Ggjpz6++T/14YeIuKOK+aqTjy3hhklv3eIzmeCdYtM2MsxXar7EhbuE/Ii2xTVV/mMOE+0TFAtxu/bGKmnwQzQeSUWUe7ehYqmippbb2d4p1qKu1lnVoT8klmsWr4GJEsb86h0a0NzPR1muRL8ntoGyniDRoafOkepCNmH4BulUgL+pUOfiMugSAJaqTe3qHbO/QduZyyl+L2Unz3L8W/0gX1UyCxE4EQirlMqGHg45IVHzlZyZPuyfdXS1ve2hCXi/ZQ2XRIQj2jLpzDOKOcYqxV4QLA+ccRfMmGs/nLoTakuZk6q1BHDm0BPset2I5qwDrEPMNuvuKQnADNXOp5ZAZcXgikw5HOjfc3uPGVSyuRnwSpEepQgxGyaqUqHV11QC+ktfEgTGY3RedCaNC4EagD4AZUUptFMj3Sc8ac+O2+gGoeV9cCOoXZMxn3BxVGfdNkry46TDvvN1THpML0NdQxm8XVZnGtbUi2WVwtXPzLs7h+sflAbD6QdZTYfCA2H4hl3V81H0iJD2t3MJkB8jvnw8s5Z7EvNToJudPIj33JyA9IWTEe2TGM6XhxHzmeNqevYsfoDVBjyck6XPZt25xXr7nkJVU25y+W73A8T/pmIpj68ydnqtP/kC6OcsElk3i9m4aeLJxdopWITFcheNEQ6jmwxiu1DiuE1ErSVT3t3bBKmi2xgKBlYkJ1lAc4yLRZ6jq3VPyVb5C0JUg6FWqjh2y6ubG4LHt5QmXm4QU02z9qvJR7HLTgBAYhbmCraJpXSNk6RGN1vDwgzaFZVzBXHYq5rGTk44BNgCox2w9CUPvQHdDx4Geh0588UbLXvdWTHaW2dfyj8OKezRz0k9zY2Fy2P/A91QrgW1qoNwMmE9qyWJqdcLpU4jGRvsO0Ci5XNeln6d3LLnEWXO8SuLbXaNW0iQ1fsBjQNcaCfPLzD1hw33G9LHUXBg+gNJHCU9u+VTJD7RoSh1rWmHkuIg7bwJeeiHjO4UhNEplnzDiU6aU9XSKspxyjH/SNQ3q25L1HvQYGaVl5MYY3NQobQNumZEg92LiP3LHG4dXTGqcJviI2TTxv0fgjcTzpvBzxKY/QIKfez7vqGVdQqqdsfxA3bsrsv+QOqY4WbZyWrtjQFcXBIQ0IQ4vI9VP/AE0N8VWRqftwaHoBreUI+LjqzzARNXlXqhybttiKL/OOfPa9eAvFfwwobt+Lt+/F2/fi7Xvxdew69r347/gJL/tevNXGrTb+bbTxHbHs2ffiv8Z78Zla2D3psfPBG/smhFUnd1Wd3BFOaN+EsG9C2Dch7JsQ9k2IzFKcBG4M+vw59BlX2wugA3m/TmWqHUmhzKUjbi843QtXl7FK4y4pjfj6hBlV4yWRbyGwhcAWAlsIbCGwhcAWAlsI/INAYAtMdxiY/paMKFMuBU7+ECHf1nfn50aa0rV6/RBzO1vmcIB+QS5+uDhPfXk0gYswiRq3/xQNxDvoeKfce4TwOjyq42o6OGdjPBXT9Eolf8UiH8HSWIsSZ+B3JpVS/ks4jffgc2dcg90ZLaS1SABqJ1UDrRhSV6HJocm7Bhv61xpdFx1sK3wODRGYQzZLqUL2+rwkqRVIs+opxIWbV53z8qTp89xRhWF3UpCPW0rpWe82D3bZL6rjhtGW2m/y2q3jOa5fD3b3Mfm7wAwOV5RehqpKgEkI1hF4HGVkpkq7UL05DplO14cvcjRUpaHSZCj5IRtewJJ8RA2l5wSLoU6z42tcr3qgqIZ6D8j1sqgGBcbn6YB0wpwxDWnJaMzd00qJlixxonxDyq4v/RBwmPwR2BZ6jii+hzEs37XHSz8dVebxIp0QJ+iOXCMQb1XyXZiz9HXLJe+a6chKWPMBCfAwGsqHGTCFfeDGsC+gcUSyoEWIsjueopT9u907h1WMEpmDSsRORNmkiTcOMQXR65zb//OMsMp7THMKGP23GJ8F2LsEsG2g3w9sASxsA4U1Mxxour2s+DEfF6HeY/ltkAKODS4CrJ5m9TSrp1k9zeppVk+zeprV06yeZvU0q6dZPc3qac+lp/2wetJ6dcIyrZ1jWjWSdG7+KBDNgMS69dDspXoH3TRq0DjWRsvVCWrDS+olUUcmlZUxSNUFqtIGv/3tzBpkrEHGGmSsQcYaZKxBxhpkrEHGGmSsQcbqNtYgYw0y1iBjDTKWaf3FBhm0qphWCZV4sIEhVQ2GzwNtZagxm9RGmvU2mLWGnK9rpPkQuHcOw0gYnYfXRs9a08yOmmZ2AgLY6FkbPWujZ230rI2etdGzuwr3C9GzbTiTbsT6JwOLTi06tejUolOLTi06tejUolOLTi06/dbotBc6I4tLLS61uNTiUotLLS61uNTiUotLLS79Jrg0V4T6yV5Im8C56MjHzaqmOuUQWK4Ru9RxfsuUPBnV04MMS4vY8ef4Ui+IuhCqHMKmjJF1SdSppbCIP8wnz0jDObTIEmpyCRnyx0klKeKZ6RDowLwRGepBvcrNtbpH/d4fum7GCbBGz5nV6VEWrxp2sb+S1rK0pPZC7lyctS+7795CkfZVu3vePjk/g7/PLi7eX5ydwl/dd1ft8+7pXnmjwmZuDiRpuI2LPrNRRK6wcqhKulc5y2YTcGC6R9cm7HCDMaDgBSTkyEdBQX6e82CGbuWvjv7Pr0WvahJPru9EixprbcqObH6uc2f6eg8V0T2NCgokHB8dVVCwyusu4neuUB5URkMvKhuS0uUSmFplW+Skv8JXC8MKfLG0+jM4APqOa/y8dmJg60QLDYeN0v+sKizGN9x3KkrTXIEuAGAPd+2n//3f+Ze3kTO/efyP//j0/1qfP2df/OdeRcOAqxO/StCkv50TZpUPp5mDOq7abonnneOjskveyxBxMoJJXPIjbGzYDKWeXlZtbFCM6s6d3Dj9KETVbJM3Q5U2NOCgYsUbVsRtT5FHW9VG7Om7f5KoK89H1cybNS6daMaXvGqyoSv2dm7UqfKbvrJaScvm8GAreW5yNrmZc1+dEtsfqX1+wcUcQLhEN4d7r46OCCfnRMOJg8+/gyoiEJtiLJ2Cs4TXpaN463ch+Zo8ufiXCbo0E/+8LprU4PblbaKHcBZFYVSi/GWZ8vfQssRPQahCmICeRzp84yRy4wXJ3hMOKkjUTnC3fSKI5/P4JgTK92Bj7RHDgZ/2tDHki6d4xOOe9gIX1FASeVBMG1acudskI0pmXSlr5fQL6ysdgnWwPGv3uySiNZUDnFQ5QSat6Rxhj3uKaxKXoULwjfzjjd4kv9/HNHo3mIZUXT/rIqnAbtcRqEJlhCpMr2uOaTfkB28OGTaE69FpmYb/N/sB1RKM9aJ+XjR//bV5pCWP7wSZ5pNuWSb3LGzGcRhNiqR+ybbm3gWHXcPvuHx3esLhVHopqFFWCfn05NTNHt+euXc8YEO9ukPjwe8YBCmaxlxi3TTUL2pbfFKHHwq/1lVxo6P5B3/98mXkCP4h8h4f8Ws4R5HcdqCNKqdkeo10xXA+au6KpgMeueOM+GgZjbccesn4cneSajmv92hzaf1pQ1r21fOqkwO9HPKE1iBJC4RgYdKiSU3njkAXsmHko0Cb/Lk9HvN5bFQscZ/cwX17drlHL4Kb56RwLkzgnScK1oxKXOKD1Y+PKY30gDUS+Pj4/wHFNfdh -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the launch identified by the given `launchId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-managed-identity.api.mdx b/platform-api-docs/docs/describe-managed-identity.api.mdx deleted file mode 100644 index 382e2b0e2..000000000 --- a/platform-api-docs/docs/describe-managed-identity.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-managed-identity -title: "Describe managed identity" -description: "Retrieves the details of the managed identity associated with the given `managedIdentityId`." -sidebar_label: "Describe managed identity" -hide_title: true -hide_table_of_contents: true -api: eJztXXtzGrmy/yoqb906dpWBvM7Wqfx1MXZyuGsSrnGydW5qKwgQMOt5sKMZ22zK3/12t6QZDTPAgJ3dhGirdteAHi2p1fp1q7v15SjhM3n0+tORNxFh4iWekEe/nR5NhBzH3iLxovDo9dGVSGJP3ArJkrlgE5Fwz5csmtLHgId8JiZMN7BkXMpo7PEEvrvzkjkVmnm3ImRDXbari3Ynw+bR6VG0EDHHrroT6Oycuh6JXrEslFvwmAciETES/OUohA9QvtQmlPSQ6gVP5kerQ+mtUhumgYi9sf5i6okYSYrFH6kXC6AniVNxeiTHcxHwo9dfjpLlAnv1wkTMRAxFp1Ec8ER99fOro4eH04y0KJ7l5PyRinhZoud9POOh9ycNfw0tu/T9G5IuF1EoYR2hxotnz/B/K33+AlXHEbQSJvgrXyx8b0wktH6XWORLudNo9LsYJ7gKMa4XMQr86k3qELbXKjyc6nnM2pfAhuGs1No7KGW4cRwL4rxVrqTmFj5PkLLtTf6732GmNMOiVB/mbOrNtk/KXRTfnHvx9m5+hYJsAow2TqJ4yZBjGXTJJHyE8gwnNA7EBHcTw1anfnTHpp4vpBpQLK7ScEAtbu+tPZkwztQ3MFk8YeJejNME9rUX0uyF04bP03A8N6UWsQfkJBEUuI1ukKR34j4hKmDIYyGBz5psIAT71I8F4+GELSKZNOI01E3I347nSbKQr1utSTSWTSn+gN3e9KKWmd/G2I/SSUt13OKTWx6OxeQnGFsD2muY9hq6vRM1cvj2aYbOpzDHjPt+xdDYnN8CT0XBwge5M/lbRirCWy+OwkBvVj1OHsccpYmXiEBu58h6G+ki74rd8tjjIx94AqoSIbfcT/dthOpSK3PBbZExiiJf8LC8YCCTlrBSnswbATZEJs2WCZtiv0cjvTeDBaznEzWtW8PWcac92CfCJzWbZkJOix9BAoO88ZGADokLmI+Puhukc/tkSaRGisRsSkOLxQhKOGpiO6tSaf0e8PBP7tvjxLqpOn6xXzwLlprPV0qR3NmXxw2xDdVWA9tS/D3xkMjACzkIve2j6NtSmRUqs2MQ/pNGFPrLU5rAEZdwBMDAMlEuhQ/bA1o6Uac8n7yH0uqUf6giRm+j5Tt1ohd/PwXwsVgglVAyiPioUThhNBv04IfiREPF1e0K8uf9lGDNEx0t2eLdFc+YSDOVn0qQe/+QTM45sDUtLpNL+DJosh78yEYo5RgfychH9qPDCcUeHLF0qHLAgAEWJCFJU38XgzxifIzS0x1QP8gBdSBySJWstbfOs910NxexdWzA3Mgn2j2sO2VR4CWwqqegck156id0Mgy1CBgS1akU8btah/sHKIknFQHMweDfOJuhEobYLCJeOlDDaKJPaljtek3/G0pS09Byt8/4ZAJKCCmI5VYXUZxsVRlevij1gRRj3SY7V5Pxmg1fvBhmmOJ/U1EHnVzPFaIx+sIfWG1FKLIUjw2YEy1qCshAbUtozEYde3Re2TH0eTf3oMuFtxC+FyoAwkBAM5mOFDc0WQcYC9gruhVx7E2Am9hoSc1ktQrbiQgN+D0ROfD+FPtM/zVp+vdekAaorI2AWBgEUZdvT6BLkWnwlBqkhFp+wkMRpRI3db6Az589y1fwf6LRe+pO7iRDdI+RqkrcvR4l4mHKZ6BN/Xtdh+tQI2xHMgWwYZHWIa0O7GYlszzFOTYFjWzpKmClAQntEYyUj5O3sKJakKIhoXj47wiVDHZReBKBTwFPammaQZYSHnK6x0HpHvDPb9AYv5ONEU/Gcxujtn8dsDP8citQLa4tGir4TFxToarVAegwRoNMxlIo6WLRndQsfgvHZyBkDe7TrZRVrLMB063gVAdRCsxxrMQdiKAWHnMtPJ5ft9AmxkF+xvR5uJd+8vhNF4uZp4xwW2QgrJkqq2EIHLpRGgN6YHceoMVRbg07Fs1ZE0RXKhuCA4Z7rse22/FlM4kajZLvKHIB+YSIvjXTQlXki3DnlvMWz6/aby/eZVYvg+K7PiwlLIb+vS4OlOkC0YOYfJbRNLkDmd1SFLbwGL31xN2JRXY3lAnixfV8XeCwzgtQP1QNpZZW0Z8twvR588W9z+OZKK4CnClXkV+jPyzF2lfvkMVmMQd2ngLTNuBP+N+Edds9BiwYeFLSiQil1skWkPAGztTrGtuOTfc4yovOgCVc3qzgoh0QWdXarxe1+vD9WhO1Qcb7Xh8vFLYbKBDp66ZwbJ3LruIO31faTWbW0cKGml+r1zsl+odQojVfdxap3Aeev8sgeaf/QeI4IzpHN/O07rQnAtBle6N9OlZ1TYfI3mv37ynyXyBmfLRM9P2Fw5eHhC9BisFGugjxY515UCXZp1/V9tPicP0Gw9ZPbPVxCmqXUArkNEUZ/mL3zt9QRdv8ubZ/1QdQcKXmS7IVytfQFt4CxwwUUt6ZwHcfeyJHFxpvWySU6VfWrGj2No7SxXae7qC0+pUO4MtoJuGghGq0i7OBMWhNHpKtT63kIOQLOY+SOur/CrtkVbcwS2uWehPRkqb4yfaVgwHNRPnSXkGkN/jjygxqy0eTfbLK1J0zLQwaIIllK1MNf6L/NoiUhlXECL8TxtMkgnNBu4SUNQOrMJ2iIGw0visSb0QPMRzof360LOIPbdKSza26aLIGrIswDVCyDfrvr+EjoHX477oPJd+Xrg3sm2wIhYaaUMnSkG7o4xRKI3tEYWMiAhyvrRPA0gyxi7xesdZgESV5YXYM4xa4+2SiuBXUnX1xQc8LyWRHqACm69ZDnkO/iM13iwG/37tLbSXctcvZIt1ZOL7tf7BmmRDFSLaBNQdj7tc5LzOrXkaoRLM92gyQwxvifgGrSX1NPNByNoyBvYNVxB+4WlXyfVqzxz1Lv3yMbaMTBQFvSIGeUYj2fE8mCAIRjt2JIhcSA6tJIrQ2SLDObLlpy5xdDK4/v+ni5jB/fu5fvX97dTEYdD9e6K3zudPutzvd6/98ft+/7va6/3dxbn7pX3U7F9W/f59tl+TDOTqkBSih2BzklZKCyvAji1IAj7oxrPCSRWlCAjHTmQvIoYriIcnHXLzkjeKn4UaaVd2ikFFcGACUWGeJK7BZCrgjYO1el3XPcRipVHq6OnFRYK/IO+sKDM+GSy9M7xsv0FrQwOMq8P5EgYD9Kz0tECKRha1ljFn/kNSvXIixN9VeasXLMazl41GUIJKAfQxN3wIao7NR3fK0A/4nfCp2j80qmFPsEcSzpCsgpRksxnWm6GO/g3OD7YUiQW0eSlEDMh3BN4/Z5Zd6V2MfujVS1mWEw6apz2mfxrBSggMTRjDy+JRpdYyOHKiqaAK+i71kSRDxKUgzDWr02D0nCicC7S2okgsqNYWT/g518DglNxdceQSZceTTKMxK4GUhyGU+hQVXmEje99Buu30d3gzuaREuycysrb2LyNOHDDRU70pzpR1LgOdKIzS273XahuYlNInnzNszY35eRFK8D89BpiRFw/DWU22CdRQ8s4zDcxFW4jRge1VBcb4Yv/hFLPu8zo04rt6NQA9GL84umC0/EDqQztLxzdPsBJ6rFYOXbKTa1f15WuddhzMAIZzB8Xez79Ll9wmrS6Ugf30Qc3ye3XecMI1oyoCBHd8+Vzhw5E36ApYQtLLZXqQbaGbgwSL2xnQZzYvHwynjMJtoG9WdGTmaH0CqqrL18KQIMpqriJauI8KITgR1ZEDnsDE9X4n8NI6R/yTWUg0DK44E4n/8Xct+uj+F9c/JWrlK/i+lboup7NC9xy47Rd2USBDed+zizaCE2KDROsfAxT1wKJ2HxTZAIppmagqy1QYsSYYsZxkd8muL3a0fT36JwnQZi6p24NWZOo0ukKW+AlklLeEsipJ9RQDWVfoASQAkOWv/1BIIYizrGko0xCoqx8aUipcsOB5Y/ywEQjmpjJa57t1k7cVChJPc6jtsiWTcAirw36Zqe6i4CogkkGA8T8g/h7V9+BvZlyyIVDDgSzw7YJNhHQ6f/SnsYKQPCxbNEhVaEVl18gEUBriywPwO/iWkBrQGLQXaoGpLobvWRNyCTIDtr4wqMKYGNartO815EvjavsNj4+RRf09cpWHZ/ooeOm9Ua5Y9TCJbjTeb4QiZFwRhrmTizAUw434zaxzmO6xQIFEMYEMEGPLG9akaBz+/2nnTt696P79ix29jfuslUWjvDWs8iqzTVRPnqaKmWq3d5/K0u/XitOgoQ6yWecgoa9nkyoCbXW4RchDRt+xI+hJ+NQDKgCdzow4bz2b93PP4pGxS1xf6+SXfafkr9MyYRdHMF0qo2c4Zb+l7RobaHf0z/nLnBXdXefh3lZvuqg/kgsBdTLqLycO/mAR2Rcatg84LZ5CuZ5Saug5rhTa055rlmYZKXcx945sG2K8G4xfaxCoEm/Thsb6PBode1rrYY92pF4OuSS3q1ri/mPORSLwxCCu0tGtTGkHB9niMCtpFwD1/O9UDVQktFqTWCaxG4Ad9kpQdQ51xBXvtTsCqx9Eyq3GVmYLweQPbmPB4Qk6AhSngZhJWvNlsc2htmzGoctpooMy8ZAtUqoVgOuIbPllYGQ8d7SgFAMuocpkS9LHXZJ8+jGC6UnZ5Pcg3A8n2pgJPpDhoOUK7pEW9y1YkGzpu/aeU2vgMa33CNPss0pGP0cdUVrvba52yiQgPL5oaQm1hW9XjoKoKsWCXgsc0uI+9DXRNoGjD10Ubt4FN4E8Yq/ZZm62BMPyoZ470gM6H8/bKDMGy6FtY5EiQrgqxIcnvjZH7FA5NlBKN6A6v4MZKy9TjNF6i/BbmhYQOaXjTNEnJmxRIleLRikaRh5/mlg8qJOegf6MC/3YvvyWsaRh0lKnzhtc6+iS6CGdemLtfNNlwMck20DDbGLiL0lBZuwv76J/P2NszYy20t9HfqLYoUfmEagv/E9ilrLW08evvQ2nZ3/lyO+53YNKByR8CTG7T/HYGMEqAfOwpI6tBMAMtfT+fv5Cfb19qsLgOgtJPSgjWdIdTvZpKljfcx55xgaPr3VqXwl6cpAAWdZW8VQ2cZTrKitcykRNtdi3TUjkJztbGMB60waX0ZmFFvpQSrSs9dHwP/qjTTynXy5iqGls/QJg5/jDOYxX9aIaJUeSCj2tBzctoxtpwHi6hFUl2Q6pqegii0FP5VEzr17gp6t0Da7t8kglSxEiFDpXlkye8E/k6ucBFOKGLmu3Nn0M92FqmIhO6pvKuMF6XxdavUr/WtKy2jZfuZk6gaQacnZhJeQQeKR5TN6LCoWj90WNbdnt80bwA9Wz5eUA/NtX/PpevgR+Ha4ynegHZVHxJJtkbUZnTQesNb3+5yG5QdsjwoBv5JR2RSwaOowBWDhAoOcvvIVh+0dghanBagbOVfw/0C5rUh6vL7CQ3BC5hLzdu/iUbGImJirI+06X0OyKuMaGDwSUb464g/zCCgtapIky0lUl2kCWls6lUmzhLOkYHyE7jzGqRfM1ydeVhcRZq0urh0Ia9g4Idaaeu5Yo1yXLQq4hBL6QWWEsVIvOnJUmvgAHqRmwi8+p9Xp40s587ujBwJ7m6lu+O6zm4A5f9pDtuWG1pflOxFR2fe0E9cNBHc43ENHofScWnqgol0O08l7gdlUeoanwNc5wyvScSdP1u6EpD7UdJ7jpseAVL8iumCAFEtRwaK2FgEmvoHsi9pF6kYk+5lGC8oraELLIBGaPFmIa0ZjQ297QyopVInHRQIVGIe2XWogk0Sz+C2PK98VLLPbxu1/KNoGDuhxyFn2VK46WD9I4v8Y9Q3JKpZ9Ovv52WJuG+gc02QHOkPbutfUsd7Gej6hPdZqPA94OFGD/SywPmLAujXhNAZ6y4sOYDOsCjeKg8gNFXEmAu8AU0jqkkAETafriov3sTpill/2n3LmEV43RMtj5Qy2Iyx5JsHKLD1euhbd5+mhFWOR0aSQGj/zvG52wzh2Wb+VpxtLWi0v+iQNpyHO1B3LqvsIHGmjkOtNW1DT/+9g3kzXEGZSe0dhBaNUynde/YMU+XbZXQV+ANDANp0HW2SmZBv9ZDuatN0tjqGKO3msofdMLqijsnm8LKG6jqApYbXSnHkbbZmAgtBTu+cYNLZpbazREiO0OO1Xyd0GGiRk4529a7XWwSXeigX2M3fZCrMa1PdGm74ndNjtaFEK5ih+NF2rdtd/XnT80UQIBscbQNnFwq9vC/qCSy0ivjlV6HJ/LNkXJ+zgFa1Akb0pdFGLozoTo6KHuUzmZZNJucd4Ni+Mk6TSDzllZuDCYqSDWt7NrYdA/A/j7McI6VmY8+4ez4WeOl4vEkjlLMoTwHVjE0j6PF8hFEY3XUHfK066AO92PvFoBhW6W6rLkpFqqSlSMTmACt1Ow4jBgcApih04efpUlJOhL+Dk4AW+On1sULq44y0Id/qC2QRY01nYn3xzDxOgXqu1WgYBhTeY2J5Wqw6Ls3A6a0KJZQFfXwhEoGbux7us2aIWvYZJDbFMtRak5vOSy9xTnCVNEmd7w2GVB465LC5KvcgrN02hjPj6dJWOWjaFwOk8icNXbqyVgAGwQqOBD3OWypSWpcDjImzxK6k7tKDf+Wfifzbcn2lspQUK+BQVZW3ZpYvtvQtn0yZEFlIkDpWGPzmmlNsqTbMZumvr9s/JFyX8UTx2IqYhGaIOhPH3uW67Puqbajsa7YMBXlySkNCLN9UDSm+QGaGuJV1tS7P7Uv67ZKBJgH+SNMRE3ZtYsjB6a2KruoYnrO78FB9YnSJ6yD/2tzKGzK17RHmmKVMPZFhQa8mph4N0/BcgJe027ysonPZ6XBV411QAtZ3eQ45dw1hpBP2lU/wLstlaEWGt07kRt9/ZN222uouOqGtmA0aGjwpXeSO7GT2Yaax35VJv2RUAkXCHsj9dtMRE5FPHwV8UCUJaeNOG3k8LWRr5QI9jERYTyGQygRyjXDykNRypaHkqyUsf7REWRrW9474VXhWaV10ZuPzDlTwDijwkWISTmzAnBU8Nlwtng5XAlBQ3dpjToKaKsfR8iK7bjmReOwW6w4pGT7pgeVucZGZhG+DYx0cPWIwN0cGV/7POkouizZkwldVGGKWeoUSikIvZAnjwijdDZfTeIPDVqaaB0Ap/RQ4xyf52vx+ViQvD2WUM0XOv2ecYZ9oiR6g4rkeXZqPKMiW/nUDil+UPopnN5VXvYD/MU9neiQtEPS3zSSdk8nuqcT3dOJ7ulE93SiezrxMK0L6ulEDFKrwqkukNMBz+8LeLpAThfIuS9JLpDTBXK6QE4XyOkCOR3edoGczg/5KwZygghPuBdXKl1t+on1zwbuhsApaoeqqB2EQHA3BO6GwN0QuBsCd0PgbggOVWNRNwS+nFaC1e5Zj10O3jik6pCqQ6oOqTqk6pCqQ6oOqX4nSDUNveRNFF9Cn0m1QzN0oMymVKZiHlWZay5vrgTZ/KrLOEx8eJhYvQ9TSselHjOgr523jIO23zK0rR3qrN8OKbw6h3HNqRzm2XX6sFW3t6XyLy2g7JazDN8AwyZX8mjZAsG8Mp8xNIWPlC/0i48521AcnRNYvgubhcdvi6+QmZfU1WSspJFikxRHW3mBTBW1v8BmAXAbXC/rxIVnL8hgsUJcUj675atnm3Bd1wYr+QM0r+gBGnVcBJ0V15o9bio/9jIpYNP36xygHc6xhAnGyQNZrt+iO1WSPcYVlpjAgyqXARq2nIFK5aIAfIVAbRZHd+pN55W35OB/KlTuGWo3IUvDLC4eSw7w9/oBeFilYeg3/GwNkoKiPAnbT7wPz4VyHKnRPBU1LRmmosER0et8FWDOJkLJE3Wc6vjGKzHrTh6XYcFESqIUgFKFh3RWwd6fRPfKi9ZJdCPCc3MWbldCzRbVmsygPWDUhB2zZSRHAXS/0C4+aiYwt8j7sJN57ZSlQ7vAIBN75pV6MlXPoHzDfj/oULDq96MGghK0NP5t2Gr9hCALVsxIdYiuA72HBHpdIPp+78N9J/bBHd5BC1OfnlVVsKvKlKIeyeXsU+n5NfVI2n7JX3J9K0v/Yto9YTxJ+HiemydstINC8DTDSdl8ltywo0ItBA+DLGHgvkHANDQzjspgYBUN3om+iwCL2vm6Ve7FzJyotQfF0tkjxCxPoiTZJ3xqNmawSRfsFUPL815soko19Hc/KbTQwPRQ9vcN63DaniD6CXLbaxs3Pl53JdCBGcasD+sdrHOIvmPM/MQBgVHiXrLPadCnD+YX/2ITAAq4yGqfZM7dYyCzlcosBeb2/OzuDD+kM3xPISZuquPD2pR8i138MnCvBTqz2Q9jNnNBZi7IbF+SXJCZCzJzQWYuyMwFmTmU74LMysLYBZm51wLda4E/pNB6wtcCc7MizcCurwJidduoYV4G3PLqX52nA7/my4C+N4WhePjcgbTNNPodNfyZmd+/dRvLupWGn/Cxx13ush82PTe4XUyJAEY1qnQKeNjn8b+HjW/gPWx+2u5h00t1ZGXe4eW5h41PyD3Uew/u4Qmec3ua82BH0LMfYKknpza8V/Ww6eUpd6od2KmGTaWz6ou/DyFsLYYe0eatIxdF5WzmB2ozPwjdzEVRuSgqF0XloqhcFJWL9z9cxPoboVZQslccNdAqcrZHWJO+JrtergttKIVxoKCL175QVyquLuke495+cTbQV33Ka4quBI+VtMNbPTzlWng6v25l/qD0WV/SfzPmkfWGMI1C8ogVen4GTgjjTr/uycLdTi+bSdRolHhHiWuu9bKHiSbIF+HOLectnl+13168yx+E1Viw68NSwmLo3+vCwMwt8bOMpskdiOyWorCFp+itJ+5OLLK7j3zKsYr+bBGmz5sv7n00IRRXAY6Uq8iv0R+WoveEgMVmMQd2nuL7iLNYPcDYbfdWXxdaJ1pAwBs0U69rbDs23aunMQcs4fJmBRbtAMiq1n7rPdTXmqgNIt736vkcYKnMURkfa73sKu7wfaXceCbGRwubR3qoOh36EHTor3Wru5Gn/9pL3dPyra6Dl4cEL10U0ZooolvgGB1tsjOB7z72RI4uMre0jIQy/cqY9XWe0DwQU59ayUHIF3IeJXW0/xV2yapuYZbWLPUmoiVN8ZPtK7dznLs2fDTZJ6vM3k9wqxgs+m+DSKmMqjGR10JmOKeoGdgOcHiKolOPwndF4o3oIYYD/c+PlkX8oS1acnuEfbIGrBsXy0H//TV8BLQO/1334bcS4rWBfZMNodBQEypZGlLQTpyqa2QWhY2JCHC8hXdhoRp2kdcr1hosovxJd9ATfHSRpXgeHb7nhfvigp4XksWOUEH2HikG7a0NNDfWwr271EbCXbt89Bu5ClGMZHuHUP/MqJcRKtFqjzYDCv8X9wvMnIB90dO1G8bA3kUJ/cDVqpIj5po97ln65eNC94MAo9/IzRum2PdkQtGZ6E8tJqykmeqHkBGtDRKsM1tu2jJnF4Prz2+6uDnMn5/7V+/fXl0MBt2PF3rrfO60++1O9/o/n9/3r7u97v9dnJtf+lfdzkX1799n2yX5cC4wag8lFJuDvFJSUBl+ZPl16DGs8JJFaUIC0Y4CyJFDFcVDko+5eMkbJd/hjTSrukUho7gQnUPqPDWsXZ7bvS5G/1rBF+rERYG9Iu+sGzA8Gy69ML1vvEBrQQOPq8D7EwUC9q/0tEAInQjEbC1jzPqHpH71E8tKxyjejWEtH4+iBJEE7GNo+hbd/PMEEyaYrdA9NqtgTrFHaZ6cVprBYlxnij72O+YpZv30MZRS/uX0/PJjdvml3tXYh26NlHUZ4bBp6nPapzGslODAhBGMPD5lWh2jIweqap/3J3oG2pAmK56DjvDWEi+jQCUXVGoKJ/0d6uBxSola7AejcRRmJfCuEOQyesSPFSaS92u8alYJejO4p0W4JDOztvYuIk8fMtBQvRvNlXYsAZ4rjdDYvrdpG5rH19H14+j7ZpjJTjWd30NZijPjMGaZqZFhZu+n5Yuvymcnzt1ZOr55mp2Q+56xwUs2Uu3q/jyt867DGfimPRx/N3s/ap/dJ6wulYL89UHM8Xl233HCNKIpAwZ2fPtc4cCRN+kLWELQymZ7kW6gmYEHixjjUiibQ+F4OMVIKI62Ud2ZkaP5AaSqKlsPT4ogo7mKaOk6IozoRFBHBnQOG9PzlchP45gCZbCWahhYcSQojwP8rmU/XZ/C+udkrdwk/5cOeJnKDt177LJTTAawUNyxizeDEmKDRuscAxf3wKF0HhbbAIlomqkpyFYbsCQZspxldMivLXa3fjz5JYrJ/2BR1Q68OlOn0QWy1Fcgq6QlnEVRsq8IwLpKHyAJgCRn7Z9aAkGMZV1DycaoMrxkwfFgKGMMpw+c5DJLeZLp3k3WXixEOMmtvsOWSMYtoAL/baq2h4qrgEgCCZkbPLrnsLYPf6voPNiBVDDglA4MNhnW4fDZn8IORvqwYNEsUaEVkVUnH0BhgCsLzO/gX0JqGCPdUqANqrYUumtNxC3IBNj+yqgCY2pQo9q+05wnga/tOzw2Ph7198RVGlZEIsEyvFGtWfYwHdK30ZijcszYgjBXMnHmMKzVb2aNw3yHFQokigFsiABD3rg+VePg51c7b/r2Ve/nV+z4bcxvvSQK7b1hjUeRdbpq4lR599aotftcnna3XpwW/WRWMs+RiWpyZcDNLrcI1Q7s+hJ+hTUy8GQlqLNZ/5j896LQX1bEedVMxVH0xiCz7LceyfFEsG6dGWMttttkR9rDfUJdZNuq+jqHCe+RjgGm3eRlEzP9pJgJoqDMcuPquVLRVklr6+0U71RTaS/r1IaQTyqLVSPAiGR1cw6N7m1gpq+zJF9K3kPbSJFo0NDgS+8kGzH7AHTrRFrQr3LwGwkFBOmgRurdHbq7Qz+Qyyl3Ke4uxQ//UvwrXVA/BhLzGA6hRKiEGhY+LlnxUZKVPOkefX+1tuW9DXGFaA+dTYdOqCfUhQsYZ1RQjI0qvAJw/vkMvmTD2eLl0BjSvFyd1aijgLYAnyMrtuMasA4xz7BbrDgkJ0A7l3oRmYGUlxLp4Mq58W6OjK9dWon8NMyMUKcGjJBVK1Pp6KoDeiGtTYRROpuvOhdCg9aNQB0AN6CSxiyS65E+HwuSt8cSqvlCXwuYFGZPZNwfVBj1bZO9vuiw7bx/ozqmFKavoY65LK4ui2ttQ7LL4urg4l+exfWLywfi8oFso8TlA3H5QJzo/qr5QEpy2LiDqQyQ37gcXi85V/vSo1OQO4v8OFaC/ISUFeuRHcuYjhf3MfeNOX2TOEZvgBpLTtbhsm/b7rJ6yyUvqbIFf7Fih+NF2rcTwdSfPzVTnf6HbHG0Cy6ZxOvdNPRU4fwSrURktgrh84bUz4E1Xul12HBIbSRd1zPeDZtOszUWELRMTKiO9gCHM22Wuc6tPf7KN0jGEqScCo3RQzXd3Pm4LHt5QmXm4wU0O37WeKl4HLTgFAYh58AqhuYNp2wdorE6Xh6Q5tCsezBXbYqFqmTl4wAmQJWYHYcRqH3oDsh9+Fma9CePPNnr3uqpjjLbOv6x8uKeyxz0g9zYuFy23/E91QbgW1qoNwOmEtqyRJmdcLp04jGZvcO0CS5XNRnk6d3LLnEOXB8SuHbXaNW0yR1fsBjQNcaSfPKLD1iIgHt+nroLgwfwNFGHp7F962SGxjUkicxZY+e5iAWwQaA8EXGfw5aapCrPmLUps0t7ukTYTjlGP5gbh2xvqXuPeg0MsrLqYgxvajQ2gLbtkyHzYBMBSscam9dMa5Il+IrZNPX9ZeOPlPvKeTkWUxGjQU6/n/exZ11B6Z5y/iBp3FTZf8kdUm8tYpyWqdgwFeXJKQ0IQ4vI9dP8AE0N8VWRqXd/ansBbZUI+LjqjzARNWVXphzbttiKL4uOfO69eAfFvw8o7t6Ld+/Fu/fi3Xvxdew67r34b/gJL/devNPGnTb+92jjB2LZc+/Ff4334nO1sHvWY5eDN+5NCKdOHqo6eSCS0L0J4d6EcG9CuDch3JsQuaU4Db0E9PlL6DOpthdAB+p+ncpUO5JCmWsub64E3QtXl3FK4yEpjfj6hB1V46dx4CCwg8AOAjsI7CCwg8AOAjsI/J1AYAdMDxiY/pKOKFMuBU5+FyHfznfnx0aayrV6+xALnK1yOEC/cC5+uLrMfHkMgcsojRs3/5INxDvoeKfde6T0OyKu42o6uGRj3BXT7EqleMWiHsEyWIsSZ+B3NpXq/FdwGu/BF3xcQ9xZLWS16AA0TqoWWrFOXY0mh7bsGuzoX2t1vepgW+FzaB2BBWSzlioUr09Lkl6BLKueRlzIvHqflyfN7OeOLgzcSUE+XimlZ73bPOCyn3THDastzW/q2q3jcy+oB7v7mPxdYgaHj5RehqoqgEkIlkvcjioyU6ddqGaOU2bS9eGLHA1daag1GUp+yIZXsCS/oobS4+FyaNLsBAbX6x4oqqHeA3K9PKpBg/FFNiCTMGdMQ1ozGpt7WhnRSiROtG9I2fWlHwEOUz+C2ELPES33MIblm/Z46Wejyj1elBPiBN2RawTibUq+C3OWvW655l0zE1kJaz6gAzyKh+phBkxhH3oJ8AU0jkgWtAhZdsfTlLL/tHuXsIpxqnJQyYTHlE2aZOMQUxC9Lrj9P80Iq7zHjKSA0f8d43MA+5AAtgv0+44tgCtsoLFmjgNtt5cNPxbjIvR7LL8MMsCxw0WA09Ocnub0NKenOT3N6WlOT3N6mtPTnJ7m9DSnpzk97an0tO9WT9quTjihdXBCq0aSzt0fBaIZUFi3Hpq91u+g20YNGsfWaLk6QW14Sb0m6simsjIGqbpAVdrgt79cOIOMM8g4g4wzyDiDjDPIOIOMM8g4g4wzyDjdxhlknEHGGWScQcYJrb/YIINWFdsqoRMPNjCkqsHweaC9DDV2k8ZIs90Gs9WQ83WNNB9C75YzjIQxeXhd9KwzzRyoaeYgIICLnnXRsy561kXPuuhZFz17qHB/JXq2DXvSi1n/bODQqUOnDp06dOrQqUOnDp06dOrQqUOnfzc67UV85HCpw6UOlzpc6nCpw6UOlzpc6nCpw6V/Cy4tFKF+NLeV/HLNOSrpdVVvXBIqFvd26Em0XvEJnyshF7BBVM+nR6+ePSv7sZ5xfJoVxIREvkE/d81qtJeUE1frd6m8NuR4LgKOf9kTEsBRA91aXqpr+NAULLuGWCO5iOMoLlH+skz5e2hZoZUw0u7FQM8DuXuOUzjJl4TmzwSIh7idoi/xJ5r+QCTzCCg/wlfMgUZyMz5q6ZeEgNbWl5W3kLqTh8xdS1KraexDHYOA+MJrqhdrMxhUPj7pF2ZWlXWwPGv3u0dIkyF5gDOsZssmPJsw7BFJoWLI5lQIvlF/vDFnyO93CU2FF04jqm7yrysqsNttBGqfVqkL0zNYY2KN4uDtIdNz0nSETaP/zn9A+YFO2dTP8+bPPzefGYQOM52LqKNzomiEJ13x2ahVar/krHp0JYCLxK1Qb0RORAI0SAMvSu9PcSmjsUfukFkMxcy7hTN8WFr1ofViZwLSAbGtRy5BNAVfNO98Osp5Byq8LrWDWwPBHBb98mXEpfgQ+w8P+DXsvFgxKpwt2sWI3hbbMOD38YyH3p+a+dNAxCAcFAlTD+M/1hB9I5a4OeMZUJRJ9CPiPyMLd6TkWD+VNjlhvdWJ3oEwc6yFS5suQ3B5OlG9p7MEw3iAYFWuDbh9kVgtlERYYfe/vbg+oic/7f21sp9se0CROlhGKnGNL1I+PGTE0guVSODDw/8Dxz+f6A== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the managed identity associated with the given `managedIdentityId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-organization-quotas.api.mdx b/platform-api-docs/docs/describe-organization-quotas.api.mdx deleted file mode 100644 index 6e3430aad..000000000 --- a/platform-api-docs/docs/describe-organization-quotas.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-organization-quotas -title: "Describe organization quotas" -description: "Retrieves the details of the organization quotas identified by the given `orgId`." -sidebar_label: "Describe organization quotas" -hide_title: true -hide_table_of_contents: true -api: eJy1Vk1z2zYQ/SsYntoZjeS0GR90qp04iaft1LWd5ODxTFbkSoQNAhSwVKJy+N+7C5IWLam1lE5P/MDbxdsPvEWdECxCMr1LnOfn/SjJMKRel6SdTabJNZLXuMKgKEeVIYE2Qbl5/GQTsPovEKxaVo4gKJ2hJT3XmKnZOqIWeoVWfWHwZfZlnIwSV6KPNpcZ7/A27jfDPwbO/oy+GFqChwIJvVCsE8sfbBJd8aoWhiVQnmzTHjpTtirQ63RDzTPe47LSHpkB+QpHSUhzLCCZ1gmtS9lEW8JFhM6dL4DaX6evk6YZPTHRNjVVhj2XZYV+vUsmvoBRRgeS3MVUKXHBaXVq42SHBHgP4lATFmHw380eMCWm0txLKKF0NmAE/HRyIo8tBr+yj9RxRJZkFcrS6DRmZ/IQBFLv7t3twUXwUjHS7QZtnV/GFfDts/OPoYQUw0F5HYnN71jMYrkPNbhFKI6AX+kSjbYYrtA/8TvCHDjAVJdg6Ts9vAVOH36v9SfODVdNrDtHh9teV/aIRDH6A/er44Y+2OY3mKH5D3m5oSrTLvDWVtvF4bY3uGRJeeOKsiLsHhd2dUS07ypJ623uXbXI2fx8TQd2LduTJoNbqtNJ2HD5n5XuujvBcqDZ4PW+M3wOmRLRwkDHHOaNzt0lrDcBFigq/8LZ7YCb+AOPAa7IMJwL753fYf7zHvXp9V5ZRwqMcV+Zj8ADppXXtI7ifo7g0Z9VLOfTu3sRNlb+3MmMWGDkKEo/TSYyqSZ1HALNZNmPioB+1c+JyhsG5kRlmE4mUOpxalyVjUPsk7F2OxrddpC6MkBSYPVG8Ors6jIRIj3PG0lrm6Ih26csyY69jMv3LIL4T/vyrm+dh68U49d27qJ5l9KOhWz7EkEJV7OydmDpB0hjPzwPfhgyt4Q2sXPn7pfNAhNZtbLCa6/Gp6fjE/lXukAFxHbqpl3fwPsG/zbhetOi/8sloss44TealAZ4/DLlGHrdNUp3pRkl0/6+0DHlguYcmyDqesYa+tGbppHf7fyWDsp0gJmRYzMHE/Bfgjt8uu+l/IjrZ/eIFZhKULHvVuC10DiS0g/X3aH/Ub18EdrLqr9+2PWQUs+2zWdzz8AcIWM3wq9dO0tTLGlgtSNPz072+4tbxsLzY7R1bKL3vYy4fBFx6x7Rcgl7giTfQrBp/ga+7cUN -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the organization quotas identified by the given `orgId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-organization-team.api.mdx b/platform-api-docs/docs/describe-organization-team.api.mdx deleted file mode 100644 index e8a557504..000000000 --- a/platform-api-docs/docs/describe-organization-team.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-organization-team -title: "Describe team" -description: "Retrieves the details of the team identified by the given `teamId`." -sidebar_label: "Describe team" -hide_title: true -hide_table_of_contents: true -api: eJytVU1v2zAM/SuGThsQxN1W9JDT0o8NxQ4r2u4UBChtM45a23IlOl1m+L+PlO18r+2KnmyRT9Ij+UjViiB1ajRRhJA7NR2oBF1sdUnaFGqkrpGsxgW6gOYYJEigMxeYmV/KnkAnWJCeaUyCaOnNqV5gEdyJ9zK5G6qBMiVakBMvEz7z3N8Q4U+bQqH/eMctgxlYgoUcCa1wqlXBC95gbMobB0oLoxJornZpbh4VFFWOVsdrZpbxFh8rbZHvJ1vhQLl4jjmoUa1oWcoluiBMPXRmbA7Umk6OVdMMVkzamJ6lIpG8P4WpbHelKRw62fH56Eg+O1n4wVtjw6cUJF4oy0zHPinhvRNIvX+pie4xJsm9lTKRbi+QSF+Hkpq+IoRBl8MV1LGyilQcW1Ec8MMCCOwvmx305phHLJgzU7VRv6KeijRl2BXrPDons2XtBSre6y7rDBDI8aG8n0ISSHHR0f8UYK2HCQfhHKQoDfh8xnvgfiY2Ariw1tg95l8OKKZvzKAwFECWmSfmI3CHcWU1LX0fniJYtOOK5T6aTEWM3KRzI82couconTBSIXeqC2vfr03oR0pYtxpplJxpF31rV1JNNScq3SgModTDODNVMnT4yJSG2uw11o33BFcZkFQ0OBN8ML66VEKo53sj6W1Ttcl6lS25UXW9J+vIg9jS/nzrtXL/RD4PupgZv71LbcdCrn2JoISrYx6dLVh0AbHXxXbwmyGzNHTmpTozX9cOJiKZa+/5NDw5GR6JrTSOcvCy6gZUL10/m3cZ1mttvtNg75JK+JvCMgOeisyqahu11cREprdj6Kif4u1Lw4ZueHDx5hyHQOs6Aofc6E0jZu4oKwLk3wVYDZFUgLWTaCf/LL8ZZA6fifLDdddjH4OXn4iDwXRGKJZKWGSVrPj3AZerl0keiDdx+vdb8QYuXTqbKSPnCAmfI8lqneM4xpI2tu2Npq2u/n5xy1jYbp2dVvGnH6TEZfSIW/OARdOsGcpaCDbNX1su58k= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the team identified by the given `teamId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-organization.api.mdx b/platform-api-docs/docs/describe-organization.api.mdx deleted file mode 100644 index 3bb5f9a4f..000000000 --- a/platform-api-docs/docs/describe-organization.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-organization -title: "Describe organization" -description: "Retrieves the details of the organization identified by the given `orgId`." -sidebar_label: "Describe organization" -hide_title: true -hide_table_of_contents: true -api: eJytVU1v2zAM/SuGThuQJt1W9JDT2rUbigFb0XanIkBpm0nUypIryUkzw/99pOwkduJ+AbvEtvgkPjLvUaXwMHNifCuMpedkIFJ0iZW5l0aLsbhCbyUu0EV+jlGKHqRykZmGT9oCWv4FxkYyRe3lVGIaxasQnskF6uiOUBfp3VAMhMnRBvBFSkefhUQx/m6dQqAcLGTo0TKrUmj6IHA4hKKSSeXg52KXafuYSBcZWplsSVnCW3wspEXK7W2BA+GSOWYgxqXwq5yTSO1xFqBTYzPw9dLxkaiqCW93udEOHe/4fHjIjx0KP2lrYugU7TkKea5kEhiN7h1Dyv2kJr7HxHPhlvvjZZ2g3dvX0TmspJ61cLExCkGHLuUWicS67mrQNPMtdQ+a/m+gjuRAiSgwLZT69Vyw05eeuDLJbmXb4BJjJ33/wcrMTId7N/THqt5YhlmM9s1F1/ArauH+aQOBpK7gmKUO+2t0+OuVgtiQxo1lKz0dMPRgAZa76N60x0vPWVnOIT+xqfM/zwMSSDGTCS8tQBXU2RAnidBvDC6EuF7ioZ4h9v5DWkxvmFlVddY26j2Lz7zpRPucf9W4i4AMPerz1ymkEZsYnX+P0ba+v6W+OwczDPxfdNQauK+mViHn1hq7x/xLz2RYT75IGx+BUmZJfBjuMCms9Ksw7E4RLNqTgsbb+HbCQ4cm4dzwtJxh4MiTbyxGPKxHZfBxJfgQu1gPzIItIObe5248GkEuh4kyRTp0+EgchtLsTc7rEIkuFXi2QvSN8dHJ5YVgBmuC19zPujdtmpv2cEbRDNUwgQKItRNevq9Ndr/0oXCppyZsb3rZsOC0rxHkcmVCd1INZiFAEoTQLb5dMmlBquDxqfm6DRAR7lyd59Pw+Hh4yGu5cT6DoKPmAlprtnPp7TItt6L8vzdn02OPT36UK6BbkEgW9bCrNdFc4AMxrqc7/XNzKoIDZUn2RRqNVcXL5B/LcqNXGgASYm4/CSeVjt9JbFNQDl8o7cNV46iP0eu3bi/1ZhH0SjALVfAXvT7ganPZVxMCzpHGkg386thJkmDuW7v2vN+xzY/zG8JCV6o70gyn9zKizgXEjXlAXVUbgp6/mWBV/QMx0i+2 -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the organization identified by the given `orgId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-pipeline-launch.api.mdx b/platform-api-docs/docs/describe-pipeline-launch.api.mdx deleted file mode 100644 index 6efd0a249..000000000 --- a/platform-api-docs/docs/describe-pipeline-launch.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-pipeline-launch -title: "Describe pipeline launch" -description: "Retrieves the launch details of the pipeline identified by the given `pipelineId`." -sidebar_label: "Describe pipeline launch" -hide_title: true -hide_table_of_contents: true -api: eJztfXtzGzmu71dheeqctetaUuJkp/bmrys/ktUZO9G1nKT25ORGlETJve6HptltW5Pyd78ASHazH5JasjOTKNyqzVhSkwTZIPADCIBf9xI+k3uvPu3NvbnwvVDIvc+HexMhx7E3T7wo3Hu1dymS2BO3QrLkWjCfp+H4mk1Ewj1fsmhK35rmzJuIMPGmnpiw0YJ+mnm3ImRD80RvMmzvHe5FcxFzHKA3gSFOacCR6OuHzmkQeGzOYx6IRMRI5Ne9ED7A43lf8IiHNM55go8XCTe9sTANROyNc+JiJCEWv6deLGD8JE7F4Z4cX4uA7736upcs5jiMFyZiJmJ4dBrFAU/UV7++3Ht4OMxouYviGznnY4uY31MRLyrUfDQPLiFnu+FllMZj8bEpEQN6nN2tooW9l/D27q7hrfHxWEjphTPGmbzmsFj5m57GUcB4GME7jvMOiws75b7caGUP98LU9/nIF+qtPDx8xv7kPAol8Cb0cPTsGf6nOK13v0HLcQS9hgn+yudz3xsTf3X+LfGRr1UiotG/xThBJouRGxNPDaAYHP/K5/Fpb8ITcRIL+BdX2CwCbpbVvXkT/Dfg9+cinAGPvjo6yppI2FfhbO8BSQ/maSLOwlt8urgEh3vc999Nif9timC6U2+GK4acAOP6PMHVrP1mxcP6p7UzGcO4yCPwSnsTaxn1LMqcdpI/bjEXg0GZni0T4a0XR2EAPzKeAh/BQ+qltdmlmqlk4t6TCXLg2I9SYL84uoXu4s4/+yfMIqnNBkKwT+oV2T983r9Okrl81elMorFsS/E7CJ62F3XMErT43OuMqV3LanfQxhcTxbPCZFcwLvQweRf6C/PWShwaz3jo/UGzq9l0bB+btyJof8ikSFB4yoVMRKDosKXME1CzShatI6UBR68b/qSOAfz5NV9DzUyEqDWUbrFpUsKwQNXzZ8+qZBXJeB96ICUZNia+RG1Vw5ttdpHKBH4JJbAiarznLei9QPEhm3B5fciglzQE9pTjKIbOQGTyMWovorIwenEJn62n9jT/ZLRuPbH83gvSgPnU9yuGfZcpybZ/iYy/V4kQMEMUN/xOtkY8Ia2Mf9N2hL9nUTTzRcv3pkCfJ0JQGPm3poH+aNrwP9I4/1F9Mr/d/EO2LOkkbgofZzfC/pjOCh+ln8J+tr7w5dT+yH0ALbH9TRDxUaFBNOZ+oUuSF3qhC32tXo9GM99orusmV1qL8syqc/9z5/qIt/yXzbwChY3gMk9k6qittDhp0go66RtNI+diDFJtzNSTaayV3QCE5DiB9QFYPRfhBGB1SBtcCh9UMaIu3QXCq9VqGjXFqRevV9CoA9gEdOw4ieIFQwRNUlDCR9S3qFziQEw8VKjY69SP7tjU84WWIbG4TMMB9bh+tO5kghiSvoGp8QQUuxjDWgI6UHMNpy1tW+in5rGHQjmCB26jGyTprbhPiAqYMgJTYdR+H5aOh7BMkUxacRrqLhoof2LIjhq4wye3HATY5BeYWwv6a5n+Wro/pW3w26eZOp/CGoMi8Wumxq75rRLxPhhAk79kppZisebJ45ijaeGB/pXrAbVRzqtX6czCArc89hAAk2omQm65n27bCbWlXq4BSlidjKLIFzysvjCwHtB29WTeCbAhMmn2mrAr9u9o1Lbg+xN1bbQ69I477eGwAPs1gFcLclj8iBjeS9BwAEmFEgbW44MepgJAahdLIjUI+vSmrEMYBLg0sSeZyFu7Bzz8k/v2PC0hiOOi1bbQfF56iuTOtjxuiG2pvlrYl+LviYdEBl7IQeitn4UR5AwfY4XGVdTM0YqGiWW6Qglz6OmgXUHID3XE6G20eKtM/eLvoOdgvZBKxHAFlYfz0GxwAT8UF7pGgeT25ROpluzl3RV1jNZqYx/wtIj/Jo1PAV+IxvMabI9QyjE+kpFP+haVE4o9y0BjAT5IQpKW/i4GeaQ9Fk5B/SQKakfkkHqy0d46zXbT3bWILbUBayOfaPew3pRFgZfAWwXDVkx56iekGYZaBAyJ6lSK+G0j5f4enszM7MHgn7iaoRKG2C36ckihhtFEa2p42826/ic8SV1Dz70+45NJDFNAC7na6zyKk7XukxdHVa8pUIxt2+xULcYrNjw6GmaY4v+mogk6ubrWzgZtvv+OzUpCkaWoNmBNtKgpIAO1LdFksFDHFoPXDgxj3l17MGTm4UUAwkBAM5mOFDe02QkwFrBXdCvi2JsANxk3f9aqaNsgoQG/JyIH3h9im+VH0gPt1QjTYATEwiSIunx7Al2KTIOn1CQltAL7LxRRKnFT5y/w+bNn+Rv8r2j0joaTG8kQPWKkmmZOpHqUiMqUz8Ca+ueyAZehRtiO5EZjwyKtQ3o7sJuVzPIU59gUtLJXVwMrDUjojmCmfJy8gTeqBSmeMBSV/4ZQyWAXhScR+BTwpJamlglewkPO9tgp2wP+9/nBdiRZGLX7ccCO8cu1QLX4btFRwWfiih6qezsAHcZ0YGNYCiVdLJadXlQevwX1GQjZgPvyk5wSTxwPmO4FlzqIUmCOfSXuQAR1UM11UD2/6uDpFQf5GdPn4Vb2yeM3XSxm2ju9RgbCO1PPahgCSpeOFiW78wAtjugMhlz1+6I9a4PoSmVLcMBwz/XcNlNfNpOo2Sj5jiIXkE+I6FszLTRFvgg37jnv8fSy++bsbeb1Mii+58OrhJehf2+KA2U6R/QgJl9kNE3uQGZ3FIUdVKO3nrg7sMjuhTJBvLicrwscdnIE5odqoczSOvqzlzB93j6693k8E8W3ADrlMvIbjIdPse7lW2SxWcyBnafAtC34E/4zYb3uBQMWDDwpSSPCU8tkC0h4A2eaDY19x2Z4nOXZyYAlXN6UcNEGiKzu3S8XtVr5fquFWiHjfa+PAQ7rHRSI9HVXOLeT857iDt9X1k3m1tHCJjtcrLU9nBH9UxjRmq9P5qncBp6/zSD5Sf+9xHlGpEdX87Qe9EIEYMtejLYZWLU1AyJ7L92/h8h/gZjx0SLR5xcOX+4SvgQpBhvpLMSPTdZBPck+fVTbT4vD5RsMez+wzUcKbVIG5DRFGX60+eCvqaHt/lw6vhrjwAqMKVG+hLbwFjhmoJDyxgS+/XAhcnSh8bZFQpV+5c2KZm/iKJ03CBJCafWRFPB5NJOgKKGZjhHSE2PQm9wlX596k4OQz+V1lDQx/0vskjVdwyydWepNREeaxw/WvzmY0ExUD7AVRHqNP5ZWUHs+2uyT9UzTNTPn7SCJZSczDX+hf1tESst6xAi/A4wVi0Av6IDUqmVQCCsKSZRpfFck3ogeYjiw//xoUcQfJiZ2/al7sgSsm+iZQf/dFXwEtA7/LvtQCTfo2cC+zYbw0FATKlka0gl9nMLTyB5R2JqIAOdr2wTwaoY4RN6u2Gowj5L8YbYP8xa4+2SiuBXMnW1xwYUXksuOUAEFSiDPwXKvOVsM+P3WQ2ov4aZDzubpxsLxTf+9tcqEKEayC6w5GHO/ib7MvHoZoRLd9ugzQA5vifs5vE0aa+KBlbNiDuxtlNAPXL3VOw/sgCV73LPsy8f4Nk6iIOAtKTBEG9Ger4PjEI7diSIXEgOrRSK0NkiwzWyxasscnw2uvrzu4eYwf37pX757c3k2GPQ+nOmt8+Wk2++e9K7+9eVd/6p30fvvs1PzS/+yd3JW//uP2XdFPpxiZHyAEopdg7xSUlA5fmRRCqCqG8MbXrAoTUggZjZzATnUUTwk+ZiLl7xT/DRcSbNqWxQyigsDgBKN4ohTwB0B6170WO8Up5FKZacrjYsCuyTvrCMw1A3nXpjet47QW9BCdRV4f6BAwPGVnRYIkcjC1jLOrL9JGteEbeloLftwTGVEgCpKEEnAPoaubwGNWUGa3YD/AZ+Kw2O3dih07j4D9IxHQMoymI+bLNGH/gmuDfYXigSteXiKOpDpCL55zC4/17sax9C9kbEuI5w2LX1OO6UECA5MSFkBFA6LS0AqB5oqmoDvYi9ZEER8CtJMhxo99k6JwolAfwua5IKemoKmv0MbPE4pzAXfPILMOPJpFuZN4GEhyGU+hReuMJG8v0C/7fr38HpwTy/hnNzM2ts7jzytZKCjZkeapX4sAZ4bjdDZtsdpK7qX0CXqmTfHxv08j6R4F56CTDFhy0212gTbKHhmOYcxq6QOpwHbqwaK88X46Dex6PMmJ+L49m4ERjB6cXbAbMWBkEI6Tsc3T7MTeG5WDF6wkerXZMpom3cZzgCEcAzq72bbV5efJ5RflYL8zUHM/ml23nHANKKpAga2f/tc4cCRN+kLeIVglc22It1AMwMP5rE3psNoXlQPh4zDaqJvVA9m5GiugFRT5evhSRFktMuIlo4jwog0glIZMDhsTM9XIj+NY+Q/ia1Ux8CKI4H4nyJwleyn81N4/zlZpaPk/1DmtphKlYKyyU5RJyUShPcdO3s9qCA26LSJGjgzmTKlPkAimm4aCrJyB5YkQ5aznA75scXm3o8nP0Rh+hmLqm7gNVk6jS6Qpb4BWRUr4TiKkm1FALZV9gBJACQ56//QEghiLJs6SjTEKhrHxpWKhyw4H3j/WS6mClIZLXLbu826c4xcz72+w45Ixh2gAv/fVn0PFVcBkQQSTOQJxeewrg9/I/uSB5EeDPgCdQdsMmzD4bM/hR2M9OGDRbdEjVVEXp18AoUJll4wv4P/E1IDWoOOAm3QtKPQXWcibkEmwPZXThWYU4s61f6d9nUS+Nq/w2MT5NF8T1ymYdX/ihE6r1Vvlj9MIluNV7vhCJkXBGFuZOLKBbDifjvrHNY7rDEgUQxgRwQY8s61Vo2DX19uvOm7lxe/vmT7b2J+6yVRaO8Naz6KrMOyi/NQUVNv1m5zeNpbe3BaDJQhVssiZJS3bHJpwM0mpwg5iOhbfiR9CF9OvzbgyZyow8azWT+PPD6outT1gX5+yHdY/QojMwq5O1Zwxhv6npGjdsP4jD89eMGdVe7+WeWqs+odOSBwB5PuYHL3DyaBXZFxm6Dzgg7S7YxR0zRgrdCHjlyzItPQqIu5b2LTAPs1YPxCn9iEYJNWHsvHaHEYZWmIPbadejHYmtSj7o1yzUcC6yP45GnXrjSCgt3xGA20s4B7/nqqB6oReizIrBPYjMAPxiQpP4bScQV/7UbA6oKjZ1bjKrME4fMW9jHh8YSCAAtLwM0ilKLZbHdoY58xmHLaaaDcvOQLVKaFYLryDHyysDIqHR0oBQDLmHKZEfThos0+vR/BcqXs/GqQbwaS7W0Fnshw0HKEdkmHRpedSLZ0uZxfUurjC7zrA6bZZ56OfCx5QM/qcHttU7YR4eFBU0uoLWybehxMVSHm7FzwmCb34WIFXRN4tOXrR1u3gU3gL5ir9kW7rYEw/KhXjuyAk/en3dIKwWvRp7DIkSBdTaZym70zTu5DUJooJVrRHR7BjZWVqedpokT5LawLCR2y8KYppUHH0BsQ8WhDo8jDT3PKBw2SU7C/0YB/s1XcErY0DDrKzHnDaybH/CycUUElPXibDeeTbAMNs42BuwhLTqC3u7CP/v6MvTk23kJ7G/2FZosSlU9otthVBeyQcvz6xzBatg++XI/7HZh0YPKnAJPrLL+NAYwSIB8ulJPVIJiBlr5fTo/kl9sXGiwug6D0kxKCDcPh1KimkRUN9+HChMDR8W6jQ2EvTlIAi7pJ3qsGzjIdZY83cpETbXYr01PAQ1Dpkx6lliaLJp1hPmiLS+nNEBnoDnTVp2RRobU0wonvwR9Nxrko9zympsbXXyo6pmMXP9bW2loywnk0Y13QhwvoRVp19fQIQRR6qp6K6f0KN0Wzc2Dtl08yQYoYqTCg8nzyhJ9Evi4ucBZO6KBmffen0A62lmnIhG6poitM1GWx98vUb7Qs5b7x0N2sCXTNgLMTsyiPwCNFNXUjagKKlqse27N7weftMzDPFl8G9GNb/edL9Rj4cbjGRKoXkE3Nl+SStasgVV2yb347y05QNqjwoDv5LR1RSAbOowBWdhAoOc/vLnh+0dkhGnBagbNVfA+MC5bU+8vzTJMbAhewl1tYjAwzMdFQ1jpdSv9ExA0WdDA4Z2PcFRQfRlDQ0irCZFuZYgdkT+N3NpVqE2eFDEmBbDTPrBXJ16xWV54WZ6EmbR4Obdg7KPiRNhpalrxJVoBeTQ56obTAUqoQmT8tSfoNGKBuxCYyr97n1UXLSorqh4E7KdS1enbcLMAduOwXPXDL6kvzm8qtOPG5FzQDB31010gsePuBTHxqqlACnc5zidtRRYSqzpcwxyHTeyLB0O+WbjTUcZQUrsOGl/BKPmKJEEBUi6HxEgamsIYegcJLmmUqXqiQEsxXNCWkswkZp8WYprRkNjb3dDKilUicnKBBohB3adWiCXRLP4LY8r3xQss9PG7X8o2gYB6HHIVfZErzJUV6xxf4RyhuydWz6tfP1Wqa9y3stgWWI+3Zdf1b5mA/m1Wf6DYbBb4fzMX4kVEesGZZGvWSBDrjxYV3PiAFHsVDFQGMsZIAc4EvsEZqghmuiR2Hi/a7N2GaUvav7sU5vEVT8hDMspjcsSQbhxhw9Wpou7efZoZ1QYdGUsDs/4r5Od/MbvlmvlUebaOs9D8pkbaaR7sTp+4lNtBYM8eBtrm24sfP30HdHOdQdkJrA6HVwHXa9Iwd63TZXgl9BN7CNJAWHWerYhb0azOUW+6S5tbEGb3WVf6gr5aoOXOyKaw9gap/wAqjq9Q40j4bk6GlYMd37nDJ3FKbBUJkOmRfrdcBKRM1c6rZtjzsYpXowgD9BrvpvSzntD7RoW0p7poCrQspXMUBx/O0b/vumq+fWimAAFbRb/KBU0jFFvEXtUTWRmW81O/hiWJzpLw+5QAtmqQN6cMiTN2ZUBudlD1KZ7Msm01e94Ji+skySyCLllZhDCYrSHWt/NrY9QWA/W2Y4RQbMx9jwtn+s9YLxeNJHKVYQ/kaWMXQPI7mi0cQjc3RdsjLroM53I+9WwCGXVXqsuGmmKtGVo1MgWXmQfXshxEDJYAVOn34WZqSpCPhbxAEsDZ/alm+sBooA334h9oCWdZY27l4fw4XrzOgflgDCqYxlVdYWK4Bi759PWDKimIJNVEXT6hi4Ma/p/tsmLKGXQa5T7Gapebslt2yW1wgTB1tcsNjkwGlty4oTb4uLDgrp023/IE2CetiFE3IYRIZXWOXnowFsEGgkgNxn8OWmqQm5CBj8qygO4WrNIhv6Z9ksS3Z3lIVCpp1MMieVacmVuw29G1rhiypTAQoHRtsXrOsSVZ0O2bT1PcXrd9T7qt84lhMRYz3Zakk6E8fLqzQZz1S40Bj3bBlGsqDQ5oQVvugbEzzA3Q1xKOsqXd/aB/WrZUIsA7yZ1iIhrJrk0CO/MosO0QVy3P+CAGqT1Q+YRn8X1pDYVW9pi3KFKuCsUc1FnC5MPFmkYLVArym3+RFG6/PSoNvmuuAHrKmxXGqtWsMIZ90qH6AZ1uqQi10unUhN/r6Fx2211J51S3twWjR1OBL7yAPYie3DXWP46pK+iOhCi4Q9kbq17mInIm4+ybijhhLzhpx1sjuWyPfqBDsYzLCeAxKKBEqNMOqQ1GploeSrFKx/tEZZEt73rrgVeFapWXZm4+sOVPAOKPCQYgpOVMCOCr5bDibvxiWUtAwXFqjjgLa6scRsmI3bnjQOOwVGw6p2L4ZQVWusZEZSHkpkQ6uLhG4u0bG1zFPOosuK/ZkUhdVmmJWOoVKCsIoFMkjwiidXZeL+EOHliXaBMApO9QEx+f1Wnw+FiRv9yU084Uuv2eCYZ+oiN6gpnieXRrPmMhWPbVdyh8sXS1s2WcD/MVdneiQtEPS3zWSdlcnuqsT3dWJ7upEd3WiuzpxN70L6upETFKrw6kukdMBzx8LeLpETpfIuS1JLpHTJXK6RE6XyOkSOR3edomcLg75GyZygghPuBfXGl1d+on1jwfuhMAZartqqO2EQHAnBO6EwJ0QuBMCd0LgTgh21WJRJwS+nNaC1d7xBTsfvHZI1SFVh1QdUnVI1SFVh1QdUv1BkGoaesnrKD6HMZP6gGYYQLlN6ZmadVTPXHF5cynI51f/jMPEu4eJ1f0wlXJc6jID+tpFyzho+z1D28apzvrukMKtc5jXnMphXl2nD1t1fV+q/tIcnl2jy/AOMOyyVEfLFgjmlvmMoSl9pHqgX7zM2YbiGJzA8l3YLlx+W7yFzNykrhajVEaKTVKcbe0BMjXU8QKrBcBtcLVokhee3SCDjxXykvLVrR4924TrtjZYyS+geUkX0Ch1EZyUQmu2OKn8cJFJAZu+j9cA7XCNJSwwLh7Icn0X3aGS7DG+YYkFPKhxFaBhzxmoVCEKwFcI1GZxdKfudC7dJQf/Ualyz9C6CVkaZnnx+OQAf2+egIdNWoZ+w8/WJCkpypOw/cS78FSowJEG3dOjpifDVDQ5InpZrAKs2UQoeaLUqc5vvBSz3uRxFRZMpiRKAXiqcJFOGez9QXSXbrROohsRnhpduN4INVtUWzKD7oBRF3bOlpEcBdB9pEN81EpgbZF34UkWtVOVDt0Cg0zslVfmyVRdg/Idx/1gQEE57kdNBCVoZf7rsNXyBUEWrFmR+hRdB3p3CfS6RPTt7of7QfyDG9yDFqY+XauqYFedK0VdksvZp8r1a+qStO2Kv+T2Vlb+xfR7wHiS8PF17p6w0Q4KwcMMJ2XrWQnDjgqtEDwMsoKB2yYB09TMPGqTgVU2+En0QyRYNK7XrWovZu5EbT0ols4uIWZ5ESXJPuFVszGDTTpnLxl6nrdiE/VUS3/3i0ILLSwPZX/fspTT+gLRT1DbXvu48fK6S4EBzDBnraw38M4h+o6x8hMHBEaFe8k/p0GfVsxH/2ATAAr4ktU+yYK7x0BmJ5VZCcz19dmdDt8lHb6lEBM39flhXSq+xc5+G7jbAp3b7Kdxm7kkM5dkti1JLsnMJZm5JDOXZOaSzBzKd0lmVWHskszcbYHutsCfUmg94W2BuVuRVmDTWwGxue3UMDcDrrn1r8nVgd/yZkDfm8JUPLzuQNpuGn2PGv7MzO/fu49l2ZuGn/Cyx03Osh9WXTe4XkyJAGY1qg0KeNjm8r+HlXfgPay+2u5h1U115GXe4Oa5h5VXyD00uw/u4Qmuc3safbAh6NkOsDSTUyvuq3pYdfOU02o7ptWwq3RWf/D3PoStxTAi2tx15LKonM98R33mO2GbuSwql0XlsqhcFpXLonL5/ruLWD8TagUjuxSogV6R4y3SmvQx2dViWWpDJY0DBV289Ia6yuPqkO4x4e1nxwN91KeipuhIcF9JOzzVQy3XQe38qpPFg9JnfUj/3bhHljvCNArJM1bo+hnQECacftmVhZtpL5tJ1GyUeEeJa471souJJsgX4cY95z2eXnbfnL3NL4TVWLDnw6uEl6F/bwoDs7DELzKaJncgsjuKwg5q0VtP3B1YZPceeZVjHf3ZS5g+bx/d++hCKL4FUCmXkd9gPHyK7hMCFpvFHNh5ivcjzmJ1AWOve1G+XWiZaAEBb9BMs6Gx79gMr67GHLCEy5sSLNoAkNW9+7XnUN9qoVaIeN9rFnOAT2WBynhZ63lPcYfvK+PGMzk+Wtg8MkLV2dC7YEN/q1PdlTz95x7qHlZPdR283CV46bKIlmQR3QLH6GyTjQl8++FC5OgiC0vLSKjSr5xZ3+YKzR1x9ak3OQj5XF5HSRPrv8QuWdM1zNKZpd5EdKR5/GD9m9s4z107Ptrsk/XM1ldwqxws+rdFpNRm1ZjMayEznFO0DOwAONSiGNSj8F2ReCN6iOHA/vOjRRF/aI+WXJ9hnywB6ybEctB/dwUfAa3Dv8s+fK4gXhvYt9kQHhpqQiVLQ0raiVN1jMyisDURAc63cC8sNMMh8nbFVoN5lF/pDnaCjyGylM+j0/e8cFtccOGF5LEjVJDdR4pJe0sTzY23cOshtZNw0yEffUeuQhQj2d0g1T9z6mWESvTao8+A0v/F/RwrJ+BYdHXtijmwt1FCP3D1VikQc8ke9yz78nGp+0GA2W8U5g1L7HsyoexMjKcWE1axTPVFyIjWBgm2mS1WbZnjs8HVl9c93Bzmzy/9y3dvLs8Gg96HM711vpx0+92T3tW/vrzrX/Uuev99dmp+6V/2Ts7qf/8x+67Ih1OBWXsoodg1yCslBZXjR1Zvhx7DG16wKE1IINpZADlyqKN4SPIxFy95pxQ7vJJm1bYoZBQXYnBIk6uGdchz96KH2b9W8oXSuCiwS/LOOgFD3XDuhel96wi9BS1UV4H3BwoEHF/ZaYEQuhCI2VrGmfU3SePqK5aVjVE8G8NWPqqiBJEE7GPo+hbD/PMCEyaZrTA8dqtgTnFEaa6cVpbBfNxkiT70T8xVzPrqY3hKxZfT9cuP2eXnelfjGLo3MtZlhNOmpc9pn8bwpgQHJoxg5vEh0+YYqRxoqmPen+gaaEOarLkOOsJTSzyMApNc0FNT0PR3aIPHKRVqsS+MxlmYN4FnhSCXMSJ+rDCRvF8SVVMm6PXgnl7CObmZtbd3HnlayUBHzU40S/1YAjw3GqGzbU/TVnSPt6Pry9G3rTCTaTVd30N5ijPnMFaZaVBhZuur5Yu3ymca5+44Hd88zU7IY8/Y4AUbqX71eJ62eZfhDLzTHtTfzdaX2mfnCeVXpSB/cxCzf5qddxwwjWiqgIHt3z5XOHDkTfoCXiFYZbOtSDfQzMCDeYx5KVTNoaAeDjETiqNvVA9m5GiugFRT5evhSRFktMuIlo4jwog0glIZMDhsTM9XIj+NY0qUwVaqY2DFkaA6DvC7lv10fArvPyerdJL8HzrhZSpP6Nxjk51iKoCF4o6dvR5UEBt02kQNnN0Dh5I+LPYBEtF001CQlTuwJBmynOV0yI8tNvd+PPkhiqn/YFHVDbwmS6fRBbLUNyCrYiUcR1GyrQjAtsoeIAmAJGf9H1oCQYxlU0fJyqwyPGTB+WAqYwzaBzS5zEqeZLZ3m3XncxFOcq/vsCOScQeowP+3Vd9DxVVAJIGELAwew3NY14e/VXYe7EB6MOBUDgw2Gbbh8Nmfwg5G+vDBoluixioir04+gcIESy+Y38H/CalhjnRHgTZo2lHorjMRtyATYPsrpwrMqUWdav9O+zoJfO3f4bGJ8Wi+Jy7TsCYTCV7Da9Wb5Q/TKX0rnTmqxowtCHMjE1cO01r9dtY5rHdYY0CiGMCOCDDknWutGge/vtx403cvL359yfbfxPzWS6LQ3hvWfBRZh2UXp6q7t8Ss3ebwtLf24LQYJ1OqPEcuqsmlATebnCLUB7DrQ/gSa2TgySpQZ7P+PsXvRaG/qMnzaliKoxiNQW7Z7z2T44lg3TI3xlJst8qPtEX4hDrItk31ZQET3iMDA0y/yYs2VvpJsRJEwZjlJtSz1NA2SRvb7ZTv1NBor9rUhpBPqopVK8CMZHVyDp1u7WCmr7MiX0reQ99IkWjR1OBL7yCbMXsPdOtCWjCuCvAbCQUESVEj9e4M3Z2h78jhlDsUd4fiu38o/o0OqB8DiXkMSigRqqCGhY8rXnyUZJVIukefXy3teWtHXCHbQ1fTIQ31hLZwAeOMCoaxMYVLAOfvz+BLNpzNXwyNI83LzVmNOgpoC/A5smI3bgDrEPMMe8WGQwoCtGupF5EZSHkpkQ6ughvvrpHxdUgrkZ+GmRPq0IAR8mplJh0ddcAoZLWJMEpn1+XgQujQOhFoAuAG9KRxi+R2pM/HguTtvoRmvtDHAqaE2RM59wc1Tn3bZa8POmw/719ojimD6VuYY66Kq6vi2tiR7Kq4Orj4p1dx/erqgbh6IOsocfVAXD0QJ7q/aT2Qihw24WCqAuR3LoeXS87yWHp2CnJnmR/7SpAfkLFiXbJjOdPx4D7mvnGnrxLHGA3Q4JWTd7ga27a5rF5zyEumbCFerDjgeJ727UIwzddPrdRJ/332cnQILrnEm500XKiH80O0CpHZWwift6S+Dqz1Ur+HFUpqJem6nYluWKXNlnhA0DMxoTY6Ahx02iwLnVuq/qonSMYTpIIKjdNDdd3eWF1WozyhMfPxAJrtP2u9UDwOVnAKk5DXwCqG5hVatgnR2BwPD8hyaDdVzHWbYq4aWfU4gAnQJGb7YQRmH4YDch9+lqb8ySM1e9NTPTVQ5lvHP0o37rnKQT/JiY2rZfsDn1OtAL6VF/V6wFRBW5YotxMuly48JrN7mFbB5boug7y8ezUkzoHrXQLX7hitnja54Q0WAzrGWFBMfvECCxFwz89Ld2HyAGoTpTyN71sXMzShIUlkdI1d5yIWwAaBikTEfQ5bapKqOmPWpswO7ekQYT3lmP1gThyyvaXOPZp1MMieVQdjeFKjsQH0bWuGLIJNBCgdG2xes6xJVuArZtPU9xet31Puq+DlWExFjA45fX/ehwvrCEqPlPMHSeO2qv5L4ZB6axHjdEzDlmkoDw5pQphaRKGf5gfoaoi3iky9+0M7CmitRMDLVX+GhWgouzLj2PbF1nxZDORz98U7KP5jQHF3X7y7L97dF+/ui2/i13H3xX/HV3i5++KdNe6s8b/GGt8Rz567L/5b3Befm4W94wt2Pnjt7oRw5uSumpM7IgndnRDuTgh3J4S7E8LdCZF7itPQS8CeP4cxk3p/AQygztfpmfpAUnjmisubS0HnwvXPOKNxl4xGvH3Czqrx0zhwENhBYAeBHQR2ENhBYAeBHQT+QSCwA6Y7DEx/S0dUKZcSJ3+IlG8Xu/NzI00VWr1+igXOVjUcYFzQi+8vz7NYHkPgIkrj1s0/ZAvxDgbe6fAeKf0TETcJNR2cszHuiml2pFI8YlGXYBmsRYUz8DubSqX/FZzGc/A5HzcQd1YPWStSgCZI1UIrltbVaHJoy67BhvG11tDlANuamENLBRaQzVKqULw+LUn6DWRV9TTiQubV+7y6aGY/n+iHgTspycerlPRsdpoHXPaLHrhl9aX5TR27nfjcC5rB7j4Wf5dYweEDlZehpgpgEoLlErejyszUZRfqmeOQmXJ9eCNHSzcaakuGih+y4SW8ko9ooVzwcDE0ZXYCg+v1CJTV0OwCuYs8q0GD8Xk2IVMwZ0xTWjIbm3s6GdFKJE50bEg19KUfAQ5TP4LYwsgRLfcwh+W7jnjpZ7PKI15UEOIEw5EbJOKtKr4La5bdbrnkXjOTWQnvfEAKPIqH6mIGLGEfegnwBXSOSBasCFkNx9OUsn91L87hLcapqkElEx5TNWmSjUMsQfSqEPb/NDOsix4zkgJm/1fMzwHsXQLYLtHvB/YAlthAY80cB9phLyt+LOZF6PtYfhtkgGODgwBnpzk7zdlpzk5zdpqz05yd5uw0Z6c5O83Zac5Oc3baU9lpP6ydtN6ccEJr54RWgyKdm18KRCugsG4zNHul70G3nRo0j7XZck2S2vCQeknWkU1lbQ5S/QN1ZYPf/HbmHDLOIeMcMs4h4xwyziHjHDLOIeMcMs4h42wb55BxDhnnkHEOGSe0/mSHDHpVbK+ELjzYwpSqFsPrgbZy1NhdGifNeh/MWkfOt3XSvA+9W84wE8bU4XXZs841s6OumZ2AAC571mXPuuxZlz3rsmdd9uyuwv1S9mwX9qQXs/7xwKFTh04dOnXo1KFTh04dOnXo1KFTh07/anR6EfGRw6UOlzpc6nCpw6UOlzpc6nCpw6UOl/4luLTwCI2T35A2gX1xoi43q1vqTELgc63Eo4GLLFOJZNRXDzJ8WiY8mONNvaDqImhyCEyZoOhSqNNoYZm8n0+ekIZz6JGl1OUSMtSPk1pS5BPTITGAeSMy9IV6tcy1ekRz3x+GbiYpiEafz5qMqB6vm3Z5vIrVsvRJE4V8cnnWveq9fQOPdD90e+fd4/Mz+Pvs8vLd5dkp/NV7+6F73jvdqzIqMHN7oEhDNi7HzMYxhcKqqWrtXhcsmy/AgR0e3Ziwww3mgIoXkBBXl4KC/jwX4QzDyl8++9+/lqOqST15AY8XDd61rTvy9flS2NNf9tAQ3TOooETC0bNnNRSsirqLxa0ndQSV1dHz2o6UdrkCoVbbFwXpr4jVwrSCQC5t/gQBgAH3rJ/XLgywTrwwcNh6+h91D8vxtQh4zdO0VmALANhDrv30P/8z//om5vPrh//8z0//r/P5c/7F/9qr6RhwdRrUKZrst3PCrOriNHtSR3Xslvr+OV4qu+S+DJmkI1jEJT8CYwMzVEZ6UcfYYBg1XTvFOP04QtNskztDtTU0EGBiJRs2RLanzKOtWiP2DLw/SNVV16Nu5e0WVzyeiSW3mmwYir1dGHVm/Ga3rNbSsjk82Eqf25JNMXPhq1MS+yPN55dCzgGEK3RzuPfy2TPCyQXVcMzx+ncwRSRiU8yl03CW8LoKFO/8Wyq5pnYu/mWDLiPEP6/LJrWkfZVNzBTO4jiKK5S/qFL+DnpW+CmMdAoT0PNAm2+cxl6yIN17LMAEibspctsngniBSK4joHwPGGuPBA78tNcxmkB2vpo/e5MH7SPZMxHhkjpNYx+aGCcLn3ttcqjknpaqhU6/sL62J9gJPs+6/R6pa0PxABdYLZZNd7ZeOOKelqAkcegh+Eb98dowzL/vEloJL5xG1Nxc8aKowGHXEajTZqR+mG7aHBNnFCdvTxmYw/Np50yj/5P/gCYK5n3ROM/bv/7afma0UMDD3ArK2De31bPVLxD7NWfUvUsBPCRuhbqFWjslJgK2qp8hnaw7dSPl1Mvv5J55tyJkw/yND62bwBPQsOgz80im07y/an75lCEHTOR6lbffM/IC9wN6ifDZr19HXIr3sf/wgF/DdosVd4LRqmOX6dLSFfP8aIQwehhE7I3zycRLSb4RMEwuv4k6bS3ukQndfPyBuk/6bhUZDC0CdQm2ctShy5kbJ3r2FqZxFDAOu/ZaxHmHayah7rP+uGQqn/GDtuU2W9d9faPs5ID1DYEbrLDRg+HCpscQbbEFoU3UP6hAgEL1QBeWaZ5YTStityCx3pxd7dFV6LZQKAkB2+IokgVcSE9c4U3dwImGSrq5Gwl8ePj/XoO1sQ== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the launch details of the pipeline identified by the given `pipelineId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-pipeline-repository.api.mdx b/platform-api-docs/docs/describe-pipeline-repository.api.mdx deleted file mode 100644 index ac01264e1..000000000 --- a/platform-api-docs/docs/describe-pipeline-repository.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-pipeline-repository -title: "Describe remote pipeline repository" -description: "Retrieves the details of a remote Nextflow pipeline Git repository. Append the repository name or full URL with `?name`." -sidebar_label: "Describe remote pipeline repository" -hide_title: true -hide_table_of_contents: true -api: eJzFVt1v2zYQ/1cIPm2AJ6dZ0ge/bMnSFsG6Lkja9SEIYFo62ZdQpEpSTgMj/3vvKCmWI9VxggB7ssX74O+Ov/tYyaDmXk4uZYklaDTg5dVIZuBTh2VAa+REnkNwCEvwIixAZBAUai9sLpRwUNgA4hN8D7m2t6L1Ij5gIGFpPQbr7hJxVJZgsuhgfSyMKkBYJ/JKa/Hl/KO4xbAQ0z/4fJrIkbQlOMUwTjMCchJhzeCsueX8wROplsqRVQDH4awkuyCT+DOSyHF8qyBqbkbXOuvh+gWSeTISU9ME9xva8QK0ttNfu5gZpk8XUCg5WclwV/K1njJm5vL+fvSAxMESPV+5FU2dt1pzJGZOmXQx4uvonUSwImtSkIgTyFWlw6SLO6vPGrtdkd1ad+NLlQIleSu4r62iMFUBDlOBGZiAOYJLxGkubIEhQDZ6gOnXjEBDfKk8OJFaEying/CQRHNwJMqtK1Soj94ebAAuFJqLiGs73iNNdDDEnyUIthG1UOSogV11kjhleWLy6fakUW048KU1ngqF5Pt7e/yzee2/f5OPGKQJLFVlqTGNNB5fe1ZZ9a+ws2tIOZ7SMekD1he06Ts1ud1B21k+/xTT1ENPgWFRavipeM2kL04PaqTaGviZkG5fEiHcsKU1Oc7fU+Z9R66cU/xuGKDwgyyN7DxB90yrtoaeaUYh5M+HWCiDOfjw9AO1veQ/alNYM6FQ3z+CmYeFnOzvjfqJa2r6OJb0LgbL3X0vbAFnag493SHlOYbCZlWTnY76m8Nh3J2a2NTf2z8YMDANLZ/03Cn/x46H1FUVFtbt5BnTft4OD3uKpBkwaD76mv/TPj5zVTlDGs+iT8fZWbfYu4LHg48Vzps+xC5I9WCoEx2rjMYDNUcfntOS2AQdZLwXFOA9M+Rq9AS1W8XBCmkDeeecdT3kvw/00HbwC2ODUDR1bwkPq3tIK4fhLk75Y1AO3FHFL3V5xe2ZVoCF5WVhDhGjYpEcP6w3Y+Tkshu3bHeFihuaXIRQ+sl4rEpMqM9VWeLhG6FI0PYmy0WUiDOtAs8p8Rfri6OzU8kYWogXnNE6O12gDwniG9txw9+zqEQn9Z/37QS8vg0xdGyHQJPNBgVf+xRADhdTmse1MlNBpZEKm8F3QyY2oI4DOLd/rgXdFiPfJG/fJnux+1sfqBHGLleP6Za17ZZY9jetx7hXa5L+n2tn8z68pYxLTe2GA6zqsVczqrswNw9zxf2Uh8ClXK1myvOcvL/n43o7YaZl6NVMc2XlSnvYEv1rrKWDYdzA3XovXipdsYrk7Wp3cK+9pW4B2lmbXwj29bfWLXA3d+kXIn7p3roF18bKvIZ1xR8OGVdsoERhUHGFI7LWlkdpChtWvdmx0XY/vPss65nbaXSPGlv03s5Hc9fxTYUTNT7bGzBUPC38wN90EQ2MHw0EFZM= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of a remote Nextflow pipeline Git repository. Append the repository name or full URL with `?name`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-pipeline-schema.api.mdx b/platform-api-docs/docs/describe-pipeline-schema.api.mdx deleted file mode 100644 index eb7527cc5..000000000 --- a/platform-api-docs/docs/describe-pipeline-schema.api.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -id: describe-pipeline-schema -title: "Describe pipeline schema" -description: "Retrieves the pipeline schema of the pipeline identified by the given `pipelineId`, enriched by `attributes`." -sidebar_label: "Describe pipeline schema" -hide_title: true -hide_table_of_contents: true -api: eJztVsFu2zgQ/RWCp13AkbO7QQ4+rbvtLoIC28Bt0UPXgGlpZDGRSZWk7BiC/r0zlGRJluy0ORQ9bA5JJD6Kb97MPE7BndhYPvvMM5lBKhVYvpzwCGxoZOakVnzGF+CMhB1Y5hJgDZDZMIGtYDruv5YRKCdjCRFbH/zSRu5AsVWDuItWEwbKSNzvMSvh8IB17sCugv8U6/ysfr++Zlfs3dsVM2AzrSyykCpM8wjG2Ay334xsj2QoHDDBbB6GYG2cp7j+JQfrJmwvXcKUZlbskF4dZKxzFeFv0wnoePTd65Nj+YTrDIwg/e4iVPC113MN9/WW9/6rCMuEEVtwYCgHBVf4gPBWKYRISkEmXMJP89J8jal8CyhnK70JEEwRSQN4vjM5THgVCp8V3B0yOkYqBxswCMXAtsJVr25veFlOjlz22jzaTIQdMiiUOQzYfGqAZ+i87HircxPCp28l8d7D2f4SF/bRYmL3CaZQ+PRLtaFaSASK1WY1NnrLhNKYcNN+sC9sLFL7XcpOuMrTVKxTqLLSDbXtgssxzhsc24k0p67Ux5aQyhdoU+wBW1XcqP5dbtRoC0+wN6kO7RlUqFUsNwFb1IsiTZmMmd5K5yAiReApS3UE5wURxgiKRDrY2s57i6GoDX0BE0U2ZHud4c3o6YoWr3bCkFD2DMpJR6LyfovNW03LslxS7mobIBJoLvSnL++7t/hdDNlhwdCqyLKU/AJXpw+WIEUnvrYWjqyITBWdXj9A6IimIT9wsjp2oE6tQnmMZ7hUnotwUQdE8SEIDW8Y0qLyNvRBNMN/9dDUBoZGXG7G1HklosYqXyoT5tCKDTyvUwO8qMYbY7Q5EeHm+o+RvDaOjObuqIb1HvkQ3EKYG+kO3oJfAdqAmefot7PPSyoZ9OdEk4tvwHMkK57x6fHCnBatX5fTY2laMLvG13OT4pbEuczOplORySBMdR4FFr4gqUDqoZH5FXafCkcWwv4iPJvf33Gi1DD2JVCJ1eV91ItObKyXntcehG+qf/5uzOlh77wSUsXab6/FrVnQsc8RpHAlumkNpsoQoa+MfvDdkFEomXpvjPWf7QISIeWqc34Lbm+Da98b2rqt8IVVO2ZzrZ4a2inZoi3U/4eZFwwzdTU5eHLTLBV4N2E6fFqLuh268+OEz3oDTGuLCWaQsEWxFhY+mrQs6XV1zVGfRNLS3djerGfT+Ny0MUr5EQ6DicbfofiW00387ef/kEHjQhBjc9ELQ/kJ54kLgfempDbiJT0YWU1W31VJvyzqu+lX9sxAPcqqGXDUocunYdtphHKJ6AREhAZMDCvAHAsjc52tg3u0dwX98+YDYkXf5U9c3X99lBb2nUd80I+gsPcalo6eiWBZfgXAKtpu -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the pipeline schema of the pipeline identified by the given `pipelineId`, enriched by `attributes`. - `200 - OK` responses include the pipeline schema. - `204 - OK` responses indicate a successful request, with no saved schema found for the given pipeline ID. - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-pipeline-secret.api.mdx b/platform-api-docs/docs/describe-pipeline-secret.api.mdx deleted file mode 100644 index 3d89f4d86..000000000 --- a/platform-api-docs/docs/describe-pipeline-secret.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-pipeline-secret -title: "Describe pipeline secret" -description: "Retrieves the details of the pipeline secret identified by the given `secretId`." -sidebar_label: "Describe pipeline secret" -hide_title: true -hide_table_of_contents: true -api: eJy1VW1v2zYQ/isasQ8J5rdsQYD6S5t23RBsQIO0xYC5bktLZ5sJTTLkyamn6b/vjpJs2RbSBsU+2eI9vHvu+NxdIVAughhPhFMOtDLQD5B6wCCmPZFBSL1yqKwRY3ED6BWsISS4hCQDlEqHxM7jZ3M9qa4nKgODaq4gS2abiFioNZjkc2W/yj4PRE9YB16y+6uMAvwaw83guvb1NkIJ5qSXK0DwzLQQhj4I3ngigGJ+TuJSHJKufCQmX4FX6Y6WJ6SH+1x5oNDoc+iJkC5hJcW4ELhxHEEZhEWEzq1fSayOLs5FWfa2NB6svwtOprBjcp+D3xxR+asBdrN5SvQpkw/OmgCBb/w8GvHPfrw3f9DV1JIXg2yVzmmVxnIPbwNDiuOgdnYLaay558dBVQVw+09CJ7viTapKEKfHfajsW5LrCZNrLWcaqmcpe3WhC7GSX/4Es6BXHp+NRiwLJE1wqh8nsv/PZf/vT9OT5+PJqP+M/tPJ9Kd/Tz6dnjz/4cOHs9PT4qx3/qz8UWx5BtKzWQiKoGXA9wHaBGtji18mEfqoiAtXX2ZvjN5sObLxFZ3i9ziJNFz2PU7ICyrk4omDNmqbujvtppYUQRl83iWqlzJL+Okh4FPU1VbLCkKQi28QTAM8KkU7ldfeW3/E/JeOdmhmTWIsJlJr+0B8GE6DJPcKN3G4vATpwV/mrLLJlDuNJs/S8nxa1MOITWJ4ODCHRTOQSu5m8OtmXuVe04Ulogvj4VA6NUi1zbNBgHuiNFC2Y2qxJbnWEvnRk1eMTy6vrwQTavi+5fJWpWqz3laLIzaDhb9nEUQn1Z/fGjndPlTqUGZu4/W6tDULDvs1gpyuSmk1VGDWhUyjLvaTb6dM0lA69v3cvtgZiAhXropzNri4GIz4zNmAKxllVQ/eRsSHu+eQbLGT6f+xw+piI3zBodOSFgCxjVkXtVY6lmtPjLfri150SckxrihmMsB7r8uSj6s9whLKVOCRSCqcSx3gkQy/smU62d7B5miRraXOGRkVt5ZeVSP5SVxObuq2P00e28OdnOpDaTZtMg3XbfHKKWGXNAPJE5OrzJdpCg5bF4+m015j//76HWHlfvccdEv03kmKHi0i3tk7MGW55Yj8zQTL8j/Zbzzi -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the pipeline secret identified by the given `secretId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-pipeline.api.mdx b/platform-api-docs/docs/describe-pipeline.api.mdx deleted file mode 100644 index 1b20cc5f2..000000000 --- a/platform-api-docs/docs/describe-pipeline.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-pipeline -title: "Describe pipeline" -description: "Retrieves the details of the pipeline identified by the given `pipelineId`, enriched by `attributes`." -sidebar_label: "Describe pipeline" -hide_title: true -hide_table_of_contents: true -api: eJzNV9tu4zYQ/RWCT7uAY6ftIg9+qnPZwmi6m+bSBRoEMC2NbSaUqJCUE9fQv3eGutqWHGcLLPpkizwkzxzOjWvuxNzy4T1PZAJKxmD5Q4+HYAMjEyd1zIf8GpyRsATL3AJYCE5IZZme+c9yHZMhxE7OJIRsuvJTc7mEmE1KxDic9BjERgaLHDMRDjeepg7spM97XCdgBJ05DvHUc89hClfFcgQkwogIHBhivOYxfiCw3h8hkggnwi34thXlPixOI0ASNWFDhxt4TqUBPNmZFHrcIstI8OGau1VCx8jYwRwMQmfaRMLlQyefeJb1Ki61RSWX5xTMaofMKAwl/RWKVUvYUqiURNZMxoFKQ9Q09kIasImOLbAPEyWmoCwKOdG4VyT/gXDCrBMutTgW6CjBnS7i5eRjn+G9pSa2DKLErcrd5YzpSDoHIVkNr4nSITKfCWXbrBbGCKIvHUS2MW6RdDynHVBO8p+KDo7lJPFPzYe86vWIwEdLYUgte+AqJ52Cxv39SYKOStFQ/Yb8L9o82UQEDV9o1/9bCezwhu+7fatTE8C3Q0nceDh72ceF3VkMlpcFBpIIArAWVWeC2YVAX62Db2Z0xESs0VtMveGmX3ddcadpPR6nCm+F5KegyLIH2i/3Re8MPx8f08+mWV9/93eIu8aOZkWSKBn4wB48WoKsd0no6SMEjmLcUBpwMj+gNPBwJOWOA26tV9zZtkNnW5fUMi+DjgkDibbSabzqtunUgjmYHYG/dDGkyc/SWLcXcSn2ALSZH8wFsZ37NCPusN2qFZ17LqWVU6mka9cxBIU1oHncVGsFIqZJhUbfJaHYBFTZqqJDiCPMPeANzLNQVXva9GpAboWZg2vJhlu4G5+W9yXNr1e34z/Gf1+c41jxf3R6eYFfd19Gf43Gl/6rJQl+3T0mqzLo29m7I4bkf44dX2Q6giPPju3XJu05zESqXOf0Cs+UQdf0GMmaRCvR6Rh04WcG3uMYWa37JSl7Pj132g83KtT7RK316JQwQSOITYeK8/a01OB6VpGrCW/7z+7Mdrt1XeR5KrAI+9SW6U9FyKi+gHXvSfl1Sbrn2AdYMQfv43tlLIF7Tb8wRpsd5r+01Kiy1WRYM5lQSr8gH4JbCFLjUw92mKeAZdaMUmwnh/cPVP6w/Vxoak8xA/iOlKb4oOqeB+u6EGXUSIBZlv1qahRiF84ldjgYiET2A6XTsG/hGdn0pd7tEPwMuypcgp0Rno2uxpy4lFRvSNlcpSbhSig6sexpfFR4EI7kfz6Xrv/44rwEMp5pv7xQtWBBx75FkMyV2KYUYHIJEXiX2DS+aTJ6hVQ+u8z0r/UEZRNULj/np/7JSf/Yh4e2LhLeo4quq/TcqhvaZrmuXfOHvWUK6R28ugFGtPQ5yGuwLpym+eTq8WGjf8GrXaCVBFmvp8LCnVFZRsN5H0m+FEpLjVnd1nVa/H95arQq8gSr7VdTUUI4p8b6cDPf6uj3HL/5avjO839IM7/HiLa3R23KA30Ymffy73KfD9dFtv7I3nhBt5IrG5F41eRTkm44ffaA6AWIEDMTMcwBI5QpcY2lO5VlIyn/dnGLWLGZ/rbSnd+9lRYGm0fc6ieIs6xi6eibCGbZv6Di+Nc= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the pipeline identified by the given `pipelineId`, enriched by `attributes`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-platform.api.mdx b/platform-api-docs/docs/describe-platform.api.mdx deleted file mode 100644 index e58a12353..000000000 --- a/platform-api-docs/docs/describe-platform.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-platform -title: "Describe platform" -description: "Retrieves the details of the computing platform identified by the given `platformId`." -sidebar_label: "Describe platform" -hide_title: true -hide_table_of_contents: true -api: eJztW91v2zYQ/1cEPm2A62RbERR5WtLGgddtTZNsewgMlJbONmNJVEgqrmP4fx+Pkmzqw5+xZ3fVky3xyPvd8Xh3pHgTomhfkvMHEvlU9bgIJOk0iAfSFSxSjIfknNyCEgyeQTpqAI4HijJfOrxnHl0eRLFiYd/JRnCYB6FiPQae0x0boj57htD5klG0vS9N0iA8AkGRR9vTXD4Ynl24SYk0QUQFDUCBQIQTEuoHTTgfRZMwBBhRNSBF1Nk4jtToNbwZKqFJBTzFTIDmq0QMDSLdAQSUnE+IGkfIJOlEptPGjO+Ii6GMqAtzxk8xiHGJ8z8ZoRPGAQjm5nmXeLFQQd80IV6qkldnb3PcBfQTTRVYbyOJq+kREPXlawbsILGMeChBYvvPp6f4k1fGp496TJdrEUOFrTSKfOaaaT95lEgyKbPg3UdwFVqAQCNRLGEQoOmFPV5F6THkGrCQKi6QIO06/jOROd/eIIEGgmJoyv4Q3mRGtRpEiVFBLQ0yoiLUf6XVSIWgqFymIJCVk0NcP5aJqa/fS3dTTPn47no4Wzl/aDW1UU26mY7kG9fnsXc4wbqxOwS1TqcFwMzyrhw6E/7SsDCvhjC+oWwzNTbIc+S+AiDzKtXF5Afo0dhXVmuXcx9omEP/d+SaZxbQPiyFMV+bD7rRLTq9BiJpJKtcL86tQCcuoqIht6wr2g2epbPURvnMGwluLJgaXwseR7tX/EIZ9DS3q7pYIO9saAnYuBu+yn4XoHzh4fYoDabEakKpaOjCvSbezHi2NZE1ZtrClHdTFyP5Ht2R7atY6qskPOmEIEkoYLVat/NGj7z7OYZ4fVUZY9LgFFVrrKqFppf0X6q131JoB/CaPebD3VgWRt6NnXth1VToCMzjUC1H2JJfWzNkpgV6srU3rBbnK5tPHVjqwPL9BpYWDZjPlttPeUDq+9y9U3qDB/3xZl2/gYhWsd9YNvMY194nca0q8A3fyR1uQCzOH9/Jqk1BX7Ad7AfszYcesEow3H10qcop9z/efdTxvo73dbyv430d74803uc3h5cYLapCSZ/zvg+HPstCVR/f8de10Y3l3tfOoPaULSWASjnTar90bJ4mFST1N6WG0lFGlmHptUD9/eR0v+PQlcnWSyzg0OlWpMPSpgffPEQhNjz61t4tWNe8K33Ny0JXA8NdpuMH+h5wNaxI/ZFAe7BPPfM9rU7I64S8TsjrhLxOyOuEfOOE/FDho/6aXPuc2ufs3eesTK2P/WvyKjXiDg2tb8Ol/T0eLBS12yzkrVKr4jXbekVFH6oS0SVrL5u+rfC3MtBVe/ojinXHbBT1adPuQ9qWp031Wc+qNHbhWc//6XDnWxWm+ubqa4WxGFR/Bd8hgwWfv8sclt4IyC7Ai92CW3Be3JlTlBut7sVr+bfpjW+cQ032turO9yX1HMwPdZAlG1z+tlPKAKREN7gyq8wIl+rgSgguSsh/KSP/lJUkOCFXDm6hRxqPvckwJ6eXQAWIixhD5UMHdRmAGnAsY8BMppFGUXIyq6o4mczLFqZ4mgniOatriIWvaQdKRfL85IRGrGm+cjWT+5BNxkmxwiCxH2dW4mAig3Nx0zbzmkG9Q80mWrIBzxSFHEl6wd/sJg2RfpP8aWXFCI+jLM6nV+9zVmzYrgKI4jIXZEpswoBrTCIvvC2ytgqGbcj213kDRgOtuYTPT82zs+YpMcFIqoAai0qrHDLLnRWmFFFO5qa5txqXVNUKvio0BhYiViNzlmrZpTcNcm5Vt+ipHGipkGQy6VIJfwl/OsXXSa0G2o52BLTr45rpUV/CEglXVKVUAh2C5lIofHmmfoyUxkutz/6H23R1/+gs52YVuuybVbEOZs6vgw+CIcMN1WwxX1qBVAkri57h2EaTwbVMY9rR1AOgnh4L8SUEF64LkbK6lvxtzlVdX91rWpp3CgUnYH8oysPSJmko7vkQwul0hlLhMwKcTv8FgRfKBQ== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the computing platform identified by the given `platformId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-user.api.mdx b/platform-api-docs/docs/describe-user.api.mdx deleted file mode 100644 index 98c5ade40..000000000 --- a/platform-api-docs/docs/describe-user.api.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: describe-user -title: "Describe a user entity" -description: "Describe a user entity" -sidebar_label: "Describe a user entity" -hide_title: true -hide_table_of_contents: true -api: eJyVVk1v2zAM/SuGThuQJWnX9pDT+rUh2LAW/cAOQQ6MzSRqbMuV6LSd4f8+UnZSJ3G79NJY0qP4SD5SLRTBzKnBSOUOrVPjjjIZWiBt0mGkBuoCXWj1BO/5WHVUBhYSJIEORoVKecEgsWV0R+mUVxnQnL8jb5nJTbwp9kGaJ2h1GOgIU9JT7a+0+Jhri+yMbI4d5cI5JqAGhaKXTG7XKeHMQ6fGJkDV1smRKsuxmLvMpA6dWBz2+/Kz6frqJ5uGhm9JSU4hy2Id+hB7D04gxa5TM3nAkCRiKwkhXTmQSOX3lfRIsaGOGSlnvyUhzOr9W3S0V3iNKxmewPMvTGec28FRf+3BkdXpTLAVjU3g4fHxNrLhprJg06m2jlr8HPTbHMXwAbCxM0j1X6hqsYfBRu228W0GsAQC20jo9tEwaj1MjUgwXDOrARNjYoRUECzzxF1NWbrnorBKPbuwBOwCiW99FyVZOw1DdG6XTaMmERB+Ic3ZlVzw4twi/20J4S0jcXSfRR8zijDGTYM1dUmEphjrJr6YXJDx+UOM3o04winkMf0xduEyCHG4n+ob/prD56bucwYI5Kit088gCqQz0dFHWr7ZzAkXCGZ79PAKuCutRgCX1ppd5l9bZtRq6AYsywDi2Dwxn9JnMbMYVtWsBySGudX04ifwGYJFe5pLg4zGMhA3L16lMIBAhkkgg5dNWbVIcyMTfoY+OBnaA9Xzz0CvqCZ6qcSbXa7GfW55wKg5UeYGvR5kuhvGJo+6Dh+ZflebnbF/60+C6xhI6hycCz44vR4qobqK5FZKUaW1Gc86s+JR1S+DF5kH8U718X2loIcn8jnT6dR487oMNQtx+z+CEq7mLq3BoiEIvYY2g2+GXE9e7/bb6wETkcxVfg66JyfdvuxlxlECXoL18/lmjbZmYZ0NwmfqZTFo32WeVlHXb/WMd9SgfpM5y3N2KEdFMQGH9zYuS9nmNrGiIf5cgtUwkVRxkSPt5JulMYXY4Q6LdVupTzd143wO3n7eW0nXm5BKlEuIc1nx5wJfXv+dKMeMnCNE8uQysepQZmhGDbOd3hZlrdX94/KOsbCppy39+NtbKXHKPOLOLDAtyzVDkrUQLMt/RG0qCg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - -:::caution deprecated - -This endpoint has been deprecated and may be replaced or removed in future versions of the API. - -::: - -Describe a user entity - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-workflow-launch.api.mdx b/platform-api-docs/docs/describe-workflow-launch.api.mdx deleted file mode 100644 index a23c0b938..000000000 --- a/platform-api-docs/docs/describe-workflow-launch.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-workflow-launch -title: "Describe workflow launch" -description: "Retrieves the details of the workflow launch associated with the given `workflowId`." -sidebar_label: "Describe workflow launch" -hide_title: true -hide_table_of_contents: true -api: eJztfftzGrmy/7+i8tatY1cZyOukzs1PF2Mnh++ahC84Tp2bSpkBBJ71PNjRjG025f/9drekGc0DGLCzSYi2ancN6NF6dX+61d36ehA7c3Hw5vPBXRjdzLzwThx8OT6YcjGJ3EXshsHBm4MBjyOX33LB4mvOpjx2XE+wcEYfdT3mOUkwuWaOEOHEdWI+ZXdufE1l5u4tD9hIF+1OR82D44NwwSMHu+hOoZNT6nLMP6lC59QcFFs4kePzmEdI5teDAD5A8awtKOIilQsnxuJ50nVrTMAQgjlzpzyI3ZnLIyga8T8TN+LQexwl/PhATK657xy8+XoQLxfYiax08PBwnOtXLJwJzzr+M+HRsrJnKsiCxOeRO8n3XerLDWI+p59mYeQ7sfzq9Svo/QuSKhZhILjAGi+ePcP/5fv78DtUnYTQShDjr85i4bkTmt/WHwKLfC13Go7/4JMYJznC1Yhd2YFcys3l3GnFZCEV/iKJ+Vlwiz9ns/wZ6Zu5c2iHZhOa85wYh1v5zZrC6ieYmPUETqBfnHTHE90KWotr1smKG6vFoFOmxsR4cOtGYeDDj8xJYHNDITnLTTaQIxWM37sixu028cJkyoCmW2guav2732EGSU025Jx9hl7huJg/fDm8juOFeNNqTcOJaAr+J5yUphu29BQ0nIXbmlC9hlHvqInTH0bz3GBX7izcVs70Q+At9QkobKlo7gTuXzS6il3MDrF6I4T6x0zwmI2XTCxFzH1Jh3lUnoCadQdqEylyo/rO/TkP5sAm3rx4cVzaC+u771RtAG9x7WygZs4DZHPADgs0SYaSo+r5s2dlsvJkfAxc4DcMK9O+RPZasTebrJeIGH4JBGxF5NXPG9B6juJjNnXE9TGDVpIAtqeYhBE0dg38doLslqjM9Z6fwmebqT3NPml5UU2sc+/6ic88avsNw7aLlKTHv0DGP8tEcBghshvnTjTGTkxiBP+m4wh/z8Nw7vGG586APpcHE+AW6be6gvqo6zh/JVH2o/ykf7v5l2gY3Inf5D7Ob7j5MZnnPgovgfNsfOGJmfnR8UDcRuY3fuiMcxXCiePlmiR+oSY619b6+ag18q3Gumlwhbkojqw89r93rI9Y5e828hJ604xLl0jFUVPKapKkJTjR15JGLPgEuNqEyZJJpITdEJjkJIb5AUC44MEUAGFAB1xwD0Qx8DvdIWK99WIaJcWpG20W0CgD2BRk7CQOoyVDyEdcUMBHgncgXCKfTxF/Zsh05npc8ZCID5JgSC1u7q09nTKHyW9gaE4Mgp1PYC4BHcixBrOGgr2q1CJykSmHUOA2vEGS3vP7mKiAIQOfAQinxH4fps4JYJpCETeiJFBN1BD+tCFbsuOWM711gIFNf4OxNaC9hm6vodqT0ga/fZqhOzOYYxAkXsXQ2LVzK1m8B4h9+l1GaggWY5xOFDkI0l2Qv2IzstXCef0snRlY4NaJXGfsSdFMhNw6XrJrI1SXWrkGKGE0Mg5DjztBecEA7i9hpVyRNQLbEDdpukzYFPsjHDcNkP5ETWupDq3jSXs4zsF+BeDlhBznPyKGd2OPE6dCDgPzcam6KQGQyskSSA2CPnUoqxAGAS5FbCdleRvPgIt/Op45ToMJYr+oZi3VPi+UIr6z6x7XxDZkWw1sS+7vqYtE+m7gANPbPArNyBkWY7nKZdTsCODbMLBUVkhmDi0dNUsI+aGKGHWMlu+lupz/HeQczBdSiRguJ/JwHGob9OCH/ERXCBDgPx9mZBB4ItGSLt5dXsYoqTbxAE/z6B+CCYClMEu4IArPK7A9Ri7HnLEIPZK3KJyQ7RkKGvOxIDFJmvq7CPgRcybIPa2A+kUE1J7wIVmy1tk6TU/T3TWPDLEBcyOe6PSw7oyFvhvDqoJiy2dO4sUkGUaKBYyI6kTw6H0t4f4RSqZq9nD4b5zNQDJDbBZtOSRQg3CqJDWsdr2m/w0lqWloudtnznQawRBQQy63ugijeKP55OWLUh9IMdZtslM5GW/Y6MWLUYop/n/C66CTi2tlbFDq+59YrcAUWYJiA+ZEsZocMpDHElUGA3Xs0Hllx9Dn3bULXS7cBffcQAIQBgyaiWQsd0OTdWBjwfYKb3kUuVPYTWiKwWbSWnndBgn1nXsicuj+xXeZfiTdV1aNIPHHQCwMgqjLjifQJcnUeEoOUkAt0P8CHiYCD3W2gM+fPctW8P+F4w/UndiKh6geQ1k1NSJVo0QUps4ctKl/r+pwFWqE40hmNDbK0zqi1YHTLHmWK3eOSUEjXboKWKlBQnsMI3Um8TtYUcVI0UqfF/5bQiWNXSSeROCTw5OKmxoqeAEPWd1jr3QP+OfLg2lIMjBq+9OQneCXG4Fqfm3RUOHM+QUVqlodgA4TtBanWwo5XcRX3V6Uit+C+PS5qLH7svuawp44GTLVCk61HyawOQ4luwMW1EIx10Lx/KaF100O8M+IPo920k8ef+giPlfW6Q08ENZMllUwBIRumESAHtidC2hxTHcwZKo/5M15E1hXIhrcAQz3XI1tO/FlbhI5GsnfkeUC8gkQfatNC1VxXwRbt5y1eDpovzt7n1q9NIrverCUsBjq97o4UCQLRA98eiXCWXwHPLslKWyhGL11+d2RQXY3EDHixdX7OrfDOi9A/ZA1pFpaRX+6CLPnzRf3nhPNeX4VQKYMQq9Gf1iKtQfvcYvNIwe28ww2bQP+hP9NWbfdY7AFfVcIkohQahVvAQ6v4Uy9rrHtSHePozzrDFnsiJsCLtoCkVWt/WpWq4Tvt5qoNTzec/t4I7/ZQIFIXzWFY+ucd+Xu8Dyp3aRmHcVs0svFSt3DKtG/hBKt9nVnkYhd4Pn7FJJ3+h8FjjMkObp+T6tOe9wHXbY33qVjWVd3iNt75fk9xv3n87kzXsbq/sLiy33Cl8DF4CCdBfixzjzIkuzzJ3n8FDtcfcCw9SNTfZyB2sWlAjlLkIe/2L7zt1TRNH+u7F/2cWQ4xhQoX0FbcAs7ZiiR8tYEvr/s8QxdKLxtkFCmX1qzwvm7KEwWNZyEkFt9IgF8Hs4FCEqopnyE1MAYtCb2ydYnV3IYOAtxHcZ11P/CdkmrbtgsrXniTnlL6OJHm1cOBjTn5QtsCZHe4o+FGVSWjyb7bJSpO2f6vh04sWilquFv9N8GkdIwimjmd4S+YiHIBeVDWdYMcm5FAbEyhe/yxGvWQxsO9D8vXObxhzJpic237vEKsK69Z4b9DxfwEdA6/HfVh5K7QdcE9k02gkIjRahgSUA39FECpXF7hEFjyn0cr6kTwNKMsIusXr7WcBHGWWF2COPmePpELHcrqDu74oKeG5DJjlABOUrgnoPp3nC36Dv3O3eprITbdjlfJFszx3f9j8YsE6IYizZszeHE8erIy9SqlxIq0GyPNgPc4Q1+v4DVpL6mLmg5a8bA3ocx/eDIVSVv4RVn3DX0y8fYNjqh7zsNwdGnGNGep5zjEI7d8fwupA0sJ4nQ2jDGOvPluiNzcja8uHrbxcOh/7zqDz68G5wNh93LM3V0rjrtfrvTvfjP1Yf+RbfX/d+zU/1Lf9DtnFX//nO2XeIPp+jK7SOHYtfAryQXlIYfkecCKOomsMJLFiYxMcRUZ84hhyqKR8QfM/aSNYqfRmtplnXzTEbuQh+gRC0/4gRwh8/avS7rnuIwEiH1dClxkWEX+J1xBYay4dwNkvvGC7QWNFBc+e5fyBCwf6mn+ZzHIne0tDHrH4L61W5bylvLvBzDWh6KohiRBJxjaPoW0JjhpNn2nb/gU757bNZ0hc7MZ4Ce8QpIagaLSZ0puux3cG6wvYDHqM1DKWpAJGP45jGn/FydauxDtUbKughx2DT1Ge2zCFaKO7AJQxh5RO6wOAUkcqCqpAn2XeTGS4KIT0GablChx+4pUTjlaG9BlZxTqRlI+jvUwaOE3Fxw5RFkRqFHo9ArgZeFwJedGSy4xETivod2283r8HZ4T4twTmZmZe1dhK4SMtBQvSvNQjsGA8+URmhs1+u0Nc0LaBLlzLsTbX5ehIJ/CE6Bp2i35bpSbYp1JDwzjMPXPKjEabDtZQW58/nkxe982Xfq3Ijj6t1w9GB0o/SC2fADIYF0kkxunuYkOJlaMXzJxrJd1Z+rdN5VOAMQwgmIv5tdly67TygulYT89UHM4Wl633HEFKIpAwZ2ePtc4sCxO+1zWELQyuY7ka6hmYYHi8id0GW0kxcPx8yB2UTbqOpM89FMAMmq0tbjxHmQ0SwiWrqOCEKSCFJkQOdwMF1PsvwkinD/CawlG4atOOaI/8kDV/J+uj+F9c/IKlwl/5dUt/lMyBCUbU6KvCkRwLzv2NnbYQmxQaN1xMCZjpQptAEcUTdTk5EVGzA4GW45w+iQXVtsb/148ksUpsoYVLV9t87UKXSBW+obkFXSEk7CMN6VBWBdqQ8QB0CS0/aPDYbAJ6KuoURBrLxyrE2peMmC44H1T4MHpZPKeJnp3k3WXqDnemb1HbV4PGkBFfhvU7Y9krsKiCSQoD1PyD+HtT34G7cvWRCpoO8sUXbAIcM6Dnz2ZnCCkT4smDdLVGhFZNXJBpAbYGGBnTv4l5Aa0Oq3JGiDqi2J7lpTfgs8AY6/NKrAmBrUqLLvNK9j31P2HSfSTh71z8QgCcr2V/TQeStbM+xhArfVZL0ZjpB5jhFmSibOnA8z7jXTxmG+gwoFEtkANkSAIWtcSdXIf/1q60PfHvRev2KH7yLn1o3DwDwbxngkWcdFE+expKZard3l8rS78eI07yhDWy31kJHWsulAg5ttbhEyENE37EjqEr4YMazBk75Rh4Nnbv3M8/iobFJXF/rZJd9x+Sv0zMjF7hjOGe/oe0aG2i39M/525wV7V7n/d5Xr7qr35ILAXkzai8n9v5iE7Yobtw46z8kgVU8rNXUd1nJtKM81wzMNlbrI8bRvGmC/Ghs/1yZWIdikhMfqPhoO9LLSxR7rztwIdE1qUbVGseZjjvkRPLK0K1MaQcH2ZIIK2pnvuN5mqoeyElosSK3jWI3AD/okSTuGlHE5e+1WwKrnoGVW4So9BcHzBrYxdaIpOQHmpsDRk1DwZjPNobVtxqDKKaOBNPOSLVCqFpypVCnwycDKKHSUoxQALK3KpUrQZa/JPn8cw3Ql7PximB0G4u1NCZ5IcVB8hE5Ji3oXrVA0VKKX3xJq4wrW+oip7bNIxh6mPKCyyt1e6ZRNRHh40dTg8gibqp4DqirnC3bOnYgGd9lbQ9cUijY8VbRx65sE/oaxalfKbA2E4Uc1c6QHdD6etgszBMuibmFxRwJ31ZHKTfZBG7mPQWgil2iEd3gFN5Faphqn9hJ1bmFeiOmQhjdLKAw6gtaAiEcrGvk9/DS3fFAhPgX9GxX4dzv5LWFNvUHHqTqv95qOMT8L5m6QuV802WgxTQ/QKD0YeIow5QRau3Pn6J/P2LsTbS00j9F3VFskq3xCtcXMKmC6lOPXP4fSsrvz5Wbcb8GkBZO/BJjcpPltDWAkA7nsSSOrRjBDxX2vTl+Iq9uXCiyugqD0k2SCNd3hZK+6kuENd9nTLnB0vVvrUtiN4gTAoqqStaqAs0jGafFaJnKizaylW/KdAET6tEuhpfGyTmMYD9pwhHDniAxUAyrrU7ws0VrooeO58EedfnrFlidUVdv6C0nHlO/ip8pcWyt6OA/nrA3ycAmtCJam6dI9+GHgynwquvULPBT17oGVXT5OGSlipFyH0vLpxE4n9FRygbNgShc1m5s/hXpwtHRFxlVN6V2hvS7zrQ8Sr9a0FNvGS3c9J9A0g50d60l5BB7Ji6kbXuFQtFr0mJbdnrNonoF6trwa0o9N+b+r8jXw43CN9lTPIZuKL8kka2ZBKptk3/1+lt6gbJHhQTXyezImlwwcRw6s7CFQspbffbD8orGD19hpuZ0t/XugX9CkPg7OU0muCVzCWW5gMjKMxERFWcl0IbwOj2pM6HB4ziZ4Ksg/jKCgIVW4jrbSyQ7SNK4mlfIQp4kMSYBsNc60FvHXNFdXFhZnoCalHo5M2DvM2ZG26loUrEmGg15FDHoutcBKqhCZPy1JagU0UNdsEzevOuflSUtTiqrCsDvJ1bV8d1zPwR122W+q44bRltpvMrai4zmuXw8c9NFcIzBD7SWp+FRVogS6nXcEHkfpESobX7E5jpk6EzG6fjdUpZHyoyR3HTYawJJ8whQhgKiWI20l9HViDdUDuZfUi1TsSZcSjFdUlpBFOiBttJjQkFaMxtw9rZRoyRKnHVRIJOIuzFo4hWbpR2BbnjtZKr6H1+2KvxEUzPyQw+BKJDReEqR3zhL/CPgtmXrW/fqlnE3zvoHNNkBzpDO7qX1DHeyno+oT3fqgwPfDBZ880ssD5iwNo14RQKetuLDmQxLgYTSSHsDoKwkwF/YF5kiNMcI1Nv1wUX93p0xRyv7T7p1jDmmV8hDUsojMscQbR+hw9WZkmrefZoRVToeaU8Dov8f4rG1mv2wz3yqOtlZU+t8USFuOo92LW/fCNlBYM8OBprq25scvP0DeHGtQtkxrC6ZVw3Ra944d83SZVgl1Bd7AMJAGXWfLZBb0az2UW2ySxlbHGL3RVP6g3oKouHMyKay8gaouYLjRlXIcKZuNjtCSsOMHN7ikZqntHCFSGXIo5+uIhIkcOeVsW+12sY51oYN+jdP0URRjWp/o0rbgd02O1rkQrnyHk0XSN2139edPzhRAACPpN9nAyaViB/+LSiIrvTJeqXV4It8cIa5PHYAWdcKG1GURhu5MqY4Kyh4n83kazSauu34+/GSVJpB6S0s3Bh0VJJuWdm1sugdgf5fNcIqVmYc+4ezwWeOl3ONxFCaYQ/katoqmeRIulo8gGquj7pClXQd1uB+5twAM2zLVZc1DsZCVjByZHNPMg+g5DEIGQgAzdHrws9ApScfc28IJYGP81Kp4YdlRCvrwD3kE0qixpjXx/homXqtA/bQKFAxjJi4wsVyNLfr+7ZBJLYrFVEU+PCGTgWv7nmqzZsgaNulnNsVylJrVW/ZLb7GOMFW0iS2vTYYU3rqkMPkqt+A0nTbG86M0Cap8FLXLYRxqWWOmnow4bANfBgfiOYcjNU20y0G6ydOE7uSuUsO/pd9JfVvSsyUzFNRrYJiWlbcmhu82tG1KhjSojPvIHWscXj2tcZp0O2KzxPOWjT8Tx5PxxBGf8Qjfy5JB0J8ve4brs+qptqOxqtjQFcXRMQ0Is31QNKb+AZoa4VXWzL0/Ni/rNnIEmAfxK0xETd61jSNH9mSW6aKK6Tl/BgfVJ0qfsAr+r8yhsC5f0w5pimXC2BcVGnAxMfF2noLlBLy63fhlE5/PSvxvGuuAFrK6yXHKuWs0IZ+Vq76Pd1syQy00unMiN/r6N+W215Bx1Q1lwWjQ0OBL9yhzYiezDTWP/cpM+mMuEy4Q9kbqN5mIrIq4/yrinihLVhux2sj+ayPfKBHsYyLCnAiEUMyla4aRh6KULQ85WSlj/aMjyFa2vHPCq9yzSquiNx+ZcyaHcca5ixCdcqYAcGTw2Wi+eDkqhKChu7RCHTm01Y9C3IrtqOZF46ibrziiZPu6B5m5xkRmwOWFQDoc+YjA3TVufOXzpKLo0mRPOnRRhimmqVMopSD0Qp48PAiT+XUxiT80aGiidQCc1EO1c3yWr8VzJpz47aGAah5X6fe0M+wTJdEbViTPM1PjaRXZyKe2T/GDhaeFDf1siL/YpxMtkrZI+odG0vbpRPt0on060T6daJ9OtE8n7qd1QT6diEFqVTjVBnJa4PlzAU8byGkDOXclyQZy2kBOG8hpAzltIKfF2zaQ0/ohf8NATmDhseNGlUpXm35i/ZOhvSGwitq+Kmp7wRDsDYG9IbA3BPaGwN4Q2BuCfdVY5A2BJ2aVYLV70mPnw7cWqVqkapGqRaoWqVqkapGqRao/CVJNAjd+G0bn0Gdc7dAMHUizKZWpmEdZ5sIRNwNONr/qMhYT7x8mlu/DlNJxyccM6GvrLWOh7Y8MbWuHOqu3Q3KvzmFccyJGWXadPhzVzW3J/EsLKLtBluEbYNhkIY+WyRD0K/PphqbwkfKFfv4xZxOKo3MCy05hM/f4bf4VMv2SupyMQhopNk1wtJUXyFRR+QusZwC3/sWyTlx4+oIMFsvFJWWzW756NglXdU2wkj1A84oeoJHiwu8UXGt2uKm87KVcwKTv0zVAO5xjAROMkwe8XL1Fdyw5e4QrLDCBB1UuAzRsOQWV0kUB9hUCtXkU3sk3nQtvycH/ZKjcM9RuApYEaVw8lhzi7/UD8LBKQ9Ov97MxSAqKcgUcP/4hOOXScaRG81RUt6Q3FQ2OiF7lqwBzNuWSn0hxquIbB3zenT4uw4KOlEQuAKVyD+kUwd5fRHfhRes4vOHBqZaFm5VQfUSVJjNsDxk1YcZsac6RA90vlIuPnAnMLfIh6KReO2Xu0M5tkKk581I9mclnUH5gvx90KCj6/ciBIActjX8Ttlo9IbgFK2akOkTXgt59Ar02EH239+F+EvvgFu+gBYlHz6pK2FVlSpGP5Drsc+n5NflI2m7JXzJ9K03/ots9Yk4cO5PrzDxhoh1kgscpTkrns+SGHeZqIXgYpgkDdw0CpqHpcVQGA8to8E74UwRY1M7XLXMvpuZEpT3ILZ0+QsyyJEqCfcanZiMGh3TBXjG0PO+0TWSphvruN4kWGpgeyvy+YQinzQminyC3vbJx4+N1A44OzDBmJay3sM4h+o4w85MDCIwS95J9ToE+JZhf/ItNASjgIstzkjp3T4DMViLSFJib87NbGb5PMnxHJsZvquPD2pR8i539PrSvBVqz2S9jNrNBZjbIbFeSbJCZDTKzQWY2yMwGmVmUb4PMyszYBpnZ1wLta4G/JNN6wtcCM7MizcC2rwJiddOooV8G3PDqX52nA7/ly4CeO4OhuPjcgTDNNOodNfyZ6d9/dBvLqpWGn/Cxx23ush/WPTe4mU1xH0Y1rnQKeNjl8b+HtW/gPax/2u5h3Ut1ZGXe4uW5h7VPyD3Uew/u4Qmec3saebAl6NkNsNTjU2veq3pY9/KUlWp7JtWwqWReffH3MYCjxdAjWr91ZKOorM18T23me6Gb2SgqG0Vlo6hsFJWNorLx/vuLWL8QagUlu+CogVaRkx3CmtQ12cVyVWhDKYwDGV208oW6UnF5SfcY9/azk6G66pNeU3QleCi5Hd7qoZRroXR+00r9QemzuqT/Ycwjqw1hCoVkESv0/AxICO1Ov+rJwu2kl7lJ5Ggke0eOq6/10oeJprgvgq1bzlo8HbTfnb3PHoRVWLDrwVLCYqjf68LA1C3xSoSz+A5YdktS2EIpeuvyuyOD7O4jn3Ksoj9dhNnz5ot7D00I+VUAkTIIvRr9YSl6Twi22DxyYDvP8H3EeSQfYOy2e8XXhVaxFmDwGs3U6xrbjnT38mnMIYsdcVOARVsAsqq133gP9a0mag2L99x6PgdYKnVUxsdaz7tyd3ieVG5cHeOjmM0jPVStDr0POvS3utVdu6f/3kvd4/KtroWX+wQvbRTRiiiiW9gxKtpkawLfX/Z4hi5St7SUhDL90pj1bZ7Q3BNTn1zJYeAsxHUY19H+C9slrbphs7TmiTvlLaGLH21eua3j3JXho8k+G2V2foJbxmDRfxtESmVUjY685iLFOXnNwHSAQymKTj0S3+WJ16yHNhzof164zOMPZdESmyPs4xVgXbtYDvsfLuAjoHX476oPX0qI1wT2TTaCQiNFqGBJQEE7USKvkVkYNKbcx/Hm3oWFathFVi9fa7gIsyfdQU/w0EWW4nlU+J4b7IoLem5AFjtCBel7pBi0tzLQXFsLd+5SGQm37fLRb+RKRDEW7S1C/VOjXkqoQKs92gwo/J/fLzBzAvZFT9euGQN7H8b0gyNXlRwxV5xx19AvHxe67/sY/UZu3jDFnitiis5Ef2o+ZSXNVD2EjGhtGGOd+XLdkTk5G15cve3i4dB/XvUHH94NzobD7uWZOjpXnXa/3ele/OfqQ/+i2+v+79mp/qU/6HbOqn//Odsu8YdTjlF7yKHYNfAryQWl4UeUX4eewAovWZjExBDNKIAMOVRRPCL+mLGXrFHyHV5Ls6ybZzJyF6JzSJ2nhpXLc7vXxehfI/hCSlxk2AV+Z9yAoWw4d4PkvvECrQUNFFe++xcyBOxf6mk+5yoRiD5a2pj1D0H9qieWpY6RvxvDWh6KohiRBJxjaPoW3fyzBBM6mC3XPTYrYU6+R6GfnJaawWJSZ4ou+x39FLN6+hhKSf9yen75Maf8XJ1q7EO1Rsq6CHHYNPUZ7bMIVoo7sAlDGHl0zJQ6RiIHqiqf9yd6BlqTJiqegw7x1hIvo0Al51RqBpL+DnXwKKFELeaD0TgKvRJ4Vwh8GT3iJxITifsVXjVFgt4O72kRzsnMrKy9i9BVQgYaqnejWWjHYOCZ0giN7XqbtqZ5fB1dPY6+a4aZVKqp/B7SUpwahzHLTI0MMzs/LZ9/VT6VOHcnyeTmaU5C5nvGhi/ZWLar+nOVzrsKZ+Cb9iD+bnZ+1D69TygulYT89UHM4Wl633HEFKIpAwZ2ePtc4sCxO+1zWELQyuY7ka6hmYYHiwjjUiibQ048HGMklIO2UdWZ5qOZAJJVpa3HifMgo1lEtHQdEYQkEaTIgM7hYLqeZPlJFFGgDNaSDcNWHHPK4wC/K95P16ew/hlZhZvk/1IBLzPRoXuPbU6KzgAW8Dt29nZYQmzQaB0xcHYPO5TkYb4N4Ii6mZqMrNiAwclwyxlGh+zaYnvrx5Nfouj8DwZVbd+tM3UKXeCW+gZklbSEkzCMd2UBWFfqA8QBkOS0/WODIfCJqGsoWRtVhpcsOB4MZYxA+oAkF2nKk1T3brL2YsGDaWb1HbV4PGkBFfhvU7Y9krsKiCSQkLrBo3sOa3vwt4zOgxNIBX2H0oHBIcM6Dnz2ZnCCkT4smDdLVGhFZNXJBpAbYGGBnTv4l5Aaxki3JGiDqi2J7lpTfgs8AY6/NKrAmBrUqLLvNK9j31P2HSfSPh71z8QgCSoikWAZ3srWDHuYCulba8yROWZMRpgpmThzGNbqNdPGYb6DCgUS2QA2RIAha1xJ1ch//WrrQ98e9F6/YofvIufWjcPAPBvGeCRZx0UTp8y7t0Kt3eXytLvx4jTvJ1PIPEcmqulAg5ttbhGqHdjVJXxha6TgyUhQZ279Q/LfCwNvWRHnVTMVR94bg8yyP3okxxPBulVmjJXYbp0daQf3CXmRbarqqxwm3Ec6Buh245dNzPSTYCaInDLraFfPQkVTJa2tt1O8U02lvaxTa0I+yyxWDR8jkuXNOTS6s4GZvk6TfEl+D20jRbxBQ4Mv3aN0xOwj0K0SaUG/0sFvzCUQJEGN1Ns7dHuHvieXU/ZS3F6K7/+l+De6oH4MJHYiEEIxlwk1DHxcsuIjJyt50j36/mplyzsb4nLRHiqbDkmoJ9SFcxhnnFOMtSpcADj/fAZfstF88XKkDWlups4q1JFDW4DPcSu2oxqwDjHPqJuvOCInQDOXeh6ZAZcXAulwpHPj3TVufOXSSuQnQWqEOtZghKxaqUpHVx3QC2ltPAiT+XXRuRAaNG4E6gC4IZXUZpFMj/ScCSd+eyigmsfVtYBOYfZExv1hhVHfNNmriw7Tzvsd1TGpMH0LdcxmcbVZXGsbkm0WVwsX//Ysrl9tPhCbD2QTJTYfiM0HYln3N80HUuLD2h1MZoD8wfnwas5Z7EuNTkLuNPLjUDLyI1JWjEd2DGM6XtxHjqfN6evYMXoD1Fhysg6Xfdu259UbLnlJlc35i+U7nCySvpkIpv78yZnq9D+mi6NccMkkXu+moScLZ5doJSLTVQieN4R6DqzxSq3DGiG1lnRVT3s3rJNmKywgaJmYUh3lAQ4ybZ66zq0Uf+UbJG0Jkk6F2ughm25uLS7LXp5QmXl4Ac0OnzVeyj0OWnACgxDXsFU0zWukbB2isTpeHpDm0KwrmKsOxUJWMvJxwCZAlZgdBiGofegO6Hjws9DpTx4p2eve6smOUts6/lF4cc9mDvpFbmxsLtuf+J5qDfAtLdTbIZMJbVkszU44XSrxmEjfYVoHl6ua9LP07mWXOAuu9wlc22u0atrEli9YDOkaY0k++fkHLLjvuF6WuguDB1CaSOGpbd8qmaF2DYlDLWvMPBcRh23gS09EPOdwpKaJzDNmHMr00p4uETZTjtEP+sYhPVvy3qNeA8O0rLwYw5sahQ2gbVMypB5s3EfuWOPw6mmN0wRfEZslnrds/Jk4nnRejviMR2iQU+/nXfaMKyjVU7Y/iBs3ZfZfcodUR4s2TktXbOiK4uiYBoShReT6qX+Apkb4qsjMvT82vYA2cgR8XPVXmIiavCtVjk1bbMWXeUc++168heI/BxS378Xb9+Lte/H2vfg6dh37XvwP/ISXfS/eauNWG/8+2vieWPbse/Hf4r34TC3snvTY+fCtfRPCqpP7qk7uCSe0b0LYNyHsmxD2TQj7JkRmKU4CNwZ9/hz6jKvtBdCBvF+nMtWOpFDmwhE3A073wtVlrNK4T0ojvj5hRtV4SeRbCGwhsIXAFgJbCGwhsIXAFgL/JBDYAtM9Bqa/J2PKlEuBkz9FyLf13fm1kaZ0rd48xNzOljkcoF+Qix8H56kvjyZwGSZR4+ZfooF4Bx3vlHuPEF6HR3VcTYfnbIKnYpZeqeSvWOQjWBprUeIM/M6kUsp/CafxHnzhTGqwO6OFtBYJQO2kaqAVQ+oqNDkyeddwS/9ao+uig22Fz6EhAnPIZiVVyF6fliS1AmlWPYW4cPOqc16eNH2eO6ow7E4K8nFLKT3r3ebBLvtNddww2lL7TV67dTzH9evB7j4mfxeYweGS0stQVQkwCcE6Ao+jjMxUaReqN8cx0+n68EWOhqo0UpoMJT9kowEsySfUUHpOsBzpNDu+xvWqB4pqqPeAXC+LalBgfJEOSCfMmdCQVozG3D2tlGjJEqfKN6Ts+tIPAYfJH4FtoeeI4nsYw/JDe7z001FlHi/SCXGK7sg1AvHWJd+FOUtft1zxrpmOrIQ1H5IAD6ORfJgBU9gHbgz7AhpHJAtahCi74ylK2X/avXNYxSiROahE7ESUTZp44whTEL3Juf0/zQirvMc0p4DRf4/xWYC9TwDbBvr9xBbAwjZQWDPDgabby5of83ER6j2W34cp4NjiIsDqaVZPs3qa1dOsnmb1NKunWT3N6mlWT7N6mtXTrJ72VHraT6snbVYnLNPaO6ZVI0nn9o8C0QxIrFsPzV6od9BNowaNY2O0XJ2gNrykXhF1ZFJZGYNUXaAqbfC738+sQcYaZKxBxhpkrEHGGmSsQcYaZKxBxhpkrG5jDTLWIGMNMtYgY5nW32yQQauKaZVQiQcbGFLVYPg80E6GGrNJbaTZbIPZaMj5tkaaj4F76zCMhNF5eG30rDXN7KlpZi8ggI2etdGzNnrWRs/a6FkbPbuvcL8QPduGM+lGrH8ytOjUolOLTi06tejUolOLTi06tejUotPvjU57oTO2uNTiUotLLS61uNTiUotLLS61uNTi0u+CS3NFqJ/shbQpnIuOfNysaqpTDoHlGrFLHee3TMmTUT09yLC0iB1/gS/1gqgLocoxbMoYWZdEnVoKi/jjYvqENJxDiyyhJleQIX+cVpIinpgOgQ7MW5GhHtSr3Fzre9Tv/aHrZpwAa/SceZ0eZfGqYRf7K2ktK0tqL+TO4Kx90X3/Doq0L9vd8/bJ+Rn8fTYYfBicncJf3feX7fPu6UF5o8Jmbg4labiNiz6zUUSusHKoSrpXOctmE3BkukfXJux4izGg4AUk5MhHQUF+nvNgjm7lr5799+uiVzWJJ9d3omWNtTZlRzY/V7kzfUVNKkxQ7Sanfsy9s1WNCV6/OtjglBfxW1dUOliRD7TA36oe9CIGivT2oxDh+DbvRCoEPOQAq+MtK+JYKNpkp9qS5Atg2pUjoiCENb5oGDbhi5XVn8DB0Xfc9f6PcbSshve4XJNr7jsrfwZ4n+R+Mh/ZSDzvHF+qXfEIh4iTMVBe/aNsePUOw19hjwOcWrGTdvAi3t7jGWog3PTdv0i6rSDFLHLhRHO+4uWS7cWuefg/qUCYc9JVBlwsAJTmi5wSpxzzlUWx8Ktnzwhi5rjqiYMvpwOKFwjrMAxNIUGCutLHuvWHkGde7hn8y8Qrmv992RSIaTDK8mnTQzmLojAqUf6yTPkHaFlCjyBU0T9AD5X+73Lp00QOBySFx1FKNNnZvSso3AHtJ6S0ofau2Bg+MAiyZYxIXLlS/ohzQ3x3kkRuvCQhfcJBV4naCUqgz4QFfR5fh0DLAexO7JVing5aOrqq9VX/1Z0+KFvKgfYcF9RmEnlQQxtjnIXbJMNLZpEpa/L0C+srvYN1sDxr97sk1jXBQ5wxOXqT7HQCsMcDxaiIiVAh+Eb+8Vafmj/uYpolN5iFVF0/BSOpwG43EajCa4QqTC9yTmip84M3hwyr7XrEMGbh/2Q/oCqD8WHUz/Pm69fNZ5qb+06QaUvpmc0C3dLZzxH7Ndt5BwMOm4Lfcvla9ZTHQEIKhQrtMEeIcOIS/EuDOefuLQ+kgUmu+ch4MzwGWYXWNZcYNY38q9ownw90FSj+Jqt+oK1quMPRnIRFv34dO4J/jLyHB/wamEskdydot8rJmV43XTPQT1pyoymCR+5Eve85c2kHVBJ8w6GXTOYTcUqrPKCNp/WxLWk5VM+1To+Y5q9MHs4aRGm4ESxNakxi1UTijQJJKYwcBvpkgfZkwhexUbXEenJn/N3ZxQG9Mm6eo8K5McF8nixYNypxgY9gw9ppKulRbCTw4eH/ALeKEOk= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the workflow launch associated with the given `workflowId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-workflow-metrics.api.mdx b/platform-api-docs/docs/describe-workflow-metrics.api.mdx deleted file mode 100644 index e0fc35b2f..000000000 --- a/platform-api-docs/docs/describe-workflow-metrics.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-workflow-metrics -title: "Get the execution metrics for the given Workflow ID" -description: "Get the execution metrics for the given Workflow ID" -sidebar_label: "Get the execution metrics for the given Workflow ID" -hide_title: true -hide_table_of_contents: true -api: eJztWUtv4jAQ/iuRT7sSgr4PnLbddqtqu2rVh/ZQ9TCEAdwmdrAdoEL57zvjJJAABbpXOEE8n+f1jZPwMRUO+la0X8RYm/depMdWvDaETtCAk1rddEVbXKINjezg3wLyB52RoRUNkYCBGB0adjEVii4IX7qizQ0hFa0k4Ab0vesdJeyYFkt3gSV3qh/ILionexINQQ0OU2mQwjuTYkPYcIAxiPZUuI+Eg+SbRJY1anFtAiHOAw9TNB8rI3tgoNIYqZZ67KVYUjnse1NPmxhcvnR2QtFfOVWbaGXR8o6jgwP+qMe7+01bQ01elGMrJEkkQ9/g1ptlyHQ5qO68Yei4yYbpcDIPEBfNnwPBGOAapcPYr89798KbQ7Se1PV+ZXebghtCpVEEnQhzYrLGLALnBpNbVH3iun10etpYpIp6kKSbKxyDUYRfW+LSEFBfQFUsRGynXgCNGn0yUm4JHB5uiTvaEne8ZYIw2bqSW+hgtKIj3svnxuHhGtvRGtvxZzYyOul4LsQDWp2aEC/Bgc8E4z3rO8f6aE/7LtLuJD+L97TvGO0GoWv3vO8c72NDvO2J3z3i6VX+2UJ/f6/fPerpxW5P/W5Sz293e+53kfuKYVEHzKrGa3QL9odCH2McAU9WKWQX0A1YtkLrviKVVZWuGK0fzI1KVwlcW/yVMdosZX68nPldKZUGSrsAIqqb8mG4xTClt6MPL41eIBg05ylrYy+vLBvW3VDbAjfAACe0y7srhL6A5sVb+nKEKpiJpjeXgk+LG2iWaPvo62SZtS1apQDbms6l2KwVz2Rbi2ZUarapoTEQA+cS2261IJHNMNJpt2lxSIU1pV5STx+9JbiPwPEsBz8ZH5zf3wguq6z6kUnKG16tfdZzjlhqrXzd8SBayb/8Kk/J29j5bkrV0357QVCRBYfdlCCXK0O0BZinC0I/XfXiqyXTgEm2cdgfcwPrGtS5PM5h8+ysecBribYuzm9chRb9f3zW6pi1yuHEtZII6IZHsXzO04LruW5Pu9s14b2kmzgZUHqMnU47YPHZRFnGy7k4zkPQlZY1XZqkHkQWlxKZHchN0vnKjN+Roiyo8yOIUkb6mRmBkbmm/KVcvj0Ux/97sPa/hJVJlY8k9VHNppps0cnsldAD+nlLvji/HHAehpi4ytalGxUXNjuf11dPhIX6EVgYee99ZVrEm0c86XdUxF2ZpeNrTjDL/gGLkLI9 -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Get the execution metrics for the given Workflow ID - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-workflow-progress.api.mdx b/platform-api-docs/docs/describe-workflow-progress.api.mdx deleted file mode 100644 index 437eee3be..000000000 --- a/platform-api-docs/docs/describe-workflow-progress.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-workflow-progress -title: "Retrieve the execution progress for the given Workflow ID" -description: "Retrieve the execution progress for the given Workflow ID" -sidebar_label: "Retrieve the execution progress for the given Workflow ID" -hide_title: true -hide_table_of_contents: true -api: eJztWM1u4zYQfhWBpxZI43R3kYNPTZx0EbSLGk62ewhyoKWxzUQiFZKyYxh+986Qoi3Z2jWF3tqcTJPzzQznj6PZMMvnhg0f2Urpl1muVoY9nTFVguZWKHmXsSG7AZNqMYVvNclYq7kGY9gZK7nmBVjQxGPDJP5BQOCF6DMmJO6U3C5wnTlOJXHGzcAvMVYLOU9EBtKKmQCNpBpeK6EB5VtdwRkz6QIKzoYbZtclCfEgtt2eteSakqewF/xagV53SnaEiawK0CJtyz6SJaSFuTuaKV1w67cuP6H0J1LVlEoaMIT4cHFBP215f/2B0FQhF2nplJdlLlJn4cGzIZLNsVA1fYbUkpE1+cMKL6AM1j9JuTr0F+7tzfrI+FRpC2SqlKNwtyirPxWvVw8CrepW5OoZF7mjEXOptF/J5ci+3a+ETcm7OSJHnpiWX6BQzvb054GbFzoo3OYEXvdrH0jAX2osLXdY+hOwJciMXE4W59n12oJxawwEv6qk9OemmhbC+ruZKk0BMrdeqryp8EoLC54PuvGE2WvhMUHRVCCOPqgeyz1cKY6+dl0ccR0LccQhhCJvWbsqjjrEWRy1D6bb2UykAmS6bsAwx6dtFGYF/m5dbPeFZNzCCAOwfe26GjUARPeLpRRCUM6N/Vpm/UBLLKvCF4cIA8AbpJVVumlerjWnLMIwL0xn7fTZHRkZdUmIpnalpI/7JiZWl30diQ29UDHi6BulIQ7QKi2RAd4sn3GQfSmNpx/Fe7hRtuMAu7IdT95H/cZTEBl0ytjjNMYDCbaHnp66R7B7QI94R8CXniG/h0RH/Q4ywv6kKup2pNs8k54ZgpBvfZMEMX/3zxNE3fVPFXJJdzTgoRU2h0YL6jy3dW9+ip0SmPFxl3VUTP8bvVR95feu6r2reu+qjl+gOjuOe6f41om+PksNqdeTPmf7NVPfw8c+N534Xg3XjzjEPUadHHo1ZZ0c+rVpnSz6Nm6dTPq2cp1MejV33+Xw/2n3Gu/42Kepf8ZpX1mej8NjfpLbxw+H3Nzjf8Mtbx18BhvOJvXQB8+J4lPX2OeaZwk1CWDo5Yue/zT7igJF8TmcfkkDYedHXtD/VmuljzT/2DGwCgPARCqb8BxbJPCWNfiViUm3dvO+a+Aa9FVlMegfn2gW1mYzcU/TEhK7gMR/oBLPMMJK0AfuaC6WIJPdPPDuxnU0dqFo/DgHd1uaIA7ZIAy1Bpv9lHE7KPcjSQN6GeaRlc4Rs7C2NMPBgJfiPM1VlZ0beMX7nQvFDjW+dyfJOOeWAiQZEX1yNb5jdLtw+Xvylbd70wQ705NEVs8R6f/UEeGOX/weQu95ZZ1RhZwpB6/9VGtBYk8pSNcVGOY1MQUZT12QtS/fvDLGmchd5M/Ub/uD5uPIfj2/vDy/cFmJXXTBXYzWc9Z/49bWbXYGs/BmB2XOhSSJTvNN7fL9aBrRw9Zoeed1dM3C9fqPbLOZcgNfdb7d0raf/1IsZMLwqWvYZjw3cKTJLj1PTYc7VX4BlHIwgF7yvCJKFzpLrgXJ76nLT5O6GPyc/HBc3qlU+HCR66Y2TWVrU26fkHqBrzHyIv08wRX2w6VtQI/KFl1sl6efbx+Qlrcz4SDyHfdOtdBvjuJBvYBE3wUtLf0nBbfbfwAUbGZN -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieve the execution progress for the given Workflow ID - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-workflow-star.api.mdx b/platform-api-docs/docs/describe-workflow-star.api.mdx deleted file mode 100644 index 03224845a..000000000 --- a/platform-api-docs/docs/describe-workflow-star.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-workflow-star -title: "Check workflow star status" -description: "Confirms whether the given `workflowId` is starred." -sidebar_label: "Check workflow star status" -hide_title: true -hide_table_of_contents: true -api: eJydVMFu2zAM/RVBpw0I4mwrevBpXdYNxYCtaDf0UBSoItOxWltSJTlZYOTfR8p2HTdBiu7ixNIj3yP5zIYHsfQ8veVr4x7z0qw9v5vwDLx0ygZlNE/53OhcucqzdQGhAMfwwZZqBZrd92EX2T1TnvkgnINsyifcWHCCMlxkmONrzLiAmw5/jUAEWeFEBQEcaWi4xhcED0kRokiCFaHgL3X1uZDVKb1kKgMdVK6AMjt4qhVK4WlwNUy4lwVUgqcNDxtLJG0Q324nI15vhYSB+KkGtznIHIFM1xU4Jcfce1xKB1jGq9y4SoT26PQE2e9IqrdGe/AU8XE2o58x368fGCoNZtGBboW1pZKxu8mDJ0izT2oWDyADNdnRLIJqCXaae6gZPKhQ0tHcgQijeV11OhFGwJPZpwNK+6kzbQITJYbiDCL6ZB/9EzG5qXX2lvKGyd7yCrwXSyDPHq+6Bx4t+dw5M64SL9GehSELLyGmJSemPOnbmDRDQ7eJb23twa16T9euRHwRgvVpkgirprI0dTb18IStmiqz567reMMuSxHILmxOeHZ2ecHJLR5k7VTYXFND2uK+gHDgzmpS9lwfMfZepPdFBOFJ++dbb8SHdYhNUDo3MbxrRqeCaF8TSOUqCb4D0ySFjJMcF79bMg5TlfE7yM3n4QKFUOdang/T09PpjM6s8aES0QjdtzovQD6y9bAChKNHqP1Luc1grf9cZV1HA/wNiS0FLgaUFEtrOj8M+xPh6Wh/RUvg3AosgYBNsxAe/rhyu6XjdsGQUTLlxaIkX+ei9HCkilfWz0G5j7DZ23ArUdaEjL5aCaeI/41a3l11n+N7dnQfHxTVHQq92VWzK7Zr4/YO0QWIDHORvhZwJiXYsBO6tziosOcP+Pv5b3T6P3+Cauc= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Confirms whether the given `workflowId` is starred. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-workflow-task.api.mdx b/platform-api-docs/docs/describe-workflow-task.api.mdx deleted file mode 100644 index f3d28f696..000000000 --- a/platform-api-docs/docs/describe-workflow-task.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-workflow-task -title: "Describe a task entity with the given ID" -description: "Describe a task entity with the given ID" -sidebar_label: "Describe a task entity with the given ID" -hide_title: true -hide_table_of_contents: true -api: eJylV99z2jgQ/lc8erqbISHXdvLA0xGa9phr0kxCrjOXyYOwF6zEthxpDWEY/++3K9tgihJM7wkjfVrtj29Xu2uBcm7F4EEstXmeJXppxWNP6ByMRKWzcSQG4jPY0Kgp/KghE2mfRU/k0sgUEAyfX4uM/hC4kUMne0JltJJLjOk7clJylkqLjazAolHZPFARZKhmCgxBDbwUygDdjaaAnrBhDKkUg7XAVc6XVIdEWfY29yIpdeBO1jvIihSMCo+8UGUIcwedaZNKrJbOP+2owKbbXIaw1eOlALPyGu+Afm2Ouf2Rlbe5zixYPvHh7Ix/du/7/jcdDTVJyZB3ZZ4nKnQB7j9Zhqz3L9XTJwiR42yYDqiqC9jP/Lt12QOFQ2JhCVoHgZR6X0gsbewJZ6/2pGeDzodgrXePKOxdt8U0Vbi/1XJjJBFOUNGljEdpjoCHOs0T4n/3E6mOiqSNl8ZIpodCSH22lVXYpMoo+j4TJdLJHA9y5eMHZ6DjhN9XISV86A8K8zpSfgWI4IU/YmFe2I56pZBqSpMuhKdUUhUBO0Cd37tBIVt4rYBXCAvUfuNTGcYUmolb97kg0UX0r87eorQK4UpHkPgYBFQa6tzKImm4olCaI+fW6wlvniyk4XSxb6BQIXNNjFiJm+1djlO2zQISNiW3sLXGaDMMq7Lh9YbCuyrZu0U2Kqp3pGMUDMjkiKBlJHvB1dbrXiLgvpHt1NTFNHF5mRMBO0KNPWx6pdxiV+h70Bzk821nwYz+p7twE8bSdMQuj8DaFdWMI7DL7hyILlYIXd2xNFQ9jzmw0MkIXw/XzAqtssURaE6Qjqmhoi4yieRFkkhmn+tNys0j29HzP2frXoG5vvxB/+7uL67Gk8nlZ/q+vb++Hl9/pa/RcPSXWxp9v7r5dlltfxmOv7mP4cX3W15qFRtuseoCwdlPj9+I4ongSVHvI+kxN5EW7/Po/wgpdxUU7YWmueWN27qTIgBDPvl6qQsZBdz7gMVjmqp2u0Q128o5HG6TGqC3MWgMuOSavaf5R08X2DT1QaYxkAl136QPwy29cZRFK9fHX4A0YIYFNdCDh0duMHfFNA4LZMBMDLhxxVWwVBgHGEMwp5KcBWMmCE0HseYJYg7OOG7KB6LfjAj99XZYKPssrL+uyF3yOwZm0cwWhaE3UsSIuR30+zJXp+5pPbXwQjadKr3XYt+5neAmkcgMCdwrGAxvxoItagy+4/hUvm6bvXE339g05Px/6kC0Un18abj3tETnSJXNtDtex6bWgq89pCCbS2+0rcGu7QsdsXaNb5tM3FKJy/aZ/nO7wTWOPFfd88fp+fnpmXs36NVPpeNlPbAcEcod5Tf+QXjFfp5Qf8oXOEXXdZi3EyWdHuxMhVjNj4PttBC7huRBrNdTaeHeJGXJy9X0xASgpo/zmbg0k4mFPX02eXhotvIq/gyrvfFtIRNubIXjC7VaqqonR+ny222d9b8H7867XqWaESFbtbVpK1s7lCfQX9Lp7Xn4FxSqg1k+EjKmJ5wHFnJWtTkMQ8ixdWyvWLKXN+Xi6+WEsHI3F3/KPSfdqxKRyCEm+hmystxqyP9ZwbL8D8amvho= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Describe a task entity with the given ID - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-workflow.api.mdx b/platform-api-docs/docs/describe-workflow.api.mdx deleted file mode 100644 index 7c83dcb97..000000000 --- a/platform-api-docs/docs/describe-workflow.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-workflow -title: "Describe workflow" -description: "Retrieves the details of the workflow record associated with the given `workflowId`." -sidebar_label: "Describe workflow" -hide_title: true -hide_table_of_contents: true -api: eJztGsty47jxV1g8JVUe2+N5VOLT2rK95aytcfzYOUy5aiGyJWGGJDgAKNtx6d+3GwAlUgQlcDfJIZmTILLf6BfAfo01m6n4+Ev8JOS3aSaeVPy4F6egEslLzUURH8e3oCWHBahIzyFKQTOeqUhMzd8aL5KQCJlGTCmRcKYhjZ64nhuYGV9AEf1Wg16mv+3He7EoQTJicZkikzPDcgKfHRAClEyyHDRIEvA1LvAPAq6pIAgn+Uqm5/Gm0DWdSKHwxSziKRSaTzlIBJXwveISkK+WFezFKplDzuLj11i/lMTEIsXL5V6LrypZAmvG3yuQL17OBjAqqhwkT9q8O7x4oWFmXk2FzJm2jz6+b3FnGiWaVBrUduYjkefsjQKyHe1BxpWmrVrjR1rgXtkd3Y9wbytZqIgVEeSlfokWLKsgQkkiYMl8jRcVQkeqhIT0SGn/4LnMRIrCTVmmfEZkUjKSkGvIVde4SAENRL4nUPqc/wvIsBmbQEZK5qAUmxl9c17wnGXkmc9vCOnNgkkyjBqIrbnOoOEc/yQbntQqosGXj+QcqhSFAiPy0eEh/bSN/OkXJJsI3LdC01tWlhlPjC8ffFUE8tq1hph8hUSTW0vyfM0tg9qdab12yy9IHjeySK94ARaHsMfkDChhVbgVSqlsBOG6muScGFQKpHtP1M+4NLpvFcOxVmgM8lWrg0OZCJEBK+Il8tBMV1v38u7h9Pry/v78DJ/dPozHl+OfcXX3MBqdn5+Zpxcnl1dmMToZj86v7Pph/Mv40+exb5PuLE/kLp4KkJQtdscObSNLPxXZi43xJT0oheJaYNR0Ax291NDN2fMVFDNMKMdvP+51oZyRPQZYCZBi4L1BlwRnMDkAHHe9zDDlhWPQnxHqqiENRNqLiyrDQCEj2/TXMVXGlH4o038v0dpr21b+26HPyiu3bgO/820JOvKUZ5t03x76CNfx4HMAijiuOzzf++isQiwA1maOMLoSFly56NupTDNFbBr17z2WWmWRNsKRl4GV3APulydjVZHMO4oeHXllL6Z8doH7psIrxnLpmgLly6ssTTllLpbdNFKbcz7L7x6ePcGIr9GOfApK787XBZKgrPQrtiXdjTry2SWFKasyfSoZmicEYRFOey5yuMFCF7SfM65zkVbO5s39/OCXu1H0Nvb/6L0HofB4ipdyznhxZ2gHORar9FzIIMo86drtw4cO4LJRZqbX9eaTCm57dzvCgE2aVDzrVBcfIKVSrBh5GZr/W3qMa9ldofZGSVsJqjfY+dwjsYt8czO8Bk6wK4R0JKqiGSz+OvzuiDCmeFwYhsFnhZDDUFSVJDAMpaGJ091T7ddU+2Aa6vWBNPXpg7HS3CTNt9hSTdrC4/YyveYaDO4UCYZ3EgfDW+nPKnugCzrc1DoMRHKaDMJqRcmdiQxiX6k2gZ4YgYLammYj1GiIg7NAS4YLw/oaT9KmKWEL+FNitGh/Rmo1ZZBSyGt7FPJ6nQG4xcbY16SaEkDdqI+pp8Fz7UVff0Wlqr/3KjTWBNjx9ryYuWanp1e5cI1gT2/Sxz4d5oPwzPXd5kloW6rBg1WVg9+DjEMr5X+ZidlFt7f1VTQ8HVU6HLZ599KuS57C1PSv+rhq93sm26LvOOTeNDCah102QQc0B3ibSGhRVleCudW9PWLgig70Nm/EqyxlbkQWI/1898R1QldBmJbSkQWm5TXkwtyV0J97pr7ZGwJ6eAvf12tFz0tg3xwuLVe49KfGLaFIbVGmIDh9sdcy9lZF2QN6Yd/b86LVzaUus16IrCnwk8SW19LZeVSvmYfmy1qAMPha9EHZOJi627owYOcLYcC1CwVq6bYqDLr2szBo60zn0ylPOBRJ87ZhWwUtq6Eow4/+f+ho365yQekRkkoLOfBkZ6I70DNcSgiGNqlkyPbdqlBZ1nkk1PXqjBEG30gNYQit1BLo4M30GYayTqXh8KPwHW6k7TCEVdoOBx8ifqMUBDqdaN0muDA2J0w9QE4LPcDZLcIAf0eE64Euv0YJ9voVykgU2AuVG91Wyzy3AyMEUT4PDRLE+XV4nCDW5fBQoS3xe4OnsTI7Z5sragtB3XS7rE4y/d/opZzKP7qqH13Vj66qW4FcdHgPyIEFhQ70pYTEyllfjYfXlz780HLjxR/UcG2jEFaMvBQGNWVeCsPaNC+JoY2bl8jQVs5LZFBz10vh/6fda9TxGxumtozTc6HNBylbzIPui9rUTPE/Y/ZCr8yYJvDdVy7ck4gan2j6b3hG9pPAjeN0pgXhfRWTy2IqBvLdZuKNK6iOpPmWa8u+MQR3NzcyYynDLP0Pq6BTV8hZ2JyBhR37rbrXGhoKPO7VGL003YzL7rP1n92hHl/BREUzQt436KuikknPVSdXZ/ZTaO/rF+TJk77XlyisLEXG/FfSf6x4N3zgiix7NjE+YDy0Hizy8lqNGA245Wgw2xx4u3VjRwSFYO99g0enLI2o16ePlQMmkJrHgzqsdjbE/fHXUOLcfj/YkPxdV/JPdbSbOTKWocJgE6SCpMLa+WJm/E6BSZAnFd1Ef3mkaawc9FzQgOAMjIw063ccH9Q3ygev63nAJZ0GQC7qgcFKZgg617pUxwcHrOT7SSaqdF/BdxRmn4t4c3ruzryJ6twXjQg+Orm5jEmUWtI7Mqw1UlPelZ2IY+zm4YzPGCB8YhcXtRN+fdLGArxOrM6oTgpiu0tAUpdjaXHA5kOJ/WbXVr6pMjoFz0ycT8VP6xfNhjR+u//x4/6hqTh4cs2ZcSg3ilg77mr0c1PK17Vn/qdmR52lNTzrA6yJ3ASkUfnVuch6ohXBjxtDo4/0JYpO41/i19cJU/Ags+WSHtuJSvKclCv3sc3NNvbqt2PY0yvnN0AuG/OkLqXGMc18hrP/L457blGlNZy61uSR/khuh8IGWfUvty5j/TXaOsfrlanOxcVLU5qm2Z0nLB8Reo6dP312RPkswAmevUvdQO3k1lZa+vn8PrYTKs0q0Y54Q90rFnqggbgX36BYLldSavpPAi6XvwPbkI18 -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the workflow record associated with the given `workflowId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/describe-workspace.api.mdx b/platform-api-docs/docs/describe-workspace.api.mdx deleted file mode 100644 index 5ab3610e4..000000000 --- a/platform-api-docs/docs/describe-workspace.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: describe-workspace -title: "Describe workspace" -description: "Retrieves the details of the workspace identified by the given `workspaceId`." -sidebar_label: "Describe workspace" -hide_title: true -hide_table_of_contents: true -api: eJytVmtv0zAU/SuRxYdNSh+DaUKVEHRjQAWCqXsg0RVwk9vUmxtnttNRQv479zppkj60AeLLFtv3ce7x8b3NmOWRYb0Ru1f61iQ8AMPGPgvBBFokVqiY9dgQrBawAOPZGXghWC6k8dTULStHT4QQWzEVEHqTpTuLxAJi73tlMgi/t5nPVAKaU+xBiNFfu1wT+LyyQouEaz4HC5qwZSzGBVoqHaGHzwSBSridsU2kn3TEY/HTBffidA5aBDUujfYa7lKhARNbnYLPTDCDOWe9jNllQklEbCFyplOl59wWW0eHLM/9CkmjogfxVDX9fzBjcjeJig1eGXo87Xbp3wYf79E1UBgltnTKk0SKwNHTuTFkkm0nVZMbCCzdgqabsqJIUNVMixr5iE1TKT8SL35Bj88WwoiJkMIuSUwPhxXhn9SLoTELn0gouMrLXOg65z8+QBwh+73DLknHom6o+K8j3vrZb325vg7Hey97jdWvUesbbr1obO3vZwf+s+f5E1YBNqj6OGKYqqpwPd1Bt7vDeO0GNu13OTTYqpkoj30GqBxi+Ww4uOpfnOLO+bv+8PS1Y1ZYIoRd1REIALdwogH/hrsCVsySXcsKLAudJDf2Mgn/ximvAdRvt7m79bKHpWDRiuwOd0n2mIceqQuM/RvtNgU5B2N4BI9rb2W4VXCzilOtld5C/mzHY1u1NS9W1uNSqnvEQ+YGglS7+8Vmdgxcg+6npIjRmN4xdrqZolYYgcNInaTHOtjuTCdzTS/v1P25kzW6T84oul6sOmWqJbrOrE1Mr9PhiWgHUqVh28AdgmsLtdWizt2Jdya5pUv2Tsje658NGEFbIT8nogvSmvgr3igjKxsYrSfOCHeKjzcr+dzcW8eIiKfKuZcklygo7WMAqVyBPJTGpBAeOIWsF98sGUUipGsmU/WqPqDHh8wVeQ7aR0ftLu0lytg5dwIr+/1KyfW024SZ1VL97/Oy5NjCD9tJJMdxgyBdsVkplhHNRoOmvdWMbMxz3G3OK7zVGRZITlk24QYutcxz2sZHp0mj+LngWhTdFkUVCkPfqNAplwYeqHxvWD7Dfe/xUbyzrHKTx0uaI1ymtMLPW1hWvwBoEP8TpkfG8T8AahKbj9F8BjzEYERbYdEPAkhsw3erj621gLenF2jL11/Xxmty0Xfiwgt1FhfqFuI8r2BaWhPAPP8NxvRqjg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the workspace identified by the given `workspaceId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/download-avatar.api.mdx b/platform-api-docs/docs/download-avatar.api.mdx deleted file mode 100644 index 11fd73f1a..000000000 --- a/platform-api-docs/docs/download-avatar.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: download-avatar -title: "Download the avatar image" -description: "Download the avatar image" -sidebar_label: "Download the avatar image" -hide_title: true -hide_table_of_contents: true -api: eJyVVE1v2zAM/SuCThtgJN1W9ODT0q0bigFb0XanIgfGZmK1sqRKcrvA8H8fKX80WbIOO1mWHvkeySe1MsImyPxOwhNE8EEuM2kdeojKmstS5vKzfTbaQrlIAJlJBx5qjOg5rpWGfgjWx1NEJpWhfwexonWJofDKcTba7HOIEL0yG6FKNFGtFXJWj4+N8kiM0TeYyVBUWIPMWxm3jgn6INl1SwYHZ03AwOfvT074s8/04xvlLKyJRMGn4JxWRapqfh8Y0v6VIpNr62ugOLlSBvyWSLsuk6fHiM6hFKwdQ/wfxpdy72SNIcAGufWDELu6x4LzOc/DiKqvdAQeaQqFqqh568J766+HBk3KPxxp0ThmYWwUoLV9Jj0JfXqI/k6YtW1MKVBjzTVy4oBF41XcJiecI3j0i4YGn98teU77KUYniVih6P0iVM0FZVRarCzbbYOpbnZPLueDK+ftaK9OMql/Gt3XeE24KkYX8vkcnJoV2jblLOAjVTdT9sCDN+lEXGmIPGbxifFicXUpWfFY0A1Pqu/6bllT45lRDi7l/1UC0U6/+DIa6P65b5Qya5vChykNKpj2XwK5XFVgGMBsMSiSxfaL3y2ZXKb4jGk/vhyQEO5cz/NudnY2O+E9Z0OsITl0uM2vjWpP7dSQiL/i3Gmgy08Zk7J2GOPL45LJfHonqNkV8fJx264g4E+vu4636TJ5dhQtn8ArWHHHaNalCrwml6xBBzxQMl0++eZ6uF5vxStPzlHlwyaYrWR63fAfLR9wu/vKdUvCVgglZWJt/fGiKNDFncCDR4A9Nnn968UtYWHfWX84KWU/Koq6lhC39gFN100aI/+zwK77Da9NA1g= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Download the avatar image - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/download-data-link.api.mdx b/platform-api-docs/docs/download-data-link.api.mdx deleted file mode 100644 index c29acf4e9..000000000 --- a/platform-api-docs/docs/download-data-link.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: download-data-link -title: "Download data-link file at path" -description: "Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`." -sidebar_label: "Download data-link file at path" -hide_title: true -hide_table_of_contents: true -api: eJzNVstuEzEU/RXLK5BCUqDqYlb0iSoQVG0RiypSnZmbjJuJPbU9DdFoJD6CL+RLuNfzDJkmbReIblLb5/qc+/Tk3ImZ5cENj4QTbxKp5paPBzwCGxqZOqkVD/iJXqpEi8gyFwMLtXKgHBPOL2fyARS7ncoELoSLb5lUfr+5kAlrdSiFg4gtpYu7VgT6jJjz6HbIB1ynYASRnkcd2pMKhIBUGLEAB4Y051zhAoHtLQiRpDhFJXzDjUaRdUaqGZMR+iGnEgxiDdxn0gASO5PBgNswhoXgQc7dKiWW0ogXxaAhrp3eSnuGIEYnzGkWVT69kDBEPGkWiW2dvc/ArDZoj1tor79PoVtqM7epCGEX2fcayFS2ACPDHVwSS2jmj6baLIQrtw72kX1MkbGpVhYsWbzb26Ofdb6vn9C0KkQ6FWmayNCXzujOEiR/1MEO50Qqgd4U+Dfg+31ERyK6xDyBdc8hbFN7wxdgrZgBdVWlQ0/uIKT7UkMF72TpaA3sywh30iW0dWqMNpdVfBrh73siVLcSUxp7NUn0EvV49P4m+ot2ZzpTEfv98xdrss60YZ2K8zdNCTZghxfnLJJWTBLsaoynb+rGcECW7QDAha//xv5/jSUeWggzI93Kz5cjEAbMYYZdHdyMqTRx+MSahtMMPCs1fMBH7fQc5e00KkaddrdgHuq5lZkErWLnUhuMRiKVwzDRWTS0cI9ZG0q90WBX/oRdJMJR9bJjwlMWOKmqRV9R1MoIdKU3QSDGuh1pPfEg3Cn/Oav74m7pfKSkmmpvXkWsUkG0uwSSuzIEW4Ep3SL06V53vusyZlwmfhRM9Yf2AIVQ5Eqet8ODg+Ee7aXauoXw1VKNq/rB6JQeTWh6qfomc94W4b974qpMOPjhRmkicKaiKz4keVVNa2/xgAdrr1tTUJj1GANA8DyfCAvfTFIUtF1OaCqzukF5MMX2hS3u73oselXPYdXzJD2IJCMsp3fk6Qp2vCBbBKw/Ui39mBZGEv8zo/Hqspo5r9n2b4ZeVdWmUKuunFptJ5vPC1BH1GNfFC+Q03zBFGPExiAidIyiVR4fhiGkrmO4MavXhuLH02vEivWh89eQ8bf3isI69ohrPQeFtVxrdLQmgUXxB5dzszs= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/download-dataset-v-2.api.mdx b/platform-api-docs/docs/download-dataset-v-2.api.mdx deleted file mode 100644 index 97932a113..000000000 --- a/platform-api-docs/docs/download-dataset-v-2.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: download-dataset-v-2 -title: "Download dataset content" -description: "Downloads the content of the dataset version identified by the given `datasetId` and `version`. The `fileName` must match the original uploaded filename." -sidebar_label: "Download dataset content" -hide_title: true -hide_table_of_contents: true -api: eJzNVdtOGzEQ/RXLT60UZSlFPOxToUCFqlIEtH1AkeLsThLDxl5sb2i02n/vjNfOvVxSVQIJwdpnPOfMteZOjCxPb3kunLDgLO91eA42M7J0Uiue8hP9qAotcsvcGFimlQPlmB76z2DGpmAswpnM8VIOJeRsMPOIkZyCYv0APM/7TKic9YNBv8tuENQfygIuxAT6bFJZxybCZWNvro0cSSUKVpVEAt8lqEJol3e4LsEI4nmeLzE9aX393EdEKQxiHXpDlTUnQ0Q+anNvS5EB2nW4JJkPFZgZXxf/KwKZqiZgZLZQaIiAzcYwETytuZuV9LLE8IzA4NVQG5TRHh0e8KbpzN3PgxGdl8KNN3wHGcw6I9VozbGBh0oaQNnOVLCFSGu14jbE/EVOY0JR9mB3jzGtT7o8QxAjA4Yha6sqJBKzHQss1F2XfXtNfbycc4/AttTKgqX7/b09+rPK9PtXfDMwoVtRloXMfAEmd5Yg9V9dLBXEAAljrTX40+EH2xwdi5wRd7DuNR4Xcm/5BKwVI6B+DkT04A4yeq801DdOtkojcFsiuZOuoKNTY7S5CgGaM/+4JUSxI5nSjomi0I/Ix6MPNtEXiBnqSuVvVSVeWsgqI93Mz49jEAbMUYVlnN72qGpwuIw1TZ8ReK9U4SlP4jxN6nmzN8k0qUNfNYlK6tgdDQ0SMNM4pCpT4BNj50qbJokoZTcrdJV3LTxgcLtSb7TQtb9hl4VwVGXsM+HZ0eU5J4pRwTWFsA3Hso55RMhjnGn0PfAgPGn/OYv1e/fofNikGmpvHsIXWJDb5wiSXJmBDWDKvch87lfFL0vG9MvCz9Oh/rS4QCJxsKX8Q/fwsLtHZ6W2biJ86YRhFNfD+kxZJ1svSvFNL7+QNQe/XVIWAgcsyvbhq0MZLq31Dk+Xt86UDhb7gH7T+bDGkhlj9Mi+rgdo88MUTUPH7ZKkGs2lFYOCmnAoCgtPhPC5FbpVxj3MNtb0VBQVIX1NT4WRROCVZN5dheHxnj25XreSCodCzZbZRLKL8NIC/CdKm8t3Bz4xuzuz+Y97eQc58+pseogdA75pfPLb66Msg9ItGW7skJVh/eX0BrFidf6tzTv/+lZS2BUecaPvQTXNnKOjbyLYNH8ADnzvdg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Downloads the content of the dataset version identified by the given `datasetId` and `version`. The `fileName` must match the original uploaded filename. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/download-dataset.api.mdx b/platform-api-docs/docs/download-dataset.api.mdx deleted file mode 100644 index 53c996400..000000000 --- a/platform-api-docs/docs/download-dataset.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: download-dataset -title: "Download dataset content" -description: "Downloads the content of the dataset identified by the given `datasetId` and `version`." -sidebar_label: "Download dataset content" -hide_title: true -hide_table_of_contents: true -api: eJzNVd9v2jAQ/lcsP20SImyr+pCntWs7VZO6qu22B4SESS7gNtip7cBQlP99d44ToGVUIE3aA8I/vvN9d/nuruJOTC2PhzwVTlhwlo96PAWbGFk4qRWP+YVeqlyL1DI3A5Zo5UA5pjO/DWZMpngoMwkpm6z8zVQuQLFxAFynYyZUysYLMBbfHfd5j+sCjCAv1+mGn4vGAu8LYcQcHFogw4or3CBuqc2TLUQCaNXjkigWws34S96/WhxT5RyMTNYkDYINPJfSAHp2poQet8kM5oLHFXergvxIDHTqoZk2c+Gao9MTXte9jkwX3l4qISRmnZFqeiCPxmjLa0jiXp8/GwwFPwHDnGZpSPCRTjOZww0t93m9QhAjA4ZJaxQSvKIyWrEEDR3EY0RgW2hlwdL9x8GA/ra9f/+Gb7av460oilwmXmLRoyVI9VcXG595IpUwK3SK4fOTXY7ORcqIO1h3iMd1uEM+B2vFFKjeAhE9eYTE695QZTjZRNoCd30c7qTL6ejSGG3uQoI65p92pKitOaa0YyLP9RL5ePTJa/QNYjJdqvR/jRIvLSSlkW7le8Q5CAPmrERpxsMRqQYbyExTf5mGnkJXPOq6iI2qjY5SR20jjKqututoEVWh5upIRVVbCjUn92bRdqjS5Pj2zLnCxlEkCtlPcl2mfQvPmPW+1K/q5d7fsNtcOJIf+0J4dnZ7zYl7G9o95bbJ02aAXarIIw/VQ/uJB+FJs7hqhf24dD6fUmXam4e8Bhbk9i2CFK7ErAUwiUIkXhTbwW+GjLqQuW+fmf68vkAibSOL+Yf+6Wl/QGeFtm4uvKZC52knw44GskW2Wmv0H06tkHMHv11U5AJ7IZL2wVdBXcP1jLJoEG9PrG7S4s3m+FjQwbqz0y/uei6KYYZ5oberaoI2P0xe13SMTciQ9nG5EEaKCX1R1GIqLa1R+ZnILexJ1bu7ULDv2Rszc2fo4VCoFQUh8pJ2uHyC1YtpTcPkKFr75ucRnNZZP5rR3ul6BKX2ux9N6MDBewTFTov1CLEzwJeNV1pzfZYkULgNw1dDYqsbf718QKzY7mMv+pZ/fScprAGPeNBPoOq64+hoTwTr+g+4+8E4 -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Downloads the content of the dataset identified by the given `datasetId` and `version`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/download-workflow-log.api.mdx b/platform-api-docs/docs/download-workflow-log.api.mdx deleted file mode 100644 index 708eb840a..000000000 --- a/platform-api-docs/docs/download-workflow-log.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: download-workflow-log -title: "Download workflow files" -description: "Downloads the workflow files for the Nextflow main job associated with the given `workflowId`." -sidebar_label: "Download workflow files" -hide_title: true -hide_table_of_contents: true -api: eJy1VU1v2zAM/SuCThsQJN1W9JDT2q0dig1d0XbooQhQxWZipYqkSnKzwPB/HynbsZ2kX4flkkh61Hskn5iCBzH3fHzHV8Y9zJRZeT4Z8BR84qQN0mg+5t/NSisjUs9CBqwBsplU4NnMuLh9AX9D3F4KqdnCTJnw3iRSBEjZSoYsoubyCTS7b+44T++HfMCNBSeI7Dzt0N3WoF9mjhgrnFhCAEdqC65xgdj2IoRIEmtFyPh2Bs1VzAcn9ZzJFHSQMwkOoQ4ec+kAqYPLYcB9ksFS8HHBw9oSSRXEy3Kw4aXcL+hnzfqYg1vv0J4higJYMCyts+JvI6DEvBUJtJnt57htgEznS3Ay6Se3wyV1gHk8ws4tRai2jg6RfUK18NZoD54iPh8c0Fef7/dPDE0M3qIDnQprlUxi90YLT5Di2QQ7nFOpBWZT4mfAD/cRnYiUUWvAh/cwtt2840vwXsyBHF0LMdMFJHSfdWS6IKtMG+C+lvAgg6KtU+eMu6oLtFH+ZU+JGjszbQITCo2HegjuIcmdDOto4RMQDtxxjn4d302o+ujvzNATmEPUSFYe81Fj8lHR2r0cdQ0F7ql5GLlTGJOFYP14NBJWDhNl8nTo4RFVDaXZcdB1PGGXSgRqD/tGeHZ8ec5JUyP5mipcVasrfFMwYmz8RutpBOFO9eOsafxiFWIppJ6ZGF5Xt1ZBtK8JpHRlgrOnApM1RBKt0U++mzK6Q6ro9Zn52h6gEKpcxfNpeHQ0PKA9a3xYiuis+j02Q2lr/G1rLVqj/v+xWVc+4BUjqzCepMcSFLV32rGO8HFvWG7sgz3OMF0CF8VUePjjVFnSdjVwyFSp9GKq6FHNhPLwQtLPjLy9Uh9g3R+lT0LlBOM0CN/O+coIfIG7P2Vb+gktnCT+d+b/4aqePx/Zi386e0XVm0Kvu2q6Yuv2lRNEZyBSvIv0VYDjJAEbOqE7k7I3ZH6c3iBW9J/x1rONt++VhV6JiBvzABr90qgMtCaBZfkPc3fnQg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Downloads the workflow files for the Nextflow main job associated with the given `workflowId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/download-workflow-task-log.api.mdx b/platform-api-docs/docs/download-workflow-task-log.api.mdx deleted file mode 100644 index 75814a4c0..000000000 --- a/platform-api-docs/docs/download-workflow-task-log.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: download-workflow-task-log -title: "Download workflow task files" -description: "Downloads the workflow files of the task identified by the given `taskId`." -sidebar_label: "Download workflow task files" -hide_title: true -hide_table_of_contents: true -api: eJytVVFP2zAQ/iuWnzapatiGeMjTYIMJbdoQMPGAKuEml9Y0jY3twKoo/313jkMSCIVO60sT+zvfd+fvvlTciYXl8TV/UGaV5erB8tmEp2ATI7WTquAx/6oeilyJ1DK3BNYCWSZzsExlftUJu2IyhcLJTELK5hu/vJD3ULAb2j1Nb6Z8wpUGI+jg07R39FU49BKBP9QCcVoYsQYHhthVvMAXxLfJMXjCJZHTwi35U8btccw6I4tFR8wg1MBdKQ1gemdKmHCbLGEteFxxt9GUpAnidT15zNsUsDUnUWdFuQYjkx0TysLBwkMzZdbCNUsH+wMK1O6f9BhI3JVgNs9YnCCKAphTLA3N5W+rkXprtUigK3Q8x1ULHC93l/Jm1B2rVWHBUsTHvT36G+b79R1DE4WnFI52hda5TLyIoltLkOrFAns557IQWE2NvwnfH0t0JFJGlwXW7ZKxu99rvgZrxQJoiAIRNb+FhM7ThrTvZFNpCxy7Eu6ky2np2BhlzkODHpl/GmlRO1WsUI6JHLWPfAhuISmNdBs/RUcgDJjDEuUbX8+o+zhiS0WTuADPkZQd86ids6jqJq6OWkFFVTMPNd02mPt2SEuTY/DSOW3jKBJaTpNclenUwh3Sm0r1TEoXfoed5cLRPbEvhGeHZ6ecyLXcL6jVTdv6FTx2jjK2wqP3uQfhSvNw0irg9sH5nsgiUz48tDmwoLSvEaRyZYK+14BJIyLxGhkW3y8ZZSJzL/pMfe42kAh1rsnzYXpwMN2jNa2sWwsvsTCYrUl21uvd1vvvU8JVJ9v/69uh1Q7+uEjnAu0Bufqaq6Ca7huC8Hjg1D0nioOV4vUusVIKq6q5sPDb5HVNy43pkJ5SacU8p8HKRG5hS6kv2N4o6RVshnZ6L/KSYJzM8O05X7HBLbmHTtuln9GLkZR/x/rfnQcPes+2fvtGSYVFUWz6bPpkw0Xu1p8ep5e/jf9AKAioniFyCSLFc6hZzeZhkoB2vbBn1j1wvW/Hl4gVQzt5Yh/+9FFKKFyPuFQrKOq6Y0jvRLCu/wL7HD2Z -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Downloads the workflow files of the task identified by the given `taskId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/explore-data-link-1.api.mdx b/platform-api-docs/docs/explore-data-link-1.api.mdx deleted file mode 100644 index 96d38dfef..000000000 --- a/platform-api-docs/docs/explore-data-link-1.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: explore-data-link-1 -title: "Explore data-link path" -description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." -sidebar_label: "Explore data-link path" -hide_title: true -hide_table_of_contents: true -api: eJzNV9tu20YQ/ZXFPiWASjmJkQc91Re5EOo4huOiD4ZRrcihtDbJpXeXlhWBQD+iX9gv6czyLimUbKBFnyRyZ+acmZ0b19yKueGjOx4IK36KZPJo+P2AB2B8LVMrVcJH/AaslvAMhtkFMF8lFhLLVOgea0UmjFG+FBYCtpR24U7n8hkSNiWhS5SZBNMBE7Z9lAq7mHp8wFUKWhDiJEDM8UsaKQ3npeIfH1AiFVrEYEET4zVP8AElG9soIokvmeSbTpzXPA16k8yZDNALGUrQKKvhKZMaENnqDAbc+AuIBR+tuV2lhFIo8Twf1MAlzI8hz8pIlYdvwVgq/WhS4UPj3VMGerWF9XslyJIsBi39rn9bWBKpzd1RqHQsbPHq83EH3Ue2ZEREZh/+WSO6M8CHOGtAaH/Rj3OtIZQvrBClHGzyr0zMA8ESeLHXYg636hGSfkwnwjKDiW0VC8H6RXKTCbzcORAPaSE2B2KTzjf5Hfphr7J4Brq2TdgabKYThpXicD02CZmKY2mx6LCwWAChyCLLYvEi4yxmzyLKgElTKkLgHZ4Lnz4i53tKW5OqxIAhjY9HR/TTJfr1V1Stoo+nIk0j6btaHj4YEllvg6rZA/h0WammyreyAFBazmUiomuqma0gboboVBhw5cWQORNRVDvKCvvGtSKZdFuVx/NBScC0QITWgq6huMq9VIvTzWDc4tuqN5Ihj42RAV7Y9GJyOZ4yRf++Xp6Pb1zX2/QPsHypHxci+IK0qCVbaSMo+5hrd2ibsMiVIq32BesKpSpmoYyAqIQqCkC7eBhKyAMaxKZZSuSOWYz2bGXBeOyiRjCYndFSrAybHk0dXCxjuC0j2M/7y+TLmNlWWAllwHwR+Vnkxs1sxQTmzOo7tZ2aB1YnJAZteOwqw9QIGzYelePOkBK1LvwJZUW30xT1+I5QDCIHldn31WwzKfjU+QKXnM7fbr/Z63TRc+wCDfoCAwp1/6ExAsb+oAOVvsqQJYrFOEFLsgL/iWchIzGLYLf75bi6KesdZUjqeFfFn4rgpqDxmspvBuAdj8EY5O0yu7fKKsFdDbV2Yay10lvEP+1oVdWSgeGx1DDUEvk46eNt6StlL1SG9/v3n3+xehRT3bQmo7MUktiAnVxPWCANxThw+UaXVCsOSLPJolrv/xpDagrgZ1ralVu4TnHogj7JqDPf3dNswG1soWhdm4NDdU2bD5tlcrhu1rN8ONNqaWC4JrmcJhHo52qby3SEqgtrUzMaDkUqPT9SWeAZeMIr86TabjzuhF1jD6AWxc5Inq6AE7WK+TcKXRGGNv86EoRYDUV6njkhfFP8uaia38PSunDJJFROvQxbyYJg9xEkd6WPLaMQpjsXvrvzrvNtl/HaZeR6b6h+bg6QCEWuwPngff7sHdG7VBkbC5cy5apR7tGttNu1qq6bBPyPtv0y+hYb2DCNBK5BSN+FYV2mUeebZMBHnT2/yCR67YTxvhfoOimt1zNcCn7TUZ7T62K1ogSr6pKPQqxa6InAnl16J/VHWG2t6277wrecVr/D4fet0j34mwv7GxkctGT30KgX+Tfiv2rh7uGxueO/kc6/tYj3MG99ITSk7+lBS2L9yox+d1OOjfes/zt4J6VqPU5WbToV1VZdvi6sLVIbX8pvYOE083uUW4DAXcwFqDg68X1IbUtpa8J2Rtkv41uUFd0psTEVnPWdhLD9OAmXcnle87MuBZFgnv8DKCIHLg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/explore-data-link-tree.api.mdx b/platform-api-docs/docs/explore-data-link-tree.api.mdx deleted file mode 100644 index 8eb3fafff..000000000 --- a/platform-api-docs/docs/explore-data-link-tree.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: explore-data-link-tree -title: "Explore data-link tree" -description: "Retrieves a list of all files in the data-link associated with the given `dataLinkId`, including files in sub-paths. Useful for retrieving complete directory structures." -sidebar_label: "Explore data-link tree" -hide_title: true -hide_table_of_contents: true -api: eJzVVsFu4zYQ/RWCp13AsdM2yMGnZrNJEXTRDZIseggMhJZGNhNaVMiRva4hoB/RL+yXdIaSLMkSknTRAu3JlvTI9zjzZjg7iWrh5fRexgrVkdHpk5ezkYzBR05nqG0qp/IG0GlYgxdKGO1R2EQoY0SiDb3TqcAliP0GQnlvI60QYrHRuAxfF3oNqXhg0CfCXMUPI1oYmTzW6aLZyOfzo0zh0o/FFw9JThzWCVfyMzKyq8wAEp12EKF1W+HR5RHmDvxYjqTNwCnWfRWT8ouvmbEOPla0dw6AMJlyakWbOD75Tqb0QNhGG0E0n5uVyMNgfNyfk4hZko4hRZ1ocMzv4DknaUROsmAkfbSElZLTncRtxjTlKlkUoz3zxronn6kIGurnHNy2x/1rDRRpvgKnoza5+BxgyrCMHq1OERbg6BNFdKWwfHV60hESkXDeTxn/mpTzBjoQCHFThSHkT0UReM+QzOm1wpZZ/KDYgRgFV7ws6VNlzQAVaAWU2Wc15I/Ut0zLxqyM6zOIWHVcLmz7srHjkErlnGIVGmHlW+/t/JGsSeqLGfvBZzb1EADfHx/zT1f2559pj8hSflLkryrLjI6ChyePniG7Fnfjr/uKmEi6xGRwx2WAumQ91NfT3d6z8rzXv8HrOwdwL22HeblW3ARsCDZzisTZ1UHPcNaieEfBsrkje/PG78eyqIS8wcaHpLe0js3ANJxy7i7zLVKTEJdkycSamOp/RJbYqK0XD8cPY/abRI0GqjLnbnCrueFckWxW0+U440AyiQ+g1nFCaAUnVem07nCVMVUaCz6VHyY8L53ArYoNfVP5h+1E6JMhB31QMdcbePxWJ62oPtXiDRmvgUO1uj/KhXPW9YT/MGD9ulmLlNJP1Wk3pCegT/roXyxe2pyi9+fvf4h9zxSUzVbfCjslDBuJs+sruie8mpuqEbEZ9gtHvLJJGT1wfpr1/9VYclFAlDuN23B9fQDlwJ3lXIr3M+45dLctLV9/CwisoUrlpGm6k11z2RWTubMbD0dYXo4e3Lq+GXNnaOESMfPTyURlehwZm8djD8+UuLG2/bILX8S1UcgFKs4Zz4mQLKzWfcuBK4PQVr+PAzPWHZef5wFEb8o/l3XpP24wBEuniQ3Lq6BVKpj2NYF8XE3XUwUOJRuFjHcP3z4yJV2b0HkS+2PzgYRw5Eqe78anp+NjfpdZjysVDFPdZdVU0jJfFfuO1F1jv//VBFblEOErTjJD/Y+DEIJZXxidaXMkp53Jq+1GssySoscrdru58vDFmaLg1+UEwB6tC1xOEyp/eCGIb5+eBo/wBNverLZWJmek5Enl7Ur+yeHpBa2H49w3qv2X56oXDlAPfY3wGT84zcr/Zvbf1VF9L14Z4QcF1bNTum3rqYW2HFzMCL0EReNFUFgCziiLGbaW9u6TTuP+6eKOsKrbFQ+6YNh9UBbVSkDc2SdIqV5qlcjPLLAo/gKHv9// -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves a list of all files in the data-link associated with the given `dataLinkId`, including files in sub-paths. Useful for retrieving complete directory structures. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/explore-data-link.api.mdx b/platform-api-docs/docs/explore-data-link.api.mdx deleted file mode 100644 index f74170bf2..000000000 --- a/platform-api-docs/docs/explore-data-link.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: explore-data-link -title: "Explore data-link path" -description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." -sidebar_label: "Explore data-link path" -hide_title: true -hide_table_of_contents: true -api: eJzNV9tu4zYQ/RWCT7uAK6e7QR781Fycwmg2G2RT9CEIYFoa2UwoUSGpOF7DQD+iX9gv6Qx1t722E6BFn2yJM3PODOemJXdiavngnkfCiZ+UTJ8sf+jxCGxoZOakTvmA34IzEl7AMjcDFurUQeqYjv1jrciEtTqUwkHE5tLN/OlUvkDKxiR0hTKjaNxjwrWPMuFm44D3uM7ACEIcRYg5fM2UNnBRKuJ5JoxIwIEhvkue4gPKNZZRRBJbMsjXXbioWVr0JZ0yGaEPMpZgUNbAcy4NIK4zOfS4DWeQCD5YcrfICKVQ4qtVrwYuYX4MeV7GqTx8D8ZcmyebiRAa755zMIsNrD8qQZbmCRgZdv3bwJJIbeqPYm0S4YpXJ8cd9BDZkhGh7D7880Z0a4APcdaCMOFsN86NgVi+skKUMrDJvjItDwRL4dXdiCnc6SdId2N6EZZbTGunWQwuLFKbTODlToF4SAeJPRCbdL7J77Ab9jpPJmBq24RtwOUmZVgnHjdgo5jpRDqsOKwqFkEscuVYIl5lkifsRagcmLSlHkTB4anw+RNSfqCstZlOLVjS+HR0RD9dnl9/Q9Uq+HgqskzJ0Bdy/9GSyHITVE8eIaS7ygyVvZMFgDZyKlOhbqhkNmK4HqEzYcFXF0PmTChVO8oK+9b3IZl2+1TAV72SgG2BCGME3UJxk3upFqfrwbjDt1VjJEMBGyIDvK/x5ehqOGaa/n29uhje+pa37h9g9VIzLkTwBWlRP3bSKSjbmO92aJuwyJUiq/YF6xqlKmaxVEBUYq0iMD4elvLxgP6wbpbyuGMWoz1ZOLABu6wRLGanmouFZeOjsYdLZAJ3ZQR38/4y+jJkrhVWQumxUKgwV37WTBZMYM4svlPXqXlgcUJq0UbArnNMjbhhE1A1bg0pUevCn1JWdBtNUY4fCMUiclSZ/VgNNptBSI0v8snp/e22m71OFy3HzdBgKDCgULcfmiJg3Q8aUOmrjFmqWYLjsyQr8J94EVKJiYLt7pfT6rasd5QhqeNtFX8motuCxlsqv5l/9zwBa5G3z+ydVVYJbuuntQtDY7TZIP55S6uqNgwMj6OGoefIx0sfb0pfa3epc7zfv//8i9WTmOqmNRi9pZjEeuz0ZsQiaSnGkc83uqRasUeaTRbVev/XGFJTgDA30i38vnWGMxfMaU6d+f6BZgMuYzNNu9oUPKpv2rzfbJL9ZbOdrfoTo+eWhp4F81JtcblRqDNzLrODfl9kMgiVzqPAwjPeVSD1ZsfxJ+wGi596EzsneYo9J04V5W8Us8L/NvE6BIRYTUN6nnghfFP8uay63uPc+TjJNNZevYxXyYJg9xEkd2WIvaIQpssWob/srvNtl/G+pfJNN9a/NAdIhCJX4PwcnJwER/Qu09YlwudKuWKU23Mr37atqMsm8/6jHb+MvsPO1c+UwPUH6fswLMv86XyJ9Pigs9+XKYT3PEOXSXi5nOAW8LtRqxW9LlYpSqyqEPkgxjKFHZ7v2Z23Un6CxcZ67tctfMtp1Tscft/qvAN/fUF/J4ODluodNOrF/Z34b1qwd/BY3+nfSedfWrx3EG99EDScH+jBSCL9xoT+cFuOiY9s92fvVkrVOpwu2nQqqq1yfFtUW6TWPozfwcJrrh5QbgYCdy8foOLoNAwhcy2ljYnaGV2/Du9QVnSHw9ow8Na3EsLu4yV8xmEHqvg5n4FIcLX6B6H0AJk= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/extend-data-studio-lifespan.api.mdx b/platform-api-docs/docs/extend-data-studio-lifespan.api.mdx deleted file mode 100644 index 609194003..000000000 --- a/platform-api-docs/docs/extend-data-studio-lifespan.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: extend-data-studio-lifespan -title: "ExtendDataStudioLifespan" -description: "Extends the lifespan of the given Studio session ID." -sidebar_label: "ExtendDataStudioLifespan" -hide_title: true -hide_table_of_contents: true -api: eJzdWVtvIjkW/itWPc1IUEl3R61RnoYm6V00mQRB0jNSqxVMlQF3quxq2wVhIv77nGPXjboAyay0q32C8rF9bt+52H7xDF1q7/Krp00acqm9bz0vZDpQPDFcCu/Su342TISamBUjEV8wnVBB5MJ+L/maCTK1S4lmWsMSMrryvZ4nE6YobjEKi02uqKFu8k22EUxMqKIxM0yhGC+egA9YkG0Gi3seRzESalZeXbYaZ5HGTPGA8JAJwxecKVih2I+UKwZSGJWynqeDFYupd/nimW1iWRnFxdLb7XoF941UTyBewEr+P1Kmtg0B/sgntvNu8OLCsKUlLaSKqXFDHy+A+zcUVSdSgDa44v35Of7s87v7DZYGEnYRBqk0SSIeWDuffdc45aXJVM6/s8CgqRV6xXDHoDRx0xa9PROcIr91JEg1XLHgKZHcyXdYgqCYezKTcsmtdVWL5If1cjjvWAx0w02EQyVWr4z0x3XdYGaqQUbYowTYV4+uYRlKDh7gEWIHAYQzLUfw8WGL8FPtUGzZpqNj3kbJ5Duo+QNsPRILifNFF4s9WHaa+UG1ixHIOEkNuxbrNpDQKLpb2GTwCmOVm3fKnETUoCVbiYot23WpWGZYiH01B1R4mDFqiAYcYPzTSB+Iqyve6gJMAU34VZhalp5hMWrCjseXYonU3EhIXG2i8KDTedSkukkCZEGaQ5wrBi6MIaWz0ObEBAZAJPxgzyABB5qhGACp0GmSSIVE0O+5j1v011Shm/Q/2qtpqy9QRcCLUyc/2krKNgS2xvl9blcLULHgy9RVsOOGXiYp/sRc8BgNdN47HMMf3lsmb1oVszhz6GsXylQYVLeiD1WKYlXjAKoWh6OhmFhzJUXM2jM6DUOORqLReM8kzbBMo4jO0eZYh52NQ3q9v3tMn2+YWEKpv3x/fvFLr7lN3oL8W6ZKv9oKrY4f7jkbkxugYKiYBWFLEBSb4ry+AXxawag2D0n4+kWAVvWqRWyxANtD63VTt8UJKKB2JagscA/oNg6hoVraUNSBXdxWxsqc/X9cDuvZvmKSE523l+MHNVdYti73WobHO7ijeVojttyQSoVw/7SRSVL561KtUlLZf/OUR6Ej27+fwXqdyfs/y6AZm2UqB4aaLts9XMbe6VGEkk0Y1W01sDTgcHJ9NbqfPk4ebh/vHu6BcjP6fD0dD24fr/8cj4AKQ9Px3f3j5Hp4M/h9cD+6u+1SpWDYnoempeuxUaBr9gnN09VEzalmo7jLJEEKCsZ1+hzqIaM2yXE9Vny9b7IK2VYLZo9sN1w8HUwTr2/T6ucoZNOPgA9xEyrHKJ/8iwk8S7KQoMohgZMecFjDFNUjuG+PuO6tR6gI4b+GfAhHMjwy+t0dYV0GzB/5wTYs5PmJ+Uu/R+Zp8MQMwZ1+9o82wA31yq8GB5/cQmUkANJyTBOaGtkPuQ7kmkHUkIWSMSnOZKTSZ/que3U6T9jiuDSTqoEs4z2BeoSLIEoxQi3hYTIi9kzJcmPM9IfLs7N423dWmcHIUtdH6F8wQoMAceTjkZVycOPMWc8JWD/dlihAuk+GqcJjV7QlWd+nySxjgFcMXTHrpnQkrJJYDUCE+D1ut7PotdhqyjeMZBoW2GtazifTQk660dYuUi4j5uyRqvLPI+ilaPHZD3Br/NTsB4A9OyDNHKLB3gcVBl7w5VhhLcYd81/HKP9yfDAvV9ng94c2k4xzUxw4INXR5YzkZneG0yzVfUiFpv8OdWYpJoz+hmnzDgBCfqdbMscrlSwutATs5WZ3gK8EwKkNjO09bCqo+Ph1LUiXyqUwLfnrbRmoHuEHUFnhHuwh9L+MmV2TWJG1kUS9AXoP9a/oDraghgRUEEgl0AHAN9fViLuOE7O1KEnSecSDShJ1drOjA7uY2+NHo9o1LvVWDDxQi20CbN1ekI5osR3ZcLOSqWn4a8VD+D6B2xcOG/GIgxaunyOLiC59MlqQGZ6UIED2hHAbu4IQsgVNI0Mirg1Zc7ZxvLv7QjjUhHci2uaXoY2rls6ZOW6+DG5G2POMbt2/FgT4edPWuEt2hJYSOAQHQ8TP7J4zAt6cZQxmkFSh8BpZjpDNCgxAtZYBt21BFS9UwcYsYjDuH2wbG/fc2J+SbLoFFBdrGvGwiqiyVjdIrXi3VzYuepdQo/9BF3W810+YyLpqLvoFQ0BDCmhl4V4T3tqgjrM1U8MS/7TGewOVFf6eold5zXWMt7VYROesNbfv3yO8rQs9dJTsvD4Ej6ftlLz76mq0r1yYdpK3wJMHXeQRCKsSGdVuFipz3nBfUXHCDVo6u9DsvAFHEtAu2h4lPtFwAnUWqvdrHieqpTmH2NFq3I3FiuA2kifZW0oh+IeW15T8jYoIaQjkQrnJssbF+UVz+q00n6GbDXsuAWEKyx6gIC3jDgukYvIq6IPxCInQyCNkw6JlLDp5/3/VZPYhJUgV1CVbHz4xyKxqkOLV3NdvmNpjqJISH/cSaT1vX+guvbPsJfHspXiI2Z1F5XufZmqdP/aleLT1VsYkeHygCfdtr+G7TsPnsvniZylknF3lE9dtgplttcklntrjilW/KndhAeSYP8/ZWLKT8D7C/vmcB8z3jbFm4vl1TGauTApke0xAVJdDt5BNtgehwPp6X/mqytmFlWX7a0nAHOQuuIH2zv/40T+3HQ6YP6YWKtnzpXttJRjAOUIrD661k2uBvre+9GY2NezZnCURnPLshZy7tHCYKF+Xe95l9WW3gAX4boUogqkvL3jKf1DRbofD7t0VwZIHkXe5gELPDihy5FW2VeAnBlxqD79ZxvcstuAQyV3deZUsP02yoP25br3TZcsroNhWhcplLg26+4aNJzRueEwAKR0de9/EVFY2ksxeNI/vpnjNRfcjphYh1ZZxXyxwn51xL5+YABfmUhr8Rgl3u78Byek6RQ== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Extends the lifespan of the given Studio session ID. - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/find-data-studios-workspace-settings.api.mdx b/platform-api-docs/docs/find-data-studios-workspace-settings.api.mdx deleted file mode 100644 index 1ee564f62..000000000 --- a/platform-api-docs/docs/find-data-studios-workspace-settings.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: find-data-studios-workspace-settings -title: "List workspace Studios settings" -description: "Retrieves the Studios settings of the workspace identified by the given `workspaceId`." -sidebar_label: "List workspace Studios settings" -hide_title: true -hide_table_of_contents: true -api: eJzNVttu2zgQ/RWBT7uA10ovCLB+qtO422CLNrDT7kMQoLQ0lplQJEtSdl1B/94Z6urYTYqgBfbFkIfDuZw5PGTJPM8cm1yzrbZ3zvAEHLsZsRRcYoXxQis2YXPwVsAGXOTXEC18kQrtIgfeC5W5SK+CvYsQiRSUFysBabTchbVMbEBFnzuXi/TzmI2YNmA5JblIMc0bodJz7nmT4L/WedEkwg2GW56DB0s1l0zhH9yobYYBRkxQsYb7NbvfwQebcSW+hVyRKnKwIunLtOhv4UshLGAd3hYwYi5ZQ87ZpGR+ZyiJUB6y4LrSNue+Np2+ZFU16ioZNPhgPV1vv76Ym3o7OH+m0x3t+VHqwqTcQ9R4Y6xEY1jlaQ83Rook4BXfOtpYHlahl7eQ0EZjaZJeIHkmLRadl0PyqIxVWGsh5fsfLe5VeWR9I5xYCin87nB5xABxJBpfzi8+Ta9maFm8nc5n50RmL7wk5099BJxZZ/4YYOhgmTdwVBU5WXBGK1c39vzk5BDPD//+OuRqIv/MmEds68xP+0qxwj64eqsL6x7d8+L5Hj79kTw4kfMGnQasl8fwOePpUyjWH4FrloNzPIMwywfxax0P+TPoZ2attgeVvzgy2VadIqV9xKXUW6wneP996H1e1O1ABBJy6vF/2i0uOkgKG04SiugZcAt2WqBMTa5vSD9QYdeaFDmDkJUUbMJiZKeLy8DRKu7vi7gcqF4Vt9dC7GoZZ5TOblrJLqzEWGvvjZvEMTdinEhdpGMHXxDtsdAHWrkIK9Gl5J5YGr0m/2h6ecGo1raVBWFZ4zJsqIOGMrJGSen/Mjihpf540/L/dusDfjSjea+js688NxJ6eeulp1e13rbfQWcealgnVRVdFCsdam2G1rRMPT6GBmErcAqNMzGOJ4Fx+0gP8UXSCRnO+kq/6hdIZHFMdZ5n49PT8QnZjHY+52rQ+jvh/OC6v/8guF9z2Z+D3/eUaMbs4auPjeR49WLpAYKyIfA1ySsVN2nfC4M3D1r37+5BMy2RkW1rxIIileWSO/hoZVWRGWli6TDh54ZbwZc0RSR7Khx941FacengAVz+mDcK8Gf0+FvlaK+NkasdEY3Lgv7h5x3suicSvVSeVNMj75UnFDREu7pB9zXwFIMRbLXH67qQv64oTh/hQEipqXrHNEnA+Ad9h+r2z+yKzn/zSsp1Slss39IDDH9DsTrgEmQl2EomucqKILusDklqwffF5p64hKaOwoE8Ch5X+g4UcqlFx9N/wqWqvgMOwgrK -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the Studios settings of the workspace identified by the given `workspaceId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/finish-data-link-upload-1.api.mdx b/platform-api-docs/docs/finish-data-link-upload-1.api.mdx deleted file mode 100644 index 4092155fd..000000000 --- a/platform-api-docs/docs/finish-data-link-upload-1.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: finish-data-link-upload-1 -title: "Finish data-link file upload to given path" -description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." -sidebar_label: "Finish data-link file upload to given path" -hide_title: true -hide_table_of_contents: true -api: eJztV9tqIzkQ/RWhpwk4ticJ82BY2FwhMJuYXJiHYNZyt9pWIksdSR2P1zTsR+wX7pdsldRX22snedqHhSHjlkp1OXVUVVpRx6aWDp5ozBw7lEK9WDrq0JjbyIjUCa3ogF4JJeyMZKnULCY6IYxU4iQRkneITXkkkqVQU9jEJZIyNyNfxrEwQ/g1PuiSh5mwBP4pHnFrmVmSRBty+uOe3B/XCi0cuoCP7/B7aPSbiLn5hS3s+IA4DaoVk+IPDlZsFqGeJJPBYHCvQ0Anm2jjCFOlyyLBD24M7C2YJVxFOlOOGx6Txaw+3HA/s/6jUvF4950kRs+Jm3Ey7oXVMWiKUy2U69IO1Sk3DCG7jivQykgevfzvX0EsZYbNORhH3FdUwQeIx4UgnO1QgagjgHQ9FRcV7tYZ9BDgUU4kghuQNfw1ExAUHTiT8Q610YzPGR2sqFumaCUconneqQ2HBO20igKIPsYOOw6SgDsEzvLIabP8pO0I5NF9Jm0d92vGvcK2C+e16NbQ32Nuoc2LTVnE9xn7UQoSlc25EdEeW0AAPvVbwOg5c2Hp2wlYHwVkALQzHS/xTKRBWjn8ydJUishj2Xu2aHq1qVxPngFkJI5BhjnBLe4GBiLV1kNejyZwj1xfEGatmCpPeq4IEBTwdAjlPJNOHAIzXcn3+mp2ye3EMYHHdlwAYrhNtbK8S3OAAa7QjQd9n3MohSUFtQadaAeOez2hOlU6mDEMsyUcn9v9EGE8N9l8ApnZl6vjIzTHH9h0K4WoE07yCstL8Avl26GconcYyyWosTXYCCVn0Yx4fCfLquRlnsZ15ATcx5LWJZcojmqwXhruMoOKhPLCJdJkxgEtY0M2mxXMGyrua2r4YeEI1DC7u4hBTAvhZpdYKRtATLSWnKmN5F1J9FDFnsNgGRwBzaYZUrPUljW4S64TMsYyMe40ZRdCSjLhoXzzOIglcOP/RS7S81RylGzlqKy5oQL/htQeAiAhdXfhMsKBfL1m+YUArafPUb+P/23rhetlnYBslReA6ZN3PPdeHfWPNu3eaFIqBZGTba6d1dF9wIMagyc6x7485TgB7L5ZpeDOu+JZdFeCEmI76R9vOn5bNk6iNLRtKfUC/PHSJ9uQcFdAqZj8/edfpCrp2PYb7cRrSlCsQ06H19CpLJvI4jIilaqDfmCoxxn48JNLdf6/iiVsWh5BCXFLP0eccWa4Oc2gfQ+eRth3YMiYaRxFUu0p4Vv7gPbqUau3qseOvCgHvcQzHLbCYJBjw+PmrZxXMiNBycy51A56PZaKbiR1Fnctf4UsdoXeqBL3focMJXNYcsk5ymNWKHpZBnGPKAZEmqFUoKDFsvf6muSFYCX8uCqL+fPCeeQwO3d15738ybBYtDtn3ZTqhlWvFaNxu4/0yy5RZWnUqplFIREq0d75In8FBhj0PngQbAFtoBBG8rHIk68NfRNw4J+QvpMl+td6AxzBvAU7X7vfvnX7uIZ8mDPP3WIyKib89lRflltoJFPxBi1m22zYmGf+fye8751QENrxn66XSpisMCc+t6vijraeYx06aD0OgkrPWYTb7xczPFBxhncdFKxWE2b5o5F5jsthzkUyl5WQDnxn3ZHOfSP31jhe+HLLYP/GZIayFKfx93uwZw7f4UB71K/Nj/DDCLT/QTS+3BXF/YDsfoRt9aocYNWy6U7pbSO/HwOo4dR73mifca2gVj4C0TBweuDC7nnw5PABddSnN7okRhVOnMJlTN1O2WbrGt7eP2CNL95Ocx3jGcMW+OKEv95T7ZHxrcOvrahkapr5pkqDTuwIrN1Q1hqIj2orFnCVvMSDfuEqzytoHH4jMHn+D1jjBEA= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/finish-data-link-upload.api.mdx b/platform-api-docs/docs/finish-data-link-upload.api.mdx deleted file mode 100644 index ab04cbf72..000000000 --- a/platform-api-docs/docs/finish-data-link-upload.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: finish-data-link-upload -title: "Finish data-link file upload to given path" -description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." -sidebar_label: "Finish data-link file upload to given path" -hide_title: true -hide_table_of_contents: true -api: eJztV9tqIzkQ/RWhpwk4tjcJeTAsbK4QmE1CLsxDMFjuVruVqKWOpI7Hawz7EfuF+yVbJfU19tpJnvZhYci4paO6nCpVlZbUsZmloycaM8f2pVAvlo57NOY2MiJ3Qis6opdCCZuSIpeaxUQnhJEaThIheY/YnEciWQg1g01cIjlzKfk2iYW5hV+TvT55SIUl8E/xiFvLzIIk2pCTH/fk/rARaOHQOXx8h9+3Rr+JmJtf2dxO9ojTIFoxKf7goMUWEcpJChkUBvN6BGSyqTaOMFWZLBL84MbA3pxZwlWkC+W44TGZp83hlvmF9R+1iMe77yQxOiMu5WQyCKsTkBTnWijXpz2qc24YUnYV16RVnjx6PIByZljGQTWyvqQKPgAcl7ArhAjkHOmj7wNxXrNunUH7gBzlRCK4Aazhr4UAl+jImYL3qI1SnjE6WlK3yFFLOERXq16jOIRnq1YEIPfoOew4CAHuEDjLI6fN4ou6I8Cj+Uzaxu/XgnuBXRPOGuhG1z+ibq7Ni81ZxHcp+1EBiSoybkS0QxeEn8/8FuRzxlxYOj4C7ePADJB2quMFnok0oJXDnyzPpYg8l4Nni6qX68L19BlIxsQxmF9OcIu7If8w0d67/N6bkHnk6pwwa8VM+ZTnikB6Ap8OqcwK6cQ+ZKarsr25mH1yM3VM4LEt6U8Mt7lWlvfpCmiAC3TtSd9lHKKwoKDUIBP1wHEvJ9SmWgYzhmG0hOOZ3U0R+nNdZFOIzK5YHR6gOv7AZhtTiDrhJK+5vAC7EN915QStQ18uQIxtyEYqOYtS4vmdLuqCV/g0bjwnYD4WtD65QDiKwWppuCsMChLKgyumScqBLWNDNNv1yysq72tu+H5pCFQwu72EgU9z4dILrJMtIqZaS87UWvAuJVqoYp/DoBkMAcmm7VK70FYVuE+uEjLBMjHptbFzISWZ8lC8eRxgCdz4f8FFOsslR2QnRlXFDfX3d0ztWyAkhO4uXEY4sHpfs/xCoNanz8FwiP9t6oTdok4AWUcFSPriDV95mw6GB+tarzWphALkaJNhp41vn7CgYeCJZtiTZxy7//Z7VQG33hSfQ3cVKcG3o+HhuuE3VdMkSkPLllLPwR6PPtrEhLuEhIrJ33/+ReqCji2/1Uy8pARhPXJyewV9yrKpLK8iJlJ90A8LzSgDH35qqc//V7mETcsjKCBu4aeIU84MNycFNO/R0xi7DowYqcYxJNc+JXxjH9FBM2YNls3QsSqLwSDx+Y1Njpu3akYpjISjqXO5HQ0GLBf9SOoi7lv+CrHrC71WGe79DrmVzGGZJWeIx1hQtK0y/R65Czy0HaipQI1Vv/V1yINgJfy4rAr489x5vjAmd023vfjJsEB0u2XTiJom1ayVw3C3dwyrzlDHZtypk2XxECrR3vgyaiUH6PQuepBsAaW/BGPKscinXJf6NuGQdUL67pXo35oNMATjFvT80j8+7g9xDbMgYz5jy2monOm7c3xVYqF5zMQbtJVN82Brhvn/ZfCxl0GZ0I7/dINcwjSFMfGxXZY3s/MA69FR50FQVI+H8npC/qV4reHUcjlllj8auVrhchhoMYOrokdHvoVuieGu2Xqj8S98sWGCf2OyQCzFsfvjFuwYuLcY0J3pG/Vj/DAC9X+SjW93ZR3fI9tfWxutqiZVtWibU1nbCurnCGoZ9ZHH2FdMK9+BqzFAw2TpiQu7Z8GS/QeU0Zxea4joVThxAjcwd1ux7S51e3P/gIW9fCRlOsYzhs3xaQl/vaXaM+P7hV9bUsnUrPD9kwaZ2AZYt4u86xreq41cwFXyiAf9whVcp4oah99IzGr1DyJT+6g= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/ga-4-gh-run-cancel.api.mdx b/platform-api-docs/docs/ga-4-gh-run-cancel.api.mdx deleted file mode 100644 index c7d974e93..000000000 --- a/platform-api-docs/docs/ga-4-gh-run-cancel.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: ga-4-gh-run-cancel -title: "GA4GH: Cancel run" -description: "Uses the GA4GH workflow execution service API to cancel the run associated with the given `run_id`." -sidebar_label: "GA4GH: Cancel run" -hide_title: true -hide_table_of_contents: true -api: eJy9VN9P2zAQ/lcsP21S1/BLPPRpBTGG9gAqoD2gCg7nmhiSONhOSxXlf9+dndICHZOmaXlIHPt89/m7z18rPWROjm5kBgdZLqcDmaJTVtdem0qO5LVDJ3yO4nR8cPpdLIx9nBVmIfAZVcMxwqGda4VifHEmvBEKKoVF2GKbSoBzRmnwmIqF9nmYz/QcK3FHy7c6vRvKgTQ1WuBsZynVPGUok6Y6DqlouQYLJXq0jLSVFf1QWNxPy5qB1uBz+RY9JRHOW11lQqdYeT3TaCnK4lOjLVIxbxscSKdyLEGOWumXNeeOm2TXTWMwOn9k0iVHKFN5SsVDqOtCqwA8eXBcsX2fytw/oPJU1Gtf8MRJWfslZ5vExFSl67iMq01FdPPevZ0d/rw+zfkPyvLX5WvLLHsdC/TkbTnxGiixR/2I6A62ATqCVPTs/Dtkpcu2wKIeefCNu1UmxY11TTWz0NOZsSX4OLW/9+ogP9GdWGvspKf45Uz7W0heSVFUxgsoSOyYhmykwNywPmsTzhsUN5JJuDnJAl0y302IV5e0kd0uUSsF8yVZybexBW3Lva/dKEmg1kNVmCYdOnyi0kNt3sn4MqyIiwI8n1IcczxfOMn6dHQTrfbLSyY4cniEYNGOGwb4QhVXlL3W+f8+BNFMHHxb8few8OG83LjJWvsnz1DWTGfb8ZWbmZC6Z7hHyJD+BL73C9cHs2pABdW8JmaTDhKOLkJrZ+breoGAMKuxzu7w8HC4w3PcnxKC6HqrCOY1EtFQ2Jfeoty41v/J8vqmeHz2SV0AeRghDwy0vbJWnjyQpC16z3fZuUhf9Bm9mF8vMdJBzrKkXW17Dw6vbdF1PE0NtGRcNzScg9Vwzw0jGaba8ZgEPYPC4QeEfJr0dvlZ/M5Qt56mn4RqyeihaPiPho+4XNt3N6XIHCGlPAwrLh7H4l+uOMV68ztf6QarHWOlsPYfxk437vDF+eUVS7839TK4irSwYI7pHYCaQEb0S55rZQFV1kDGsTEnP78A33x+Mw== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Uses the GA4GH workflow execution service API to cancel the run associated with the given `run_id`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/ga-4-gh-run-create.api.mdx b/platform-api-docs/docs/ga-4-gh-run-create.api.mdx deleted file mode 100644 index fabd171a3..000000000 --- a/platform-api-docs/docs/ga-4-gh-run-create.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: ga-4-gh-run-create -title: "GA4GH: Launch run" -description: "Uses the GA4GH workflow execution service API to launch a new run. Runs are launched in the user workspace context by default. To launch in an organization workspace context, include the `workspaceId` in `workflow_engine_parameters`. Runs are launched with the workspace primary compute environment by default. To launch with a different compute environment, include the `computeEnvId` in `workflow_engine_parameters`." -sidebar_label: "GA4GH: Launch run" -hide_title: true -hide_table_of_contents: true -api: eJztVsFu2zgQ/RWCZ9dK2qAHnzYJ0jToAg2SFHsIAmcsji2mEsmSlB2voX/vDCVbju0iPQQLLNCbRL4Zvpl5M+RKRpgFObqXMziZFfJhIBWG3GsXtTVyJL8FDCIWKC5PTy4/i4X136elXQh8xrxmjAjo5zpHcXp9JaIVJdQmLwQIgwvhazMUN7UJAjx2W6iENsllTabJY3BADnJrIj5HMVkKhVOoyzgUdxuHZANGWD8Do/+FdPKe6YBQeVkrTO4fN/tX6pHtH9fsx2hm2uDYgYcKI/rweIjmQscieeoPcl5X4Jd0YOXqiALNXHtrKjS/4p2cgFB6OkXPsAOmO7w7xIWZ/w5xOZDWoU8puVJUskuuJEVz7hEi0rbHHzWGeGbVUo5WOwUmoOgABE2JNJFh4Fyp8+Q2ewqMXclAeamAv+LSIVnbyRPmbOg8k4gaA+9u+CaiYcsgRK/NTDaDHtPuvIYYzyla3dLYQ7Yi3mcFSmkOAMrrF/x2HGyftZfhN/Jb+/IwIupYYluIm64OvFyRjjSxiNnU+uqdggh/KvAfVqBp+0Z7pJ6Kvsa0EJw1oT3p/dHRfjd9/fJ2TUTDc6zVq5Sp55tE9+QQoTNQb9/eVZgdFEGIEOswzq3alpOmM2foyQsrGWK79OH9i0D+wXDhvfU3XYo3MX04kOT1uBPGRgElFRdV2zQYC8sz0NkUr4NY0F+WLrdsgSGbH2eU10B7fG8lcd2vZJKGLGJ0YZRl4PQwL22thgF/0FFDbeXuvXibdsR1CZGjEueM5ztQNg/sO6+9jstbTmibszOku8Wf1kxokxo+kakkGP1PEohW2o9P63w9LdqhwIW66af5xTNUrsSD/b4uy16b/2Kj7+4e0DX1a82512RbktBmalPAXZ27vHGiXktp97AIHZi1C3nS7stybReJ5KvLJLCp/avfICJ9eMfDjx+HR7zGKqkgSd9AKkB65YzE3+3dTUrZZbnqe+jP2+j/8DbqRM8pyFwJ2nDhu6ugHQ/rty+pGHkwzI/5zcRDgjq54EFCkNVqAgG/+bJpeJla0NNj6p4+5+A1TFjc9w/kukBQ1MI8Vb4jQeR5q5d3d0yE4WXNhA7d781gbXSa5+jiFnxvXPOY2Yy766+3dzw1uhdelQZwGrfJ76D/ZJJN8xPMukNU -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Uses the GA4GH workflow execution service API to launch a new run. Runs are launched in the user workspace context by default. To launch in an organization workspace context, include the `workspaceId` in `workflow_engine_parameters`. Runs are launched with the workspace primary compute environment by default. To launch with a different compute environment, include the `computeEnvId` in `workflow_engine_parameters`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/ga-4-gh-run-describe.api.mdx b/platform-api-docs/docs/ga-4-gh-run-describe.api.mdx deleted file mode 100644 index c2618e787..000000000 --- a/platform-api-docs/docs/ga-4-gh-run-describe.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: ga-4-gh-run-describe -title: "GA4GH: Describe run" -description: "Uses the GA4GH workflow execution service API to retrieve the details of the run assoiated with the given `run_id`." -sidebar_label: "GA4GH: Describe run" -hide_title: true -hide_table_of_contents: true -api: eJztVkuPGzcM/iuCTi2wsHeTRQ4+1XGmrpGNvfUDaRssHHmGHmt3PJpIHHsNw/89pDR+rB/dogjQS08jkRzyI8XXWqJKnWx8kam6TWfy4Uom4GKrC9Qmlw05cuAEzkC0m7ft38TS2KdpZpYCniEuWUY4sAsdg2jedwQaYQGthgX4nxJApTMnzNRfbZkL5ZzRCiERS40zT071AnLxlbhjnXytyStpCrCKtXcSwtBmaP0y/+CRTYAECmXVHBAsY1/LnC4kGDQQWzP0QuFMHvtDaoQjhHkqdAI56qkGS1IWvpXaAplDW8KVdPEM5ko21hJXBesOP8nN5oGFXWFyigzz31xf8+elmd5H0hmbHMkEc1VRZDr2LtUfHYusT02YySPEyN5ZDgDqYKDy6hRKQA0OX9exfbexD5w7q2wnEzivSYwXFH0dXDmRDFl1ikolieYgqOz+Bb7jIB/YgjzVOYwPX/yH6C1tdl4CNWYQUqVfxZeoDilpT3+4kpCXcy6gUfdjt/e5S5TfR9Eo+kCHTrcz7DTvOn91um269kfdbjjdN0cDL9Hqfbq/i4YRHaM/otZo2OuPo36/1yfC4M/BMPq0u7aa3VZ0F/7yR1b1sIc78AA5KShfMpO+nhShas68Xjw/TDdlrVpxUSGczZwQHItj1Bf0QZ5cZjpMTImXWGDteZXPGsexSQ51aiq31Ffz1Ni5wkB6++bFq96ZKkHdE0fJ/QNH/w/fUfjoTjaLEtmfo5IJAky8PdcY36tEbLvWD+uQc5deCIDC0v0rPz+Di6w1tl+1+p1Pb880++20ErlBoTLqLjRIWJwa1szwCEvBo+aJ1JB1P2vrS3D1xU2dytXV16HJb0iI5+l2rvkeJWeIhWvU66rQtTgzZVJz8I1M1rQ5mW8DzxH3mUL2TrRYnmez5MHlaGhbjasBBzbE7j0oC7ZZMrJdiNiirIYg3ydeiCjh8Os2bo9L9H7qfGr879teFFCw2dcAVuuDq4Q5I1TsM+Kl84cuU1LozD/b1PyyZxCQ3UySN7V372rXTCuMw7nK9yUr/S7TENt9gveSY5zrfW7+RztQ9RQIz1gvMkUrDflSDa2QSNuljYYavSU5fyN99+dzo9oa6NFnhjeEL3K9nigHI5ttNkymGrQrotNxoaxWE345yrlEOz5T1k5V5uBv4vJTv1qafhaX1qqzTmwbY85tcaGykm90fILVfonbPJDkDBS1MA8rMJtxDAUe/HbSNjjNd2XXjoaUn98BM0y3lA== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Uses the GA4GH workflow execution service API to retrieve the details of the run assoiated with the given `run_id`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/ga-4-gh-run-list.api.mdx b/platform-api-docs/docs/ga-4-gh-run-list.api.mdx deleted file mode 100644 index 703cee3a2..000000000 --- a/platform-api-docs/docs/ga-4-gh-run-list.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: ga-4-gh-run-list -title: "GA4GH: List runs" -description: "Uses the GA4GH workflow execution service API to list all run records." -sidebar_label: "GA4GH: List runs" -hide_title: true -hide_table_of_contents: true -api: eJytVdty2jAQ/RWNnhmc2+SBpxLqUiYEKOBJL5NhhL2AEmM5khxCPfx7d2WbQKBNOpMXkHaP9np2nXMr5oY3fvG5uJgv+F2NR2BCLVMrVcIbPDBgmF0Aazcv2l/ZSumHWaxWDJ4hzAjDDOgnGQJrDjrMKhZLY5mIY6azhGkIlY5Mnde4SkELetCJ0GybvA2zpItoVKZCiyVY0BRKzhO8ICgVc5gY+RsQISmYxwz0mr8OcYAwVsJMuICl4I2c23VKNmRiYQ4aVTOll8IWovMzvtnU9h1Z9QDJOzxVuANXxmqZzNEwFlGDSVWCtSP92ckJ/e3b6l+jjVBheIklrUjTWIauQt69IUh+6EJN7yF0BdNUTysLB1hqs4MSWgsKXlpYmne9nsjoSCKYoxUWDjU1Dkm2JNYEvete/7aHkm+BH/if8dDpdcadZrfzs9Nr43UY9HrFadAMRg7R6t8Muv7Yx6P/3W8F4/5w4g+H/SEKRj9GY/9me201ey2/W7xyRzKF9bXSxhTQyAWIvdxKkFQkzIyTJvBsJzvtPdKtvafEx2HZO9SR9uJY965EhORGljj6flAbl2b+1y5kZhKqCN7J7G1Kt2B8rZU+yOn8CCOrCWWJciOsVhA5aziaC0VjO4diWu0CL55bGd4KjPd06jkOYqy4DaoxznSMsIW1qWl4nkhlPYxVFtUNPKKnulQHAzZyGjaIhaWkWIvwtFk4DZXBlaOlXY+onkXJrkBo0M2MAtpWhjxWA0r3qQOhpDh8qcp1v7IuPZnMlHtekaqIgty+FWC5/EwJJiKI0BFhP/ndlJELMnbdmqlPLwoMhCpX+DmtX17WT0iWKmOXwvGo3FZuEzcYUZWVVd8LMn/h48et77K0FufJS2OBSxJjcznmJR+qT0iNIyPw9+kUf1x82LoFZkGQPJ8KA4GONxsSF2uWuBJJI6Yx8q0xE7GBf6S0u+6PRvUA61cfjycRZ4TjtPP/01O17t9yVeFefN3RRUtyhineIXwBIkIiUr7Fy2YYQmp3Xh2sD7KyHb+2P0bC/gHU25XJ -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Uses the GA4GH workflow execution service API to list all run records. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/ga-4-gh-run-status.api.mdx b/platform-api-docs/docs/ga-4-gh-run-status.api.mdx deleted file mode 100644 index bbf1493f9..000000000 --- a/platform-api-docs/docs/ga-4-gh-run-status.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: ga-4-gh-run-status -title: "GA4GH: Retrieve run status" -description: "Uses the GA4GH workflow execution service API to retrieve the status of the run associated with the given `run_id`." -sidebar_label: "GA4GH: Retrieve run status" -hide_title: true -hide_table_of_contents: true -api: eJzFVUtv2kAQ/iurPbUSwnkpB04l1KUoCaQGK30oShZ7wJsYr7u7hiDL/70zawOhJO2lUi94dh4738x+M5TcirnhnR98Ls7mCb9r8RhMpGVupcp4h4cGDLMJsH73rP+ZrZR+mqVqxeAZooJ8mAG9lBGw7s2AWcU0WC1hCS7IWGELw9TMnXSRMWGMiqSwELOVtInTz+USMvaA5nsZP7R5i6sctKDbBzFi6BO0oMjG7jY050KLBVjQhLzkGR7QrY5HsyTgubAJ/70avAQxaZnNmYwhs3ImQaOXhp+F1IDJrC6gxU2UwELwTsntOqe76yBeVXfkbHKVYV/IfnJ0RJ/9NKNLvDNSmcUUZBV5nsrIFeQ9GnIpD1Oo6SNElqrTVL6VdYKmqkMoiBL7AYeWFoesWNCbhsPL4eh2iJovoR/6H1EYDAeTQfdq8H0w7OMxCIfDWrrphmPn0Rtd31z5Ex9F/6vfCyej4N4PglGAivG38cS/3h573WHPv6qjnEhXYYestCkBGjuAVbXT7F6xqkh/9lr7LkTM6EXA2H/Xx4WZv9nEwtxHKn7ZSok5544aM6UXwtaq05O9Ym7B+ForHTSE2NZ0+golNoxmmbJMpDhDSDdyRyInimg+B4eaeNvhnptHbwXGWx57SALjlTUVKs9s5oBGbzMEhU4xLLE2Nx3PE7lsR6kq4raBn5i5LdXBMIydhd2kwlKRrEf+NMacWG5wvrW06zH1t27hBQgNulsQwG2nKCNvJobOU+eEmlr4tGnf48q6cmU2Uy58w5EaBaX9G8Bm05jGmYghIkeM/eJflozckKl7vZn6sDMgEOpcnee4fX7ePiJdroxdCMerZqm4tddhwWarabdBmv7vwS13TP1PW7N5EQvP1stTgWsQS3KtKRtabdZ8iyOx8Hd5TMsPyYWfznZ/NvUhCRLsB0WV5VQYCHVaVaTG0dRr1KO4FFqKKb0kcjCWhmQk80ykBv7QoHdBs3Hfs7d28qvVNEqRrQm9SAs6ofgE690/QHWHngmIGO8hWLWxG0WQ2xdhB9uEaL+dxr4/Qb7+AgBIaCc= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Uses the GA4GH workflow execution service API to retrieve the status of the run associated with the given `run_id`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/ga-4-gh-service-info.api.mdx b/platform-api-docs/docs/ga-4-gh-service-info.api.mdx deleted file mode 100644 index a3c91d027..000000000 --- a/platform-api-docs/docs/ga-4-gh-service-info.api.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: ga-4-gh-service-info -title: "GA4GH workflow execution service API info" -description: "GA4GH workflow execution service API info" -sidebar_label: "GA4GH workflow execution service API info" -hide_title: true -hide_table_of_contents: true -api: eJytVlFP2zAQ/iuRn1kLDPHA0zoErBowNMb2gNB0da6JmWMH22npqv733TlpKCihTNtTXfvO/u6+7+6yFAEyL45uRQYHWS7udoQt0UFQ1oxTcSTOePsa3UxJHJupFTvCoS+t8UhuS7G/u8s/KXrpVMlu5PTlM5lJawKawKdQllrJeOnw3rPJUniZYwG8CosSyclO7lEGciwdQwiqfmCGzqvapTH0wSmTidUO3au+v3IsbVGowGF0+VYh/0abfuMUnIMFIVABC9/hRW7aZspcQcg7LzUwm4DbHlSBpnrLwz3uGiaoOwFUrmufDoIKmrcuI8Jja6YqG9R/LggM2fQY8a05ggsThDAmSt0MNt9QtJWhI4xT6woI9db7/YjGo/th3S9fgsQTAxONm2RMrNUIJrKhtZ2PjQ9gJB47TEk5CrTvttZgUgrspjNYCgNd4b9Mbzz2WTTa7DsGA3oRlHwDFXk1oWroE1lpfchtNirVZ1xssfhEq9e5G7Ww1hk7txL0V6RLOhK1Q1VZOqS646wHV+FT5BfweKo0XqvfuJXLwwN+bw6z1ynMnK1M6ueo9VvtRhwDpq1E3lIS/Rjpbi8Lz80KXR+15JThlcOpeuw89/hA7e9Y26oHPpL8W8Dj9J8hMyEgw0kBqkeMnKRLfAxT+j3W6txmfWVhM1t1i5paU6U1s9IoYUNWm919FfvAQVdT/whp4vChQh/+X3cvfNZNQ4BQ+Z/Sptv1yb1mI5wf6E+cs+5rM6bamN53DKr1rEuMDQnUcoy3Pbc7Gx2cfUrmRDuTkOAjyiq6+Tp3yehqnKh6PBZIBc2jM8MYb5wVYhjn63COfjjbGzZu7xoXHyXLY3hZd3CRh1D6o+GQJtxAshgHtTAHyoqX4K7jSXKlIXBakiheRiRWd3y3rJwKi2tmpE76R2rn6EbVsyHGLzKUaMa6ika0Uy9O1wm/n4eYoAid3VsVRRT87DaATfS+MW4qgC97HvxmyFjXR3z2w9MBAWk/EMTe4PBwsLvuqgVEJRqI4fwNg8/QtwkKVILDUoMyG4O2Znf99URdkjJMkPYaUluOiYg89vdbsVxOIE6m1Yq3qaAcjYZbWs7AqbpEb+/qqZsSAyyKXzw9xEhKLFlT1IKq2HBeVh4T3urv7OQbMfUHQH9qmA== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -GA4GH workflow execution service API info - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/generate-data-link-upload-url-1.api.mdx b/platform-api-docs/docs/generate-data-link-upload-url-1.api.mdx deleted file mode 100644 index c2ef369c2..000000000 --- a/platform-api-docs/docs/generate-data-link-upload-url-1.api.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: generate-data-link-upload-url-1 -title: "Generate data-link file upload URL (to given path)" -description: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`)." -sidebar_label: "Generate data-link file upload URL (to given path)" -hide_title: true -hide_table_of_contents: true -api: eJztV8tu6zYQ/RWCqwSQ7dzeIAuvmmcRNLkJ8sBdpEFNSyObiUzqklQS1xDQj+gX9ks6Q0qW/Kid3HbRRTeJSQ7ncWY4ZzTjTows7z/wRDjRyaR6tvwx4gnY2MjcSa14nx8bEA4sE+z+5oI5zYo80yJhqcxwF9duDGyugAlrdSzxRsJepRv705F8AcUGJHSBMufJIGI2h1imU6lGqJl0sVyg+M4gkeYafw12u7+oM23Y4ddbdvu5sWAjJhQTSSLJQZGxVGeZfu0UOTPwrQDr2KTAP0NgFpRjInVg2FQXJpip3B8Ly2I9yTMgV3fQEKhYFwqFcY0WwBhtdinAVKIZ+Rv4WKrrHVQeNga9sNVDMWnHA9ST5Foq1+UR1zkYQX6eJwjlT6BoCScVEPf+4r3Jfv2EsrkwYoLeGErJjCtc4J0GNBSRlBDCiS9n6WSeAOsMgSoTDF6mEgzKEjAS4+J9ZwqIuI3HMBG8P+NumpOVcImXZdQYDnnYaJUE5iWAyCNQdMLwLsROm+l32o5RntwXmW3ixtx6hSvlWYuuDf095l61eba5iGGbsa+1IFPFBIyMt9jCKoCRP0q1mQgXtg72F6xfGTlCm5XhMYhko+MRV0WWiWEGAdGyfAwgI/5HOpnSjVijYeXop8jzTMY+Lb0nS1HMVlXr4RPmi2rQUMU6CZZO6b188U6uOrEIDEkxnfpC8K9s3ie6vIxqfy5AjbCK3oHPsv5ben5r9TOp2HCKDapt6M6r3+b05fnlKSORv9G8A91RN2KDNoQ6duA6qBDEBLvYwMGb6+WZkAobFqWVO+koNbx+5JdF5uS1MC689puQKRQtl9+G37C5VjbA/8PeHv1bdPrqZx79W/kNcVJr2gZV8J2dn7BR1cMSRL3qzV12U8WBvdisb4pVgfokFXXbsy3DwhhBD046mNg1z3XZo0OSp8TlBjpWjhRaR4LyjARvEBcOkAcQ+g72VVcXI7tS4HkMUWB08M6chaxQ0lB6f11ejprUfiA/TQE88AlYK0ZADLw5bbXgup42D+WU6GvF8c9rCqqmKKY0siVxKfrjpfdXpb9od4YsmbA/f/+Dzfsmw7S3erbXlJJYxA6vz5EOLPWrpjzmFyO62QwP2oQpYH7/v4olHlqsMSPd1JP1EQgD5rCg7vbwSB0ZmXysifRz7UvC82ef95o5pjdruL2s38usot2SGADMSz0NFCYjcnAut/1eT+SyG2e6SLoWvmH6ulKvtkx/wq4z4ai5smOSp3Rwcq/2/pbgC1C0Y5ijQRZrMqL10AvhTvhxVrftp1fnIaO03DRkdPomaMRaJJOmySzxwt5SA289fqlS7d2qUlJFR+FsC5xglDHOqkGYLIjY19MiqG0osaRk5tko1T82B+gIZSTY+dQ9OOju0R6leCJ8OVacXk96rdpuD5/UgXawUYXBmEpjdzmMFon/P4L/kxG8KuSGqD0FUeZn1aNc+P6JeH9h5A6a/XY1EOPrGdObxnuz2VBYQCYrS9oOQyM917rj8X6K/RA253bj/LrW/WeYrpmSX0RWkCyn4fL9HmwZajc4sDg3N+YfaWFkmFE/hMZOPUnsss1fNGu9qkcJNW27U3vbSuvHAGo59Z4Pnu9xrSqt8hFFqy+AjwG3OVHzT4yFEglnx0FHx7fcRmKFa5sbh3EMudso2ybA66vbOyKM6ttkohO6Y8QrfRziX++89jF5HvJ7M54JNSo8NfOgk+hFLLLTEht5zNYijQ/VS9zpZ1BlOQfe0ZpgL8u/AKyS7Zc= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). -For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/generate-data-link-upload-url.api.mdx b/platform-api-docs/docs/generate-data-link-upload-url.api.mdx deleted file mode 100644 index 43250d936..000000000 --- a/platform-api-docs/docs/generate-data-link-upload-url.api.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: generate-data-link-upload-url -title: "Generate data-link file upload URL (to given path)" -description: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`)." -sidebar_label: "Generate data-link file upload URL (to given path)" -hide_title: true -hide_table_of_contents: true -api: eJztV0tv4zYQ/isETwkg22k3yMGn5lkETTZBHthDGsC0NLKZyKSWpJK4hoD+iP7C/SU7Q0qW/KidbHvooZfEJIczw28e32jGnRhZ3n/giXCik0n1bPljxBOwsZG5k1rxPj82IBxYJtj9zQVzmhV5pkXCUpnhLq7dGNhcARPW6ljijYS9Sjf2pyP5AooNSOgCZc6TQcRsDrFMp1KNUDPpYrlA8Z1BIs01/hrsdn9XZ9qwwy+37PZTY8FGTCgmkkSSgyJjqc4y/dopcmbgawHWsUmBf4bALCjHROrAsKkuTDBTuT8WlsV6kmdAru6gIVCxLhQK4xotgDHa7NIDU4lm5B/g31Jd76DysDHoha0eikk7HqCeJNdSuS6PuM7BCPLzPEEofwVFSzipgLj3F+9NhpK5MGKCvhgKyIwrXOCNBjIUkRQOQokvx+hkDr91hiCVCT5dphIMyhIsEl/F+84UEHEbj2EieH/G3TQnK+ESL8uoMRyisNEqCcwTAHFHmOiE4V2InTbTH7Qdozy5LzLbvBsj6xWuJGctuvbp7zH3qs2zzUUM24x9qQWZKiZgZLzFFuYAjPxRqs1EuLB1sL9g/crIEdqsDI9BJBsdj7gqskwMMwiIluVjABnxP9LJlG7EGg0rRz9Fnmcy9mHpPVl6xWxVtR4+YbwoBw3lq5Ng6ZSq5bN3ctWJRWBIiunUJ4KvsXmX6PIyqv25ADXCLHoHPsv6b6n41upnUrHhFNtT29CdV7/N6cvzy1NGIn+jeQe6o27EBm0IdezAdVAhiAn2sIGDN9fLMyEVtisKK3fSUWh4XeKXRebktTAu1PpNiBSKlsu14TdsrpUN8P+8t0f/Fp2++o1H/1Z8wzupMW2DKvjOzk/YqOpgCaJedeYuu6negZ3YrG+JVYL6IBV107Mtw8IYQQUnHUzsmnJd9uiQ5ClwuYGOlSOF1pGePB/BG8SFA2QBhL6DfdXVyciuFHgWQxQYHbwzZiEqFDSU3l8Xl6MmtB+IT5MAD3wC1ooREP9uDlstuK6nzZ9ySuS14vinNQlVExRTGrmSmBT98dL7q9KftTtDjkzYtz//YvO+yTDsrZ7tNaUkFrHD63OkA0v9qkmP+cWIbjajgzZhBpjf/69iiYcWc8xIN/VkfQTCgDksqLs9PFJHRiYfa6L8XPuU8PzZ571miunNGm4vq3qhvg/mpZ4BChwMkBKcy22/1xO57MaZLpKuha8YtK7Uq43Sn7DrTDhqqeyY5CkInJyqfb4l0AIAbc/nGJDFmoJoPfRCuBN+nNXN+unVeaAoGDcNBZ2+CRqrFimkaS1LbLC31LZbJS9Vqr1bVSCq19Fztj2cYJQxzqdBmCyI2GfRIqhtKDGRZOY5KNW/NAfoCEUk2Pmpe3DQ3aM9CuxE+CSsmLye7loZ3R44qe/sYHsKwzAlxO7yM1rU/f/Y/U/G7iqRG3r2xEORn1WluPDNE/H+wqBdVSOWzJjKF4Vns6GwgKRVlrQd5kOq0bq58X6KrQ82B3TjqLrW52eYrhmIX0RWkCynOfL9HmyZXzc4sDgiN+YfaWFkGEc/hMZOPTTsss0fL2u9qqcGNW27U3vbiuXHAGo59Z5vmx9xrfqsKh9RtBr2Pwbc5kDNvyYWUiScHQcdHd9nG4kVWm1uHMYx5G6jbJvrrq9u74glqs+QiU7ojhGv9B2If73z2r/Jk4/fm/FMqFHhWZgHncQpYpGSlijIY7YWaSxUL3Gnn0FhsdbAOFoT7GX5HQaX5Z4= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). -For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/generate-download-script.api.mdx b/platform-api-docs/docs/generate-download-script.api.mdx deleted file mode 100644 index e9e5006ba..000000000 --- a/platform-api-docs/docs/generate-download-script.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: generate-download-script -title: "Generate download script" -description: "Creates a script to download files from the data-link associated with the given `dataLinkId`. Append `?dirs` or `?files` to specify a list of files or paths to download within the data-link." -sidebar_label: "Generate download script" -hide_title: true -hide_table_of_contents: true -api: eJzVVt1u2zYUfhWCVxvg2VkX5MI3XZr+IFixFk2HXQQGzEhHFhOaVEgqniEY2EPsCfskO4cSJcsSnGRFgfXKFvmR5zsfz1/FvVg5Pr/mqfDiJyX1neOLCU/BJVYWXhrN5/zCgvDgmGD1KvOGpWajlREpy6TCrcyaNfM5sPYeJpwzicSDKdtIn4fdlXwAzZYEeo+Yy3Q5ZedFATply5eptG7JjMW/4dIl2XEFJDLbom0lnWcmawwirBA+dz0uZEfqPo8pn3BTgBXkzGWK7rwDTZ/wujl2FZxCWCGsWIMHS4pUXOMHwjuyCJGkBxnmhyK9bh133kq9YjIF7WUmwRIFC/eltID2vS1hwl2Sw1rwecX9tiAz9Sm+201ayxtj71whEuhM35dgtwPbf0Yg0+UarEz2jbMPASYU0RiYldrDCixuZcauha+Xzk57RBIkTvcJ5R6jctFBR4RgnxoZGFpjq/ohCNM+YX2XC/uFlQ/4Tt1bulEXRpSjUDrO830TTYiExBu77cJJ6kSVKbAYSX1qoxSEtYJsSA9rt7dubm7xdqS2xy3E79PIEfQb81pQaLrCaAcB8OLkhH76fD78hnckBkNFe9oVRaFkEjJqdusIUg1tNzYwrSzln5e1gfre4fMdanCVg1Kx4DS2n1R4phQJ3EuvoElLyt5+sn9qXCYFEHw65vQrkVK0gvPPcb7L82u+BufECqigHtckAsdiuvXkjbXGDoj/MvJasdoxbTwTSpkN8gno0yH6d+PfmhIL8Je//2FtxaH6upf14aaMYBN2/vESs8aJG9WkManfHpzQya4JNGW6O/9/1RI3HSSllX4biv8rEBbseYmVfn69oDTBzpAb6h8rqJsFbfFZV5xmVdcqdrNa41kMV8pOsA+xt5RW4eHc+8LNZzNRyGmiTJlOHdzj402lGeZD2GEflfBUqdkF4ekxOJGL3K9IvFqIfQ9aLchiLBT0fRNAuFL/eRt7wO3GB8Gkzkw43gjXsCCzjxEkd2WCKVqD6dVFEl697/y+y/jwUoUWlJlfuw0kQsrVdn6enp1NT2itMM6vRQiaprbG1n5YHA/JVl0Qfv/TTfO0Hv7ys0IJ7CuoTdC4aqK0N95N+Lw30nQKxVDFeMpRWjpXVTfCwR9W7Xa0XLcrCuBYAfg8w/oAR/R9+nAy6sgdbAej0INQJSE5tdWnM/n2s8kRDw5nqP/ow1fNLUfoNRPTV7J67sByhFAckzpGC/qwkig9MwR/iE/7I3tkTB8lFIcpvd3n0yrXJdNugegcRIollRjWgPMkgZBg8eig6/Xay7s3nxEr+nX7oE6H20dpYcIGxGdzBxqTNrL09E0Ed7t/AeiH3p8= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a script to download files from the data-link associated with the given `dataLinkId`. Append `?dirs` or `?files` to specify a list of files or paths to download within the data-link. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/generate-download-url-data-link.api.mdx b/platform-api-docs/docs/generate-download-url-data-link.api.mdx deleted file mode 100644 index d06c26123..000000000 --- a/platform-api-docs/docs/generate-download-url-data-link.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: generate-download-url-data-link -title: "Generate download URL" -description: "Returns a pre-signed URL to download files from the data-link associated with the given `dataLinkId`. The URL can be used for direct downloads or preview purposes." -sidebar_label: "Generate download URL" -hide_title: true -hide_table_of_contents: true -api: eJzVVs1uGzcQfhWCpwSQV25j+LCnOnEcGAkaQ3HQgyFA1O6sRJsi1yRXqiAIyEPkCfMkneH+aaWN7AQt2p6kJb/hfDOc+YYb7sXM8fiOp8KLEyX1g+PjAU/BJVbmXhrNYz4CX1jtmGC5hRMnZxpS9nn0gXnDUrPSyoiUZVKBY5k1C+bnwJrzmHDOJFJ4tFlJPw+7M7kEzSYE+oCY63QSsVtcp0MTodkUWOHQIDOWpdJC4htHjuEa8lhKWLG8sLlx4CI+4CYHK4jxdYqc34GmT7iszD5bdVl5Q2wurFiAB0uxb7jGD7Rp6SBEUuS58HO+n47LJjTnrdQzJlPQXmYSLPGw8FggZSThbQED7pI5LASPN9yvc3JTWvHtdtB4puTdlL6C38cC7PrA8RWiGFHqJJ6SKvVe0l9ANIsGbJIZlYIdumJa/TPTe8zm5CUxfQ6zBCOh6IRybVr66b1poT2ZYaMqL+FSZ+X1EKYJBC/fhc3cyiVeXRuOey7blbEPLhcJPMX1jxrIdLEAK5MO1Y8BJlSvW6k9zMDiFnJdCF8unZ91iFQFepzEdcYmVCOTQZ0PoCajJsj6ipyRQYbp/Z7FXqtE7BIyUSgf12a9AU2NUSA08h9T9brcaPRGgF9PT+mny/rjezwkMZgF7WlX5LmSSei84b0jyObQR1l21HmW+tTL0kFh1eGF7qfp5vuiQ0VP/QaO5IW6KKJr4F56BVWrUkfvqMCoChBxhDzrC/G1SEflqT8Satv4d3wBzokZkJYez0AN7CvrJoy31hp7QPxVz93UGsi08UwoZVbIJ6DPDtG/G39lCp2yb1++sqZ1SF93uj6clBFswC5urrHGnJiqqo0p/43hgCxbCaIKJq1q7P+rucRNB0lhpV+HafAahAV7UaAcx3djagocFXNDU2UGwSspdcyHrT4NN+3s2A7r1jyp6/SE6py82GU9ckLl87n3uYuHQ5HLKFGmSCMHj2gbSXPQBp/CDrtRwpPwsDeEpyvhRLGO4BOlsEzHbhxNRshjLQKh+QMIV8o/V7Wk3a98SJvUmQnmVfoqFuT2KYIUrkxQoEow3b1IfNP2TfC7IeP1SxUUNTO/tRtIhDJX+vklOj+PTmkNZdEvRCidSnfrsd+ZKvtMN20d/k/eNtXlefjTD3MlcKZg9JV4ltXYecENeNx5y/QXJFbNHBNItpvNVDhAddxuabkcV1SmdbfzOAyQI4n8ux8nvSE/wLr7WloKVRCM0+x9Ptl/+KlyhPv+e+onA3j+++UIl+5r6SeZ/DuPmCNRtU+vNqIxfVhJIf1gWb+oa+Ele+Ld30upWhR6vcunprrTpNsxoucgsA0CwxJwkSSQ+x3Tg6nZGU/v3t4iVnQVf0/hw+m9tFAEAuLWPIBGIahZevomgtvtX0du71A= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Returns a pre-signed URL to download files from the data-link associated with the given `dataLinkId`. The URL can be used for direct downloads or preview purposes. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/generate-random-workflow-name.api.mdx b/platform-api-docs/docs/generate-random-workflow-name.api.mdx deleted file mode 100644 index b136c1949..000000000 --- a/platform-api-docs/docs/generate-random-workflow-name.api.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: generate-random-workflow-name -title: "Generates a random name" -description: "Generates a random name" -sidebar_label: "Generates a random name" -hide_title: true -hide_table_of_contents: true -api: eJyFU01v2zAM/SuGzlmcfaCHnJYNW9HLVrQddhh6YGQmVmJLqkQnCwz/95GykzjNsJ309fj4+Ei1imAd1fyX2ruwXVVuH9XzRDmPAcg4e1eoubpFK0d8AFu4+ucA/AY1qokKGL2zEZmkVe9mM1kKjDoYLwSj8CKzfYh2ltCSIMH7yuiUKt9Egbcq6hJrkB0dPDKBW25QEwf6IMLI9MkS2xkVKRi7Vl03UWSokqtrwQ+DWoYJ8MPs/bXe78fiM+sog4pDsUi8EXUTDB3Yr1Z9QggYFg2VfHzu2LW/lx0zyEIScqy/RiqdGLvGVBUIhcqPHch79JsBHTHsMMSUswkVI0siH+d5Dt5MdeWaYhrxhXNNjVOvVTyml+y+Alq5UGefBZ8t7u+UKD4W9CiW966Oyzp5KxlFSoLxeZlAfNNvvjIzcD/VZk/JKGNXLoUPjRhUSNr/CZRyjWbXerDMCug0K5fFj0vmcTHyJmk/nh9YiDjX53k7vbmZzuTOu0g12PMI/aNVF1pPdhD+ptxXYKzwJV3t0MbzR5K/MWoku11yYkG07RIi/ghV18n1S4NBRoq3OwgGlmIZTxQHIBRss3R+iwxRC63Ry8zsoGpEydX/ka6e5uv2yxNj4bKXr3qX2IcnsIcRN8tMiCe3RctSJ4MIkjMn4h/0B5Dvdng= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Generates a random name - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/get-allowed-dynamic-labels.api.mdx b/platform-api-docs/docs/get-allowed-dynamic-labels.api.mdx deleted file mode 100644 index 0c2680d60..000000000 --- a/platform-api-docs/docs/get-allowed-dynamic-labels.api.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: get-allowed-dynamic-labels -title: "GetAllowedDynamicLabels" -description: "GetAllowedDynamicLabels" -sidebar_label: "GetAllowedDynamicLabels" -hide_title: true -hide_table_of_contents: true -api: eJyVU8Fu2zAM/RVD5yDOiqGHnJauXVFgwIq2Ow09MDKbKJEtVWLSGYb/faTkpEmQrdjJsvTI9/hIdopgEdX0l7IwRxvV80g5jwHIuOauUlN1izSz1r1hdd02UBv9PQNHKmD0ronI4Z26mEzkU2HUwXiJ5tgfa4Zp1xA2JK/gvTU65S5XUSCdinqJNciJWo8c5OYr1MSBPogSMplgC3aTTwMOQoCWYYawPryPFEyzUH3fjxQZsnJ3roKHQb4gGfr5XAFXUBUP+MrE9D+VBA4xASvxtcYYYYFi7L8L3AHPVPJeyE0ILhwp58eIehMMtUzXqSuEgGG2oSX/PvdMe1zS3/tZIy2dtHyBSR1IClXmwSirjC4hByuhDVsMMbFugmXsksjHaVmCN2Nt3aYaR3zlYRobp051PKaX4t4CvbhQF18FX8zu75Ro3pX0KJ5mfw4L21skjCIlwfh/nkB8kw/fODNww9TqjZKPpnlxKXzwc1AhtB8JlHKNxjiAZRhAp2E4Lv6wZJ4HI29C++X9gYWIc5nn0/jycjyRO+8i1ZBmib3G3Kxi6FYxtKvY9+tI7t4Rwt9UegumkZRJWjf0cr/kHJuT8WnXTzZ9yfyC6ro5RPwZbN/LNY9/kNni4xaCgbk4x6PFAQgVuy0DsMZW9kxr9DI8aVtlSU/3RJq7H7TbmydRcNzSkxam7LuVb9qD3CwzIZ7cGhuWOhpEkPwzEe/GH/ELrPA= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -GetAllowedDynamicLabels - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/get-data-studio-checkpoint.api.mdx b/platform-api-docs/docs/get-data-studio-checkpoint.api.mdx deleted file mode 100644 index 11560b215..000000000 --- a/platform-api-docs/docs/get-data-studio-checkpoint.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: get-data-studio-checkpoint -title: "Get Studio checkpoint" -description: "Retrieves the details of the given Studio checkpoint ID." -sidebar_label: "Get Studio checkpoint" -hide_title: true -hide_table_of_contents: true -api: eJzNVktP20AQ/ivWnlopJLRFHHIqb6FKFPFQDyiHxZ7EC47X7I4DaeT/3pldvxJbEGgPvSS2d2bnm2+eK4FyZsX4TljMI6WtmAxEBDY0KkOlUzEWV4BGwQJsgDEEEaBUiQ301L3O1ALS4NrpBmEM4WOmVYrB+fFQDITOwEi+5jyii84AjyVKL3xUy5JcJo2cA4JhJCuR0gvJW7DW6w6EYiSZxFhswittl8JBms/BqDBQEaSopgoMaRh4ypUBAoEmh4GwhHQuxXglcJk5U+RiOhNFMaitN868AeCiY7Eip7liuA0IkoOZwzvVZi7Rf9rfW4P1rM2jzWQIDaqnHMyyA+tXJdhPyXusTxi8zXRKJLPG191d/lu39/MHqYaabqGQ0qnMskSFLvqjB8siq5bRhow7IXOMNRuOJMKRAfqNyrdruXDPin8cA4MqCBYl5i5dSwf0/QOELpsM5x0qD5ZUt3GyvL6bEuuwOuetm1huBxXdUrTRb61S8rDJzoJqhhETcyqpuMgtmAsG/O/8r6/s48Ab7zsp8fXVkkCFCX+6pavP06lmeRe+vovKgPbQBZTBTAXMM1y6rKdWoebshUplon77HEkX9BwxIy87rLKzkIaDat+lW2HebFPXHl7brb5udozkZcFSe31VciijKwouWPxotZA/Vs62CHwl+GpkTozR5qos7hr4t57yrlp5kGoMZJLoZ4iGwonvdcUvNJ7qPI0GwXNMA4K7oR8wgTYbvTFQ1t05ZXk+rjUOLs/5MFJW3icQkYTXrXvg/8ohZzOEuVGUcjzQDkEaMAc5Z/7dhPspTbtY81CcAVY9bSxG5RAererZV4wapuh7eyoV3AXBLKqxmRuqUBEjZnY8GslMDcNE59HQwhPFbqh0d3a6k+Aykcj9IDhieaZdMMbKhWvm0PPRdqSmhC1WE4Xf750QffEPp1WneXhGx5viTsDqVaV5FGz2LYDsrgppFfHCHHwZuuCvO992uWxdzuz35oCAMHPezpfh/v5w17UnbXEuXe6UE5fWlu6Cs4l01STi3yxMJaMILzjKEknjnRuzcZ3X50izqA3EuL0htdKEj9bWFwpmTH6x9mp1Ly3cmqQo+LPfHTh7qioT46lMLLzi3xubRa8Pj7DsLC/UcnOWdMlGvVqx/Xdi+XRVlvXnYJtFsBdb+VGmyzaoCnPDMW9hH0K27Yb4AXRrYS4mJB+DjMhXptGLHIQhZNhS7vTJtYZ0dnIj/C7SKvGNkna39wKj9HISN/oR0qKocSK/M8Ci+AMzB0tI -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the given Studio checkpoint ID. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/get-workflow-log.api.mdx b/platform-api-docs/docs/get-workflow-log.api.mdx deleted file mode 100644 index 21e26641f..000000000 --- a/platform-api-docs/docs/get-workflow-log.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: get-workflow-log -title: "Get workflow log" -description: "Retrieves the execution log output of the workflow identified by the given `workflowId`." -sidebar_label: "Get workflow log" -hide_title: true -hide_table_of_contents: true -api: eJy1Vstu2zAQ/BWCpxYw7PSBHHxq0qZB0FeQpOghMFJaWstMKFIhKTuGoH/vLiVZUqw6cIGeLGuH3NnlcFYF9yJxfHrL18Y+LJRZOz4b8RhcZGXmpdF8yq/AWwkrcMwvgcETRDlFmDIJM7nPcs/MIsSaTZiMQXu5kBCz+SaEErkCzX43iIv495iPuMnACtrsIsZE5+B/1fGvJsFwJqxIwYMligXX+Adh7R4IkcQwE37Jn9NutmIO6euk5WQRauExlxYwq7c5jLiLlpAKPi2432SUpFrEy3LUy+syEUGb+DEHuxnMHIBM5ylYGfVz7+SS2kMSQgtjU+GrV8fve9k1PPmX04aC6WCi3DozmG2gslQ8fQWdhCbuSfBNPMk0T5kKWCY1Hq5HWdSnT2m9YbaWy4GVzuhQXGa0A0cr3h4d0U+fwY8vuDQyuIv2FBVZpmQUFDS5dwQpdpOa+T1E1LvMkt68rBIg3ZdBqA6N+5NQttC5MQqE5uWIIw3bIJ/t46VX9OLCk8SNvbsOfb+jZRbWUsc35gH0wMGE5qyF3QPIQMf0OEgqBedEAoMLY7PWyoi4S1lYK+iwpYd0sJR+S5xYwfegmyHmUv09GEuXKbG5ISUP6XHbM7z9l1jB+FPNFoO70d6Kjm9c1SqiRYh4P6SjUxEzsgBw/hBBta5xu+0y6nZ/v/5+HB3+Z9Yau8P83cANaByTaeOZUFgzxGErh75spd8EqzwFYcGe5Hilp7czulzoo0tDLptA4EiWOeWTxkwnRWur5UQF+3VgV4335lYhfOl95qaTicjkOFImj8cOHpHQWJodt7gOEXaphKfLzj4Snp1cXnCi07C9puZWjepy3vaKMjZOEnQeQPimevjc2Mj92ocuSL0wYXnd2JoFpX2JIJUrI/SzCkyqEFFQRb/4bskoDKmCiy3MhzaARKhzVZ434+Pj8VG4tsb5VARR1c6LI6+dmlXXeySLVpz/cw7XzfZ4Myd4RWXwkVB1USul/UJA+LQ3gok2nugSiyNcUcyFg59WlSW9rkYJSQivv5gruj0LoRzsqfSFATrI9gE2OzN6JVROSE6z7rD0u4N0T9Z6Nv9juoPH6h4m3Une0pnRHyuJz4En8eqqtrzXbO/31CClZr7oTZdN96hqDZUzRC9BxLgX8asAJ1EEWbevO+bc87XzsxvEir59PLOLsPsgLVRtQISZi8ptWPowg5FgWf4BdXngSA== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the execution log output of the workflow identified by the given `workflowId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/get-workflow-task-log.api.mdx b/platform-api-docs/docs/get-workflow-task-log.api.mdx deleted file mode 100644 index 759f7dbc6..000000000 --- a/platform-api-docs/docs/get-workflow-task-log.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: get-workflow-task-log -title: "Get workflow task logs" -description: "Retrieves the output logs for the workflow task identified by the given `taskId`." -sidebar_label: "Get workflow task logs" -hide_title: true -hide_table_of_contents: true -api: eJy1Vk1v4zYQ/SsET13AsLMfyMGnZrvbRdBtGyQpegiMXVoay0woUiEpO4ag/94ZSrIkW9auA/RkmZzhvBm+ecOCe5E4Pn/gW2OfVspsHV9MeAwusjLz0mg+57fgrYQNOObXwEzus9wzZRLHVsaGtcaZeeGemIxBe7mSELPlLuwncgOafafd6/j7lE+4ycAKOv86xghfwP9bH3GPNl9NgiaZsCIFD5bwFVzjHzRtQqHfhEuClwm/5oeYm+OYQ+w6aTFZNLXwnEsLGNnbHCbcRWtIBZ8X3O8yClI58bKc7ONW2EdjEnSm8xSsjM4MKLWHJJhiSVPhq6XLDz0IGl58A+A5B7s7nTXeDoty6wwd+TPpUVldJiJoczwdIhgOZ/q6zFLx8hV0Emo6EvtP8SLTPGUq2DKpkV8eaWlWgWWUtDfM1nQ9E82CrsllRjtw5PHu4oJ++gj+/gNdI4OnaE+7IsuUjAKRZ4+OTIrjoGb5CBHdXGaJ9l5WARDuj42QLxrPJ+rsTZfGKBCalxOOMGxjeXCOl17RwrWnTjP221249W/kZmErdXxvnkAP0CIUZyvsiEEGOqbPQVApOCcSGHSMzVYrI+IuZGGtoMuWHtLBVPolcWIDfwXeDCGX6vRmLF2mxO6e+mioG/Y1QwG6wQymn2q0uHm82/NoOg/3bmsWkRNafBji0UcRMxIFcP4cQrU68rCvMvJ2vF6nr6OD/7O1xh4hfz/QAY1wM208Ewpzhjgc5QAVR/pdUOuPICzYqxxbev6woOZCKV8bEvsEAkZS0DmfNXo+K1plL2fYG7OiktyS+hjsppkDuVXot/Y+c/PZTGRyGimTx1MHz4hsKs2RbNyFHXajhKeuZ7+RPbu6ueaEq4F9R1WuKtYFvy8aRWwkJRA+GOFK9fF7oyePWx/KIfXKBPe6wjUKCvsjgJSujFDYKmOih4gCPfrJd1NGhkgV5Gxlfm03EAhVrorzdnp5Ob0I/WucT0VgVy3BOIIPxjhN+EOoRcvV/+VZUNfaY4fOsFVl0JOQdFEzpn2poPm89xpQ4dkwryc1Xu0asySPolgKB/9YVZa0XA0X4hIKglgq6qeVUA5Gkh2erINwn2DXDuuNUDmZcJp254UbmbIjcfuD/JXhzx60I4C6s72Fs6A/VhKeM2/il9taBN+w0UfeIKRm4uhdF023djWbzqtXB9PpR+ArANVULhdouQYR4zlUrGrzKoog63LsaHb0ZPfL53u0FX1ROxCxcPogJGyhYBGeBGXZIgxPBARYlv8BJ05A3g== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the output logs for the workflow task identified by the given `taskId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/info.api.mdx b/platform-api-docs/docs/info.api.mdx deleted file mode 100644 index 84a7c7159..000000000 --- a/platform-api-docs/docs/info.api.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: info -title: "General Seqera service features and version." -description: "General Seqera service features and version." -sidebar_label: "General Seqera service features and version." -hide_title: true -hide_table_of_contents: true -api: eJylVk1TGzEM/SsZn9OEUoYDpwYGaIavDCntIcNB8Sobg9debG8gzeS/V/IuIaG7CUxPWWTJevJ7kliIAKkXRyPh0c2UxC/KTKy4bwubo4OgrOkn4kj02doWDn1ujUeKWIj9vT3+SdBLp3J2JcebC3KT1gQ0gU8hz7WS8aLug2eXhfByihnwV5jnSEF2/IAyUGDuOG1QZYIKUsy903mGzqvy/srRB6dMKpZtAqF+bTmWNstU4DrrYosw/UlGv3YKzsGcEKiAma+JojBtU2UGEKa1lxqYjcHtLipDU3wkcUO4hjHqWgCFq7PTQVBBs+k6IjyxZqLSTvnHFYEhnwYnvnWK4MIYIfSJfzeD9RyKTCk6wjixLoNQmr7tRzTE9G/rHn0OEk8NjDWukzG2ViOYyIbW9rlvfAAj8cRhQjJToH29twaTUGF3tcVSGegyfzO589jkUQm56RgM6HlQ8gNUTIsxtU6TyHLrw9SmvVxd4HyHxw/62s5dbwXr9cUurQR9i3RJzUO1qYVzh9Sk/OrBFfhW+RW8nCmNQ/UHd3J5eMD5nmG2ncLU2cIk/hm1/qhfj2vAZCWRj7REM0a628vMD0mh6JqopaAUBw4n6qX23OMTzccTbYsG+EjyXwHuJ/8NmQkBGU4zUA1i5Ee6xpcwod8TrS5t2tQWNrVFvahpNBVaMyuVEtZkNVwbxw3222o/8Jggj4O6DXEMScvhU4E+fGZVcIhyLJYRjUXvIUVeU7vmZ+m4tV1OnbNuA/my/Q7zORpiW7eGkfVWtZhaExp1Be3EFs2ZVrWAOgQiQ+pVXpspRkxxDYjuxoptx/VGMVTQopzHYhpC7o+6XdpXHcnS6pQy6ygr3kOqoAw0BFZLK0qx1Rv0xfKe75aFU2E+5Pcr3+KYhjO6XrGxkjgjQ4lurJLoRJby4+xVhw/PIb6Zet3FK+4jCk67C2BVva+cKz3zZZvFr5eMpdpj2u9vBwRkte7F187hYWfvdUZmEHVjIJbzSd42Cli9UaCe6uYalFnbnCWn//7bNI3TeSQWizHEvbJcspnk7miwj+hzBk6VDTa6L3dmQi/OInjk2S96UmLOsqEBUsRx8b4vmOCVxM5PfxIzfwHL9maY -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -General Seqera service features and version. - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/info/actions.info.api.mdx b/platform-api-docs/docs/info/actions.info.api.mdx deleted file mode 100644 index 5e8f3a121..000000000 --- a/platform-api-docs/docs/info/actions.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: actions-info -title: "Actions" -description: "API operations for pipeline actions in Seqera Platform" -sidebar_label: Actions -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -[Actions](https://docs.seqera.io/platform-cloud/pipeline-actions/overview) enable event-based pipeline execution, such as triggering a pipeline launch with a GitHub webhook whenever the pipeline repository is updated. Seqera Platform currently offers support for native GitHub webhooks and a general Tower webhook that can be invoked programmatically. - -### Path and query parameters - -::table{file=parameter-tables/actions/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/actions/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/avatars.info.api.mdx b/platform-api-docs/docs/info/avatars.info.api.mdx deleted file mode 100644 index 67e16135b..000000000 --- a/platform-api-docs/docs/info/avatars.info.api.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: avatars-info -title: "Avatars" -description: "API operations for avatar images in Seqera Platform" -sidebar_label: Avatars -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -Manage avatar images. - -### Path and query parameters - -::table{file=parameter-tables/avatars/parameters.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/compute-envs.info.api.mdx b/platform-api-docs/docs/info/compute-envs.info.api.mdx deleted file mode 100644 index e38fd7d3e..000000000 --- a/platform-api-docs/docs/info/compute-envs.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: compute-envs-info -title: "Compute environments" -description: "API operations for compute environments in Seqera Platform" -sidebar_label: Compute environments -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -[Compute environments](https://docs.seqera.io/platform-cloud/compute-envs/overview) define the execution platform where a pipeline or [Studio](https://docs.seqera.io/platform-cloud/studios) will run. Compute environments enable users to launch pipelines and studios on a growing number of **cloud** and **on-premises** platforms. - -### Path and query parameters - -::table{file=parameter-tables/compute-envs/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/compute-envs/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/credentials.info.api.mdx b/platform-api-docs/docs/info/credentials.info.api.mdx deleted file mode 100644 index 70c434e02..000000000 --- a/platform-api-docs/docs/info/credentials.info.api.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: credentials-info -title: "Credentials" -description: "API operations for credentials in Seqera Platform" -sidebar_label: Credentials -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -Credentials store the access keys and tokens for your [compute environments](https://docs.seqera.io/platform-cloud/compute-envs/overview), [Git hosting services](https://docs.seqera.io/platform-cloud/git/overview), and container registries in Seqera Platform. - -Container registry credentials are used by the [Wave container service](https://docs.seqera.io/wave) to authenticate to private and public container registries like Docker Hub, Google Artifact Registry, Quay, etc. - -### Path and query parameters - -::table{file=parameter-tables/credentials/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/credentials/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/data-links.info.api.mdx b/platform-api-docs/docs/info/data-links.info.api.mdx deleted file mode 100644 index 0f8e27c07..000000000 --- a/platform-api-docs/docs/info/data-links.info.api.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: data-links-info -title: "Custom Data Explorer links" -description: "API operations for custom Data Explorer buckets and data links in Seqera Platform" -sidebar_label: Data Explorer -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -[Data Explorer](https://docs.seqera.io/platform-cloud/data/data-explorer) enables you to browse and interact with remote data repositories from organization workspaces in Seqera Platform. It supports AWS S3, Azure Blob Storage, and Google Cloud Storage repositories. - -Data links are custom bucket directory paths (for new or existing buckets) added to Data Explorer in organization workspaces. To add a data link, the workspace must contain [credentials](https://docs.seqera.io/platform-cloud/credentials/overview) with permissions to access the data. - -### Path and query parameters - -::table{file=parameter-tables/data-links/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/data-links/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/datasets.info.api.mdx b/platform-api-docs/docs/info/datasets.info.api.mdx deleted file mode 100644 index 32f039fae..000000000 --- a/platform-api-docs/docs/info/datasets.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: datasets-info -title: "Datasets" -description: "API operations for datasets in Seqera Platform" -sidebar_label: Datasets -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -[Datasets](https://docs.seqera.io/platform-cloud/data/datasets) are CSV (comma-separated values) and TSV (tab-separated values) files stored in a workspace. They are used as inputs to pipelines to simplify data management, minimize user data-input errors, and facilitate reproducible workflows. - -### Path and query parameters - -::table{file=parameter-tables/datasets/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/datasets/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/ga4gh.info.api.mdx b/platform-api-docs/docs/info/ga4gh.info.api.mdx deleted file mode 100644 index c81c44b8f..000000000 --- a/platform-api-docs/docs/info/ga4gh.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: ga4gh-info -title: "GA4GH" -description: "API operations for GA4GH-WES endpoints in Seqera Platform" -sidebar_label: GA4GH -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -The [GA4GH Workflow Execution Service (WES)](https://www.ga4gh.org/product/workflow-execution-service-wes/) is a protocol for running the same genomic data analysis in multiple cloud environments. Use GA4GH WES endpoints to send the same workflow to different compute centres and receive reliable, consistent results, enhancing the reproducibility and reusability of genomic analyses. - -### Path and query parameters - -::table{file=parameter-tables/ga4gh/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/ga4gh/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/identities.info.api.mdx b/platform-api-docs/docs/info/identities.info.api.mdx deleted file mode 100644 index 473371b50..000000000 --- a/platform-api-docs/docs/info/identities.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: identities-info -title: "Managed identities" -description: "API operations for managed identities and managed credentials in Seqera Platform" -sidebar_label: Managed identities -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -[Managed identities](https://docs.seqera.io/platform-cloud/credentials/managed_identities) offer significant advantages for high performance computing (HPC) environments by enabling granular access control for individual workspace users. Unlike traditional SSH credentials that grant all workspace users access to HPC clusters using the same set of credentials, managed identities ensure each user’s activity is logged under their own credentials. - -### Path and query parameters - -::table{file=parameter-tables/identities/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/identities/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/info.api.mdx b/platform-api-docs/docs/info/info.api.mdx deleted file mode 100644 index bccfe9f26..000000000 --- a/platform-api-docs/docs/info/info.api.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: info -title: "Get API version and features" -description: "General Seqera service features and version." -sidebar_label: "Get API version and features" -hide_title: true -hide_table_of_contents: true -api: eJylVk1TGzEM/SsZn9OEUtoDpwYGaIavTAPtIcNB8Sobg9debG8gzfDfK3k3IaG7JExPWWTJlvSe9FiIAKkXhyPh0c2UxE/KTKy4awubo4OgrOkn4lD02doWDn1ujUeKWIj9vT3+SdBLp3J2Jcfrc3KT1gQ0gU8hz7WS8aLuvWeXhfByihnwV5jnSEF2fI8yUGDu+NmgygeqlOLbW51n6Lwq768cfXDKpOKlTUmoX+8cS5tlKnCddbFFmN6Q0a+dgnMwpwxUwMzXRFGYtqkyAwjT2ksNzMbgtheVoSl2ebghXMMYdW0Chauz00FQQbPpKmZ4bM1EpZ3yj0tKhnwanPjWKYILY4TQJ/zdDNbfUGRK0VGOE+syCKXpy37MhpD+bd2Dz0HiiYGxxnUwxtZqBBPR0No+9Y0PYCQeO0yIZgq0r/fWYBIq7La2WCoDXeavJ7cemzwqIjcdgwE9D0ruAMW0GNPoNJEstz5MbdrL1TnOt3j8oK/3seut0lp27MJK0D+RLqlpVJtGOHdIQ8pdD67A18ov4flUaRyqP7gVy28H/N4TzN6HMHW2MIl/Qq139etxDZisKLLLSDTnSHd7mfkhMRRdE7QUlOLA4UQ91557fKT9eKxt0ZA+Ev1XCfeT/06ZAQEZTjJQDWTkJl3hc5jQ77FWFzZtGgub2qKe1LSaCq0ZlYoJa7Qarq3jBvvPSh94TZDHQZ1CHEHScvhYoA8fkQoOUY7JMqK16D2kyDK1bX+Wju+Oy4lz1m1k/tJ+k/MZGkJbt4YR9VYlTK0JrbqCNLFFe6ZVCVCHksiQZpVlM8WYU5QB0d2Q2HaUN4qhghblPhbTEHJ/2O2SXnUkU6tT0qyjqON3HCELp8J8yF0pKzyilYuuV2wIDd/DD0Q3xj46kaX8OF2y6/4pxE6opcKuEI1l9gZ98bYT1dFAQ2CSLlvhK+eKpXzZZkmvhdBolByOz35fq7D9KuLic+fga2dvufkyiGwwEMv5IBobBax6FGhSurkGZdb0sETq33+GpnHnjsRiMYaoFi8vbCYSO1rXI/qcgVPl2IzuSiVMqOMM7QNvdNGTEnMmA62FIi6Bt2xngFfEOTu5IWT+AtpFWCw= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -General Seqera service features and version. - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/info/labels.info.api.mdx b/platform-api-docs/docs/info/labels.info.api.mdx deleted file mode 100644 index 9af799b98..000000000 --- a/platform-api-docs/docs/info/labels.info.api.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: labels-info -title: "Labels" -description: "API operations for labels and resource labels in Seqera Platform" -sidebar_label: Labels -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -Labels endpoints in the Seqera Platform API are used to manage both labels and resource labels. - -[Labels](https://docs.seqera.io/platform-cloud/labels/overview) are workspace-specific free-text annotations that can be applied to pipelines, actions, or workflow runs, either during or after creation. Use labels to organize your work and filter key information. - -[Resource labels](https://docs.seqera.io/platform-cloud/resource-labels/overview) provide a flexible tagging system for annotation and tracking of the cloud services consumed by a run. Resource labels are sent to the service provider for each cloud compute environment in `key=value` format. - -### Path and query parameters - -::table{file=parameter-tables/labels/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/labels/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/organizations.info.api.mdx b/platform-api-docs/docs/info/organizations.info.api.mdx deleted file mode 100644 index 63ae54e42..000000000 --- a/platform-api-docs/docs/info/organizations.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: organizations-info -title: "Organizations" -description: "API operations for organizations in Seqera Platform" -sidebar_label: Organizations -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -[Organizations](https://docs.seqera.io/platform-cloud/orgs-and-teams/organizations) are the top-level structure in Seqera Platform, containing workspaces, members, and teams. Organization owners can add or remove members from an organization or workspace, and can allocate specific access roles within workspaces. - -### Path and query parameters - -::table{file=parameter-tables/orgs/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/orgs/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/parameter-tables/actions/parameters.yml b/platform-api-docs/docs/info/parameter-tables/actions/parameters.yml deleted file mode 100644 index 968697b66..000000000 --- a/platform-api-docs/docs/info/parameter-tables/actions/parameters.yml +++ /dev/null @@ -1,21 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`attributes`" - Type: array - Location: query - Req/Opt: Optional - Description: "Additional attribute values to include in the response (`labels`). - Returns an empty value (`labels: null`) if omitted." -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Action name to validate -- Name: "`actionId`" - Type: string - Location: path - Req/Opt: Required - Description: Action string identifier diff --git a/platform-api-docs/docs/info/parameter-tables/actions/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/actions/request-bodies.yml deleted file mode 100644 index 261c48f56..000000000 --- a/platform-api-docs/docs/info/parameter-tables/actions/request-bodies.yml +++ /dev/null @@ -1,286 +0,0 @@ -- Name: "**CreateAction**" - Type: "" - Req/Opt: "" - Description: Create action -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: source - Type: string - Req/Opt: Optional - Description: "" -- Name: launch - Type: object - Req/Opt: Optional - Description: "" -- Name: launch.id - Type: string - Req/Opt: Optional - Description: Launch configuration identifier. -- Name: launch.computeEnvId - Type: string - Req/Opt: Optional - Description: Compute environment identifier where the pipeline will run. - Defaults to workspace primary compute environment if omitted. -- Name: launch.runName - Type: string - Req/Opt: Optional - Description: Custom run name for the workflow execution. -- Name: launch.pipeline - Type: string - Req/Opt: Optional - Description: Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`). -- Name: launch.workDir - Type: string - Req/Opt: Optional - Description: Work directory path where workflow intermediate files are stored. - Defaults to compute environment work directory if omitted. -- Name: launch.revision - Type: string - Req/Opt: Optional - Description: Git revision, branch, or tag to use. -- Name: launch.sessionId - Type: string - Req/Opt: Optional - Description: Nextflow session identifier for resuming failed runs. -- Name: launch.configProfiles - Type: array - Req/Opt: Optional - Description: Array of Nextflow configuration profile names to apply. -- Name: launch.userSecrets - Type: array - Req/Opt: Optional - Description: Array of user secrets to make available to the pipeline. -- Name: launch.workspaceSecrets - Type: array - Req/Opt: Optional - Description: Array of workspace secrets to make available to the pipeline. -- Name: launch.configText - Type: string - Req/Opt: Optional - Description: Nextflow configuration as text (overrides config files). -- Name: launch.towerConfig - Type: string - Req/Opt: Optional - Description: Platform-specific configuration options. -- Name: launch.paramsText - Type: string - Req/Opt: Optional - Description: Pipeline parameters in JSON or YAML format. -- Name: launch.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.mainScript - Type: string - Req/Opt: Optional - Description: "Alternative main script filename. Default: `main.nf`." -- Name: launch.entryName - Type: string - Req/Opt: Optional - Description: Workflow entry point name when using Nextflow DSL2. -- Name: launch.schemaName - Type: string - Req/Opt: Optional - Description: Name of the pipeline schema to use. -- Name: launch.resume - Type: boolean - Req/Opt: Optional - Description: Enable resume to restart workflow execution from the last - successful process. See [Resume a workflow - run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run). -- Name: launch.pullLatest - Type: boolean - Req/Opt: Optional - Description: Pull the latest version of the pipeline from the repository. -- Name: launch.stubRun - Type: boolean - Req/Opt: Optional - Description: Execute a stub run for testing (processes return dummy results). -- Name: launch.optimizationId - Type: string - Req/Opt: Optional - Description: Optimization configuration identifier. See [Pipeline resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.optimizationTargets - Type: string - Req/Opt: Optional - Description: Comma-separated list of optimization targets. See [Pipeline - resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to each pipeline run. -- Name: launch.headJobCpus - Type: integer - Req/Opt: Optional - Description: Number of CPUs allocated for the Nextflow head job. -- Name: launch.headJobMemoryMb - Type: integer - Req/Opt: Optional - Description: Memory allocation for the Nextflow head job in megabytes. -- Name: launch.launchContainer - Type: string - Req/Opt: Optional - Description: Container image to use for the Nextflow launcher. -- Name: launch.dateCreated - Type: string - Req/Opt: Optional - Description: Timestamp when the launch configuration was created. -- Name: "**UpdateAction**" - Type: "" - Req/Opt: "" - Description: Update action -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: launch - Type: object - Req/Opt: Optional - Description: "" -- Name: launch.id - Type: string - Req/Opt: Optional - Description: Launch configuration identifier. -- Name: launch.computeEnvId - Type: string - Req/Opt: Optional - Description: Compute environment identifier where the pipeline will run. - Defaults to workspace primary compute environment if omitted. -- Name: launch.runName - Type: string - Req/Opt: Optional - Description: Custom run name for the workflow execution. -- Name: launch.pipeline - Type: string - Req/Opt: Optional - Description: Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`). -- Name: launch.workDir - Type: string - Req/Opt: Optional - Description: Work directory path where workflow intermediate files are stored. - Defaults to compute environment work directory if omitted. -- Name: launch.revision - Type: string - Req/Opt: Optional - Description: Git revision, branch, or tag to use. -- Name: launch.sessionId - Type: string - Req/Opt: Optional - Description: Nextflow session identifier for resuming failed runs. -- Name: launch.configProfiles - Type: array - Req/Opt: Optional - Description: Array of Nextflow configuration profile names to apply. -- Name: launch.userSecrets - Type: array - Req/Opt: Optional - Description: Array of user secrets to make available to the pipeline. -- Name: launch.workspaceSecrets - Type: array - Req/Opt: Optional - Description: Array of workspace secrets to make available to the pipeline. -- Name: launch.configText - Type: string - Req/Opt: Optional - Description: Nextflow configuration as text (overrides config files). -- Name: launch.towerConfig - Type: string - Req/Opt: Optional - Description: Platform-specific configuration options. -- Name: launch.paramsText - Type: string - Req/Opt: Optional - Description: Pipeline parameters in JSON or YAML format. -- Name: launch.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.mainScript - Type: string - Req/Opt: Optional - Description: "Alternative main script filename. Default: `main.nf`." -- Name: launch.entryName - Type: string - Req/Opt: Optional - Description: Workflow entry point name when using Nextflow DSL2. -- Name: launch.schemaName - Type: string - Req/Opt: Optional - Description: Name of the pipeline schema to use. -- Name: launch.resume - Type: boolean - Req/Opt: Optional - Description: Enable resume to restart workflow execution from the last - successful process. See [Resume a workflow - run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run). -- Name: launch.pullLatest - Type: boolean - Req/Opt: Optional - Description: Pull the latest version of the pipeline from the repository. -- Name: launch.stubRun - Type: boolean - Req/Opt: Optional - Description: Execute a stub run for testing (processes return dummy results). -- Name: launch.optimizationId - Type: string - Req/Opt: Optional - Description: Optimization configuration identifier. See [Pipeline resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.optimizationTargets - Type: string - Req/Opt: Optional - Description: Comma-separated list of optimization targets. See [Pipeline - resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to each pipeline run. -- Name: launch.headJobCpus - Type: integer - Req/Opt: Optional - Description: Number of CPUs allocated for the Nextflow head job. -- Name: launch.headJobMemoryMb - Type: integer - Req/Opt: Optional - Description: Memory allocation for the Nextflow head job in megabytes. -- Name: launch.launchContainer - Type: string - Req/Opt: Optional - Description: Container image to use for the Nextflow launcher. -- Name: launch.dateCreated - Type: string - Req/Opt: Optional - Description: Timestamp when the launch configuration was created. -- Name: "**LaunchAction**" - Type: "" - Req/Opt: "" - Description: Trigger Tower Launch action -- Name: params - Type: object - Req/Opt: Optional - Description: "" -- Name: "**PauseAction**" - Type: "" - Req/Opt: "" - Description: Pause or resume action diff --git a/platform-api-docs/docs/info/parameter-tables/avatars/parameters.yml b/platform-api-docs/docs/info/parameter-tables/avatars/parameters.yml deleted file mode 100644 index 1cf227918..000000000 --- a/platform-api-docs/docs/info/parameter-tables/avatars/parameters.yml +++ /dev/null @@ -1,5 +0,0 @@ -- Name: "`avatarId`" - Type: string - Location: path - Req/Opt: Required - Description: Avatar string identifier diff --git a/platform-api-docs/docs/info/parameter-tables/compute-envs/parameters.yml b/platform-api-docs/docs/info/parameter-tables/compute-envs/parameters.yml deleted file mode 100644 index f6e3f9703..000000000 --- a/platform-api-docs/docs/info/parameter-tables/compute-envs/parameters.yml +++ /dev/null @@ -1,27 +0,0 @@ -- Name: "`status`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter by compute environment status. -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier. If omitted, lists compute - environments in a user context. -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Compute environment name to validate for uniqueness and format. -- Name: "`computeEnvId`" - Type: string - Location: path - Req/Opt: Required - Description: Compute environment alphanumeric identifier. -- Name: "`attributes`" - Type: array - Location: query - Req/Opt: Optional - Description: "Additional attribute values to include in the response. Returns - `labels: null` if omitted." diff --git a/platform-api-docs/docs/info/parameter-tables/compute-envs/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/compute-envs/request-bodies.yml deleted file mode 100644 index cde6db061..000000000 --- a/platform-api-docs/docs/info/parameter-tables/compute-envs/request-bodies.yml +++ /dev/null @@ -1,137 +0,0 @@ -- Name: "**CreateComputeEnv**" - Type: "" - Req/Opt: "" - Description: Create compute environment -- Name: computeEnv - Type: object - Req/Opt: Required - Description: "" -- Name: computeEnv.credentialsId - Type: string - Req/Opt: Optional - Description: Credentials identifier for compute environment authentication. - Requires existing cloud provider/HPC credentials. See [Create - credentials](https://docs.seqera.io/platform-api/create-credentials). -- Name: computeEnv.orgId - Type: integer - Req/Opt: Optional - Description: Organization numeric identifier (read-only, set by system). -- Name: computeEnv.workspaceId - Type: integer - Req/Opt: Optional - Description: Workspace numeric identifier (read-only, set by system). -- Name: computeEnv.id - Type: string - Req/Opt: Optional - Description: Compute environment alphanumeric identifier (read-only, generated by system). -- Name: computeEnv.name - Type: string - Req/Opt: Required - Description: Unique name for the compute environment. Must consist of 1-100 - alphanumeric, dash, or underscore characters. -- Name: computeEnv.description - Type: string - Req/Opt: Optional - Description: "Description of the compute environment. Maximum length: 2000 characters." -- Name: computeEnv.platform - Type: string - Req/Opt: Required - Description: Compute platform provider. -- Name: computeEnv.config - Type: object - Req/Opt: Required - Description: "" -- Name: computeEnv.config.workDir - Type: string - Req/Opt: Optional - Description: Work directory path for storing intermediate workflow files. -- Name: computeEnv.config.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: computeEnv.config.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: computeEnv.config.environment - Type: array - Req/Opt: Optional - Description: Environment variables to set in the compute environment. -- Name: computeEnv.config.environment[].name - Type: string - Req/Opt: Required - Description: Environment variable name. -- Name: computeEnv.config.environment[].value - Type: string - Req/Opt: Required - Description: Environment variable value. -- Name: computeEnv.config.environment[].head - Type: boolean - Req/Opt: Optional - Description: Apply this variable to the Nextflow head job. -- Name: computeEnv.config.environment[].compute - Type: boolean - Req/Opt: Optional - Description: Apply this variable to the Nextflow compute jobs. -- Name: computeEnv.config.nextflowConfig - Type: string - Req/Opt: Optional - Description: Additional Nextflow configuration to apply. See [Nextflow config - file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file). -- Name: computeEnv.config.discriminator - Type: string - Req/Opt: Optional - Description: Platform type discriminator (read-only, set based on platform selection). -- Name: computeEnv.dateCreated - Type: string - Req/Opt: Optional - Description: Creation timestamp (read-only, set by system). -- Name: computeEnv.lastUpdated - Type: string - Req/Opt: Optional - Description: Last update timestamp (read-only, updated by system). -- Name: computeEnv.lastUsed - Type: string - Req/Opt: Optional - Description: Last usage timestamp (read-only, updated by system). -- Name: computeEnv.deleted - Type: boolean - Req/Opt: Optional - Description: Deletion status flag (read-only, updated by system). -- Name: computeEnv.status - Type: string - Req/Opt: Optional - Description: Current status of the compute environment (read-only). -- Name: computeEnv.message - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.primary - Type: boolean - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to the compute environment. -- Name: "**UpdateComputeEnv**" - Type: "" - Req/Opt: "" - Description: Update compute environment -- Name: name - Type: string - Req/Opt: Optional - Description: New name for the compute environment. Must be unique within workspace. -- Name: credentialsId - Type: string - Req/Opt: Optional - Description: Updated credentials identifier. Changing credentials may affect - running workflows. -- Name: "**UpdateComputeEnvPrimary**" - Type: "" - Req/Opt: "" - Description: Define primary compute environment diff --git a/platform-api-docs/docs/info/parameter-tables/credentials/parameters.yml b/platform-api-docs/docs/info/parameter-tables/credentials/parameters.yml deleted file mode 100644 index 9c0211a04..000000000 --- a/platform-api-docs/docs/info/parameter-tables/credentials/parameters.yml +++ /dev/null @@ -1,26 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`platformId`" - Type: string - Location: query - Req/Opt: Optional - Description: Platform string identifier -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Credentials name to validate -- Name: "`credentialsId`" - Type: string - Location: path - Req/Opt: Required - Description: Credentials string identifier -- Name: "`checked`" - Type: boolean - Location: query - Req/Opt: Optional - Description: If set credentials deletion will be blocked by running jobs that - depend on them diff --git a/platform-api-docs/docs/info/parameter-tables/credentials/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/credentials/request-bodies.yml deleted file mode 100644 index 73e536c0e..000000000 --- a/platform-api-docs/docs/info/parameter-tables/credentials/request-bodies.yml +++ /dev/null @@ -1,112 +0,0 @@ -- Name: "**CreateCredentials**" - Type: "" - Req/Opt: "" - Description: Create credentials -- Name: credentials - Type: object - Req/Opt: Optional - Description: "" -- Name: credentials.id - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.name - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.description - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.provider - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.baseUrl - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.category - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: credentials.lastUsed - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.keys - Type: object - Req/Opt: Optional - Description: "" -- Name: credentials.keys.discriminator - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateCredentials**" - Type: "" - Req/Opt: "" - Description: Update credentials -- Name: credentials - Type: object - Req/Opt: Optional - Description: "" -- Name: credentials.id - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.name - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.description - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.provider - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.baseUrl - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.category - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: credentials.lastUsed - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.keys - Type: object - Req/Opt: Optional - Description: "" -- Name: credentials.keys.discriminator - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/data-links/parameters.yml b/platform-api-docs/docs/info/parameter-tables/data-links/parameters.yml deleted file mode 100644 index cc009bb77..000000000 --- a/platform-api-docs/docs/info/parameter-tables/data-links/parameters.yml +++ /dev/null @@ -1,94 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`credentialsId`" - Type: string - Location: query - Req/Opt: Optional - Description: Credentials identifier -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: "Free text search criteria — data-link name and keywords: `region`, - `provider`." -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`visibility`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter results by visibility -- Name: "`dataLinkId`" - Type: string - Location: path - Req/Opt: Required - Description: Data-link string identifier. -- Name: "`path`" - Type: string - Location: path - Req/Opt: Required - Description: Content path -- Name: "`nextPageToken`" - Type: string - Location: query - Req/Opt: Optional - Description: Token used to fetch the next page of items -- Name: "`pageSize`" - Type: integer - Location: query - Req/Opt: Optional - Description: Number of items to return per page. If omitted, a default maximum - value is returned. -- Name: "`paths`" - Type: array - Location: query - Req/Opt: Optional - Description: List of paths to explore. Returns all files within the specified - paths, including sub-paths. -- Name: "`filePath`" - Type: string - Location: path - Req/Opt: Required - Description: File path to download -- Name: "`filePath`" - Type: string - Location: query - Req/Opt: Optional - Description: File path to download within the data-link (e.g., `folder/subfolder/object`). -- Name: "`preview`" - Type: boolean - Location: query - Req/Opt: Optional - Description: "If `true`, generates a URL for preview purposes. If `false`, - generates a URL for direct download. Default: `false`." -- Name: "`dirs`" - Type: array - Location: query - Req/Opt: Optional - Description: List of directory paths to include in the download script. -- Name: "`files`" - Type: array - Location: query - Req/Opt: Optional - Description: List of file paths to include in the download script. -- Name: "`dirPath`" - Type: string - Location: path - Req/Opt: Required - Description: Path to the destination directory -- Name: "`Origin`" - Type: string - Location: header - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/data-links/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/data-links/request-bodies.yml deleted file mode 100644 index 8ac6d2f8c..000000000 --- a/platform-api-docs/docs/info/parameter-tables/data-links/request-bodies.yml +++ /dev/null @@ -1,164 +0,0 @@ -- Name: "**CreateCustomDataLink**" - Type: "" - Req/Opt: "" - Description: Create data-link -- Name: name - Type: string - Req/Opt: Optional - Description: Unique name for the data-link. Must consist of alphanumeric, dash, - or underscore characters. -- Name: description - Type: string - Req/Opt: Optional - Description: "Description of the data-link. Maximum length: 1000 characters." -- Name: type - Type: string - Req/Opt: Optional - Description: Data-link type. Currently only `bucket` is supported. -- Name: provider - Type: string - Req/Opt: Optional - Description: Cloud provider for data-links. Supports AWS S3, Google Cloud - Storage, Azure Blob Storage, Azure with Entra ID, Seqera Compute storage, - and generic S3-compatible storage. -- Name: resourceRef - Type: string - Req/Opt: Optional - Description: Resource path for the data-link, including the URI scheme (e.g., - `s3://my-bucket`, `gs://my-bucket`, `az://account.container`). -- Name: publicAccessible - Type: boolean - Req/Opt: Optional - Description: Whether the data-link is publicly accessible. If `true`, no - credentials are required. If `false`, `credentialsId` must be provided. -- Name: credentialsId - Type: string - Req/Opt: Optional - Description: Credentials string identifier. Required when `publicAccessible` is `false`. -- Name: "**UpdateCustomDataLink**" - Type: "" - Req/Opt: "" - Description: Update data-link -- Name: name - Type: string - Req/Opt: Optional - Description: New name for the data-link. Must be unique within the workspace or - user context. -- Name: description - Type: string - Req/Opt: Optional - Description: "Updated description for the data-link. Maximum length: 1000 characters." -- Name: credentialsId - Type: string - Req/Opt: Optional - Description: Updated credentials ID for accessing the data-link. -- Name: "**DeleteDataLinkItem**" - Type: "" - Req/Opt: "" - Description: Delete data-link content -- Name: files - Type: array - Req/Opt: Optional - Description: Array of file paths to be deleted from the data-link. -- Name: dirs - Type: array - Req/Opt: Optional - Description: Array of directory paths to be deleted from the data-link. -- Name: "**GenerateDataLinkUploadUrl**" - Type: "" - Req/Opt: "" - Description: Generate data-link file upload URL (to given path) -- Name: fileName - Type: string - Req/Opt: Optional - Description: Name of the file to upload. -- Name: contentLength - Type: integer - Req/Opt: Optional - Description: Size of the file to upload in bytes. -- Name: contentType - Type: string - Req/Opt: Optional - Description: MIME type of the file to upload (e.g., `application/octet-stream`, - `text/plain`). -- Name: "**FinishDataLinkUpload**" - Type: "" - Req/Opt: "" - Description: Finish data-link file upload to given path -- Name: uploadId - Type: string - Req/Opt: Optional - Description: Upload ID assigned when initiating multi-part upload for AWS S3. - Obtained from the `/upload` endpoint response. -- Name: fileName - Type: string - Req/Opt: Optional - Description: Name of the uploaded file. -- Name: tags - Type: array - Req/Opt: Optional - Description: Array of ETags assigned for each part by AWS S3 during the upload - process. Each ETag is returned in the response headers when uploading a part - to the pre-signed URLs from the `/upload` endpoint. -- Name: tags[].partNumber - Type: integer - Req/Opt: Optional - Description: "" -- Name: tags[].eTag - Type: string - Req/Opt: Optional - Description: "" -- Name: withError - Type: boolean - Req/Opt: Optional - Description: Flag indicating whether the upload encountered an error. If `true`, - the upload will be aborted. If `false`, the upload will be completed. -- Name: "**FinishDataLinkUpload_1**" - Type: "" - Req/Opt: "" - Description: Finish data-link file upload to given path -- Name: uploadId - Type: string - Req/Opt: Optional - Description: Upload ID assigned when initiating multi-part upload for AWS S3. - Obtained from the `/upload` endpoint response. -- Name: fileName - Type: string - Req/Opt: Optional - Description: Name of the uploaded file. -- Name: tags - Type: array - Req/Opt: Optional - Description: Array of ETags assigned for each part by AWS S3 during the upload - process. Each ETag is returned in the response headers when uploading a part - to the pre-signed URLs from the `/upload` endpoint. -- Name: tags[].partNumber - Type: integer - Req/Opt: Optional - Description: "" -- Name: tags[].eTag - Type: string - Req/Opt: Optional - Description: "" -- Name: withError - Type: boolean - Req/Opt: Optional - Description: Flag indicating whether the upload encountered an error. If `true`, - the upload will be aborted. If `false`, the upload will be completed. -- Name: "**GenerateDataLinkUploadUrl_1**" - Type: "" - Req/Opt: "" - Description: Generate data-link file upload URL (to given path) -- Name: fileName - Type: string - Req/Opt: Optional - Description: Name of the file to upload. -- Name: contentLength - Type: integer - Req/Opt: Optional - Description: Size of the file to upload in bytes. -- Name: contentType - Type: string - Req/Opt: Optional - Description: MIME type of the file to upload (e.g., `application/octet-stream`, - `text/plain`). diff --git a/platform-api-docs/docs/info/parameter-tables/datasets/parameters.yml b/platform-api-docs/docs/info/parameter-tables/datasets/parameters.yml deleted file mode 100644 index 1f5f29fe8..000000000 --- a/platform-api-docs/docs/info/parameter-tables/datasets/parameters.yml +++ /dev/null @@ -1,41 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier. If omitted, lists datasets in a user context. -- Name: "`mimeType`" - Type: string - Location: query - Req/Opt: Optional - Description: Dataset MIME type filter (e.g., `text/csv`, `text/tab-separated-values`). -- Name: "`datasetId`" - Type: string - Location: path - Req/Opt: Required - Description: Dataset string identifier. -- Name: "`header`" - Type: boolean - Location: query - Req/Opt: Optional - Description: "Indicates whether the uploaded file contains a header row. Default: `true`." -- Name: "`version`" - Type: string - Location: path - Req/Opt: Required - Description: Dataset version number. -- Name: "`fileName`" - Type: string - Location: path - Req/Opt: Required - Description: File name for the downloaded dataset content. Must match the - original uploaded filename. -- Name: "`launchId`" - Type: string - Location: path - Req/Opt: Required - Description: Launch string identifier. -- Name: "`workspaceId`" - Type: integer - Location: path - Req/Opt: Required - Description: Workspace numeric identifier diff --git a/platform-api-docs/docs/info/parameter-tables/datasets/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/datasets/request-bodies.yml deleted file mode 100644 index f89034f21..000000000 --- a/platform-api-docs/docs/info/parameter-tables/datasets/request-bodies.yml +++ /dev/null @@ -1,48 +0,0 @@ -- Name: "**CreateDatasetV2**" - Type: "" - Req/Opt: "" - Description: Create dataset -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateDatasetV2**" - Type: "" - Req/Opt: "" - Description: Update dataset -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: "**CreateDataset**" - Type: "" - Req/Opt: "" - Description: (Deprecated) Create dataset -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateDataset**" - Type: "" - Req/Opt: "" - Description: (Deprecated) Update dataset -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/ga4gh/parameters.yml b/platform-api-docs/docs/info/parameter-tables/ga4gh/parameters.yml deleted file mode 100644 index ac38a176f..000000000 --- a/platform-api-docs/docs/info/parameter-tables/ga4gh/parameters.yml +++ /dev/null @@ -1,15 +0,0 @@ -- Name: "`page_size`" - Type: integer - Location: query - Req/Opt: Optional - Description: Page size -- Name: "`page_token`" - Type: string - Location: query - Req/Opt: Optional - Description: Page token -- Name: "`run_id`" - Type: string - Location: path - Req/Opt: Required - Description: Run string identifier diff --git a/platform-api-docs/docs/info/parameter-tables/ga4gh/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/ga4gh/request-bodies.yml deleted file mode 100644 index f4e0c26db..000000000 --- a/platform-api-docs/docs/info/parameter-tables/ga4gh/request-bodies.yml +++ /dev/null @@ -1,32 +0,0 @@ -- Name: "**Ga4ghRunCreate**" - Type: "" - Req/Opt: "" - Description: "GA4GH: Launch run" -- Name: workflow_params - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow_type - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow_type_version - Type: string - Req/Opt: Optional - Description: "" -- Name: tags - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow_engine_parameters - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow_url - Type: string - Req/Opt: Optional - Description: "" -- Name: "**Ga4ghRunCancel**" - Type: "" - Req/Opt: "" - Description: "GA4GH: Cancel run" diff --git a/platform-api-docs/docs/info/parameter-tables/identities/parameters.yml b/platform-api-docs/docs/info/parameter-tables/identities/parameters.yml deleted file mode 100644 index e3cde92fe..000000000 --- a/platform-api-docs/docs/info/parameter-tables/identities/parameters.yml +++ /dev/null @@ -1,43 +0,0 @@ -- Name: "`orgId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Organization numeric identifier. Append to list managed identities - within an organization other than the requester's default. -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: "Filter search parameter. Supports free text search on name and - keywords: `platform:`." -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: "Maximum number of results to return. Default: `20`." -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: "Number of results to skip for pagination. Default: `0`." -- Name: "`managedIdentityId`" - Type: integer - Location: path - Req/Opt: Required - Description: Managed identity numeric identifier. -- Name: "`checked`" - Type: boolean - Location: query - Req/Opt: Optional - Description: "If `true`, deletion is blocked if running jobs depend on - associated managed credentials. Default: `false`." -- Name: "`userId`" - Type: integer - Location: query - Req/Opt: Optional - Description: User numeric identifier. Filter managed credentials by specific user. -- Name: "`managedCredentialsId`" - Type: integer - Location: path - Req/Opt: Required - Description: Managed credentials numeric identifier. diff --git a/platform-api-docs/docs/info/parameter-tables/identities/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/identities/request-bodies.yml deleted file mode 100644 index 466045a9b..000000000 --- a/platform-api-docs/docs/info/parameter-tables/identities/request-bodies.yml +++ /dev/null @@ -1,301 +0,0 @@ -- Name: "**CreateManagedIdentity**" - Type: "" - Req/Opt: "" - Description: Create managed identity -- Name: name - Type: string - Req/Opt: Optional - Description: Unique name for the managed identity. Must consist of alphanumeric, - dash, or underscore characters. -- Name: platform - Type: string - Req/Opt: Optional - Description: HPC platform type for this managed identity. -- Name: config - Type: object - Req/Opt: Optional - Description: "" -- Name: config.workDir - Type: string - Req/Opt: Optional - Description: Nextflow work directory on the cluster's shared file system. Must - be an absolute path and credentials must have read-write access. -- Name: config.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: config.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: config.nextflowConfig - Type: string - Req/Opt: Optional - Description: Additional Nextflow configuration to apply. See [Nextflow config - file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file). -- Name: config.launchDir - Type: string - Req/Opt: Optional - Description: Directory where Nextflow runs. Must be an absolute path and - credentials must have read-write access. If omitted, defaults to `workDir`. -- Name: config.userName - Type: string - Req/Opt: Optional - Description: Username for SSH connection to HPC head node. -- Name: config.hostName - Type: string - Req/Opt: Optional - Description: Hostname or IP address of HPC head node. -- Name: config.port - Type: integer - Req/Opt: Optional - Description: "SSH port. Default: `22`." -- Name: config.headQueue - Type: string - Req/Opt: Optional - Description: The name of the queue on the cluster used to launch the Nextflow execution. -- Name: config.computeQueue - Type: string - Req/Opt: Optional - Description: The name of queue on the cluster to which pipeline jobs are - submitted. Can be overridden by the pipeline configuration. -- Name: config.maxQueueSize - Type: integer - Req/Opt: Optional - Description: "The maximum number of jobs Nextflow can submit to the queue - simultaneously. Default: `100`." -- Name: config.headJobOptions - Type: string - Req/Opt: Optional - Description: Additional submit options for the Nextflow head job. -- Name: config.propagateHeadJobOptions - Type: boolean - Req/Opt: Optional - Description: If true, `headJobOptions` are also applied to the - Nextflow-submitted compute jobs. -- Name: "**UpdateManagedIdentity**" - Type: "" - Req/Opt: "" - Description: Update managed identity -- Name: managedIdentity - Type: object - Req/Opt: Optional - Description: "" -- Name: managedIdentity.id - Type: integer - Req/Opt: Optional - Description: Managed identity numeric identifier. -- Name: managedIdentity.name - Type: string - Req/Opt: Optional - Description: Name of the managed identity. -- Name: managedIdentity.platform - Type: string - Req/Opt: Optional - Description: HPC platform type. -- Name: managedIdentity.config - Type: object - Req/Opt: Optional - Description: "" -- Name: managedIdentity.config.workDir - Type: string - Req/Opt: Optional - Description: Nextflow work directory on the cluster's shared file system. Must - be an absolute path and credentials must have read-write access. -- Name: managedIdentity.config.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: managedIdentity.config.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: managedIdentity.config.nextflowConfig - Type: string - Req/Opt: Optional - Description: Additional Nextflow configuration to apply. See [Nextflow config - file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file). -- Name: managedIdentity.config.launchDir - Type: string - Req/Opt: Optional - Description: Directory where Nextflow runs. Must be an absolute path and - credentials must have read-write access. If omitted, defaults to `workDir`. -- Name: managedIdentity.config.userName - Type: string - Req/Opt: Optional - Description: Username for SSH connection to HPC head node. -- Name: managedIdentity.config.hostName - Type: string - Req/Opt: Optional - Description: Hostname or IP address of HPC head node. -- Name: managedIdentity.config.port - Type: integer - Req/Opt: Optional - Description: "SSH port. Default: `22`." -- Name: managedIdentity.config.headQueue - Type: string - Req/Opt: Optional - Description: The name of the queue on the cluster used to launch the Nextflow execution. -- Name: managedIdentity.config.computeQueue - Type: string - Req/Opt: Optional - Description: The name of queue on the cluster to which pipeline jobs are - submitted. Can be overridden by the pipeline configuration. -- Name: managedIdentity.config.maxQueueSize - Type: integer - Req/Opt: Optional - Description: "The maximum number of jobs Nextflow can submit to the queue - simultaneously. Default: `100`." -- Name: managedIdentity.config.headJobOptions - Type: string - Req/Opt: Optional - Description: Additional submit options for the Nextflow head job. -- Name: managedIdentity.config.propagateHeadJobOptions - Type: boolean - Req/Opt: Optional - Description: If true, `headJobOptions` are also applied to the - Nextflow-submitted compute jobs. -- Name: "**CreateManagedCredentials**" - Type: "" - Req/Opt: "" - Description: Create managed credentials -- Name: provider - Type: string - Req/Opt: Optional - Description: Authentication provider type. Currently supports `ssh`. -- Name: credentials - Type: object - Req/Opt: Optional - Description: "" -- Name: credentials.id - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.name - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.description - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.provider - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.baseUrl - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.category - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: credentials.lastUsed - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.keys - Type: object - Req/Opt: Optional - Description: "" -- Name: credentials.keys.discriminator - Type: string - Req/Opt: Optional - Description: "" -- Name: metadata - Type: object - Req/Opt: Optional - Description: "" -- Name: metadata.discriminator - Type: string - Req/Opt: Optional - Description: Type discriminator for metadata structure (read-only). -- Name: "**UpdateManagedCredentials**" - Type: "" - Req/Opt: "" - Description: Update managed credentials -- Name: provider - Type: string - Req/Opt: Optional - Description: Authentication provider type. Currently supports `ssh`. -- Name: credentials - Type: object - Req/Opt: Optional - Description: "" -- Name: credentials.id - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.name - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.description - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.provider - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.baseUrl - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.category - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: credentials.lastUsed - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.keys - Type: object - Req/Opt: Optional - Description: "" -- Name: credentials.keys.discriminator - Type: string - Req/Opt: Optional - Description: "" -- Name: metadata - Type: object - Req/Opt: Optional - Description: "" -- Name: metadata.discriminator - Type: string - Req/Opt: Optional - Description: Type discriminator for metadata structure (read-only). diff --git a/platform-api-docs/docs/info/parameter-tables/labels/parameters.yml b/platform-api-docs/docs/info/parameter-tables/labels/parameters.yml deleted file mode 100644 index ff139524b..000000000 --- a/platform-api-docs/docs/info/parameter-tables/labels/parameters.yml +++ /dev/null @@ -1,35 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter search parameter -- Name: "`type`" - Type: unknown - Location: query - Req/Opt: Optional - Description: Label type -- Name: "`isDefault`" - Type: boolean - Location: query - Req/Opt: Optional - Description: Label default flag -- Name: "`labelId`" - Type: integer - Location: path - Req/Opt: Required - Description: Label numeric identifier diff --git a/platform-api-docs/docs/info/parameter-tables/labels/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/labels/request-bodies.yml deleted file mode 100644 index 624e31def..000000000 --- a/platform-api-docs/docs/info/parameter-tables/labels/request-bodies.yml +++ /dev/null @@ -1,144 +0,0 @@ -- Name: "**AddLabelsToActions**" - Type: "" - Req/Opt: "" - Description: Add labels to actions -- Name: actionIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**ApplyLabelsToActions**" - Type: "" - Req/Opt: "" - Description: Replace action labels -- Name: actionIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**RemoveLabelsFromActions**" - Type: "" - Req/Opt: "" - Description: Remove labels from actions -- Name: actionIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**CreateLabel**" - Type: "" - Req/Opt: "" - Description: Create label -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: value - Type: string - Req/Opt: Optional - Description: "" -- Name: resource - Type: boolean - Req/Opt: Optional - Description: "" -- Name: isDefault - Type: boolean - Req/Opt: Optional - Description: "" -- Name: "**UpdateLabel**" - Type: "" - Req/Opt: "" - Description: Update label -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: value - Type: string - Req/Opt: Optional - Description: "" -- Name: isDefault - Type: boolean - Req/Opt: Optional - Description: "" -- Name: "**AddLabelsToPipelines**" - Type: "" - Req/Opt: "" - Description: Add labels to pipelines -- Name: pipelineIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**ApplyLabelsToPipelines**" - Type: "" - Req/Opt: "" - Description: Replace pipeline labels -- Name: pipelineIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**RemoveLabelsFromPipelines**" - Type: "" - Req/Opt: "" - Description: Remove labels from pipelines -- Name: pipelineIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**AddLabelsToWorkflows**" - Type: "" - Req/Opt: "" - Description: Add labels to workflows -- Name: workflowIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**ApplyLabelsToWorkflows**" - Type: "" - Req/Opt: "" - Description: Replace workflow labels -- Name: workflowIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**RemoveLabelsFromWorkflows**" - Type: "" - Req/Opt: "" - Description: Remove labels from workflows -- Name: workflowIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/launch/parameters.yml b/platform-api-docs/docs/info/parameter-tables/launch/parameters.yml deleted file mode 100644 index 57209341f..000000000 --- a/platform-api-docs/docs/info/parameter-tables/launch/parameters.yml +++ /dev/null @@ -1,10 +0,0 @@ -- Name: "`launchId`" - Type: string - Location: path - Req/Opt: Required - Description: Launch string identifier -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier diff --git a/platform-api-docs/docs/info/parameter-tables/orgs/parameters.yml b/platform-api-docs/docs/info/parameter-tables/orgs/parameters.yml deleted file mode 100644 index dd37be08b..000000000 --- a/platform-api-docs/docs/info/parameter-tables/orgs/parameters.yml +++ /dev/null @@ -1,40 +0,0 @@ -- Name: "`role`" - Type: string - Location: query - Req/Opt: Optional - Description: Organization user role identifier -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Organization name to validate -- Name: "`orgId`" - Type: integer - Location: path - Req/Opt: Required - Description: Organization numeric identifier -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter search parameter -- Name: "`memberId`" - Type: integer - Location: path - Req/Opt: Required - Description: Organization member numeric identifier -- Name: "`include`" - Type: array - Location: query - Req/Opt: Optional - Description: Optional list of quota names to include diff --git a/platform-api-docs/docs/info/parameter-tables/orgs/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/orgs/request-bodies.yml deleted file mode 100644 index 24a94f662..000000000 --- a/platform-api-docs/docs/info/parameter-tables/orgs/request-bodies.yml +++ /dev/null @@ -1,96 +0,0 @@ -- Name: "**CreateOrganization**" - Type: "" - Req/Opt: "" - Description: Create organization -- Name: organization - Type: object - Req/Opt: Optional - Description: "" -- Name: organization.id - Type: integer - Req/Opt: Optional - Description: "" -- Name: organization.name - Type: string - Req/Opt: Required - Description: "" -- Name: organization.fullName - Type: string - Req/Opt: Required - Description: "" -- Name: organization.description - Type: string - Req/Opt: Optional - Description: "" -- Name: organization.location - Type: string - Req/Opt: Optional - Description: "" -- Name: organization.website - Type: string - Req/Opt: Optional - Description: "" -- Name: organization.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: organization.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: logoId - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateOrganization**" - Type: "" - Req/Opt: "" - Description: Update organization -- Name: fullName - Type: string - Req/Opt: Optional - Description: "" -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: location - Type: string - Req/Opt: Optional - Description: "" -- Name: website - Type: string - Req/Opt: Optional - Description: "" -- Name: logoId - Type: string - Req/Opt: Optional - Description: "" -- Name: paying - Type: boolean - Req/Opt: Optional - Description: "" -- Name: type - Type: object - Req/Opt: Optional - Description: "" -- Name: "**CreateOrganizationMember**" - Type: "" - Req/Opt: "" - Description: Add organization member -- Name: user - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateOrganizationMemberRole**" - Type: "" - Req/Opt: "" - Description: Update member role -- Name: role - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/pipeline-secrets/parameters.yml b/platform-api-docs/docs/info/parameter-tables/pipeline-secrets/parameters.yml deleted file mode 100644 index 8a28fbe37..000000000 --- a/platform-api-docs/docs/info/parameter-tables/pipeline-secrets/parameters.yml +++ /dev/null @@ -1,15 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Secret name to validate -- Name: "`secretId`" - Type: integer - Location: path - Req/Opt: Required - Description: Secret numeric identifier diff --git a/platform-api-docs/docs/info/parameter-tables/pipeline-secrets/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/pipeline-secrets/request-bodies.yml deleted file mode 100644 index 9a740d25f..000000000 --- a/platform-api-docs/docs/info/parameter-tables/pipeline-secrets/request-bodies.yml +++ /dev/null @@ -1,20 +0,0 @@ -- Name: "**CreatePipelineSecret**" - Type: "" - Req/Opt: "" - Description: Create pipeline secret -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: value - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdatePipelineSecret**" - Type: "" - Req/Opt: "" - Description: Update secret -- Name: value - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/pipelines/parameters.yml b/platform-api-docs/docs/info/parameter-tables/pipelines/parameters.yml deleted file mode 100644 index 723cce1af..000000000 --- a/platform-api-docs/docs/info/parameter-tables/pipelines/parameters.yml +++ /dev/null @@ -1,64 +0,0 @@ -- Name: "`attributes`" - Type: array - Location: query - Req/Opt: Optional - Description: "Additional attribute values to include in the response (`labels`, - `optimized` status, `computeEnv`). Returns an empty value (`labels: null`, - etc.) if omitted." -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier. -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Maximum number of pipelines to return per request. -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: "Number of results to skip for pagination. Default: `0`." -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Free-text search filter to match against pipeline names and descriptions. -- Name: "`visibility`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter pipelines by visibility. Accepts `private`, `shared`, or `all`. -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Pipeline repository name (e.g., `nextflow-io/hello`) or full URL. -- Name: "`revision`" - Type: string - Location: query - Req/Opt: Optional - Description: "Git revision, branch, or tag to describe. Default: repository - default branch." -- Name: "`mainScript`" - Type: string - Location: query - Req/Opt: Optional - Description: "Alternative main script filename. Default: `main.nf`." -- Name: "`orgId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Organization numeric identifier. Used for organization-level validation. -- Name: "`pipelineId`" - Type: integer - Location: path - Req/Opt: Required - Description: Pipeline numeric identifier. -- Name: "`sourceWorkspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Source workspace numeric identifier. Used when accessing a shared - pipeline from another workspace. diff --git a/platform-api-docs/docs/info/parameter-tables/pipelines/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/pipelines/request-bodies.yml deleted file mode 100644 index 679bb8eb1..000000000 --- a/platform-api-docs/docs/info/parameter-tables/pipelines/request-bodies.yml +++ /dev/null @@ -1,296 +0,0 @@ -- Name: "**CreatePipeline**" - Type: "" - Req/Opt: "" - Description: Create pipeline -- Name: name - Type: string - Req/Opt: Optional - Description: Pipeline name. Must be unique within the workspace. -- Name: description - Type: string - Req/Opt: Optional - Description: Pipeline description. -- Name: icon - Type: string - Req/Opt: Optional - Description: Pipeline icon URL. -- Name: launch - Type: object - Req/Opt: Optional - Description: "" -- Name: launch.id - Type: string - Req/Opt: Optional - Description: Launch configuration identifier. -- Name: launch.computeEnvId - Type: string - Req/Opt: Optional - Description: Compute environment identifier where the pipeline will run. - Defaults to workspace primary compute environment if omitted. -- Name: launch.runName - Type: string - Req/Opt: Optional - Description: Custom run name for the workflow execution. -- Name: launch.pipeline - Type: string - Req/Opt: Optional - Description: Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`). -- Name: launch.workDir - Type: string - Req/Opt: Optional - Description: Work directory path where workflow intermediate files are stored. - Defaults to compute environment work directory if omitted. -- Name: launch.revision - Type: string - Req/Opt: Optional - Description: Git revision, branch, or tag to use. -- Name: launch.sessionId - Type: string - Req/Opt: Optional - Description: Nextflow session identifier for resuming failed runs. -- Name: launch.configProfiles - Type: array - Req/Opt: Optional - Description: Array of Nextflow configuration profile names to apply. -- Name: launch.userSecrets - Type: array - Req/Opt: Optional - Description: Array of user secrets to make available to the pipeline. -- Name: launch.workspaceSecrets - Type: array - Req/Opt: Optional - Description: Array of workspace secrets to make available to the pipeline. -- Name: launch.configText - Type: string - Req/Opt: Optional - Description: Nextflow configuration as text (overrides config files). -- Name: launch.towerConfig - Type: string - Req/Opt: Optional - Description: Platform-specific configuration options. -- Name: launch.paramsText - Type: string - Req/Opt: Optional - Description: Pipeline parameters in JSON or YAML format. -- Name: launch.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.mainScript - Type: string - Req/Opt: Optional - Description: "Alternative main script filename. Default: `main.nf`." -- Name: launch.entryName - Type: string - Req/Opt: Optional - Description: Workflow entry point name when using Nextflow DSL2. -- Name: launch.schemaName - Type: string - Req/Opt: Optional - Description: Name of the pipeline schema to use. -- Name: launch.resume - Type: boolean - Req/Opt: Optional - Description: Enable resume to restart workflow execution from the last - successful process. See [Resume a workflow - run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run). -- Name: launch.pullLatest - Type: boolean - Req/Opt: Optional - Description: Pull the latest version of the pipeline from the repository. -- Name: launch.stubRun - Type: boolean - Req/Opt: Optional - Description: Execute a stub run for testing (processes return dummy results). -- Name: launch.optimizationId - Type: string - Req/Opt: Optional - Description: Optimization configuration identifier. See [Pipeline resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.optimizationTargets - Type: string - Req/Opt: Optional - Description: Comma-separated list of optimization targets. See [Pipeline - resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to each pipeline run. -- Name: launch.headJobCpus - Type: integer - Req/Opt: Optional - Description: Number of CPUs allocated for the Nextflow head job. -- Name: launch.headJobMemoryMb - Type: integer - Req/Opt: Optional - Description: Memory allocation for the Nextflow head job in megabytes. -- Name: launch.launchContainer - Type: string - Req/Opt: Optional - Description: Container image to use for the Nextflow launcher. -- Name: launch.dateCreated - Type: string - Req/Opt: Optional - Description: Timestamp when the launch configuration was created. -- Name: labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to apply to the pipeline. -- Name: "**UpdatePipeline**" - Type: "" - Req/Opt: "" - Description: Update pipeline -- Name: name - Type: string - Req/Opt: Optional - Description: Pipeline name. Must be unique within the workspace. -- Name: description - Type: string - Req/Opt: Optional - Description: Pipeline description. -- Name: icon - Type: string - Req/Opt: Optional - Description: Pipeline icon URL. -- Name: launch - Type: object - Req/Opt: Optional - Description: "" -- Name: launch.id - Type: string - Req/Opt: Optional - Description: Launch configuration identifier. -- Name: launch.computeEnvId - Type: string - Req/Opt: Optional - Description: Compute environment identifier where the pipeline will run. - Defaults to workspace primary compute environment if omitted. -- Name: launch.runName - Type: string - Req/Opt: Optional - Description: Custom run name for the workflow execution. -- Name: launch.pipeline - Type: string - Req/Opt: Optional - Description: Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`). -- Name: launch.workDir - Type: string - Req/Opt: Optional - Description: Work directory path where workflow intermediate files are stored. - Defaults to compute environment work directory if omitted. -- Name: launch.revision - Type: string - Req/Opt: Optional - Description: Git revision, branch, or tag to use. -- Name: launch.sessionId - Type: string - Req/Opt: Optional - Description: Nextflow session identifier for resuming failed runs. -- Name: launch.configProfiles - Type: array - Req/Opt: Optional - Description: Array of Nextflow configuration profile names to apply. -- Name: launch.userSecrets - Type: array - Req/Opt: Optional - Description: Array of user secrets to make available to the pipeline. -- Name: launch.workspaceSecrets - Type: array - Req/Opt: Optional - Description: Array of workspace secrets to make available to the pipeline. -- Name: launch.configText - Type: string - Req/Opt: Optional - Description: Nextflow configuration as text (overrides config files). -- Name: launch.towerConfig - Type: string - Req/Opt: Optional - Description: Platform-specific configuration options. -- Name: launch.paramsText - Type: string - Req/Opt: Optional - Description: Pipeline parameters in JSON or YAML format. -- Name: launch.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.mainScript - Type: string - Req/Opt: Optional - Description: "Alternative main script filename. Default: `main.nf`." -- Name: launch.entryName - Type: string - Req/Opt: Optional - Description: Workflow entry point name when using Nextflow DSL2. -- Name: launch.schemaName - Type: string - Req/Opt: Optional - Description: Name of the pipeline schema to use. -- Name: launch.resume - Type: boolean - Req/Opt: Optional - Description: Enable resume to restart workflow execution from the last - successful process. See [Resume a workflow - run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run). -- Name: launch.pullLatest - Type: boolean - Req/Opt: Optional - Description: Pull the latest version of the pipeline from the repository. -- Name: launch.stubRun - Type: boolean - Req/Opt: Optional - Description: Execute a stub run for testing (processes return dummy results). -- Name: launch.optimizationId - Type: string - Req/Opt: Optional - Description: Optimization configuration identifier. See [Pipeline resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.optimizationTargets - Type: string - Req/Opt: Optional - Description: Comma-separated list of optimization targets. See [Pipeline - resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to each pipeline run. -- Name: launch.headJobCpus - Type: integer - Req/Opt: Optional - Description: Number of CPUs allocated for the Nextflow head job. -- Name: launch.headJobMemoryMb - Type: integer - Req/Opt: Optional - Description: Memory allocation for the Nextflow head job in megabytes. -- Name: launch.launchContainer - Type: string - Req/Opt: Optional - Description: Container image to use for the Nextflow launcher. -- Name: launch.dateCreated - Type: string - Req/Opt: Optional - Description: Timestamp when the launch configuration was created. -- Name: labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to the pipeline. If null, empty, or - omitted, all existing labels are removed. Label IDs to be preserved must be - included in your request. diff --git a/platform-api-docs/docs/info/parameter-tables/platforms/parameters.yml b/platform-api-docs/docs/info/parameter-tables/platforms/parameters.yml deleted file mode 100644 index 2700d6504..000000000 --- a/platform-api-docs/docs/info/parameter-tables/platforms/parameters.yml +++ /dev/null @@ -1,25 +0,0 @@ -- Name: "`orgId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Organization numeric identifier -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`platformId`" - Type: string - Location: path - Req/Opt: Required - Description: Platform string identifier -- Name: "`regionId`" - Type: string - Location: query - Req/Opt: Required - Description: "" -- Name: "`credentialsId`" - Type: string - Location: query - Req/Opt: Required - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/studios/parameters.yml b/platform-api-docs/docs/info/parameter-tables/studios/parameters.yml deleted file mode 100644 index e94a6752f..000000000 --- a/platform-api-docs/docs/info/parameter-tables/studios/parameters.yml +++ /dev/null @@ -1,62 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: "Optional search criteria, allowing free text search on name and - templateUrl and keywords: `userId`, `computeEnvId` and `status`." -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`attributes`" - Type: array - Location: query - Req/Opt: Optional - Description: "Optional attribute values to be included in the response - (`labels`). Returns an empty value (`labels: null`) if omitted." -- Name: "`autoStart`" - Type: boolean - Location: query - Req/Opt: Optional - Description: Optionally disable the Studio's automatic launch when it is created. -- Name: "`orgId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Organization numeric identifier -- Name: "`status`" - Type: string - Location: query - Req/Opt: Optional - Description: Optional Studio status -- Name: "`exclude`" - Type: string - Location: query - Req/Opt: Optional - Description: Optional Studio session ID to exclude in the request. -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Studio name to validate -- Name: "`sessionId`" - Type: string - Location: path - Req/Opt: Required - Description: Studio session numeric identifier -- Name: "`checkpointId`" - Type: integer - Location: path - Req/Opt: Required - Description: Numeric identifier of the checkpoint. diff --git a/platform-api-docs/docs/info/parameter-tables/studios/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/studios/request-bodies.yml deleted file mode 100644 index ebbdcb023..000000000 --- a/platform-api-docs/docs/info/parameter-tables/studios/request-bodies.yml +++ /dev/null @@ -1,96 +0,0 @@ -- Name: "**CreateDataStudio**" - Type: "" - Req/Opt: "" - Description: Create Studio -- Name: name - Type: string - Req/Opt: Required - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: dataStudioToolUrl - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnvId - Type: string - Req/Opt: Required - Description: "" -- Name: initialCheckpointId - Type: integer - Req/Opt: Optional - Description: "" -- Name: configuration - Type: object - Req/Opt: Optional - Description: "" -- Name: configuration.gpu - Type: integer - Req/Opt: Optional - Description: "" -- Name: configuration.cpu - Type: integer - Req/Opt: Optional - Description: "" -- Name: configuration.memory - Type: integer - Req/Opt: Optional - Description: "" -- Name: configuration.mountData - Type: array - Req/Opt: Optional - Description: "" -- Name: configuration.environment - Type: object - Req/Opt: Optional - Description: "" -- Name: configuration.condaEnvironment - Type: string - Req/Opt: Optional - Description: "" -- Name: configuration.lifespanHours - Type: integer - Req/Opt: Optional - Description: "" -- Name: isPrivate - Type: boolean - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: spot - Type: boolean - Req/Opt: Optional - Description: "" -- Name: "**UpdateDataStudioCheckpoint**" - Type: "" - Req/Opt: "" - Description: Update Studio checkpoint name -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: "**StartDataStudio**" - Type: "" - Req/Opt: "" - Description: Starts a Studio -- Name: configuration - Type: object - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: spot - Type: boolean - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/teams/parameters.yml b/platform-api-docs/docs/info/parameter-tables/teams/parameters.yml deleted file mode 100644 index 0ef766d98..000000000 --- a/platform-api-docs/docs/info/parameter-tables/teams/parameters.yml +++ /dev/null @@ -1,35 +0,0 @@ -- Name: "`orgId`" - Type: integer - Location: path - Req/Opt: Required - Description: Organization numeric identifier -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter search parameter -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Team name to validate -- Name: "`teamId`" - Type: integer - Location: path - Req/Opt: Required - Description: Team numeric identifier -- Name: "`memberId`" - Type: integer - Location: path - Req/Opt: Required - Description: Member numeric identifier diff --git a/platform-api-docs/docs/info/parameter-tables/teams/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/teams/request-bodies.yml deleted file mode 100644 index fb6541e08..000000000 --- a/platform-api-docs/docs/info/parameter-tables/teams/request-bodies.yml +++ /dev/null @@ -1,56 +0,0 @@ -- Name: "**CreateOrganizationTeam**" - Type: "" - Req/Opt: "" - Description: Create team -- Name: team - Type: object - Req/Opt: Optional - Description: "" -- Name: team.id - Type: integer - Req/Opt: Optional - Description: "" -- Name: team.name - Type: string - Req/Opt: Required - Description: "" -- Name: team.description - Type: string - Req/Opt: Optional - Description: "" -- Name: team.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: team.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: avatarId - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateOrganizationTeam**" - Type: "" - Req/Opt: "" - Description: Update team -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: avatarId - Type: string - Req/Opt: Optional - Description: "" -- Name: "**CreateOrganizationTeamMember**" - Type: "" - Req/Opt: "" - Description: Create team member -- Name: userNameOrEmail - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/tokens/parameters.yml b/platform-api-docs/docs/info/parameter-tables/tokens/parameters.yml deleted file mode 100644 index ea177f591..000000000 --- a/platform-api-docs/docs/info/parameter-tables/tokens/parameters.yml +++ /dev/null @@ -1,5 +0,0 @@ -- Name: "`tokenId`" - Type: integer - Location: path - Req/Opt: Required - Description: Token numeric identifier diff --git a/platform-api-docs/docs/info/parameter-tables/tokens/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/tokens/request-bodies.yml deleted file mode 100644 index 15e24aac7..000000000 --- a/platform-api-docs/docs/info/parameter-tables/tokens/request-bodies.yml +++ /dev/null @@ -1,8 +0,0 @@ -- Name: "**CreateToken**" - Type: "" - Req/Opt: "" - Description: Create token -- Name: name - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/trace/parameters.yml b/platform-api-docs/docs/info/parameter-tables/trace/parameters.yml deleted file mode 100644 index 23fe35708..000000000 --- a/platform-api-docs/docs/info/parameter-tables/trace/parameters.yml +++ /dev/null @@ -1,10 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`workflowId`" - Type: string - Location: path - Req/Opt: Required - Description: Workflow string identifier diff --git a/platform-api-docs/docs/info/parameter-tables/trace/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/trace/request-bodies.yml deleted file mode 100644 index 8bf9df51d..000000000 --- a/platform-api-docs/docs/info/parameter-tables/trace/request-bodies.yml +++ /dev/null @@ -1,1828 +0,0 @@ -- Name: "**CreateTrace**" - Type: "" - Req/Opt: "" - Description: Create workflow execution trace -- Name: launchId - Type: string - Req/Opt: Optional - Description: "" -- Name: sessionId - Type: string - Req/Opt: Optional - Description: "" -- Name: runName - Type: string - Req/Opt: Optional - Description: "" -- Name: projectName - Type: string - Req/Opt: Optional - Description: "" -- Name: repository - Type: string - Req/Opt: Optional - Description: "" -- Name: workflowId - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateTraceBegin**" - Type: "" - Req/Opt: "" - Description: Signal workflow execution start -- Name: launchId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.requiresAttention - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.status - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.ownerId - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.repository - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.id - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.submit - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.start - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.complete - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.runName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.sessionId - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.profile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.workDir - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.commitId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.userName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.scriptId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.revision - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.commandLine - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.projectName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.scriptName - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.launchId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.configFiles - Type: array - Req/Opt: Optional - Description: "" -- Name: workflow.params - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.configText - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.nextflowVersion - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.defaultBranch - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.version - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.homePage - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.gitmodules - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.description - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.name - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.mainScript - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.author - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.icon - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.version - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.build - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.timestamp - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.stats.computeTimeFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.fusion - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.fusion.enabled - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.fusion.version - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.wave - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.wave.enabled - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.errorMessage - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.errorReport - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.projectDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.homeDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.container - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.containerEngine - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.scriptFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.launchDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.duration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.exitStatus - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.resume - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.success - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.logFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.outFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.operationId - Type: string - Req/Opt: Optional - Description: "" -- Name: processNames - Type: array - Req/Opt: Optional - Description: "" -- Name: towerLaunch - Type: boolean - Req/Opt: Optional - Description: "" -- Name: "**UpdateTraceComplete**" - Type: "" - Req/Opt: "" - Description: Signal workflow execution completion -- Name: workflow - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.requiresAttention - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.status - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.ownerId - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.repository - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.id - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.submit - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.start - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.complete - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.runName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.sessionId - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.profile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.workDir - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.commitId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.userName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.scriptId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.revision - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.commandLine - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.projectName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.scriptName - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.launchId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.configFiles - Type: array - Req/Opt: Optional - Description: "" -- Name: workflow.params - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.configText - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.nextflowVersion - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.defaultBranch - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.version - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.homePage - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.gitmodules - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.description - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.name - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.mainScript - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.author - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.icon - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.version - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.build - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.timestamp - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.stats.computeTimeFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.fusion - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.fusion.enabled - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.fusion.version - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.wave - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.wave.enabled - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.errorMessage - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.errorReport - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.projectDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.homeDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.container - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.containerEngine - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.scriptFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.launchDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.duration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.exitStatus - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.resume - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.success - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.logFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.outFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.operationId - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].id - Type: integer - Req/Opt: Optional - Description: "" -- Name: metrics[].process - Type: string - Req/Opt: Required - Description: "" -- Name: metrics[].cpu - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].mem - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].time - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].time.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].time.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].time.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].reads - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].writes - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: progress - Type: object - Req/Opt: Optional - Description: "" -- Name: progress.pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes - Type: array - Req/Opt: Optional - Description: "" -- Name: progress.processes[].index - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].name - Type: string - Req/Opt: Optional - Description: "" -- Name: progress.processes[].pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].terminated - Type: boolean - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: "**UpdateTraceHeartbeat**" - Type: "" - Req/Opt: "" - Description: Signal workflow execution heartbeat -- Name: progress - Type: object - Req/Opt: Optional - Description: "" -- Name: progress.pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes - Type: array - Req/Opt: Optional - Description: "" -- Name: progress.processes[].index - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].name - Type: string - Req/Opt: Optional - Description: "" -- Name: progress.processes[].pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].terminated - Type: boolean - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: "**UpdateTraceProgress**" - Type: "" - Req/Opt: "" - Description: Store workflow task execution metadata -- Name: tasks - Type: array - Req/Opt: Optional - Description: "" -- Name: tasks[].hash - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].name - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].process - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].tag - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].submit - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].start - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].complete - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].module - Type: array - Req/Opt: Optional - Description: "" -- Name: tasks[].container - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].attempt - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].script - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].scratch - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].workdir - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].queue - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].cpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].memory - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].disk - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].time - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].env - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].executor - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].machineType - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].cloudZone - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].priceModel - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].cost - Type: number - Req/Opt: Optional - Description: "" -- Name: tasks[].errorAction - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].exitStatus - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].duration - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].realtime - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].nativeId - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].pcpu - Type: number - Req/Opt: Optional - Description: "" -- Name: tasks[].pmem - Type: number - Req/Opt: Optional - Description: "" -- Name: tasks[].rss - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].vmem - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].peakRss - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].peakVmem - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].rchar - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].wchar - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].syscr - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].syscw - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].readBytes - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].writeBytes - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].volCtxt - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].invCtxt - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].exit - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].id - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].taskId - Type: integer - Req/Opt: Required - Description: "" -- Name: tasks[].status - Type: string - Req/Opt: Required - Description: "" -- Name: tasks[].dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: progress - Type: object - Req/Opt: Optional - Description: "" -- Name: progress.pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes - Type: array - Req/Opt: Optional - Description: "" -- Name: progress.processes[].index - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].name - Type: string - Req/Opt: Optional - Description: "" -- Name: progress.processes[].pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].terminated - Type: boolean - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: containers - Type: array - Req/Opt: Optional - Description: "" -- Name: containers[].requestId - Type: string - Req/Opt: Optional - Description: "" -- Name: containers[].sourceImage - Type: string - Req/Opt: Optional - Description: "" -- Name: containers[].targetImage - Type: string - Req/Opt: Required - Description: "" -- Name: containers[].buildId - Type: string - Req/Opt: Optional - Description: "" -- Name: containers[].scanId - Type: string - Req/Opt: Optional - Description: "" -- Name: containers[].mirrorId - Type: string - Req/Opt: Optional - Description: "" -- Name: containers[].cached - Type: boolean - Req/Opt: Optional - Description: "" -- Name: containers[].freeze - Type: boolean - Req/Opt: Optional - Description: "" -- Name: containers[].requestTime - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/users/parameters.yml b/platform-api-docs/docs/info/parameter-tables/users/parameters.yml deleted file mode 100644 index 1b5cd1071..000000000 --- a/platform-api-docs/docs/info/parameter-tables/users/parameters.yml +++ /dev/null @@ -1,10 +0,0 @@ -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: User name to validate -- Name: "`userId`" - Type: integer - Location: path - Req/Opt: Required - Description: User numeric identifier diff --git a/platform-api-docs/docs/info/parameter-tables/users/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/users/request-bodies.yml deleted file mode 100644 index 39bac6e1c..000000000 --- a/platform-api-docs/docs/info/parameter-tables/users/request-bodies.yml +++ /dev/null @@ -1,68 +0,0 @@ -- Name: "**UpdateUser**" - Type: "" - Req/Opt: "" - Description: Update an user entity -- Name: id - Type: integer - Req/Opt: Optional - Description: "" -- Name: userName - Type: string - Req/Opt: Required - Description: "" -- Name: email - Type: string - Req/Opt: Required - Description: "" -- Name: firstName - Type: string - Req/Opt: Optional - Description: "" -- Name: lastName - Type: string - Req/Opt: Optional - Description: "" -- Name: organization - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: avatar - Type: string - Req/Opt: Optional - Description: "" -- Name: avatarId - Type: string - Req/Opt: Optional - Description: "" -- Name: notification - Type: boolean - Req/Opt: Optional - Description: "" -- Name: termsOfUseConsent - Type: boolean - Req/Opt: Optional - Description: "" -- Name: marketingConsent - Type: boolean - Req/Opt: Optional - Description: "" -- Name: lastAccess - Type: string - Req/Opt: Optional - Description: "" -- Name: dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: deleted - Type: boolean - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/parameter-tables/workflows/parameters.yml b/platform-api-docs/docs/info/parameter-tables/workflows/parameters.yml deleted file mode 100644 index 8c58931ec..000000000 --- a/platform-api-docs/docs/info/parameter-tables/workflows/parameters.yml +++ /dev/null @@ -1,81 +0,0 @@ -- Name: "`attributes`" - Type: array - Location: query - Req/Opt: Optional - Description: "Additional attribute values to include in the response (`labels`, - `optimized` status). Returns an empty value (`labels: null`) if omitted." -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter search parameter -- Name: "`force`" - Type: boolean - Location: query - Req/Opt: Optional - Description: Force the deletion even if any workflows are active -- Name: "`sourceWorkspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Source workspace numeric identifier -- Name: "`runName`" - Type: string - Location: query - Req/Opt: Optional - Description: Workflow run name to validate -- Name: "`sessionId`" - Type: string - Location: query - Req/Opt: Optional - Description: Workflow session ID to validate -- Name: "`workflowId`" - Type: string - Location: path - Req/Opt: Required - Description: Workflow string identifier -- Name: "`fileName`" - Type: string - Location: query - Req/Opt: Optional - Description: Filename to download -- Name: "`taskId`" - Type: integer - Location: path - Req/Opt: Required - Description: Task numeric identifier -- Name: "`next`" - Type: string - Location: query - Req/Opt: Optional - Description: Workflow log cursor -- Name: "`maxLength`" - Type: integer - Location: query - Req/Opt: Optional - Description: Maximum length in bytes of the log to retrieve -- Name: "`sortBy`" - Type: string - Location: query - Req/Opt: Optional - Description: Field to sort by -- Name: "`sortDir`" - Type: string - Location: query - Req/Opt: Optional - Description: Sorting direction (asc|desc) diff --git a/platform-api-docs/docs/info/parameter-tables/workflows/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/workflows/request-bodies.yml deleted file mode 100644 index 7edc186cf..000000000 --- a/platform-api-docs/docs/info/parameter-tables/workflows/request-bodies.yml +++ /dev/null @@ -1,143 +0,0 @@ -- Name: "**DeleteWorkflowMany**" - Type: "" - Req/Opt: "" - Description: Delete workflows -- Name: workflowIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**CreateWorkflowLaunch**" - Type: "" - Req/Opt: "" - Description: Launch workflow -- Name: launch - Type: object - Req/Opt: Optional - Description: "" -- Name: launch.id - Type: string - Req/Opt: Optional - Description: Launch configuration identifier. -- Name: launch.computeEnvId - Type: string - Req/Opt: Optional - Description: Compute environment identifier where the pipeline will run. - Defaults to workspace primary compute environment if omitted. -- Name: launch.runName - Type: string - Req/Opt: Optional - Description: Custom run name for the workflow execution. -- Name: launch.pipeline - Type: string - Req/Opt: Optional - Description: Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`). -- Name: launch.workDir - Type: string - Req/Opt: Optional - Description: Work directory path where workflow intermediate files are stored. - Defaults to compute environment work directory if omitted. -- Name: launch.revision - Type: string - Req/Opt: Optional - Description: Git revision, branch, or tag to use. -- Name: launch.sessionId - Type: string - Req/Opt: Optional - Description: Nextflow session identifier for resuming failed runs. -- Name: launch.configProfiles - Type: array - Req/Opt: Optional - Description: Array of Nextflow configuration profile names to apply. -- Name: launch.userSecrets - Type: array - Req/Opt: Optional - Description: Array of user secrets to make available to the pipeline. -- Name: launch.workspaceSecrets - Type: array - Req/Opt: Optional - Description: Array of workspace secrets to make available to the pipeline. -- Name: launch.configText - Type: string - Req/Opt: Optional - Description: Nextflow configuration as text (overrides config files). -- Name: launch.towerConfig - Type: string - Req/Opt: Optional - Description: Platform-specific configuration options. -- Name: launch.paramsText - Type: string - Req/Opt: Optional - Description: Pipeline parameters in JSON or YAML format. -- Name: launch.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.mainScript - Type: string - Req/Opt: Optional - Description: "Alternative main script filename. Default: `main.nf`." -- Name: launch.entryName - Type: string - Req/Opt: Optional - Description: Workflow entry point name when using Nextflow DSL2. -- Name: launch.schemaName - Type: string - Req/Opt: Optional - Description: Name of the pipeline schema to use. -- Name: launch.resume - Type: boolean - Req/Opt: Optional - Description: Enable resume to restart workflow execution from the last - successful process. See [Resume a workflow - run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run). -- Name: launch.pullLatest - Type: boolean - Req/Opt: Optional - Description: Pull the latest version of the pipeline from the repository. -- Name: launch.stubRun - Type: boolean - Req/Opt: Optional - Description: Execute a stub run for testing (processes return dummy results). -- Name: launch.optimizationId - Type: string - Req/Opt: Optional - Description: Optimization configuration identifier. See [Pipeline resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.optimizationTargets - Type: string - Req/Opt: Optional - Description: Comma-separated list of optimization targets. See [Pipeline - resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to each pipeline run. -- Name: launch.headJobCpus - Type: integer - Req/Opt: Optional - Description: Number of CPUs allocated for the Nextflow head job. -- Name: launch.headJobMemoryMb - Type: integer - Req/Opt: Optional - Description: Memory allocation for the Nextflow head job in megabytes. -- Name: launch.launchContainer - Type: string - Req/Opt: Optional - Description: Container image to use for the Nextflow launcher. -- Name: launch.dateCreated - Type: string - Req/Opt: Optional - Description: Timestamp when the launch configuration was created. -- Name: "**CancelWorkflow**" - Type: "" - Req/Opt: "" - Description: Cancel workflow diff --git a/platform-api-docs/docs/info/parameter-tables/workspaces/parameters.yml b/platform-api-docs/docs/info/parameter-tables/workspaces/parameters.yml deleted file mode 100644 index 0ff96ecff..000000000 --- a/platform-api-docs/docs/info/parameter-tables/workspaces/parameters.yml +++ /dev/null @@ -1,40 +0,0 @@ -- Name: "`orgId`" - Type: integer - Location: path - Req/Opt: Required - Description: Organization numeric identifier -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Workspace name to validate -- Name: "`workspaceId`" - Type: integer - Location: path - Req/Opt: Required - Description: Workspace numeric identifier -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter search parameter -- Name: "`participantId`" - Type: integer - Location: path - Req/Opt: Required - Description: Participant numeric identifier -- Name: "`userId`" - Type: integer - Location: path - Req/Opt: Required - Description: User numeric identifier diff --git a/platform-api-docs/docs/info/parameter-tables/workspaces/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/workspaces/request-bodies.yml deleted file mode 100644 index 2b1e87147..000000000 --- a/platform-api-docs/docs/info/parameter-tables/workspaces/request-bodies.yml +++ /dev/null @@ -1,120 +0,0 @@ -- Name: "**CreateWorkspace**" - Type: "" - Req/Opt: "" - Description: Create workspace -- Name: workspace - Type: object - Req/Opt: Optional - Description: "" -- Name: workspace.id - Type: integer - Req/Opt: Optional - Description: "" -- Name: workspace.name - Type: string - Req/Opt: Required - Description: "" -- Name: workspace.fullName - Type: string - Req/Opt: Required - Description: "" -- Name: workspace.description - Type: string - Req/Opt: Optional - Description: "" -- Name: workspace.visibility - Type: string - Req/Opt: Required - Description: "" -- Name: workspace.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: workspace.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateWorkspace**" - Type: "" - Req/Opt: "" - Description: Update workspace -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: fullName - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: visibility - Type: string - Req/Opt: Optional - Description: "" -- Name: "**CreateWorkspaceParticipant**" - Type: "" - Req/Opt: "" - Description: Create workspace participant -- Name: memberId - Type: integer - Req/Opt: Optional - Description: "" -- Name: teamId - Type: integer - Req/Opt: Optional - Description: "" -- Name: userNameOrEmail - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateWorkspaceParticipantRole**" - Type: "" - Req/Opt: "" - Description: Update participant role -- Name: role - Type: string - Req/Opt: Optional - Description: "" -- Name: "**FindDataStudiosWorkspaceSettings**" - Type: "" - Req/Opt: "" - Description: List workspace Studios settings -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: fullName - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: visibility - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateDataStudiosWorkspaceSettings**" - Type: "" - Req/Opt: "" - Description: Update workspace Studios settings -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: fullName - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: visibility - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/info/pipelines.info.api.mdx b/platform-api-docs/docs/info/pipelines.info.api.mdx deleted file mode 100644 index 136a587ab..000000000 --- a/platform-api-docs/docs/info/pipelines.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: pipelines-info -title: "Pipelines" -description: "API operations for pipelines in Seqera Platform" -sidebar_label: Pipelines -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -A [pipeline](https://docs.seqera.io/platform-cloud/launch/launchpad) is a repository containing a Nextflow workflow, a compute environment, and pipeline parameters. - -### Path and query parameters - -::table{file=parameter-tables/pipelines/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/pipelines/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/platforms.info.api.mdx b/platform-api-docs/docs/info/platforms.info.api.mdx deleted file mode 100644 index 5d481cda3..000000000 --- a/platform-api-docs/docs/info/platforms.info.api.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: platforms-info -title: "Platforms" -description: "API operations for platforms in Seqera Platform" -sidebar_label: Platforms -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -Use the Platforms API to retrieve the details of available computing platforms (such as AWS Batch, Google Cloud Batch, and Grid Engine) in Seqera. - -### Path and query parameters - -::table{file=parameter-tables/platforms/parameters.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/secrets.info.api.mdx b/platform-api-docs/docs/info/secrets.info.api.mdx deleted file mode 100644 index c2ad8c80e..000000000 --- a/platform-api-docs/docs/info/secrets.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: secrets-info -title: "Secrets" -description: "API operations for pipeline secrets in Seqera Platform" -sidebar_label: Secrets -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -[Secrets](https://docs.seqera.io/platform-cloud/secrets/overview) store the keys and tokens used by workflow tasks to interact with external systems, such as a password to connect to an external database or an API token. - -### Path and query parameters - -::table{file=parameter-tables/pipeline-secrets/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/pipeline-secrets/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/seqera-api.info.mdx b/platform-api-docs/docs/info/seqera-api.info.mdx deleted file mode 100644 index e0521413f..000000000 --- a/platform-api-docs/docs/info/seqera-api.info.mdx +++ /dev/null @@ -1,117 +0,0 @@ ---- -id: seqera-api -title: "Platform API" -description: "Seqera Platform services API" -sidebar_label: Platform API -sidebar_position: 0 -hide_title: true -custom_edit_url: null -slug: / ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - - - - - - - -The Seqera Platform services API is a programmatic interface for all operations available in the Platform web UI. This allows organizations to integrate Platform seamlessly into existing processes. - -
- -### Authentication - -The API requires an authentication token to be specified in each API request using the -[Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication) HTTP header. - - - -:::note -The token is only displayed once when it is created. Store your token in a safe place. -::: - -### Versioning - -The API uses the [semantic versioning convention](https://semver.org/) (major.minor.patch). In the event that a breaking change is introduced in future versions, we will publish guidance on the v1 support schedule and steps to mitigate disruption to your production environment. The following do _not_ constitute breaking changes: - -- Adding new API endpoints, new HTTP methods to existing endpoints, request parameters, or response fields -- Adding new values to existing enums or string constants -- Expanding accepted input formats or value ranges -- Adding new optional headers or query parameters -- Improving error messages or adding new error codes -- Deprecation warnings (without removal) - -Clients should be designed to gracefully handle unknown enum values, ignore unrecognized response fields, and not rely on specific error message text. - -### Encoding and formatting standards - -- The API can be accessed from `https://api.cloud.seqera.io`. -- All API endpoints use HTTPS, and all request and response payloads use [JSON](https://www.json.org/) encoding. -- All timestamps use the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date-time standard format: `YYYY-MM-DDTHH:MM:SSZ`. - -:::note -The Platform API is live on `https://api.cloud.seqera.io`. The legacy API `https://api.tower.nf` remains fully operational, so existing API integrations will continue to perform as expected. Deprecation of the legacy API will be communicated well in advance to avoid any breaking changes to your integrations. -::: - -### Programmatic API - -Both the [Seqera Platform CLI](https://docs.seqera.io/platform-cloud/cli/overview) and [seqerakit](https://docs.seqera.io/platform-cloud/seqerakit/installation) are built on the Platform API and provide a programmatic automation layer for operations. - -You can also use tools such as [openapi-python-client](https://github.com/openapi-generators/openapi-python-client) to generate your own programmatic API for a particular language (such as Python) based on the OpenAPI schema. However, we do not guarantee that any OpenAPI client generators will work with the Platform API. - -### Parameters - -Some API `GET` methods will accept standard `query` parameters, which are defined in the documentation. Optional parameters such as page size, number (when available), and file name can be submitted as query parameters. `POST`, `PUT`, and `DELETE` requests require additional parameters to be provided in your request body. - -Several head parameters are also accepted, such as `Authorization` for bearer access tokens or `Accept-Version` to indicate the desired API version to use (default version 1): - -```bash -curl -H "Authorization: Bearer QH..E5M=" - -H "Accept-Version:1" - -X POST https://api.cloud.seqera.io/domain/{item_id}?queryString={value} - -d { params: { "key":"value" } } - -``` - -### Client errors - -Two typical standard errors (i.e., response statuses other than `200` or `204`) are returned by the API. - -#### Bad Request - -The request payload is not properly defined or the query parameters are invalid. - -```json -{ - "message": "Unexpected error while processing - Error ID: 54apnFENQxbvCr23JaIjLb" -} -``` - -#### Forbidden - -Your access token is invalid or expired. This response may also imply that the endpoint you are trying to access is not available. Check your request syntax for typos, and confirm that your access token is valid. - -```bash -Status: 403 Forbidden -``` - -### Rate limiting - -For all API requests, there is a limit of 20 calls per second, per access token (72000 calls per hour). diff --git a/platform-api-docs/docs/info/studios.info.api.mdx b/platform-api-docs/docs/info/studios.info.api.mdx deleted file mode 100644 index 7332da8cc..000000000 --- a/platform-api-docs/docs/info/studios.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: studios-info -title: "Studios" -description: "API operations for Studios in Seqera Platform" -sidebar_label: Studios -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -[Studios](https://docs.seqera.io/platform-cloud/studios) is a unified platform which hosts a combination of container images and compute environments for interactive analysis using preferred tools like JupyterLab and RStudio Notebooks, Visual Studio Code IDEs, or Xpra remote desktops. Each Studio session is an individual interactive environment that encapsulates the live environment for dynamic data analysis. - -### Path and query parameters - -::table{file=parameter-tables/studios/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/studios/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/teams.info.api.mdx b/platform-api-docs/docs/info/teams.info.api.mdx deleted file mode 100644 index c4782fcbe..000000000 --- a/platform-api-docs/docs/info/teams.info.api.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: teams-info -title: "Teams" -description: "API operations for teams in Seqera Platform" -sidebar_label: Teams -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -[Teams](https://docs.seqera.io/platform-cloud/orgs-and-teams/organizations#teams) are organizational units that allow organization owners to group users together, managing team members and access permissions as a whole. - -### Path and query parameters - -::table{file=parameter-tables/teams/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/teams/request-bodies.yml} - diff --git a/platform-api-docs/docs/info/tokens.info.api.mdx b/platform-api-docs/docs/info/tokens.info.api.mdx deleted file mode 100644 index bc00abe8f..000000000 --- a/platform-api-docs/docs/info/tokens.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: tokens-info -title: "Access tokens" -description: "API operations for access tokens in Seqera Platform" -sidebar_label: Access tokens -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -Use the Tokens API to manage Seqera Platform API access tokens. - -### Path and query parameters - -::table{file=parameter-tables/tokens/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/tokens/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/trace.info.api.mdx b/platform-api-docs/docs/info/trace.info.api.mdx deleted file mode 100644 index b19e98050..000000000 --- a/platform-api-docs/docs/info/trace.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: trace-info -title: "Workflow traces" -description: "API operations for workflow execution traces in Seqera Platform" -sidebar_label: Workflow traces -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -Manage workflow execution (pipeline run) traces. - -### Path and query parameters - -::table{file=parameter-tables/trace/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/trace/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/users.info.api.mdx b/platform-api-docs/docs/info/users.info.api.mdx deleted file mode 100644 index 680091bc9..000000000 --- a/platform-api-docs/docs/info/users.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: users-info -title: "Users" -description: "API operations for users in Seqera Platform" -sidebar_label: Users -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -Manage Seqera Platform users. - -### Path and query parameters - -::table{file=parameter-tables/users/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/users/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/workflows.info.api.mdx b/platform-api-docs/docs/info/workflows.info.api.mdx deleted file mode 100644 index ac24a0147..000000000 --- a/platform-api-docs/docs/info/workflows.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: workflows-info -title: "Pipeline runs (workflows)" -description: "API operations for workflow executions in Seqera Platform" -sidebar_label: Pipeline runs (workflows) -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -Manage workflow executions ([pipeline runs](https://docs.seqera.io/platform-cloud/monitoring/overview)) in Seqera Platform. - -### Path and query parameters - -::table{file=parameter-tables/workflows/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/workflows/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/info/workspaces.info.api.mdx b/platform-api-docs/docs/info/workspaces.info.api.mdx deleted file mode 100644 index 3bc5182f5..000000000 --- a/platform-api-docs/docs/info/workspaces.info.api.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: workspaces-info -title: "Workspaces" -description: "API operations for workspaces in Seqera Platform" -sidebar_label: Workspaces -hide_title: false -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; -import MDXComponents from "@theme-original/MDXComponents"; -import Button from "@site/src/components/Button"; - -[Workspaces](https://docs.seqera.io/platform-cloud/orgs-and-teams/workspace-management) are organizational units to manage Seqera resources such as pipelines, Studios, compute environments, and credentials, in a user or organization context. - -### Path and query parameters - -::table{file=parameter-tables/workspaces/parameters.yml} - -### Request body parameters - -::table{file=parameter-tables/workspaces/request-bodies.yml} \ No newline at end of file diff --git a/platform-api-docs/docs/launch-action.api.mdx b/platform-api-docs/docs/launch-action.api.mdx deleted file mode 100644 index 907640f46..000000000 --- a/platform-api-docs/docs/launch-action.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: launch-action -title: "Trigger Tower Launch action" -description: "Triggers the execution of the Tower Launch action identified by the given `actionId`." -sidebar_label: "Trigger Tower Launch action" -hide_title: true -hide_table_of_contents: true -api: eJy1VVFr2zAQ/itCTxtkSbeVPuRpaemgbNDQZuyhBKrYF1utbamS3DQY//fdSXadxF7KxvYSYumT7rvv7jtV3InE8ukdF5GTqrB8OeIx2MhITd98yhdGJgkYy1wKDF4gKmmDqbVfWKgNGPZdlEWUsnAHkzEUTq4lxGy19ahEPkPB7sP+VXw/5iOuNBgRvjFKuGHmAbiphRE5OAyL3Cpe4AeC2vMIkERNC5fyQ77hDmadkUXScTEINPBUSgMYz5kSRtxGKeSCTyvutpoChEO8rkevMTfKPFotIujCPpVgtr24P1sgK8ocjIz2Y/diycJB4rfWyuTChaWzU4y+DFTBunMVb+nMYIpZUL2B4kWRwjsLRweE1pmMvL6TB0unqj4FtXqAiA5qQ9VwEiztevHtEE7EsaQrRTbfOUFiomTcSZfBQS1vGnI1Afb19wtWY9OFsJ9OTvqpXn/7d3lRKdeZ2lDDDZT8N/wDQ0oAIadDHM9F/DdF6NS44zlYKxIg9x3PoQUeTeDSGGV6zD8PqNt6kBXKMZGhOMiH4BZ9bqTbevudgzBgZiW6bXq3pPZEb6aKfKuVT9o7cconzRSZVK1V60noUnIAmOfW0KXJEJ46p+10MhFajqNMlfHYwhMyGkvVs9et32HzTDjyC7sgPJvNrzjxaenekrpBqV3Sr2JRxNaM9L3yIFwJf762TnzYOC8DVe2ms+Lli8h1BnsmIZgs1spHaQrQkCV2b+VBqsgIbAOm7kHt6LJ9jXaVwQaSmZ8Xa/Wl20AiJHCI83F8djY+oTUqUS588zUzrRnpQ8P7kG/V9fN/ewma2jh4cROdCZyxyNpnXzWN1T1PIz7deQWa3sIGSKkPEVdVK2Hhh8nqmpbDqKaOi6UVq4zcthaZhSNpvjHIB9k+wrb3VjyLrCSkb9BnYSTF/0Mu726aIfGeHXnXBik1i6LY7nJpqb6KWC8Rm4KI8SbiFrYvAoMPC7qkO94baPRQhhOzKALtjmJ358b8+nZBtmvet1zFdMaIDT3T+OupKh2KTsOS1ioseJGUfv7xcCe5T+x7/MDTPqtBMbBXPGKhHqHAfmm1cfRNwtT1L8byK38= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Triggers the execution of the Tower Launch action identified by the given `actionId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/leave-organization.api.mdx b/platform-api-docs/docs/leave-organization.api.mdx deleted file mode 100644 index 1dfc0f29f..000000000 --- a/platform-api-docs/docs/leave-organization.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: leave-organization -title: "Leave organization" -description: "Removes the requesting user from the organization identified by the given `orgId`." -sidebar_label: "Leave organization" -hide_title: true -hide_table_of_contents: true -api: eJy1VE1v2zAM/SuCThuQxdlW9JDT2i0DihVb0XanIkAZm4nVypIqyekyw/+9pGw3Hy3W006WxUfykXxUIyOsgpzeSOvpOx/JAkPulYvKGjmVl1jZNQYRSxQeH2oMUZmVqAN6sfS2SgZyBaP+AvsIVaCJaqmwEItNMq/UGo24JdRZcTuWI2kd+gQ+KyjFOcIaf+2EIIQDDxVG9EytkYZ+CJkikFUxMwexlId0d8MIU1foVb5l5AnPRSiPlDj6Gkcy5CVWIKeNjBvHSZSJuErQpfUVxO7q+Ei27Zzdg7MmYGCPT5Mj/hxQ+CE+iJ9W5JYCmSjbkTyaTF7iTqEYOkq5BjTBwDmt8lRCdhcY2+yw3PK/kRWGACvkqfXk7eIOc47nPDc5qo7oANxWGaKnOVJN5Kqi5quZ99Zf9vWRpU3MP79S4TA+YWwUoLV9JD4MD5jXXsVNGtopgkd/UtOYpjdzbh5NtLQ88gI1DTfNma0yY/FlTZpvm1VYLWjymWZhSI7q14MSaq8JX8bowjTLwKlxrm1djAM+EKmxsi8kcZUs4kJD5IGKr4wXJxdnkikNjK+4wV2zdnk/94szyl4t/L9IILrpDt8Hqdw9xtQJZZY2uffN7Vlw2rcIcrkqp53rwKwMyJMy9ovfLZnEoXRS6tJ+2RqICHeuy/NxfHw8nvCdsyFWkITVb1bawb09PqTZbCX6fx6FvtER/8TMaaAdJ6ap4qaXSf9GjeR0eAh6pdCp0woNtKTaGNo0Cwj42+u25Wsi6VmWdFyDV7DgqZCeChX4TKJcgg74j6LfXfab9168/cq8Wkx/CWYjmYWu+Y+O97h5ftzaOQFLhILCML/OdpLn6OKO14s3Ym+9vs3OZ9czgsO+iA9EmxK8SoqalxDX9h4NNXDgGPmfObbtE9QnJTQ= -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Removes the requesting user from the organization identified by the given `orgId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/leave-workspace-participant.api.mdx b/platform-api-docs/docs/leave-workspace-participant.api.mdx deleted file mode 100644 index 284e43e18..000000000 --- a/platform-api-docs/docs/leave-workspace-participant.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: leave-workspace-participant -title: "Leave workspace" -description: "Removes the requesting user from the given workspace." -sidebar_label: "Leave workspace" -hide_title: true -hide_table_of_contents: true -api: eJytVE1v2zAM/SuCThuQxdlW9JDT0i0DihVb0XbYIciBsZlErW2plJwuM/zfRyp2vlosQLGTZemJfHx8Yq0DLLweTvSTpQfvIEWvpz2doU/JuGBsqYf6Bgu7Qq/CEhXhY4U+mHKhKo+k5mSLeLAwKyzVNkxf97R1SCAxLjOOcoWwwl/d+TVQMKlxUAZGOiAoMCAJl1qX/MM3LC34Zk8bIeEgLPUxsx+0gNL8iUlUWRVIJlUmwzKYuUFivPA1hEwgUIU97dMlFqCHtQ5rJ0lMGXARoXNLBYTN1vmZbprelsm2rBN8tuX9fzJTue6dLT23iG98GJzJ50iPb+qd+m5VajkQK9v09Nlg8Bx3AVnXSc7VoRkGzuUmjXom916w9R7LHf+JLtB7WKC4pSVvZ/eYxm6SdD6YDdEOuKvSB2L/iMA6mJDL1pjI0k1bH580kfnHFyrsPKVKGxTkuX1iPgL3mFZkwjo66AKBkEYV92g4mYp4bK+lFR9mmLPTounkVCdsM5/U0WxNsnsHSb3X9SZxO8N6Ldlo1dm1opzjLENwfpgk4Ew/zW2V9T0+Mtm+sc98chtP1HUOQRqtPgteja4vtVDtKrkV4Tci7tez1VEy6tZF8j+LIN7ZLL52Frp/ClEhU85tvN6K3rKQtKcISrmGRWnB4hhIo2MOi98vmU1j8ujguf20O2Aiotwmz/v++Xl/IHvO+lBANFz76OLA2E2UY471zrevnlCtkAF/h8TlwA+bmcSK6tYeE5lC0vBhN432JiXvHk6GA5NwJ5dclMSo6xl4/El508g2EyTxKS9XQAZm0g42Uma8rNmlc8g9/qPgNzftU3yrTs/AF6tsN6Fca2GRV/LHywdcb0evTMBXcToxB19BaF/nZsrwJULGwUS2DWKUpujC3t1ns+xgDHwZX43vxgyHw0d19IhighepcU8j4s4+YMl97ZgG+ReOTfMXzNuMbA== -sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Removes the requesting user from the given workspace. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-action-types.api.mdx b/platform-api-docs/docs/list-action-types.api.mdx deleted file mode 100644 index f958044be..000000000 --- a/platform-api-docs/docs/list-action-types.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-action-types -title: "List action event types" -description: "Lists the supported event types that trigger a pipeline action. Append `?workspaceId` to list event types in a workspace context." -sidebar_label: "List action event types" -hide_title: true -hide_table_of_contents: true -api: eJzNVU1v2zAM/SuCzkXSbUUPuWzp0A3FBqxYO+xQFChjM4laRVIlOl1g5L+PlO3E+UCL3XZKJD6Sj08kXWuCWdKjOw0FGe+Svj/RJaYimiBnPdLfTaKkaI4qVSH4SFgqXKIjRauAYgH+G81shlGBCiagNQ5VE3CgxiGgK9XDxxcfn1KAAq/KB0VeWQ68E8k49t+gVOEd4R8a6BPtA0aQcFdly2ico9+KH9sDRFggYZRSau34wLheQsYYKea5wrjS+yX+3uR01QKjKZQpmZaZGowMTsUcF6BHtRaejDdMbJZNUx8XQM3V+Zler1m+iCmwkkyMPd6fnsrPbr4f39g1l+dIrBCCNUUucPiYBFIfJvWTRyxIio0iB5kmQRaw0WGLhRhByjSEi/R2jOSrWGAPl/g93UyvWSiTguVYR239oo7Y0cHEYtmzTby3CI51OtFkyMrdZVcA3/au5ZE3pvSz1VQwDDo7puoFlCoiv3Cif5FXXEwUmnd6gSnBDGUIXlesAx6W3a8sRh8PmH840g9deyvnSYG1/oX5CDxhUUVDq9zWFwgR47iiOR/vpdW45+deRmKGmSOISQ/bWR5SOx4J47KbjSpahsyJQhoNhxDMoLC+KgcJn5nEwPiD6bjJFnVtgaTd1WfBq/H1lRYKHcMbEbQRp89zo49k7GYpt0IG8U3z50s3SI8vlCs3buqzeytmy0LSvkVQyjUFL5QGLJ3Aikiw3eL7JXMzGJvneOo/bQ1MRJRr8rwbnJ8PTuUu+EQLyI3U7hpp13bl9XfaPtd625f/xWJtH0eOQ55z3pFcXVapbrtp+2Vo0PkLMef6xVTXE0j4K9r1Wq6b7Spdxmujnf0p2ISvqPDG7j1K8AlXB+t9CbYSZG7KJUQj+fOcMF2EkqMJscZ1XBQYqOd1sCJ2puvr5S1jYbeh9xo4R+/Wr1v1YrNIGXHrn9CxUB1/kjMn4r3wF6Zhnrc= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists the supported event types that trigger a pipeline action. Append `?workspaceId` to list event types in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-actions.api.mdx b/platform-api-docs/docs/list-actions.api.mdx deleted file mode 100644 index d0fd99c73..000000000 --- a/platform-api-docs/docs/list-actions.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-actions -title: "List actions" -description: "Lists all available actions in a user context, enriched by `attributes`. Append `?workspaceId` to list actions in a workspace context." -sidebar_label: "List actions" -hide_title: true -hide_table_of_contents: true -api: eJztV1Fv4zYM/iuCn3ZAmnbboQ952XJtVgTr2rs0tz0cCkSxmUStLPkkur0gyH8fKduJnTjprdiww7CXxBIpkR/1iSJXEcq5j3qfIhmjssZH950oAR87lfE46kXXyqMXUmshn6TScqpBlMpCGSFF7sGJ2BqEL9gRYJyKF5CI6VJMJKJT0xzBT7qin2VgEjH56dm6R5/JGIbJRKAVmiw0t9xoVPt2o05kM3CSlYZJ6Va/9LkTZdLJFBAcY1lFhgakUzNEOorRfM7BLaNdjH9s7Jk8BQIgVAIG1UyBI2VPgFIZ9VYRLjPeWJFT8yCaWZdKLKbO30brdWdjfQv+uPF+kij+lBThaol4kjoHz9FRJtZ5AhwYXIBw4DPCDOK7CZ0FaD950xUjwNxR8KQRkGa4LJZvVHoES+vJG6FmwqYKEZJuGyzpnGT/FELqa/OevDJzEgCFh8lSbMtc+XLCcydP0jFq3xSiQs3ri3P6wOj7FUIK1ZpUKjjB3A9nZ/zXDM/tr2Q40MAgS2WWaRUHIpw+eFZZ7SOx0weIkYnhmDaoCgMVyV+GfGADleyHZd0pT7xFkKkMtDLtQm9zF7eItnGeK1zkU5pA+0x0a4/3vlIz7t27wg5bRIn50ZO9GA364+HNFU31L8bD3wf0MRiNbkf0/77/8W5w2Wag2JYMaOnxDsC0mdhclUQinKBKg0s8uHBAvy2hPbQInkoyHD+tRDGRUmUkWte2O9lNbo1eRj10OawZGAUVZZp9rS+MYNdK6cTypsgDTXknSonBvCFplkf3DwBxMGvlXGxTSgDDdhoXwt/Aezk/wOfcL8DdHKR7EA9Seida5a8Jb8W1qxCrgnGDcP7rivLfAhE64bWZafvcGtz13qUZs+sNOKxkDdzOwhv2PyNew4j/BhP2U2wQjHknTn8myaxqZMBtRMvn9+954g4XOkcevVB8tErotd9986bWapCGpcpfwkzmGg+Kl2RTxYfEQ3LWZVbvvCU1nVc8NrXjuubIXk4v0YbpnO/ERfrCGdfq1FFZ63SL8dDMbHHpj+iyAmm8bauM3smEykEqKj3+lRKJlyjHEfgUpeXNZsIdZUV6MAXU/B84Z92e5z+21HRVKS+MRe4t6AYkYSsPce4ULkMKfAfS0c3IcUHDe74VVOMvLJf/cwg+ShZFp3LTCFAv8lR1AbmjnBMtEDPfOz2VmerG2uZJ18NnMt9Vdq8UvwsS8Z4oxFwQF6wv+u+H4UpWvt1xKIuw1D3cRIYtVuV1IGBQopni45eKZQ/PGDArJgIvL8NYesFmX3KQ4aqYGoVCmTlAseDNmuDrkKFIxsHsz1sBX1yKXGHn++75efcsJHDrMZWBQmVfc11r13YdXG1p+O00juWx8PA001KFVBDisyoZ1Gh/F4SYp1arqfTw0en1mqeL5o15RW8IgyEazqT2cCQEL/SVrY49wnKvdS0zahQeuK83/691lkeANbriLa57HjjFwMJdp2Ogh5hrOwp4sbIfx5BhbdVemmtkiKvBmHRl82ruXMV6oSXNsrY3HX7QGNtHMESAyn3kMRmi3PYneuv6Hg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available actions in a user context, enriched by `attributes`. Append `?workspaceId` to list actions in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-compute-envs.api.mdx b/platform-api-docs/docs/list-compute-envs.api.mdx deleted file mode 100644 index 6652251fd..000000000 --- a/platform-api-docs/docs/list-compute-envs.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-compute-envs -title: "List compute environments" -description: "Lists all available compute environments in a user context. Append `?workspaceId` to list compute environments in a workspace context, and `?status` to filter by compute environment status." -sidebar_label: "List compute environments" -hide_title: true -hide_table_of_contents: true -api: eJzVVktv4zYQ/isEz66ctoscfGmVrHdh1EgWTnZ7WARYWhrbk1CklqScGob+e2co+a143QI99KTHvL/5Zsi1DGru5eCrzGxRVgF+ArP08qknc/CZwzKgNXIgx+iDF0proZYKtZpqEK2FIAt01hRgSAWNUKLy4EhsAvwVEpGWJZhcfPvt1boXX6oMRvk3EazQ5PSMl636xlVPqOjHBxUqH13MUAeKNV11+RGNYiJ70pbgFNcyyttqbhv9IZfbk6VyqgByxVispaEP0mvsSYyMwfcK3EoeI/Phwgx8toBCycFahlXZOHdo5iQBUxXcgdvJMH0c3X2kX+mXdDROb8ZDeh9OJveT4Xt6G919SccjfrtY9amue9ty9vA/X9OfW+QpNXCYCcypGpwhuESMZsIWGALkvdhCfykTulBAEs3BkWhmXaFC8+v6naxrIqEDX1rjwbPFL1dX/DhM9f4PMo0BTGCpKkuNWWx1/9mzyvo0qJ0+Qxa47Y6JEbAJkO1RYqesnFMMEQYo/I+dYH7a47rXtqBDUGoVuPROYUvADtI4UPm90Ss5CK6Cf0EiQjdg0Ox0NwrJQxOQQhfgvZp356yVD589dFS618Zc0TYJSGVzlQ4LRUzbGUyt1aAMC7e8vHsLpCV6nKLGsOoUs4P36DplmYPIXaX9qLs1DubYEOVIVO8gOtoYk5aXydAEqqq+QJWVSOtdF4lvVC4c0Cz68E/YzCbouA1ft+3itp7l59t93ath6Jx1J5n/2jF+m70qjA18PthXyofVPWSViw2jfXoDyoFLq7CgzyeebFq2C8u7eA4xR8Ui2T84hdiJW252cuU0aSxCKP2g31clJpm2VZ54+E45JGhP1thDlIhP7YSJW9YX6aeR5Aw2CT4wng02+2lu4eGIm80ViRuV6E/z8mHD9+fXEAtHM7PRvMWyzYLD/ihBLhcz8K0yE0FlkQiHxe+XTFxAHbfmzP6+E/DQEHJNnJ+T6+vkKs6h9aFQkUftoTB+6xA+zna9I+b//jrQtpa99GkBY1xDEeN1S8XTC9GCoOP/6/VUefjsdF3z7+YEZYLm6BkIIvWMlg2cge/SO0Nnmi+w2r+aLJWuWEnyQX95Cv/dEX8m6cMLyC7zJ/5wyKnH/UBg0/FGQ8awNqZplkEZ9qxOVuPBVvk4fCRddTjJR5MbvW8OebPa800tjhqP9gUMtXmTf+BvCkT78G+g5+Kf -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available compute environments in a user context. Append `?workspaceId` to list compute environments in a workspace context, and `?status` to filter by compute environment status. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-credentials.api.mdx b/platform-api-docs/docs/list-credentials.api.mdx deleted file mode 100644 index 1168c404a..000000000 --- a/platform-api-docs/docs/list-credentials.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-credentials -title: "List credentials" -description: "Lists all available credentials in a user context. Append `?workspaceId` to list credentials in a workspace context, and `?platformId` to filter credentials by computing platform." -sidebar_label: "List credentials" -hide_title: true -hide_table_of_contents: true -api: eJztWt1P20gQ/1esfQ6BQoUqXu5CjqMIVCrS6h4qdN3YE2eJ7TW7a9I0yv9+M2s78Vc+EOREgBdIvLMz85udr3Vmygz3NTv5wVwFHkRG8ECz2xbzQLtKxEbIiJ2wK6GNdngQOPyBi4D3A3AKGxwROdxJNCjHlZGBX6btdOIYIs/5+cdYqpGOuQsX3k/HSCdAXvXNc6qcQ8vhdnsccDOQKsx2D0RgSExhf3+Ce8I4MSLynZy8zVpMxqA4IbjwMgzdAsgWi7niISA7MsCURfgF6Qr6Io0g+PcJqAmrGuWfucpREoISriMs84EAhcTaHULI2cmUmUlMjAXi8u0SKchN+uj4I5vNWnPpC7irhX/N6BxtFOFeLTolQkF4sgp0LCMNmtYPDw7oX5n39SXysMcQGVrlcRwI11py/04TybQuQvbvwDVkVUV2NyIVUHSrBTFXihMmYSC0zxXcJwJJyROtJSyfB0SlyBtXyxAe/Q35ryuIfDNkJ4eHrSryVmbgEt2Hg4MGwpIxaiYsKFZhdlzl1WKAnkGQ+Jj8jf9OFOT//0WrKI7ffCn9gB77wgyTfvoBQww/9IXpJ+4ICLLWQ/w7+qSzs+EiArWngMSY8R736bBoyQOMhlCYlBHwXKCCWNJmDfcYFmnEzLXZcwOZkMvpI3aLGPtcw3cVVO1K9oq5wZAhP2ENxkM3AV+iw1Z3Nho6wOjzCkbuSxkAjxh5KfeuowD5GJUAEgdcm++6RD038zyePJS+Z4T1nxoHWsQEwM1TmFg1Yu9pTEYw0etDxxPkh6GIuJGqSViFL0Gsbsk4Tr6k2aW83sITimPiRQF99PwaoXO5Lmh9CZPGSNKA6cE0rrbYWKH3lpih5w17ZhJAx3I9i6gONbkPmcJgENGz3lEP3AR5TS7J6rN5nG0BLVXAPM3U0wbXGmtLo9tUsRb0Pxfmc9KvYihE9I7g6JDGN6RxI5YsHTaAwa7jemAL9HPD7HPjDr8sw6mRDWbVpet298a+m3HbkL5qt4rJpk+GjqWdR+ai4RAphwcC1iz2bORuBIV6jhKYMzrp/PDLpWxLvrz0DB/jy8Tbxx5SNeWywoF1c0Q3GXkOdV6lt4ASzRghp6zXbUBKXe1fooEZ+eaQq7V5tOOnx14KXWpHtoGGNg+o5VxybEo84NrGwWfkCBp6uZVxd/mplqioBdsC2seiIaeNhwo7tEdC6vU+12ph2nxuARU2QA03kNWlzipTVXHRBG9By409YztF8VSYU4utoUeBDW5XL6O0n5OytWApXTP+17r+rE0nmgRv9zeYEDuq6T5YTJHjasp4aqEuFc+etWg3tWjV3IV73454TRc17lqNG5yf7r+vL9wxUK54vZcfb6WIvpwoyF58bAHjrnbwtCwjeAP576W2FbuRIxsv/28jLb46lMt6vZ3xxFqP96quQm/lFvtehHcs8pa+OH3F78peywuy3fCwpTex95fxb+pl/Ps7mq2+o3nhRnyWX1dLpijdeAvppjASMisuVCZ0brJBFSJCqo9Noyqn3HNodgR0Ovyw4cxKcdwkRLCYDNaPmeSEK/3rTCmpapof1TW/zoeTnEgaGq2SY9Rnlp6bNZyNu1PA0qM6CQ1R/Lgl+4ZghpIGmnw7F0LHhl/23dJoE1aJh3yuKaE5DjY0JtYn+/s8Fm077NFO39C2hWTV4aLUi535jFGX6J3O1wt7wLl+PTJnapqilnPrkESWDSNZ/7FE+CT98Hc+KnE3Nha3iAbSbi/FkhW7TkGCK9BrM2L7o6Jr/aAMvggZXUHQGon9c7GAipDlUjkf2sfH7QNbWqU2IbdulE1qXVXm2KpKThfuuKPzc9k5Erd9fC4iMkSSTgWlblcbGxyimejxdJpNEM1m9DidYSNnxCSX5ZUBboEVNlszXteo3IiSXWWC74EHCVHaDLy5+JUDdiuElwb4FrJv6YsSJNwGMpoKszkNkaFR0p2Ud2NT2FXLYaXwPz/7RhW6HHOVGCuWbh5NCrzxgCzFN7pU4iHl6qeXzNktJq7/AF3I1xE= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available credentials in a user context. Append `?workspaceId` to list credentials in a workspace context, and `?platformId` to filter credentials by computing platform. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-data-links.api.mdx b/platform-api-docs/docs/list-data-links.api.mdx deleted file mode 100644 index 47546acdb..000000000 --- a/platform-api-docs/docs/list-data-links.api.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: list-data-links -title: "List data-links" -description: "Retrieves all available data-links in a user context. Append `?workspaceId={your-workspace-id}` to retrieve data-links in a workspace context." -sidebar_label: "List data-links" -hide_title: true -hide_table_of_contents: true -api: eJztWV9v2zYQ/yqEnjbAVtKk6EOAYUuTdjDWpUGSdg9bMNHSyWZDiypJ2XUNA/sQ+4T7JLsjJVmyHNtLN6wPfklM8nR/f3c86RaB5SMTnP0aJNzyvhTZgwnue0ECJtYit0JlwVlwA1YLmIJhXErGp1xIPpTAVs8wkTHOCgOaxSqz8MmG7DzPIUtY9P1M6QeT8xgGyXeLuSp0v97pi2QZMauYLkV0eNakNePfsqAXqBw0J/UGCSr4Rhh7iQ++cfr3gpxrPgELmkxbBBkukKqhB9IIsuxjAXoerNv7Sy0zKyagRcxEApkVqQCNxCYew4QHZ4vAznNiLFCxkTtKlZ5w67dePA+Wy14tPdbgmHBpdsm/WJHukGzQa9moJccA1/F4u4DXGoCRM5mnZniG3hKc/fXHn6sQMGLJOAbxAebovcScsUjDCJlEPRblWk1RPR2Fe6o24Z+263XNRyJzYWVIi6AwhbRmf5efnrTkqTQ1YPcWWZM/TdpUGDEUUtj5DucLib6ujGPDOWs9+bgjMS/xoVxlBgydnxwf078297c/IQ+XKpmlU57nUsTOwKMPhkgWXRFq+AFishxDiollhReQ1Cm1IuVac2eghYnZzUIkXUvWHXJZ480TNDAfsh8ho0yHhA25wb8Ypwp3PUZ8e8wjsueAig7CAoOZm3M7DoNlr4zOLh2uCOkqZXbcKEHsGwhHYY8Ni/gBrMuGbx3P1rM7zVutOhJCdlVgSUVUNQsfL6zqJ8LEagpYCliq1aRZCFflwWlT2XwD6W5tbpoOcoJbCvWw6saySCgMdPDuZsAcXKByRmROz46OJvO+9woVgpFZ3+GfcYfHsSoyGxIaucAwRt57XsF14K5QQOchuyi0RivlnJkiz5XGVIlKAVRv1q0ELNV0j3kSusM+9WmvP+WaAmfah1ZYCaVUgvgdsVs69DpsdfW7kKpIaux1PRey21pPPjPOL0qNJHh/FHr143e0S/N62Y+JNS0NfESwx2qSF5bICdHo760GoyxceVH4w3Gs/ntB1crLoRLTFEPr000uua5c4SA22gvr3kme+tF0igrTB25s/xnZDAUVjP4MjH2GAGE/8zkb0s1b5oVRiL3K7R7wjQTYVpk0fCwEkpKXBNntSkEjxve9f6F6NS/rbv16WgVaz/AtqGxIj1sI/Z8xs+weNnTtFNHgnKJH9jdsR19wy2KOfWAcg6G1MM2MezXJ7dyhJC+GeM01iqj3m9s9dw+LoWxGYaiUBJ51e78xYATWcpuhWM8LyxGv2bGZsGNV2E68xiLB9R7S3tc3P2KH28KwVPJRyAYpi6wuqAa0lPCM/YWQQMqxg2ASm19sIWDmZXs+m/CmgSdvMzkPzog1BljKt6lrkHdRVrh5f/5mcInngyv/awMCwlsvf9l5i/AHG67ACwwwZnzkeEYMoxmVAiIsqnjx4vtBvcNmY3QAN0bFwrUFTbxwjYxBYuefOF9g2Td8tEfyvdIaxZbkDlAim3IpkiaiVnd152gj3i+t2oLzVVx98fHRs8pyeSs+wz6vF+u87+hhemcZIoCbIgy20zYeV5e660s362zoVeqm7DKRgmhOjk+6hYeSKkc/H7rNQ7d56DYP3eah2zx0m4du89BtHrrNQ7f5Rd3m801fNV/y5AbrK1btf9JvNktyFZydVfjRKDYNcBHsKH664XNsNadgmbI0PlEz1MdRP+9SXyn7GpuYxH2GX7VgiIEm7ohTSmQ9VrYF59cDylds4mguk9DkhLZrDuHX6jWqIBAXmj59U2l4CZhU+rywY1zeU1ZPsEAqmvGM3Kd56iNxcdQYVxELPa1mPYWWeD62Nqc2kecidHdK6G+UUKgOjm/dCbuW3BLime8q0KWuqlTq3bq21NnaVLI2lyRWX+9dDXZEuON/vK5y6cPMOp+ILFXu8dI3pRYkdpeCZK7AW6Ekdg1v7ALbNr5pMsZWSJfKqfphdYCKkOe8nGfhixfhsbvJlLET7nBRDjcoUVnL6WtvJTW8vsZpYRkj2jjKJb4dkJHOWYsSUesD0DF6gHYXC3oRfKflcknbfqJDOKtyLThLMSdhiz92TBM36vYAKGVtYInXQEGUAc2c9hf/6DBxi+D1WeUTRf8HY8YtSteDzydq++jwcYtMP9H8coH16HGLrJrmqdHYPnfcIrlFt5J+TwuMpmt1sVpj1mAnR+8NmB/+Sf+VqPFU5+pp1fgfX93Rq0C7sq5V0mYLybOmRpirjuJOPUCG+Vqpb2mNgvC6+RtxT3Qv -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves all available data-links in a user context. Append `?workspaceId={your-workspace-id}` to retrieve data-links in a workspace context. - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-data-studio-checkpoints.api.mdx b/platform-api-docs/docs/list-data-studio-checkpoints.api.mdx deleted file mode 100644 index 8f9c15946..000000000 --- a/platform-api-docs/docs/list-data-studio-checkpoints.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-data-studio-checkpoints -title: "List Studio checkpoints" -description: "Retrieves the list of checkpoints for the given Studio session ID, sorted by creation date in descending order." -sidebar_label: "List Studio checkpoints" -hide_title: true -hide_table_of_contents: true -api: eJzNVktv20YQ/iuLPbUALbmJ4YNOdeykMFqkhp2gB0OAVuRQWpvi0rtD2aqg/56ZXb4ksbKcFkgvEsmdnfnm/a0lqpmTo3vpsEy0cXIcyQRcbHWB2uRyJG8BrYYlOIFzEJl2KEwq4jnEj4XROTqRGuvPZnoJubjzioQD50iBuL6KhDMWIRHTlYgtKNYrEoUgNP2TLcgTnc+EsQnYgYykKcB6qeuE7P9BFq8UqqD3srVLkoWyagEIll1Yy5xe6EZlmm5HUrMLhcK53PVrB2deLsDqWOgEctSpBks3LDyV2gLBQFtCJB25vVBytJa4Krwpik0+k5tN1Fh/NvbRFSqG1v5TCXa1B+CvWrDf9p4t8hlm/ogCvlAYPp2fbVl3oGw8P2z4T/+gMhGEKSmaQqhVJFSWmWfORWoBBMIL1jIcIbIgVJ6IR1iRk4kbiYlDhaWbRGIyBUIFEy8wUSkpnPjCcGpJqed09/nUE7+FejkM/0bNdB6qiGSFBVdmvhqOjNj7d1v2TJo6wKNNNuJvsTbmUnKFyana+Ma701P+20nL73Q1NqQlRz5VRZHp2FsdPjgWWXeMtqV5L+OtpkCDKrvTfwP3coXNTB8gZtSF5e5CHXB0L7aOKGsVx4CqYuF2bakS54ad5JRecjtDUr3dcar5Hv/46EZ164U6eR0QXT2m4Cv1+3W0DWvvvKOJ5U5Qk5ZNF/3RV6o47EZnSZOKEVOWdFbHonRgPzPg/87/RmVfDILxvpMKX18DStSY8aevpPo6Tw3L+/T1KaoS2hMuoGnGoYBFgb6Kch4uC/aCeiijugxzcUnPCUfk5YSvnCyV5aS6N92tMe8uh7sAr+tW3w65QhNkmpY5btz2KOU11VlOt1W7kzTLn/U1/AeV3FLtgMPvbXwKl1OzI+qqFjyY+I/WGrsH/H3PpKoXtMgNhqUByUB68bN98c8GP5kyTyLxPCeCwFShWr7aeQ0pn9L+b88vbq75MNFOTTPaHzXFaJbr4P8aMu4NiEtaqSvPST7Q/gR7UXIf3Y95ExBhmRtmNjO/R0KLyWFFwIbrhr5shtuDnfpyWVOd0lKDyzli4UbDoSr0IM5MmQwcPFFuBtrs8x1/Im4yhVzQ4pLlOdCSQdWY7zhoIQBd5E0M2GK9/Ph96oXoS3j4VLfKwzP6QGkeJHy9btSAgs2+BpDd1THxziDM2Vaxz/a2812Xq8nnzf7aHhAQjlyw88vg/Hxw6qebcbhQvlgqMsBdXBfndvC3sK7b2vsB/LhKBdOzYZEp4i28EKyf+KGaWjofyVGXDnd9oqzPKQAsvV5PlYOvNtts+HMgQVxmdQPKUaoyBwfC8Aqb7cVMRHKPMNNoL1lSMkU73vyP47QHPGvI+Hc69Y9M94DNQJ//vcGG5x6w1ci05sb8QnGfcre/qYB+uq2m9M+7LXJ8QdUENl91QbXpqBthMybhOShqKI8ynF/EMRRdd/a2ytb4/u3jFxl4YGc+7sxDr70XFbWcl/hiHiGntqtBIr8zwM3mG+VZZ0c= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the list of checkpoints for the given Studio session ID, sorted by creation date in descending order. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-data-studio-templates.api.mdx b/platform-api-docs/docs/list-data-studio-templates.api.mdx deleted file mode 100644 index 7cba5be02..000000000 --- a/platform-api-docs/docs/list-data-studio-templates.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-data-studio-templates -title: "List available Studio templates" -description: "Returns the list of available, configured Studio templates." -sidebar_label: "List available Studio templates" -hide_title: true -hide_table_of_contents: true -api: eJy1Vk1v2zgQ/SsEz46dtkEOPjXdtosCi20QZ9vDIoeJNLKZSCRDjpx4Df/3zlCSLceO6zbYk0TO48ybT3KpCaZRj//VkercuKhvBjrHmAXjyTirx/oKqQ42KpqhKk0k5QoFczAl3JY4UJmzhZnWAXM1SSoUYeVLIIxDPdDOYwDR9CVnXX/x+Y9A0CCvOyDjPASokDAImaW2vGD8owv30UOGfHqgjdB5qDEs9HOS3zugMjlaMoXBwKCYzbACPV5qWnhRaCzhNIkKFyqgZuv8TK9Wg7XVCp4OW7uEqbHJK8VYFTDWJcXj7b17u2XPFUVEOtrkGv4r1jitTNM7GzncfOLt6al8to18vVcnyjeWOJ872d6bYS4A4pCLNvC+NFliObqLonLZIxnwoTZcJ1Jt1Es9OYJyYv5Dqb3WE3d7h5n46INUEJmG9ebYxmkIASRehoX9/RdUBPQuGnIc4w02UjB2qlesJWto7wgiAdVxVzTQaOtKfAqYuapCm2Oe0ud5Q+IokCdmYFjGnvKytrH23gURss9PJ6LiZA5BCiK+ShcZKoXdpsu+cU9xQiYN/5XE25V7XFztO9y1aCNeJ+q4hjqgL8okuGoLkrGCPttXkh8gv+K6wUi/W2oc0QjTI4qrAx4MzacQXNgh/m5PL3WDT1lHCsrSPWI+1Al+tgv/29FnV9t8oB5naNOwvbj8okxUuYnSe7niAKf99VD87e77v0Mi7YJZHQwt0jT/gBAwXNQ04+WNzCIe9TMnN8I0TTIPItKj9hIa9cdDxDDvroU6cOXqGZGP49EIvBlmpavzYcQHjvbQuJ25OUkSdcnapEDVH4KX0Gqh0bGcSJgal/tc116LxW7gyvo2gXin+fnclf7dI6XQGFu4dLwNUctCzP6MoLhrMowtWPILWcrvtvN9lznFpkydV7j3GwETmTfNz7I3w/Pz4ans8fyjClJ5tBeQNOOBKf+c83JTda98HbThJXyiEe/y/cf8kp/LtiY2D5NBb/pz6mbshYiXy1uI+E8oVyvZbm5PqZWub/S4gDLiAR9eeDzsJXePi513yRzKWpBa7vTjzb74ijhguHmavN7g+g1xwNYaszF3I4tgxF7qZE4DQs7RkoA3py6yDH3/1M5Y2ur/Pz9dMxa22+1ZeyXt3W1vFz3dnPyEuHb3aLkAOuokazbEo+gHPFnGrg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Returns the list of available, configured Studio templates. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-data-studios.api.mdx b/platform-api-docs/docs/list-data-studios.api.mdx deleted file mode 100644 index c964be947..000000000 --- a/platform-api-docs/docs/list-data-studios.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-data-studios -title: "List Studios" -description: "Lists all available Studios in a user context. Append `?workspaceId` to list Studios in a workspace context." -sidebar_label: "List Studios" -hide_title: true -hide_table_of_contents: true -api: eJzdGttu2zj2Vwg9TQFbSZuiWORl103SWWMziTdOOgMMipiRjm02kqiSlNNMkH/fc0jdL7aTLmYH+2RLPOS5X6knz/CV9o5/97TJQiG192XkhaADJVIjZOIde+dCG814FDG+4SLidxGwuQNmImGcZRoUC2Ri4Lvx2SRNIQnZ4u8PUt3rlAcwDRfMSBbhOc2NJUS52xt5MgXFCfU0zJGfcsPzfbiecsVjMKCI6icvwQeEqyFDGEF0f8tAPXptbn4tcSZZDEoETISQGLEUoBBYB2uIuXf85JnHlA4WSNjKLi2lirlxrz68956fRyV2DVwF6+2IL+0fHjEHzHAJmRB8RKKVDyJZsaUCYCSHAkYmjDAwjgI1EKcRN3CjIvt8D4/IdKiP2YIUgEIesUUg4zQzcJZsSOgEttCGm0wv/D7mtFGIt8FKzL9v52PGVyKxCmIIyxToLDJ6f9EdvWvgk8ulBrM3yhL8ddi4QY7vUEJ6T2WVG9iGRxloMuQ7QPMNoiyEkOzYrIGkkMpEA/tpgQ4CkV688dkVmEwl6DoJQ92ZR3dECXKMFhhFizdMLJmMhTEQ9iqJK8WJQjSXWHeVN/IALZk82B1LDvx9TO/GG66Ib91cNMJEtL9yq3+TDCYFpyiwZwQrWLIo3x0e0k9LSP9C5NZzE0OrPE0jEVg9HXzVBPJU40bBt0woCOuxBomRhkdz8QdYyhxj8u4rBKTjVFEwMMLRUGzaLZmhA0DrPK50PGDUiCD7uL+NRMj5yRqC+1QKJ4PtFAQl7N5Iqi0X1oR7KN/OlxPbwObnPnM4NdKftXlDSAozbU1iSjCcKEcti4h0QfGXIC3GnUoV+8qhPLKPR4e8byWnbyvnNxQ+k6Uk+GQIRcP0B8WMwbl3tYrLfUaCCeByabPZC4RVHT5IM+ULkmTvooJVPy81yZyUZJ/eoVV4FElbFo12QOmTR3qLX52KXhU890ajGlKL0isy327/UpBKLYzEiN5HiggGlUc5cltsVYAqjLGwgdAmixRfIEn0AN+RAoFrGMnI9hOdpalUtNgfil99VldWn7EMQi3OHf0kKyn7LLDXz68LuVoDTZZilbnKa7egV2lGP7FIREwCOhxt92FKw4jkVbtiiHOFvnSjzBJbPO6fTElQkGyEkkkM/RGdh6FwxcGsIZKuW2J2p2LZOzYqAyfjkJ81T8cS6hySlVl7x+8O3/9t1D0mEkvMxDz5p8yUfrEUehV/0lA2BTe0ghMF1gh7nKA8lODGBu3TEsa1uUnDl29Ca1Uv2gTLJcpebOC8LYs9rIDbnchyQmdgRbPNGuqpjUid2M19aayK2f/H6bAd7Wsi2VN5jRg/aanConWx1yLcXcHtjNOabMu9UlmSuH/ayDSt/XWhVimp7L+7TEShW7Z/P6H0BoP3fxdB1zerUI4INV/1a7jyvf29iCi7Aq77cmAlwJOrs9Pp9fz26ubi9vLmGlfOp5/O5rPJxe3Zb7MpruKr+ezy+vbq7OR88svkenp5McRKibA/Ds0r1VOhwDfwkcQzVETdcQ3TeEgkQYYMxu31O8yHwG2QE3qmxKYpstqyzRYQEnXnIrn/gT6jr0xrN5iEZhwhHuYAalMIn/0MCc1AsL0klkMaAyCGDYKoEaNzR8xVbyPb4mOnhvEwAJZys/aHK8I2DRQ/sKG2DWxY0vMT+Ct/xO6y4B6MHT+88XcWwB32qqcOBp9dYGZkaKTVO2ySMyPHodCB3AB6DVsqGdcHRFWd6bvq1fF8Bcvd1FzVBWQRNwga5e08qYEWbq6mzPatUAhjoY+ODw7ix7GTCk1aVrr9hv+Bb3gQkB351BZzgWpcOOk5AtsddGUFtO6zk0xR2xU9srzu02yRI6DRwJDPOpCBgFUt1h2QTPyajnu21mttq0vfSSSzsLS9ruR8Ni/p5A/aykXKVQROHpmq/twiX4qXj+OAjqZHDd/Q2PMGaTHKh1ZHWxlGXPjkUFEuphOLX4eoeHJ4KC7X0dDzUZ9IZoUotjRIbetyQnLQg+60yPQYQ6EZvyWeIaOAMX4Abd7SpOgX/khTpaTwCy3R9gqxO4OvOcC+BYytPWwoqOn4ZSXIEMsVMT3x63URqO3hW6yyhj1oWOj/2Gaeu4s1WjtB1JuQ9oj/Gu8oC25YwBOGoQQrAHwWuu5xZ3aUSFaSZneRCGpB1MnNvp3YzcK2H51s15mJrwE10PJthmjdWRiOeHkcexBmLTPT0ddahPi8B7bPAg8SkUAuXD3HlhFf+Wy6ZAvqlNBBGkS4g11CCGHJs8i4u4SNgAeHe7guxKYmvEyiR9eE9YxaBiELu/k8OZ9SzTO9cP96LMAvirbO3Ylb6EmBJ6hg9PiFPXPBUJuLHMECgyomXiOrN+xhjQLgWstA2LKgbi9c4cEQgR0fbysb27SdUX3KcnBrUCLZ8EiEdYuqcnVnqdfe7cjGee8Kc/SPTGt31vp0z+TeiGRcIkRryNBaIWwU4b0F6izfMzeQ+vsV3g+YWfHvPnxVY65duK3E8gF999zmHOF1Vei2VnJwfGivKwZmh66gGiq0T52bDi4/Ik4RDC1PkViVyqg1WajBvGJeUVPCOUk6H2gOTsDdjvJ2Yr8LwZ6j6ALzKr9KIXQI9L7vMuUjD68wd2NF8NpLlcJsd2b4YfuucWCjQ4fwo55boOK+liXSuLvMPBK9P3zfBb+Q5hNWyOHIBTUKi1WVj9GeDlkSAMXEEmQym9Ii9gfkCWFZiZZb/b+q1Oz9TJApTHc27XwEDNhqktHE7/cvlDFiTL6S7rpX9mKTehR8OKjuyDSoTXHdnVFv7K2NSan/4KnwbbHiu1LFF7IT5ud2hc3yuwDmylUUqE1XBW1z2+9YRusUlrwSxuJy0jqjBaKBhv3zqXCFrw/GCkQU85xcMDkVhHYXgcSuwHIjB7adVGC12mS+znI+8bJo/1EtUBBzE3Jce+t/+OAf2hJJahNzaxT5vfB57duENoFPlWH92d9C5MKnx4M0wn7Sjv7ceMTZSeO7jTXyRa+enmhucKOi52d67a64yXoK//GOl1g6wBZGd3wm0UvYPSCW1pcYeQ7x7DBxf/R/gY8ltrBYfu7xSu4GP6HYgtN9l/HjCMsPKLbgKmF+VHt//tcTW7hqfPtRcfaFHtC0bIWFERndCDsB6jvRYdxOaqbSujw66aURx38+o7EpbwbQVsCstyA8eaydjc5rIa7lPSTowAX5hp4REaaU/wDnLw+V -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available Studios in a user context. Append `?workspaceId` to list Studios in a workspace context. - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-dataset-versions-v-2.api.mdx b/platform-api-docs/docs/list-dataset-versions-v-2.api.mdx deleted file mode 100644 index 4fe6a5013..000000000 --- a/platform-api-docs/docs/list-dataset-versions-v-2.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-dataset-versions-v-2 -title: "List all dataset versions" -description: "Lists all versions of the dataset identified by the given `datasetId`. Filter by MIME type to retrieve specific file format versions." -sidebar_label: "List all dataset versions" -hide_title: true -hide_table_of_contents: true -api: eJzNVktvGzcQ/isETwkgr9w08EGn2rXTCm3aILHTgyFA1O5Ios1drslZOYKg/94Z7kOUtZEVoIeetOIMOd83741EtfBydC8zhcoDejkZyAx86nSJ2hZyJP/UHr1QxogVOE9nXti5wCWI5o7QGRSo5xoyMVsHyUKvoBDTRmGcTRPxQRsExwofxx9vBK5LEGiFA3QaViB8CSm9kYq5NiDm1uUKO4uJHEhbglOMaZw1qK7r5782Sl/fkVapnMqBLDGrjSzoD2k/W/foS5UC3R1IzbSeKnBr+ZLsP62iKKocHMHpyDkG4dMl5EqONpIJ0AVdICzAkaiGXB9dvJfb7aAz3/mhNV4qXB7YbugITx4pFi8MO3iqtAOijq6CHiD1rT2zuc7hlqVHKf8dPpSJ4jKvY/UGkkUyEFOEbzhM/WrafqOanXlgVyNkZytlKvDTt73+6WBNmIMvKU7gWf7u/Jx/XmD5g95ILfm0QJaqsjQ6DVEfPnhW2RyasLMHSJFj7zhHUNcG2tyJNJVzih2gEXL/+gu7sB3yGbTSv4Kvvy+/jgn2qC2V/x1URim0k86sNaAKFjcsTso4cp0DDsnVmvV3KXMv1YrQ8B1ynTbsAs7FyoML+Ck4x12hsxMRdE/2ca2N90kafH3pLFGj4aM7enpczC3rG+XxrsyY7OGlCBdrnCHVAV/izvJdbDlkWoVq6ZPGDeRER7g+phGd/e51jcQrFvc0uM9N/bAiab7vq6ArlQkOPHj8kVKKcyUH79XihKRoFY/SvHHOugPkP/fUftvfRWGR5419Jjys7iGtnMZ16OhXoBy4y4oa6Oh+wm2F2v3S8kxYQMDIvXUkh+1EG266Ot4Ou6bAr7pVOyZCsOQSsfSj4VCVOkmNrbLEwxOBSrQ96JpfgkR8Mgo59uJX1heXn8aSIbWIv7CDa2fFuDt/scW2a4bCD0p0Un98aLPq4RmDJzSnP19vnNugYLOvAWS6OgXfKHNmqDRkxj75mHJTr8HsLztB3JbkT8nFRXLOZ6X1mKuQWM0A4hwOm0O7KUTuz/b7Ypep/5t9owlRGHilUbqIqrrOsWhrGshRPOQ7npQLS3IL6242M5LfObPd8nE9jDn5Mu3VzHDtzZXxcMQ1r20nvZAfYX2wAYWRTaeSt4XT7f+nq8IRsNHiskM64T9OM9QfdNubz013eyuO7li9iNrVoVjHaFqku6BvJzzMm0lO8Gr5ZZpCidHNgza818F+u7klXbXfJF40hfB6LyrKsKBxax+hoCxrQSL/Z4Db7b8c3h+/ -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all versions of the dataset identified by the given `datasetId`. Filter by MIME type to retrieve specific file format versions. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-dataset-versions.api.mdx b/platform-api-docs/docs/list-dataset-versions.api.mdx deleted file mode 100644 index aa00b0538..000000000 --- a/platform-api-docs/docs/list-dataset-versions.api.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: list-dataset-versions -title: "(Deprecated) List all dataset versions" -description: "**This endpoint is deprecated. See [List all dataset versions](https://docs.seqera.io/platform-api/list-dataset-versions-v-2) for the current endpoint.**" -sidebar_label: "(Deprecated) List all dataset versions" -hide_title: true -hide_table_of_contents: true -api: eJzdVsFy4zYM/RUOT0nGttLtTg4+NWnS1tNuu7NJ2oPXM8tIsM1EEhWScurR6N8LUKQkx4qT7LEnywRAPDyAACpuxcrw6ZwnwgoD1vDFiCdgYi0LK1XOp/zk5GYtDYM8KZTMLcPvBAoNsbCQTNg1AJv/IY1lIk2Zv4ZtQBs0N4ujtbWFmUZRomIzMfAIWkykiopU2KXS2VgUMkrRfOxNx8F0vBl/OGaow+waWFxqDeg9wJicnHzNv+bk2DjPwYyppTNYyQ3k7Ju/dZZ8m/ARVwW6p7hmCUZGxpeN/G9vjTqF0CIDiwfIS8Vz/IO6T0o/mELEgJYjLomYQtg1f87WP0GP5WUGWsZMJohbLiVoVNbwWEoN6N3qEkbcxGvIBJ9W3G4L8oOhwcqpEjvCNkdnH3ldj1owbVAHofjQmLFa5qt34miMdrxmMoMbknqnjyXo7Z7XT7NPV4wuYUuZWufs5csXhMQUSDwYkn84PaWf3Rv/+h3viBUSk1uSiqJIZezSGN0bUqn2Xai7e4gtpVNT0q1sHIQq6WkKrQWFIS1k5vUbOu734xkF6Z+OsZfll/0AB9TWwvwGIkH2OumdUimInMQ+ijeVDVKngZ7qxZb0u8TPudggGrJB6mRKFFBBlQa0w4/JOUyFTN6IoL1yKNbG+ZDE4xsqSm6lTenoFq+e5UtF+qkw9rZIKNh9ox4u0hhbrGYywiqFF7FlkEjhan5I2u8JbyRCD0XaC2e3HV1ajKsvHuhYX/z7IUXU/Dj0gi5EwijxYOx7nlK/VjIwRqzeUBRB8WCYV1orvYf8x4G3Hxo2y5WbMOoJ8ZB6N4PaHgY4JKTdurZ9AUKDPi+xL07nC2o02NPXitr+ChxqaplTHrVJNFHVS2gdhYkYVe2Tr6NNNyew8DZhSLi88jDqcKRN4lSVSTfv9trktZOwz34Msp9Jn51/nnHCGkK5plw0vPYDaqklj6HBuh7hlPCk+fglFOD9k3WkSXopZO7z4FGQ29cAUrgSWfLKVEQidkW0G3w/ZP+0ndufOkG/g/EfJmdnk1M6K5SxmXA16CfO0WWb5GP24o7xHHrVVfj/annxObfwryUEMu91lKaa511LIlamu0tLu+KhpL9BtDxi4a0xB3RPVd2h/FandU3HzainSk+kEXcpPbqlSA0coH5gERiM4AG2u8vFRqQlqbmXsBFaksN3Oj/64nvXMXtlIxvEFFaDfNvHE7D2aaX96LtgHdrOvgNTl9B6QQuE3x6QtEZ+HsdQ2J7lXuvf6ZG/Xt2grtjtNs+6i7t9EBVWj9O4UQ+QYwUFkJb+E8C6/g89KFLo -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - -:::caution deprecated - -This endpoint has been deprecated and may be replaced or removed in future versions of the API. - -::: - -**This endpoint is deprecated. See [List all dataset versions](https://docs.seqera.io/platform-api/list-dataset-versions-v-2) for the current endpoint.** - -Lists all versions of the given `datasetId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-datasets-v-2.api.mdx b/platform-api-docs/docs/list-datasets-v-2.api.mdx deleted file mode 100644 index a96260396..000000000 --- a/platform-api-docs/docs/list-datasets-v-2.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-datasets-v-2 -title: "List datasets" -description: "Lists all available datasets in a user context. Append `?workspaceId` to list datasets in a workspace context. Results can be filtered by search query, sorted, and paginated." -sidebar_label: "List datasets" -hide_title: true -hide_table_of_contents: true -api: eJzdVktvGzcQ/isEz6rkJoEPvqR2nBZCjTZI7PZQBMiIO5Joc0ma5MpRBf33znB3pV1r5ThBLs1JWs7rm4/z4EYmWER59o8sIEHEFOXHkSwwqqB90s7KM3mlY4oCjBGwAm1gZlC02kJbAaKKGIRyNuHnNBbn3qMtxKfXDy7cRQ8Kp8UnkZww5OiR5U5lb/4eY2VIrsCKGYq5NgkDFmK2FhEhqKW4rzCsRyK6kLAYCaBgHhbaAn2O5Ug6jwEY/LRo4F82Qf96QWIPAUokp5z3Rlr6ILUOWNLRnHiOIx/T8fcOsq1KDFoJXaBNeq4xjMV0LlypUwZmMnFPUEW+o1piCfJsI9PaMw5NogUGEs1dKCHVR6ev5HZLNxMwemcjRrZ4cXLCP314f/5OpjmATSwF741WmY7JbWSVzWFQN7tFlZibwOQlXQfY1cReE0IA5kQnLOOXPeiioxNT0HYhtyPJLLAg4H2l6XK5AKm4EnDeBE0bDsEXwZp/8A1R8l8R6jiLHZdDyOrgQ5IG36GIZEknw0c35Hpq5471uwX1PGAuLMDqf3el+ywjeywTAzHd+IKb4mL9o5Pd64EBfyUWGq7z6YCUSXoTkKk6lHeyYr2fkqZs+vw+36hAg32DmXMGwdYeZ2i+V7N9U82swFTDEho8rgoKh5HreIlzoLF9VLymmFodE08JbPDOwFFuvuGKOqVyxcxezi6Ty8crmv39Snli6u69NFuk9tL13tkw75sBzRqk8mpoRF9AIbgZMaavmdXd/i0xRlg8o1FbxSc76W0ILhwgfzmwXNrNKqxL/CRwD4SH1SOqKui0ziv1gvY0hvMqLenzI+8t2rdLx9t4gRkjsEhOdguGHYRVu5KrQFNBLlPy8WwyAa/HyriqGEe8p/hj7Q6W8ocsEe+ogvgCxRvWF+fvppKjt+A+MJc1L12IO2o4YruTc/1lJTqp//zalsbtQ8pJa54+bN7w2KDgsF8CyOlqhbFR5iIAlYugn3w35WZc5rC/7AXdgpY/j09Pxyd85l1MJeQaap44V93312OEm30h/v9efM39sbuJN6DzyMhEbppa6z9wl8QNn202Mzq7CWa75eP6wccVWOjIWVPFzsFEfIKr7/scHEzkDtcHD9RmUstc3ysImuHmbqPsEAp+X1Eetem5UuhTx+pg0PR69Le316QL/d541AvZe7um7LrjmzjNGtfuDi3x2uJP/E2BaLr8B0m4Sco= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available datasets in a user context. Append `?workspaceId` to list datasets in a workspace context. Results can be filtered by search query, sorted, and paginated. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-datasets.api.mdx b/platform-api-docs/docs/list-datasets.api.mdx deleted file mode 100644 index 5671fa6c9..000000000 --- a/platform-api-docs/docs/list-datasets.api.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: list-datasets -title: "(Deprecated) List available datasets" -description: "**This endpoint is deprecated. See [List datasets](https://docs.seqera.io/platform-api/list-datasets-v-2) for the current endpoint.**" -sidebar_label: "(Deprecated) List available datasets" -hide_title: true -hide_table_of_contents: true -api: eJzlVktv2zgQ/isET0ngR7Zb5ODTJnW3MFrsFk2CHlwDpcWxzYQmVZJy1hX03ztDS7IUy0la7Gn3ZJkznPnm47xyHsTS89GUSxGEh+D5rMcl+MSpNChr+Iifnd2slGdgZGqVCQy/JaQOEhFADtg1AJt+UD6wysTsZBVC6kfDobSJH3j4Bk4MlB2mWoSFdeu+SNVQ45V+daW/6b86ZShjYQUsyZwD9FS5HJydfTFfDDnxTGjNxEYoLeYaap9MmXj1wbp7n4oEjVgT4B+EK9GUWiiQbL6NOku1AcO+1qoT+XXAe9ymCJNinkiMmpyNK056PBVOrCGAI7JybvAPKjVMoI4itlIRVvwxhZ9rVCZbg1PJHpVDZQffMuUA3QaXQY/7ZAVrwUc5D9uU/CAHsIyqRJ8Iu6OL17woZnTdp9Z48HTj1fk5/bT9//0er0ZCTCCpSFOtkhjs8M6TSn7o1M7vIAkUuyNqgto5qBNlrymcE1siIMDaP29ByYaOD06ZJS96PPMYIQr2bEw5PnQQFDdCU5pcENGk+Re9AAb/E66Os9gw2YVs57xLUuI7FKEsqKDp6BZNT8zCkn4zYV4GzLqlMOp7nZgvumSORaKFD7eppMq92v7XyW7VQIe9NUglbuJph5RIeuOAqDqUN6IivX5QGE2b35dfkqChfWFurQZhdhbnoP+tYvulnNkInXVLsPHYzCXQjVz5MSxEpsNR8RZ9quSYeIJgXWq1OMrNLzxRI1U+ELPj+TjYeLzB3t7OlCe67t5KOSN2VprWG/PjU9mgSQNVXne16CshGRUj+PAzvbpZv2vwXixfUKiV4pOV9NY56w6Q/94xXKq5yYwNNJ7tA+IpYmJXa0I92QBnuwrbOESvQDhwlxkOzNF0RpMMJ+zK0vRdQkRNs3TEh3XX9MO80UGLodwPaKz7TTWdM4cNhFdLCC4bg0TbTO43kYMBfR0l7GO5oLA3pM8uP044wapQXxPtOwqb2GsWySMvx3dM1aiEJ7uPP6ssunsIkR9FjYqul5SXKMjtcwApXIWElMqULyKJ+dIOvhly2Vmj2z/2gmbu898GFxeDczpLrQ9rEdOt3HZOxvV7nrK48R3uYY+B5/tU/t8skmU20CVCqmKvis+Slyk93S8CxNiovUc2V/EVvgLp5/kcz26dLgo6xj7hqIhm1J6doghi5kvl6RtLaCG0hyce4+RT2TlO2TPbaWc41TAyNIrKCcHx8x62j/biYobqKxCStjuEuNO4TBJIQ+PuQZtr9YN3b29QV7TL7VF5ReuduJC8qHFj78EggRXMQP8JYFH8AFFrgAA= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - -:::caution deprecated - -This endpoint has been deprecated and may be replaced or removed in future versions of the API. - -::: - -**This endpoint is deprecated. See [List datasets](https://docs.seqera.io/platform-api/list-datasets-v-2) for the current endpoint.** - -Lists all available datasets in the workspace context identified by the given `workspaceId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-labels.api.mdx b/platform-api-docs/docs/list-labels.api.mdx deleted file mode 100644 index c65285178..000000000 --- a/platform-api-docs/docs/list-labels.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-labels -title: "List labels" -description: "Lists all available labels in a user context. Append `?workspaceId` to list labels in a workspace context." -sidebar_label: "List labels" -hide_title: true -hide_table_of_contents: true -api: eJy9Vk1v2zgQ/SsEz46dbYsccummTVsEDbDBJos9FAE6lkY2E0pkSSqJK+S/d4b6sGXLijcF9mSL88g3M3wznEoGWHh5+k1qmKP28nYiU/SJUzYoU8hTeal88AK0FvAAilAaRY0VqhAgSo9OJKYI+BSm4sxaLFLx/f2jcffeQoIX6XcRjNB0TG9fB+g2y4k0Fh0w8UXaUF/Wbk2kBQc5BnTsbSUL+iDIBg1hFDv8o0S3ktth/NvRFWWOTiVCpVgElSl0BPbJEnOQp5UMK8sHK/JpEU2ZcTmEeunknXx+nnTsOTyNs17BQhUxIEFY4dCXOvjD+d6+6fGZLPMYDqbs4K9j8wguWY6zfVaarkTUUNHd0RCnD04Vix5DtIyeH69fNLh9R04k0qWyiL3KrWYoZdqULuG/JF1W9dMRg44ewDG5fwEdVNDY8t8w26bfyp9jBnSVhzif1lCRaVgMBTE3RiMURHAbPbGm8OxfJd8cH/NP/9C/vtIhsWSKwFawVqskXvjszjOk2uUw8ztM2FvruMSCqgmaml/jwDngOFTA3L+8X6UHVcykyduOFCbyAXQ5bOnuZCBTk40b2GdeEadK9pkvyFlnjYaA6TAmJdNHh1uATnFdjIw7CiqPCunr5nx+Hky9bALoa/UTD+ww63O6Fvh3owwyM+DdkDY+QEo9hsTow38RCW9RjuP8Jqk0PCww1sDo3bfAoQLv3P/knHE7nr8dUHXb+EVhAr825pH8YbjHpHQqrGLX/0B9Bt1ZGZb0ecsFQ+1mafixWMROZ4FNcqbbZ4Nep4f2zSidJtsyBOtPZzOwappoU6ZTjz+IfarMTgVfR4u4Ip3wJYmPjBdnVxeSuVvXrjmTdVY2HewSw4xt5UeVRRCt1H8+t9d/9xhiyKrITNzeZLHxgmlfcpDDVQn6BswSgCRKoB/8ZsikAqWj+jLz59rA1UmZq3n+mJ6cTI95zRofcogKarrh5fpp3/avWovw/x0kmszz58xqULGkYwqqRiObE8+SYuKVqpqDx3+cfn7m5bqrs3JS5dlf0lkG2uNIlC/MGYN+3eNqZ5RpGqOU/OwcTr934BghrqeY3yfsxo0Rrg7zSrr988YIaTfIvJK0N4SM8DSI32LZmhZG2DaHkDXlLX84xZyxRZK4EVLKEMu43niWJGg3d+28Dr3G+uXTDc9F/Za21cLi6e0MUaw2zqaSiogbc48FlVWXK/4mInoSfgFRmEj9 -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available labels in a user context. Append `?workspaceId` to list labels in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-latest-dataset-versions-v-2.api.mdx b/platform-api-docs/docs/list-latest-dataset-versions-v-2.api.mdx deleted file mode 100644 index 36037a347..000000000 --- a/platform-api-docs/docs/list-latest-dataset-versions-v-2.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-latest-dataset-versions-v-2 -title: "List latest dataset versions" -description: "Lists the latest version of each dataset in the user context. Append `?workspaceId` to list latest versions in a workspace context. Filter by MIME type and search query." -sidebar_label: "List latest dataset versions" -hide_title: true -hide_table_of_contents: true -api: eJzVVk1v2zgQ/SsET1vAkbNtkUMuu0mTtkbTbrFN2kMRwGNpbDORRIUcOzWM/PedoSSbtlXXC7SHnmxxhsP33nyQS00w8fr0q86AwCN5fdvTGfrUmYqMLfWpvjKevKIpqhwIPak5Os8mZccKIZ2qZqsyZfCaeXQqtSXhN0rUWVVhmanhX4/W3fsKUhxkQ0VW5Rx2K6KXEKBWnusor01OHHW0UO8H7y8VLSpUwGE9gmMEDzN0i0T3tK3QgeAeZA3yq3DCRQ3xc3PO5+fsW4GDAjms8F/qkj94TwSTfYwIEKLrbVm+rFCWswKdSZXJsCQzNugSNRgrWxgizHqBqV+ptMl1Qyw+w6dTLECfLrVw5GMMmybo2DS2rgCql05e6qen3gp0YQq8Fv+9iBsRIgnHtax/YDJJemooIPqpnw/b/wSjI48iFBM5mkM+Qz981onTkzPlhFFx/Tj0FTNEL/bnx8fyswnln3ccI9AuSaxQVblJQ+b6d15clrtH2NEdpiSZc5JnMvUBraCRJzgHwt8QFv7HEZrUSM3s8Om11g9B6u/bL2KCHW5T8G8RMk7l2jqyNkcoxdywOCjzLJ1DScn5QvwdPsyMw0zaGOaMRvawdCYXCaSMpcoCfk7OfilMdiCCVcgurvXhXZYGX0fdMDJDuSzdcOhBObbin4OnmyoTsrubIlzicUTcBrKJyxq/i63AzEBoli5r3P4HCuG6mEZ0NmfPBTGv2CxDams8/dv0jziy58uuDjqHTEniebj9n1aKa6VA72FyQFG0jntpXjpn3Q7yFx29385oVVpSkOf2kfGIu8d05gwtwjw+59GO7mxGU/68lbHCw3pqZa5PMGAEMel+e3P1V4NAIrl5O9hDgvSUqPKn/T5UJklzO8sSjw8MJDF2Z1B+Chb1kW8nybd6Jf7q7ONAC4wW5ScRtRYoxrrSSE5sJ2Vo9uDEK/Wf120l3T1SYG+k5GV7I2iDQo79EUCha1L0jbNUA6ShGjbJx5SbHg3H/r02xKNI/5mcnCTHslZZTwWEYmrunKvo/t6+27YBL9cF+ls9J5pMhruwysGUUcPX5Rc9nHrrm4irZMqCiXm5HLH5xuVPT7Jc38xSlpnxMMqlE8eQe9yj2K95aXRyu8fFzhsoXPu8quXBcTjqn/na2IM1evqsgd7KhzOCNAwPTkdz9bLw9b6zNMWKol07c3Nj5Ly5vGZf2OzwrY4O0dsXSLmIYnMRBI9re48lF0ILnuSbD+Jh+R/v3//I -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists the latest version of each dataset in the user context. Append `?workspaceId` to list latest versions in a workspace context. Filter by MIME type and search query. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-launch-dataset-versions.api.mdx b/platform-api-docs/docs/list-launch-dataset-versions.api.mdx deleted file mode 100644 index 795bbb72e..000000000 --- a/platform-api-docs/docs/list-launch-dataset-versions.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-launch-dataset-versions -title: "Describe launch datasets" -description: "Retrieves the details of the datasets used in the launch identified by the given `launchId`." -sidebar_label: "Describe launch datasets" -hide_title: true -hide_table_of_contents: true -api: eJztfXtzGkmy71ep0MSeleIIsGXvxF7/dRGStZwRNkfIcuzx8RUNFKhH/WC6uiUxDn33m5lV1V39ABokj21cG7EeAfXIemX+Misz68te7MzE3ptPexMndgSPxd7nw70JF+PIncduGOy92bvgceTyOy5YfMPZhMeO6wkWTuVHVY0lgk+YG9CXnpME4xvmTngQu1MXfhgt6IeZe8cDNpS/dyfD5t7hXjjnkYNddSfQ2bkr4nP6+US2fMUjAT8KKDl3IsfnMXwBBH/ZC+AD1NCNQQEXyZ078c1ecQyySSZgJMEsIyxCAiL+R+JGHHqPo4Qf7onxDfedvTdf9uLFHHuQtfYeHw/TTu/D6FbMnTHP+v0j4dGi1PFHXZAFic8jd1zovNSZG8R8xiP4aRpGvhPLr359Dd1/RlrFHCaDC6xx9OIF/iff4fvfoOo4hFaCGH915nPPHdMEt34XWORLudNw9DsfxzjFES5H7MoO5NTiX9kc0U7hnYjDvzj2uTvnnhtw3DerW3Mn+K/vPJzzYAZr9Obo6LA4xUi6P09ifhrcYekg8Txn5HG9No7nvZ/S6psUwXCn7gw6pNWBfj0nxtmr/GZFYfXT2pGMoV9cRMcT3Ul5oxT3QCcrbqw+g06ZGi3jwZ0bhYEPPzIngaMCheSiNdmFHKlg/AEOB+7fsRcmEwY03UFzUetf/Q4zSGqyAefsk1wi84fP+zdxPBdvWq1JOBZNwf+Ak9d0w5aegoYzd1tjqtcw6h00cWHCaJYb7NKNirvUmbwPvIVetcIOjWZO4P5Jo6s4FWwfqzdCqH/IgAEg7xALEXNf0mEevWegZtUBXUdKjR29rvtO1Qbw5jfOGmpmPEC2KVmrSZNkUDmqXr54USYrT8aHwAX+xbAy7Utk1hV7s8l6iYjhl0DAVkQZ8LIBrecoPgSZIG4OGbSSBLA9xTiMoLEbYN5j5N1EZa73/BS+WE/tSfZJy6FqYp0H10985lHbbxi2XaQkPf4FMv5RJoLDCJHdOPeiMXLiMYoZ/JuOI/w9C8OZxxueOwX6XB6Muci+1RXUR13H+TOJsh/lJ/3b7T9Fw+BO/Db3cXbLzY/JLPdReAmcZ+MLT0zNj44HYjwyv/FDZ5SrEI4dL9ck8Qs10bm2Vs9HrZFvNNZ1gyvMRXFk5bH/tWN9wip/s5GXUKFmXLpEKo6aUoqTJC2hk76WNGLOx8DVxkyWTCIl7AbAJMcxzA8AzTkPJgA0JaYU3ANRDPxOd4joabWYRklx4kbrBTTKADYBGTuOw2jBEEESFxTwkfAiCJfI5xMXBSq2OvXCezZ1Pa54SMQvkmBALa7vrT2ZMIfJb2BoTgyCnY9hLoXGz8G0oSC0KjWPXGTKIRS4C2+RpHf8ISYqYMjAZwARKrHfh6lzApimUMSNKAlUEzWEP23Iluy45UzuHGBgk19gbA1or6Hba6j2pLTBb59n6M4U5hgEiVcxNHbj3EkW7wH8n3yTkRqCxRinE0UOgn4X5K9YD6i1cF49S6cGFrhzIhcBMIlmIuTO8ZJtG6G61MoNQAmjkVEYetwJygsG2gOqbq7IGoFtiJs0XSZsiv0ejpoGfH+mprVUh9bxpD0e5mC/AvByQg7zHxHDuzEqDsCpkMPAfFypbkoApHKyBFKDoE8dyiqEQYBLEdtJWd7aM+Din45njtNggtgvam0Ltc8LpYjvbLvHNbEN2VYD25L7e+Iikb4bOMD01o9CM3KGxViuchk1O2gbgIGlskIyc2jpoFlCyI9VxKhjtHgn1e/87yDnYL6QSsRwOZGH41DboAc/5Ce6QoBk+uUziZZ08e7zMkZJtbEHeJpHfxdMACyFWcIFUXhege0RcjnmjETokbxF4YRsz1DQmI8FiUnS1N9HwI+YM0buaQXUTyKgdoQPyZK1ztZJeprub3hkiA2YG/FMp4d1pyz03RhWFRRbPnUSLybJMFQsYEhUJ4JH72oJ9w9QMlWzB4N/4WwGkhlis2jLIYEahBMlqWG16zX9LyhJTUPL3T5zJpMIhoAacrnVeRjFa80nr45KfSDFWLfJTuRkvGHDo6Nhiin+O+F10MnljTI2KPX9D6xWYIrSpAxzolhNDhnIY4kqg4E6tui8smPo8/7GhS61cZMACAMGzUQykruhyTqwsWB7hXc8itwJ7CZt5U5r5XUbJNR3HojIgfsn32b6kXRfWTWCxB8BsTAIoi47nkCXJFPjKTlIAbVA/wt4mAg81NkCvnzxIlvB/wpH76k7sREPUT2GsmpqRKpGiShMnRloU/9a1uEy1AjHkcxobJindUirA6dZ8ixX7hyTgka6dBWwUoOE9ghG6ozjM1hRxUjR6p8X/htCJY1dJJ5E4JPDk4qbGip4AQ9Z3WOndA/43+dH05BkYNT2xwE7xi/XAtX82qKhwpnxSypUtToAHcZ0YaO3FHK6iC+7vSgVvwPx6XNRY/dlNzmFPXE8YKoVnGo/TGBz7Et2ByyohWKuheL5TQtvrxzgnxF9Hm6lnzz90EV8pqzTa3ggrJksq2AICN0wiQA9sHsX0OKI7mDIVL/Pm7MmsK5ENLgDGO6lGttm4svcJHI0kr8jywXkEyD6VpsWquK+CDZuOWvx5KJ9dvoutXppFN/1YClhMdTvdXGgSOaIHvjkWoTT+B54dktS2EIxeufy+wOD7G4gYsSLy/d1bod1jkD9kDWkWlpFf7oI05fNowfPiWY8vwogUy5Cr0Z/WIq1L97hFptFDmznKWzaBvwJ/5mwbrvHYAv6rqD7ayy1jLcAh9dwpl7X2Haku8dRnnYGLHbEbQEXbYDIqtZ+OatVwvdrTdQKHu+5fbzgX2+gQKSvmsKxdc67cnd4ntRuUrOOYjbp5WKl7mGV6J9CiVb7ujNPxDbw/F0KyTv9DwLHGZIcXb2nVac97oMu2xtt07GsqzvE7b30/B7i/vP5zBktYnV/YfHlLuFL4GJwkE4D/FhnHmRJ9umjPH6KHS4/YNj6gak+TkHt4lKBnCbIw4827/wtVTTNn0v7l30cGI4xBcqX0BbcwY4ZSKS8MYHvrno8QxcKbxsklOmX1qxwdhaFybyGkxByq48kgM/DmQBBCdWUj5AaGIPWxC7Z+uRKDgJnLm7CuI76X9guadU1m6U1S9wJbwld/GD9ysGAZrx8gS0h0lv8sTCDyvLRZJ+MMnXnTN+3AycWrVQ1/IX+bRApDaOIZn4H6CsWglxQvpllzSDnVhQQK1P4Lk+8Zj204UD/88JFHn8ok5ZYf+seLwHr2ntm0H9/CR8BrcO/yz6U3A26JrBvsiEUGipCBUsCuqGPEiiN2yMMGhPu43hNnQCWZohdZPXytQbzMM4Ks30YN8fTJ2K5W0Hd2RYX9NyATHaECshRAvdc5jC77G7Rdx627lJZCTftcjZPNmaOZ/0PxiwTohiJNmzNwdjx6sjL1KqXEirQbI82A9zhDf4wh9WkviYuaDkrxsDehTH94MhVvXdBD1hyxl1Dv3yKbaMT+r7TEBwdlBHteco5DuHYPc/vQtrAcpIIrQ1irDNbrDoyx6eDy+u3XTwc+s/r/sX7s4vTwaB7daqOznWn3W93upf/vn7fv+z2uv9zeqJ/6V90O6fVv/+YbZf4wwn6hfvIodgN8CvJBaXhR+S5AIq6MazwgoVJTAwx1ZlzyKGK4iHxx4y9ZI3ip+FKmmXdPJORu9AHKFHLjzgB3OGzdq/Luic4jERIPV1KXGTYBX5nXIGhbDh3g+ShcYTWggaKK9/9ExkC9i/1NJ+jK795tLQx6++C+tVuW8pby7wck47/IIpiRBJwjqHpO+m8r2952r7zJ3zKd4/Nmq7QmfnMlVEFUjOYj+tM0VW/g3OD7QU8Rm0eSlEDIhkFPH7KKT9Xpxr7UK2Rsi5CHDZNfUb7NIKV4g5swhBGHpE7LE4BiRyoKmmCfRe58YIg4nOQphtU6LF7QhROONpbUCXnVGoKkv4edfAoITcXXHkEmVHo0Sj0SuBlIfBlZwoLLjGReOih3Xb9OrwdPNAinJOZWVl756GrhAw0VO9Ks9COwcAzpREa2/Y6bUXzAppEOXN2rM3P81Dw98EJ8BTttlxXqk2wjoRnhnH4hgeVOA22vawgdz4fH/3GF32nzo04rt4tRw9GN0ovmA0/EBJIx8n49nlOgpOpFYNXbCTbVf25SuddhjMAIRyD+Lvddumy+4TiUknIXx/E7J+k9x0HTCGaMmBg+3cvJQ4cuZM+hyUErWy2Fekamml4MI/cMV1GO3nxcMgcmE20jarONB/NBJCsKm09TpwHGc0ioqXriCAkiSBFBnQOB9P1JMtPogj3n8BasmHYiiOO+J88cCXvp/tTWP+MrMJV8t+kus2nQoagbHJS5E2JAOZ9z07fDkqIDRqtIwZOdaRMoQ3giLqZmoys2IDByXDLGUaH7Npic+vHs1+iMFXGoKrtu3WmTqEL3FJfgaySlnAchvG2LADrSn2AOACSnLZ/aDAEPhZ1DSUKYuWVY21KxUsWHA+sfxqJKJ1URotM926y9hw91zOr77DF43ELqMD/N2XbQ7mrgEgCCdrzhPxzWNuDv3H7kgWRCvrOAmUHHDKs48BnbwonGOnDgnmzRIVWRFadbAC5ARYW2LmH/xNSA1r9lgRtULUl0V1rwu+AJ8Dxl0YVGFODGlX2neZN7HvKvuNE2smj/pm4SIKy/RU9dN7K1gx7mMBtNV5thiNknmOEmZKJM+fDjHvNtHGY76BCgUQ2gA0RYMgaV1I18n99vfGhb1/0fn3N9s8i586Nw8A8G8Z4JFmHRRPnoaSmWq3d5vK0u/biNO8oQ1st9ZCR1rLJhQY3m9wiZCCib9iR1CV8MRJZgyd9ow4Hz9z6mefxQdmkri70s0u+w/JX6JmRi90xnDPO6HtGhtoN/TP+cucFe1e5+3eVq+6qd+SCwF5M2ovJ3b+YhO2KG7cOOs/JIFVPKzV1HdZybSjPNcMzDZW6yPG0bxpgvxobP9cmViHYpITH8j4aDvSy1MUe607dCHRNalG1RrHmI475ETyytCtTGkHB9niMCtqp77jeeqoHshJaLEit41iNwA/6JEk7hpRxOXvtRsCq56BlVuEqPQXBywa2MXGiCTkB5qbA0ZNQ8GYzzaG1bcagyimjgTTzki1QqhacqdQr8MnAyih0lKMUACytyqVK0FWvyT59GMF0Jez8cpAdBuLtTQmeSHFQfIROSYt6F61QNFQCmV8SauMa1vqAqe0zT0YepjygssrdXumUTUR4eNHU4PIIm6qeA6oq53N2zp2IBnfVW0HXBIo2PFW0ceebBP6CsWrXymwNhOFHNXOkB3Q+nLQLMwTLom5hcUcCd9WRyk32Xhu5D0FoIpdohPd4BTeWWqYap/YSde5gXojpkIY3TSgMOoLWgIgnKxr5Pfw8t3xQIT4B/RsV+LOt/Jawpt6go1Sd13tNx5ifBjM3yNwvmmw4n6QHaJgeDDxFmHICrd25c/SPF+zsWFsLzWP0DdUWySqfUW0xswqYLuX49Y+htGzvfLke91swacHkTwEm12l+GwMYyUCuetLIqhHMQHHf65MjcX33SoHFZRCUfpJMsKY7nOxVVzK84a562gWOrndrXQq7UZwAWFRVslYVcBbJKC1ey0ROtJm1dEu+E4BIn3QptDRe1GkM40EbjhDuDJGBakBlfYoXJVoLPXQ8F/6o00+v2PKYqmpbfyHpmPJd/FiZa2tJD+fhjLVBHi6gFcHSNF26Bz8MXJlPRbd+iYei3j2wssvHKSNFjJTrUFo+ndjphJ5KLnAaTOiiZn3zmGsQjpauyLiqKb0rtNdlvvWLxKs1LcW28dJdzwk0zWBnx3pSnoBH8mLqllc4FC0XPaZlt+fMm6egni2uB/RjU/7nunwN/DRcoz3Vc8im4ksyyZpZkMom2bPfTtMblA0yPKhGfktG5JKB48iBlR0EStbyuwuWXzR28Bo7LbezpX8P9Aua1IeL81SSawIXcJYbmIwMIzFRUVYyXQivw6MaEzoYnLMxngryDyMoaEgVrqOtdLID0qfxO5NKeYjTRIYkQDYaZ1qL+GuaqysLizNQk1IPhybsHeTsSBt1LQrWJMNBryIGPZdaYClViMyflyS1Ahqoa7aJm1ed8/KkpSlFVWHYneTqWr47rufgDrvsF9Vxw2hL7TcZW9HxHNevBw76aK4RmPD2ilR8qipRAt3OOwKPo/QIlY0v2RyHTJ2JGF2/G6rSUPlRkrsOG17AknzEFCGAqBZDbSX0dWIN1QO5l9SLVOxJlxKMV1SWkHk6IG20GNOQlozG3D2tlGjJEicdVEgk4i7MWjiBZulHYFueO14ovofX7Yq/ERTM/JDD4FokNF4SpPfOAv8I+B2Zelb9+rmcTfOhgc02QHOkM7uufUMd7Kej6hPd+qDA94M5Hz/RywPmLA2jXhJAp624sOYDEuBhNJQewOgrCTAX9gXmSI0xwjU2/XBRf3cnTFHK/t3unWNSapXyENSyiMyxxBuH6HD1Zmiat59nhFVOh5pTwOi/xfisbWa3bDNfK462VlT6XxRIW46j3Ylb98I2UFgzw4Gmurbix8/fQd4ca1C2TGsDplXDdFr3jh3zdJlWCXUF3sAwkAZdZ8tkFvRrPZRbbJLGVscYvdZU/qielqi4czIprLyBqi5guNGVchwpm42O0JKw4zs3uKRmqc0cIVIZsi/n64CEiRw55Wxb7naxinWhg36N0/RBFGNan+nStuB3TY7WuRCufIfjedI3bXf150/OFEAAI+k32cDJpWIL/4tKIiu9Ml6rdXgm3xwhbk4cgBZ1wobUZRGG7kyojgrKHiWzWRrNJm66fj78ZJkmkHpLSzcGHRUkm5Z2bWy6B2B/m81wgpWZhz7hbP9F45Xc43EUJphD+Qa2iqZ5HM4XTyAaq6PukKVdB3W4H7l3AAzbMtVlzUMxl5WMHJkc08yD6NkPQgZCADN0evCz0ClJR9zbwAlgbfzUsnhh2VEK+vAPeQTSqLGmNfH+HCZeq0D9sAoUDGMqLjGxXI0t+u7tgEktisVURT48IZOBa/uearNmyBo26Wc2xXKUmtVbdktvsY4wVbSJDa9NBhTeuqAw+Sq34DSdNsbzozQJqnwUtcthHGpZY6aejDhsA18GB+I5hyM1SbTLQbrJ04Tu5K5Sw7+l30l9W9KzJTMU1GtgkJaVtyaG7za0bUqGNKiM+8gdaxxePa1xmnQ7YtPE8xaNPxLHk/HEEZ/yCN/LkkHQn656huuz6qm2o7Gq2NAVxcEhDQizfVA0pv4BmhriVdbUfTg0L+vWcgSYB/EzTERN3rWJI0f2ZJbpoorpOX8EB9VnSp+wDP4vzaGwKl/TFmmKZcLYowoNuJiYeDNPwXICXt1u/KqJz2cl/leNdUALWd3kOOXcNZqQT8pV38e7LZmhFhrdOpEbff2LcttryLjqhrJgNGho8KV7kDmxk9mGmsd+ZSb9EZcJFwh7I/XrTERWRdx9FXFHlCWrjVhtZPe1ka+UCPYpEWFOBEIo5tI1w8hDUcqWh5yslLH+yRFkS1veOuFV7lmlZdGbT8w5k8M4o9xFiE45UwA4MvhsOJu/GhZC0NBdWqGOHNrqRyFuxXZU86Jx2M1XHFKyfd2DzFxjIjPg8kIgHY58ROD+Bje+8nlSUXRpsicduijDFNPUKZRSEHohTx4ehMnsppjEHxo0NNE6AE7qodo5PsvX4jljTvx2X0A1j6v0e9oZ9pmS6A0qkueZqfG0imzkU9ul+MHC08KGfjbAX+zTiRZJWyT9XSNp+3SifTrRPp1on060TyfapxN307ogn07EILUqnGoDOS3w/LGApw3ktIGc25JkAzltIKcN5LSBnDaQ0+JtG8hp/ZC/YiAnsPDYcaNKpatNP7H+8cDeEFhFbVcVtZ1gCPaGwN4Q2BsCe0NgbwjsDcGuaizyhsAT00qw2j3usfPBW4tULVK1SNUiVYtULVK1SNUi1R8EqSaBG78No3PoM652aIYOpNmUylTMoyxz6YjbC042v+oyFhPvHiaW78OU0nHJxwzoa+stY6Ht9wxta4c6q7dDcq/OYVxzIoZZdp0+HNX1bcn8S3Mou0aW4Rtg2GQhj5bJEPQr8+mGpvCR8oV+/jFnE4qjcwLLTmEz9/ht/hUy/ZK6nIxCGik2SXC0lRfIVFH5C6xmAHf+5aJOXHj6ggwWy8UlZbNbvno2CVd1TbCSPUDzmh6gkeLC7xRca7a4qbzqpVzApO/jDUA7nGMBE4yTB7xcvUV3KDl7hCssMIEHVS4DNGw5BZXSRQH2FQK1WRTeyzedC2/JwX9kqNwL1G4ClgRpXDyWHODv9QPwsEpD06/3szFICopyBRw//j444dJxpEbzVFS3pDcVDY6IXuarAHM24ZKfSHGq4hsv+Kw7eVqGBR0piVwASuUe0imCvT+J7sKL1nF4y4MTLQvXK6H6iCpNZtAeMGrCjNnSnCMHuo+Ui4+cCcwt8j7opF47Ze7Qzm2QiTnzUj2ZymdQvmO/H3QoKPr9yIEgBy2Nfx22Wj4huAUrZqQ6RNeC3l0CvTYQfbv34X4Q++AG76AFiUfPqkrYVWVKkY/kOuxT6fk1+UjadslfMn0rTf+i2z1gThw745vMPGGiHWSChylOSuez5IYd5moheBikCQO3DQKmoelxVAYDy2jwTvhDBFjUztctcy+m5kSlPcgtnT5CzLIkSoJ9wqdmIwaHdM5eM7Q8b7VNZKmG+u4XiRYamB7K/L5hCKf1CaKfIbe9snHj43UXHB2YYcxKWG9gnUP0HWHmJwcQGCXuJfucAn1KMB/9k00AKOAiy3OSOnePgcxWItIUmOvzs1sZvksyfEsmxm+r48PalHyLnf42sK8FWrPZT2M2s0FmNshsW5JskJkNMrNBZjbIzAaZWZRvg8zKzNgGmdnXAu1rgT8l03rG1wIzsyLNwKavAmJ106ihXwZc8+pfnacDv+bLgJ47haG4+NyBMM006h01/Jnp3793G8uylYaf8LHHTe6yH1c9N7ieTXEfRjWqdAp43Obxv8eVb+A9rn7a7nHVS3VkZd7g5bnHlU/IPdZ7D+7xGZ5zex55sCHo2Q6w1ONTK96relz18pSVajsm1bCpZFZ98fchgKPF0CNav3Vko6iszXxHbeY7oZvZKCobRWWjqGwUlY2isvH+u4tYPxNqBSW74KiBVpHjLcKa1DXZ5WJZaEMpjAMZXbT0hbpScXlJ9xT39tPjgbrqk15TdCW4L7kd3uqhlGuhdH7TSv1B6bO6pP9uzCPLDWEKhWQRK/T8DEgI7U6/7MnCzaSXuUnkaCR7R46rr/XSh4kmuC+CjVvOWjy5aJ+dvssehFVYsOvBUsJiqN/rwsDULfFahNP4Hlh2S1LYQil65/L7A4Ps7hOfcqyiP12E6cvm0YOHJoT8KoBIuQi9Gv1hKXpPCLbYLHJgO0/xfcRZJB9g7LZ7xdeFlrEWYPAazdTrGtuOdPfyacwBix1xW4BFGwCyqrVfew/1tSZqBYv33Ho+B1gqdVTGx1rPu3J3eJ5Ublwd46OYzRM9VK0OvQs69Ne61V25p//aS93D8q2uhZe7BC9tFNGSKKI72DEq2mRjAt9d9XiGLlK3tJSEMv3SmPV1ntDcEVOfXMlB4MzFTRjX0f4L2yWtumaztGaJO+EtoYsfrF+5jePcleGjyT4ZZbZ+glvGYNG/DSKlMqpGR15zkeKcvGZgOsChFEWnHonv8sRr1kMbDvQ/L1zk8YeyaIn1EfbxErCuXSwH/feX8BHQOvy77MPnEuI1gX2TDaHQUBEqWBJQ0E6UyGtkFgaNCfdxvLl3YaEadpHVy9cazMPsSXfQEzx0kaV4HhW+5wbb4oKeG5DFjlBB+h4pBu0tDTTX1sKtu1RGwk27fPIbuRJRjER7g1D/1KiXEirQao82Awr/5w9zzJyAfdHTtSvGwN6FMf3gyFUlR8wlZ9w19Munhe77Pka/kZs3TLHnipiiM9Gfmk9YSTNVDyEjWhvEWGe2WHVkjk8Hl9dvu3g49J/X/Yv3Zxeng0H36lQdnetOu9/udC//ff2+f9ntdf/n9ET/0r/odk6rf/8x2y7xhxOOUXvIodgN8CvJBaXhR5Rfhx7DCi9YmMTEEM0ogAw5VFE8JP6YsZesUfIdXkmzrJtnMnIXonNInaeGlctzu9fF6F8j+EJKXGTYBX5n3IChbDh3g+ShcYTWggaKK9/9ExkC9i/1NJ9zlQhEHy1tzPq7oH7VE8tSx8jfjWEtD0VRjEgCzjE0fYdu/lmCCR3Mlusem5UwJ9+j0E9OS81gPq4zRVf9jn6KWT19DKWkfzk9v/yUU36uTjX2oVojZV2EOGya+oz2aQQrxR3YhCGMPDpkSh0jkQNVlc/7Mz0DrUkTFc9Bh3hriZdRoJJzKjUFSX+POniUUKIW88FoHIVeCbwrBL6MHvFjiYnEwxKvmiJBbwcPtAjnZGZW1t556CohAw3Vu9EstGMw8ExphMa2vU1b0Ty+jq4eR982w0wq1VR+D2kpTo3DmGWmRoaZrZ+Wz78qn0qc++NkfPs8JyHzPWODV2wk21X9uUrnXYYz8E17EH+3Wz9qn94nFJdKQv76IGb/JL3vOGAK0ZQBA9u/eylx4Mid9DksIWhls61I19BMw4N5hHEplM0hJx4OMRLKQduo6kzz0UwAyarS1uPEeZDRLCJauo4IQpIIUmRA53AwXU+y/CSKKFAGa8mGYSuOOOVxgN8V76frU1j/jKzCTfLfVMDLVHTo3mOTk6IzgAX8np2+HZQQGzRaRwycPsAOJXmYbwM4om6mJiMrNmBwMtxyhtEhu7bY3Prx7JcoOv+DQVXbd+tMnUIXuKW+AlklLeE4DONtWQDWlfoAcQAkOW3/0GAIfCzqGkpWRpXhJQuOB0MZI5A+IMlFmvIk1b2brD2f82CSWX2HLR6PW0AF/r8p2x7KXQVEEkhI3eDRPYe1PfhbRufBCaSCvkPpwOCQYR0HPntTOMFIHxbMmyUqtCKy6mQDyA2wsMDOPfyfkBrGSLckaIOqLYnuWhN+BzwBjr80qsCYGtSosu80b2LfU/YdJ9I+HvXPxEUSVEQiwTK8la0Z9jAV0rfSmCNzzJiMMFMyceYwrNVrpo3DfAcVCiSyAWyIAEPWuJKqkf/r640Pffui9+trtn8WOXduHAbm2TDGI8k6LJo4Zd69JWrtNpen3bUXp3k/mULmOTJRTS40uNnkFqHagV1dwhe2RgqejAR15tbfJ/+9MPAWFXFeNVNx5L0xyCz7vUdyPBOsW2bGWIrtVtmRtnCfkBfZpqq+zGHCfaJjgG43ftXETD8JZoLIKbOOdvUsVDRV0tp6O8U71VTayzq1JuSTzGLV8DEiWd6cQ6NbG5jp6zTJl+T30DZSxBs0NPjSPUhHzD4A3SqRFvQrHfxGXAJBEtRIvb1Dt3foO3I5ZS/F7aX47l+Kf6UL6qdAYicCIRRzmVDDwMclKz5yspIn3ZPvr5a2vLUhLhftobLpkIR6Rl04h3FGOcVYq8IFgPOPF/AlG87mr4bakOZm6qxCHTm0Bfgct2I7qgHrEPMMu/mKQ3ICNHOp55EZcHkhkA5HOjfe3+DGVy6tRH4SpEaoQw1GyKqVqnR01QG9kNbGgzCZ3RSdC6FB40agDoAbUEltFsn0SM8Zc+K3+wKqeVxdC+gUZs9k3B9UGPVNk7266DDtvN9QHZMK09dQx2wWV5vFtbYh2WZxtXDxL8/i+sXmA7H5QNZRYvOB2HwglnV/1XwgJT6s3cFkBsjvnA8v55zFvtToJOROIz/2JSM/IGXFeGTHMKbjxX3keNqcvoodozdAjSUn63DZt21zXr3mkpdU2Zy/WL7D8Tzpm4lg6s+fnKlO/0O6OMoFl0zi9W4aerJwdolWIjJdheBlQ6jnwBqv1TqsEFIrSVf1tHfDKmm2xAKClokJ1VEe4CDTZqnr3FLxV75B0pYg6VSojR6y6ebG4rLs5QmVmYcX0Gz/ReOV3OOgBScwCHEDW0XTvELK1iEaq+PlAWkOzbqCuepQzGUlIx8HbAJUidl+EILah+6Ajgc/C53+5ImSve6tnuwota3jH4UX92zmoJ/kxsbmsv2B76lWAN/SQr0dMJnQlsXS7ITTpRKPifQdplVwuapJP0vvXnaJs+B6l8C1vUarpk1s+ILFgK4xFuSTn3/AgvuO62WpuzB4AKWJFJ7a9q2SGWrXkDjUssbMcxFx2Aa+9ETEcw5HapLIPGPGoUwv7ekSYT3lGP2gbxzSsyXvPeo1MEjLyosxvKlR2ADaNiVD6sHGfeSONQ6vntY4TfAVsWnieYvGH4njSefliE95hAY59X7eVc+4glI9ZfuDuHFTZv8ld0h1tGjjtHTFhq4oDg5pQBhaRK6f+gdoaoivikzdh0PTC2gtR8DHVX+GiajJu1Ll2LTFVnyZd+Sz78VbKP5jQHH7Xrx9L96+F2/fi69j17HvxX/HT3jZ9+KtNm618W+jje+IZc++F/813ovP1MLucY+dD97aNyGsOrmr6uSOcEL7JoR9E8K+CWHfhLBvQmSW4iRwY9Dnz6HPuNpeAB3I+3UqU+1ICmUuHXF7weleuLqMVRp3SWnE1yfMqBoviXwLgS0EthDYQmALgS0EthDYQuAfBAJbYLrDwPS3ZESZcilw8ocI+ba+Oz830pSu1euHmNvZMocD9Aty8cPFeerLowlchEnUuP2naCDeQcc75d4jhNfhUR1X08E5G+OpmKZXKvkrFvkIlsZalDgDvzOplPJfwmm8B5874xrszmghrUUCUDupGmjFkLoKTQ5N3jXY0L/W6LroYFvhc2iIwByyWUoVstfnJUmtQJpVTyEu3LzqnJcnTZ/njioMu5OCfNxSSs96t3mwy35RHTeMttR+k9duHc9x/Xqwu4/J3wVmcLii9DJUVQJMQrCOwOMoIzNV2oXqzXHIdLo+fJGjoSoNlSZDyQ/Z8AKW5CNqKD0nWAx1mh1f43rVA0U11HtArpdFNSgwPk8HpBPmjGlIS0Zj7p5WSrRkiRPlG1J2femHgMPkj8C20HNE8T2MYfmuPV766agyjxfphDhBd+QagXirku/CnKWvWy5510xHVsKaD0iAh9FQPsyAKewDN4Z9AY0jkgUtQpTd8RSl7N/t3jmsYpTIHFQidiLKJk28cYgpiN7k3P6fZ4RV3mOaU8Dov8X4LMDeJYBtA/1+YAtgYRsorJnhQNPtZcWP+bgI9R7Lb4MUcGxwEWD1NKunWT3N6mlWT7N6mtXTrJ5m9TSrp1k9zeppVk97Lj3th9WT1qsTlmntHNOqkaRz80eBaAYk1q2HZi/VO+imUYPGsTZark5QG15SL4k6MqmsjEGqLlCVNvjst1NrkLEGGWuQsQYZa5CxBhlrkLEGGWuQsQYZq9tYg4w1yFiDjDXIWKb1Fxtk0KpiWiVU4sEGhlQ1GD4PtJWhxmxSG2nW22DWGnK+rpHmQ+DeOQwjYXQeXhs9a00zO2qa2QkIYKNnbfSsjZ610bM2etZGz+4q3C9Ez7bhTLoR6x8PLDq16NSiU4tOLTq16NSiU4tOLTq16PRbo9Ne6IwsLrW41OJSi0stLrW41OJSi0stLrW49Jvg0lwR6id7IW0C56IjHzermuqUQ2C5RuxSx/ktU/JkVE8PMiwtYsef40u9IOpCqHIImzJG1iVRp5bCIv4wnzwjDefQIkuoySVkyB8nlaSIZ6ZDoAPzRmSoB/UqN9fqHvV7f+i6GSfAGj1nVqdHWbxq2MX+SlrL0pLaC7lzcdq+7L47gyLtq3b3vH18fgp/n15cvL84PYG/uu+u2ufdk73yRoXN3BxI0nAbF31mo4hcYeVQlXSvcpbNJuDAdI+uTdjhBmNAwQtIyJGPgoL8POfBDN3KX7/4P78WvapJPLm+Ey1qrLUpO7L5uc6d6es9VET3NCookHD04kUFBau87iJ+5wrlQWU09LKyISldLoGpVbZFTvorfLUwrMAXS6s/gwOg77jGz2snBrZOtNBw2Cj9z6rCYnzDfaeiNM0V6AIA9nDXfvrf/51/OYuc+c3jf/zHp//X+vw5++I/9yoaBlyd+FWCJv3tnDCrfDjNHNRR1XZLPO8cH5Vd8l6GiJMRTOKSH2Fjw2Yo9fSqamODYlR37uTG6UchqmabvBmqtKEBBxUr3rAibnuKPNqqNmJP3/2TRF15Pqpm3qxx6UQzvuRVkw1dsbdzo06V3/SV1UpaNocHW8lzk7PJzZz76oTY/kjt8wsu5gDCJbo53Hv94hXh5JxoeA9YVKKQIFSBQEDMI23hcQI694Ik2DEHIB+1E1yzTwSUfB7fhED2HizPHh1b+GlPmxS+eOqkPbaAeEfgEmqnakEtJpEH5bWdwpm7TfmufGqsKCu59AvrK0jOOlietftdknia3AFyF3k0TKLT2cUe9xQTokNLheAb+cdbPee/38c0DW4wDam6fiVFUoHdriNQRZ4IVZgeqxwTN8kP3hwycEbXo803Df9v9gOifAydon5eNn/9tflCM3LfCTJFIt0BWj03Zj9H7Bcih1SXvQsOO47fcfmQ84TDNvdSlKAbkHq/sjSqxuUDj1M3e+J65t6Bxj3Uqz80ntWOQVyhAcolBkkz8EVtm0/qiEHhN7rqHp0pSftnaW/Bgl++jOC7D5H3+Ihfgw4dyR0K6p/yAqbnP1cM96NmZ6ir88gdZ+OIltJ7y6GbjBMSfUrv2qP9pzWWDYnZVw+aTg7YubLd0vGvQ5PmwcHCJEbTmk4k4RzkfMi6gDj5c3s85vPYqEgKuowMaf0uMN7ePOVnp5d79Ai3eZYKZ8fEunmiYNWoxCW+EQ0rp2mkN6ORwMfH/w+ze9Qo -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the details of the datasets used in the launch identified by the given `launchId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-managed-credentials.api.mdx b/platform-api-docs/docs/list-managed-credentials.api.mdx deleted file mode 100644 index 38af38b1b..000000000 --- a/platform-api-docs/docs/list-managed-credentials.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-managed-credentials -title: "List managed credentials" -description: "Lists all managed credentials associated with the given `managedIdentityId`. Filter by user with `?userId`." -sidebar_label: "List managed credentials" -hide_title: true -hide_table_of_contents: true -api: eJzNV91v2zYQ/1cIvqzFPDtLizz4ZUs/MgRL0iJJnwoDpqWTxUQSFZJy4hr+33dHSrZssbZjDMOeJFHHu9993y24FVPDh9+5jKGw0kowfNTjMZhIy9JKVfAhv5LGGiayjOWiEFOIWaTB0YsMz41RkRQWj5+lTZlNgU3lDAo2rskvPe/5ZTzuswuZWdBsMmeVwae7Mv6D3uk373FVghYk+TKuZV97Nh/XQpGsFFrkgKwI/oIX+IHkHYlIKUmHUtiUbytWM2a18nNWVDloGdUHiQRNiDQ8VRKF86HVFfS4iVLIBR8uuJ2XJFUWFqagkTRROhfWH52958tlbwVN6ekazlMFet7B80VPRSF/OO1/guU42d68u4V/I3cEhDYeC/kevWhKiJAwcu58HcIeL6osE5MMvGXbiA0IHaW7EdfAPClbBUSf3VVlqTTGbKIBmIUX2xChXccE9AZJxz02TqQ2lj7YrywT/hXPRRGzR5g/Kx2bIRtLM8ylMbKY0h38EnEMPlo72hqrkW7D+rl42a3ItXiReZWT9SeokEqYBlNlqIBV+GorXfTZJ0gEniGc05Ow6LCh351uhmGSGLC78dyEcJhHWTJkjIaeysLFaBvU6zGNKLNMqQqDRQdvnJ6c0GMrJf7Gq5FCLoWlv6IsMxk56YMHQySLrlA1eYCIdCw1VRNX1fBv3q0j6ztCa0GWkBZycwwvKleHxHy4BLWzKpT5y16TxEcI+Ulqh0q3gTaUldwbFzzbQR6SQ2FGkUNtoMXfVwfktsq4/ewuiJTtY9ik7X5+V+IAdmImrNDfdHaAurdXDSe6/gv2QneZyRx96rhh0MzQ4DrEDNAj1HqNSbs997xCtugEH+qs4cOIieOMpU7EKK2bMudxLOlVYL+uiVzeEs5AEae03R3rsST2OSW9CmqiQcRfimzeNMhNPPdIzTZ4ODgrbMimirDGAXtDjH5TyOltn4oWx6ZMzYF3J4DrRv02WXhYuMUi88kqMtqWoSjlyYOh1uZt4TPAKiuyO/kDjkm+e7rcKu0hYXg/StGWzkeuJvcPVIyqJ5IS8ftQ/fwgYkbzCxj7mkK6Hnm+Y6QZg5IpRvfUxJow1AxXqnzWWukO8neByt/MgaxQlqZP9Yx4iNxAVGkc19zg9wEbO2hKF/wcUVPBwEoVzY5T1+fc5Dfkg/WEO1h0xsTlINqYLjGdZ81oWVEt4Km1pRkOBqKU/ShTVdw38IQI+1J1XH7n/rCvmbAUHOwj0bPzr5ec8DXw78ja3nJtJVbGI4lNS6XviSPCE/9y0YTdw7N1ZpFFotz12tI1ChK7DyCpKyMwNTGFiYhcmGwq31YZI0VmLuoT9ef6BwIhy3k5v/fPzvonrhAqY9HqxLIeRCimQ8mwDXaxjtr/eBOp/UDz46DMBA5M1A19Z/BRtbE39fgwtH60VUPvp2gIurhYTIQB7DPLJR37QYzCDSsljcQYwAle2a6mbWscsC4EVcDJtrWPzERWEQ2nIfFw4f/WurAD4WprORLi/2E/2KHeasU5Ur3jtoYdgPyeciSa43eGXTHaLCtrUCP60NJvja9Klze3dVN7yw5c/IPImn2hmLdxrW24XQGWI7yU4mBDUyAC9nTnUQRlW7NOP95oZX99vkdasdkgthqC4x5Eh7XGUdyrRyiw3jRgLX0TwOXyH1a/SeA= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all managed credentials associated with the given `managedIdentityId`. Filter by user with `?userId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-managed-identities.api.mdx b/platform-api-docs/docs/list-managed-identities.api.mdx deleted file mode 100644 index 300456766..000000000 --- a/platform-api-docs/docs/list-managed-identities.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-managed-identities -title: "List managed identities" -description: "Lists all available managed identities in an organization context. To list the managed identities for an organization other than the requester's default, append an `?orgId`. Only organizations accessible to the requester's access token can be queried." -sidebar_label: "List managed identities" -hide_title: true -hide_table_of_contents: true -api: eJzlWMty2zYU/RUMu2g7o4fjZLLwpnXsJHbbJG7srDKeCCJBCTYJMABoWdH433suQEqUyMiKmk4WXdki7uPc9wUWkeMTGx19jGQilJNOChtd96JE2NjIwkmtoqPoL2mdZTzLGL/jMuPjTLCcKz4RCVvxMakYV0ybCVfyCydeFmvlxL0bsCvNMkhhbtrJmmrT4tWgNWDAd+Iy4nMprBPmZ8sSkfIycz3Gi0KohFhHv4H5PBkN2DuVzdckAXocC2sl4Xa6JS2c4uRWADFkjQXDqZEiGUS9SBfCeDnnSeWLN8GA85XLelHBDc8FBJI3F5HCD1B7TDiV5EaSOY82nfuuabMqc+iNK9ekUpgBOw42usqDHd6bSTftcP7jDiTzbDwVOY+OFpGbF4RZImQTYXCEqOTchU/Pn0UPD72lYVZwE0+3W/ZKZtDGAilbOmjALsui0AYplRqBiCBBaiJyAahgSsJuxXymTWKP2KjIuCMwR6NOxNYZqSY4UWXmszM6cqYUTbw5v98O9g2/l3mZUwTGAK1T+MvCRZQX+NeVRg3YaXAbEB0edEPpdt7Tw63gdJpa4bbje9uFy97KwtdOwSdS+ag3Qf57jGgFUFeghpDkkHB4cEB/NjL4T3D6SleOTlGUmYw9muGNJZJFG4Qe34iYbC4MFZivIpzmrdJasXBjODlGOpHbx0XJZJekbufBWnnNu0oyeuhVoWun4EbUKJkRs462N/di6szuEiWgmlozzxyXpr8k7UWZTZs/c83Hzd82K03e/FBOxOpnq72fXZyw+pQRCI8MAU3l5HE3o0ZvT6XZwReo8zTTM0YcLJEG0rSZU82Te+KsrJqTnXIDP6US7drO8TEfsDc4pL6MXsbHVmelE0h6N/WdIgY5+ZRnluVEOOV31O940p8ZZEvV4YPDjXhfqkuP63HMxwmGCwtfqJM6Ju5FDOV+2hFslfYzXir0roqqMBIFieKU6k7fQihbGg7HEQ5h0QLR+D5emNDpCm1d35SqEmGvf5k6V9ij4TDRsR1Y8RkTaCD1sI5SP850mQyD4iFP7riKRfITbOtDXr+W16/k/Rosx9fvYzpPqa/TPtA2Lfg+1nmRodknP8RSVaE62Uzhr5sq6V/eMCikfxkmP4WTutq8MmeDyqfqvqbUYPtBVp9kBTMC5U61dbqsphlmvliZAd/Y71Q97DxlOpcOUe3VC4SfQqOqBYw86tIK83an5vgBlH7a0wS7vDwjbyqYUTmc2tIUKJjSSWhJU0R7N9FnoPSiIfn8gvEkMbTioRO3pdIqstt0XNdBiIl3bS04DE4gDX+XotwB6hU1kcaY+ExsG02RwalhAwytho6WIQ5lSaM/tO28QHj3UN6pGDpnU0nrmyxEJpVgN3qMDoAcs+U4ZMOAnYSlWd8JY2SCbGLjuRez5ForJw8UG5kHeSm/iH3cf+VH6ubS5tGtyhO4Asx67w9GWnBhqCqhS0tFvQrgk4ODVQT/0ON3Xp39ph5SadSB1Wf3WsB8+gFoNY80ljfuxNnXFI61zgRXLY0oR1rSemy0jnXko4NqDj1LhsxpIugvQ8eqdPF+G9CGH2E1of0vOh7DUh6714ho1Ui3LQ59W4gY61G80Tlr6zu2n4ay9RvV/HR86vSnNoJP5LENv9NSSJFv34u8f512PNspxzqWwStibmRXx90L7PGUpnyVXWbDss774vtqpwYl0T7r2qpfIEmqK9u3rNfEgmGQ0OKYo+dBMW18j2zdFWEry5uWvDRGmxbypx33gfrCjB7raE3QM+AhcotOhZEy91fkF7jyCXNcuil+XtNVA9fDqaZL9sTfhmhC4cdQNu/ZmBl39SW7NBnO67HLCznwI3Y1e9s925+wi3rbPSF6dnxxHpH+Gt4leTN4pgly6RzSWF+sfIV6InwJ/7yqk+pm5rzZUqXas1eerFCQ2scAkrkS47cipjRARZCwdeObJiMTZOZzOtW/rw4AhDwX9DwZPH8+OKjXQuQ1iayuo391PzNsYl2skvJ//kJUpQXZQdsebvG0B1F8FlUSb76v0SZDXxeLMbfig8keHuhzuPpTaifSkhNRDCk6udji+h/9ftRp/K2YN16/7nhGy0gU0ZvH7pb9V+9HWxAvn7X2hLzfK9IWQOHdak80+78ZbQtq/Vi1AnVNP4wMD0do5WF7QkekTA5cx6igosnVmmJrA+D1yyvQ8vW2u9FmvfT6aUjNG7JRVZ7iiuoVlVVD9/ULRRhd/wC0TRpt -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available managed identities in an organization context. To list the managed identities for an organization other than the requester's default, append an `?orgId`. Only organizations accessible to the requester's access token can be queried. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-mounted-data-link-ids.api.mdx b/platform-api-docs/docs/list-mounted-data-link-ids.api.mdx deleted file mode 100644 index f9e3a05d5..000000000 --- a/platform-api-docs/docs/list-mounted-data-link-ids.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-mounted-data-link-ids -title: "List mounted data-links" -description: "Lists the IDs of all available data-links mounted in existing Studios. Append `orgId` or `?workspaceId` to list mounted data-links in an organization or workspace context, respectively." -sidebar_label: "List mounted data-links" -hide_title: true -hide_table_of_contents: true -api: eJzVVcFuEzEQ/RXL57ApUPWQCwQKKKKIihZxQJU63Z0kbh17a8+mDVH+nRnvJtkkJS2oF07J2jPz3jw/j+eaYBR176eOVBXGR33R0QXGPJiSjHe6p09MpKhojGpwHJUfKrBWwRSMhSuLqgCCF9a4m6gmvnKEhTJO4T1nGTdSZ3XZTPXLEl2hLn0YDYpL5YO6fHPnw00sIUdZIa8sJ62qtApzQXCcMgJnfoHwkvxVtso9Z9xTRwWMJeZkpmhnme5oX2JI8YOi6eRLXf2Yi59w7UEROayEABMkDKLEXDv+4PDElHeNqHBbYZjpbW2+tim5aoLB5MoU6MgMDQaOj/kYJ6B7c02zUqoahh+lraEPE6B66ehQLxadFXRLmP0Efqw0eEb0SEBVfKTz9Adsc8BqlbMDGSmwETYA8D63VYF/iYAxisyDY7FKU0KsIdYMyEUiZXsJsLXFIN5xKdl/dXAgP1uwn7lGMpQj2YWytCZPJ9y9jhIy34XwV9dsO3FSEMuRqQGKlsvWwRACSLuGcBIf4rnoaDJkZU18WvffGFfKxW9NFxLLwYcHrx/oY2l95TzJnfV3WGRyDDpiXgVDs2T2dwgBQ7+iMX9eiEZ8E8Ze7ssIU0sgW7rbDIju+l6K2Bimy2tTBctxY6Iy9rpdKE2WW18VWcRbppIZv3PEZ2lHnVogsaN6L/GqfzrQwmNJ80zUrgVtk13pJojLc5fvqxTEK/Wfj0ujX99Rat+4oU/pjcYNC4F9jKC0a3KMTbDYBPJkk83m2y2zU4xN92zo3643mIgoV+O8zI6OsgNZK32kCSSXNZfl5OGhuM11vjbtfz2ym0OVzW5pgQcEq5LUnTdWXL9VHd3Sgx0zZvFkfz6/gojfg10sZLmeL2LRwkRRgM09BBtxj4SPT/YHid7grPVyTMFWEqNl9j0d+5Ghvgd48934R/g/jvY9wKuY58J84rDfQ2n9yKw5XchHMEIqTTu2DELBqoo56rR+nmNJraydB2BjRn76cM6xsDmRtiZQqr4c/m7Wqs1GTRHn/gYdm3XJneSbgXi8/wbq2lnu -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists the IDs of all available data-links mounted in existing Studios. Append `orgId` or `?workspaceId` to list mounted data-links in an organization or workspace context, respectively. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-organization-collaborators.api.mdx b/platform-api-docs/docs/list-organization-collaborators.api.mdx deleted file mode 100644 index ff47b6239..000000000 --- a/platform-api-docs/docs/list-organization-collaborators.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-organization-collaborators -title: "List organization collaborators" -description: "Lists the collaborators of the organization identified by the given `orgId`." -sidebar_label: "List organization collaborators" -hide_title: true -hide_table_of_contents: true -api: eJytVtluGzsM/RVBT7eAa6cL8uCnm6QLgrsFSe9TYKD0DG0r1YwmEseJa/jfS2oWbxPHCfqUjHikc0hRh15qgmnQw1vtPP8d9XSKIfGmIONyPdR/m0BB0QxV4qyFsfNAzgflJnGRN0FufoKglUkxJzMxmKrxIoanZo65+s6oy/R7X/e0K9BH8GVaH/7fxgkXmxSMLsBDhoReBC51zh+8K57GUSP6CqCZ3hW9eabKywy9SdbqPOM93pfGI4sgX2JPh2SGGejhUtOiEBKTE04jdOJ8BlQtnX7Uq1WvVZLBY6PjvkS/2BNyBVOTVzIYqzyG0pJkdiTfh/dbfG4yCUhHU7bw17EFBJ/MDrN9MZavR1VQ1d5XF2cgb/IpM4yk/KFwecAg8fcnJ/Jn5wr/4jMSxzpzkigUhTVJzGtwFwSy3Kdw4ztMJOHCS6ORqQgyzMaxh1ogeA+SjCHMwrEHSMse0R89XYYXgv+NBd+rVE9zesZ2RibGB3pyn4UDQZgDge8MeWc79rAOfkTRIx7ymEZVkHhD6xcr5vH4VqBv5+ClicJRe8iQsMqrvRZ+7sF27Z+46dP4E7lq3RHYG/MTj3yq7UFiNdVh4bpuPo4L4mNX+51DqsQjMNBL+nBtK7ecbwgwxZjhM91VATueylr/Z++d31P+oePhNA6rckcKrHUPrEfgAZPSG1pELz3nF4v+rGT3HN6O5E3yw505ceVp9IxorEM9kLEwWEbPXQ2SHYPm3p037lx67lQ9IyrCcDCAwvQT68q0H/CeFfWN2zOPmxhRVxZIbk5dCF6dXV1q0dPIvZHqVpXaFN0WSxgbv5HvcQTxSvXPl6Yn7h4olsHkExe315WtVQjtcwIlXZNgqMHSFpDEtthOfjPl+glH2j/XARYilat43vVPT/snsla4QBnErqpdWBp3e8zuXsKW5uW6WX/37K7rTfhIg8ICTwWxLx/9qeqW+kdETw+bGb2tlW91xgkKcLkcQ8D/vV2tZLmaLtJGqQkwtvKEJmADHkjvyeHaKfQHLtqJPQdbCkLLtHsVYTtaD3C1mFfSPT1bD5C2Q3tNOpIPb4T1hRX+47r2szfq+Z9UnaKaeZsvNiW1FYpdshoxcIaQ8jGir4qdJQkWm9Xbc94t0/r6+RtjYdsadqwgnt6piLsxIr65H5hzRzYCSb5F4Gr1C0gQ13U= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists the collaborators of the organization identified by the given `orgId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-organization-members.api.mdx b/platform-api-docs/docs/list-organization-members.api.mdx deleted file mode 100644 index 103c08fc0..000000000 --- a/platform-api-docs/docs/list-organization-members.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-organization-members -title: "List organization members" -description: "Lists the members of the organization identified by the given `orgId`." -sidebar_label: "List organization members" -hide_title: true -hide_table_of_contents: true -api: eJytVttuGjEQ/RXLT61EIb0oDzw1vSrqLUrapwipw+4ATr3rjT1LQhH/3hnvBQgbQqI+JbbP+pwZz5xhqQmmQQ8vtfP8d9TTKYbEm4KMy/VQfzWBgqIZqgyzMfqg3CQuGQ65+QuCUybFnMzEYKrGi3g8NXPM1W9Gnaa/+7qnXYE+gk/T+tofGzd8qy5nXAEeMiRZDC+XOucF4+M9fGpEUwE003eFbt6m8jJDb5K1Ls94j9el8cj05Evs6ZDMMAM9XGpaFEJicsJphE6cz4CqreM3erXqtUoyuG10XJfoFztCzmBq8koGY5XHUFqSyA7ke/1qi89NJgHpYMoW/jS2gOCT2X62T8by86gKqtr36uIM5E0+ZYaRpD8ULg8Y5PzV0ZH8ufOEX/iOxLHOnOQUisKaJMY1uAoCWe5SuPEVJhJw4aXEyFQEdbVuAMF7kGAMYRYOvUCK9YD66OkyPBL8PSZ8J1M9zeEZ23kyMT7Qvd9Z2HMIcyDwnUfe2Y5vWAc3UfSFmzyGUSUkvpC1MHbczc6LYdy+EOiLOXgponDQN2RIWKVrz4Wfa7Ddq7zgw/gDuWrfEdgL8xcPbNX2IjGZ2ljO6+Ljc0G86Sq/d5Aq8QgM9Jg6XNvKJccbAkwxRvhAdVXAjlZZ6//ovfM7yl93NE7jrSp3pMBad8N6BB4wKb2hRfTSd9yx6E9Kds/h5Uh6kht35sSPp9EzorEO9UBGwWAZPXc1yFpr5qqdN75ceq5RPSMqwnAwgML0E+vKtB/wmrX0jduxjYt4os4skLyZei94dXJ2qkVJI/RC8lrlaFNumyZhbJxG1uMI4p3qn09NNVzdUEyAyScufl7ntFYhtA8JlHBNgqEGS0FAEgtiO/jNkOvmjbRv1wcsRDJX8bzsHx/3j2SvcIEyiPVU+6+U7PZoXad/S+1yXaD/b0bXOSa8pUFhgWeAmJWPblTVRv0zoaeHzURu9PEbzjgcgSyXYwj4y9vVSrarKSJFk5oAYyutMgEbcE9I9w7RTol/cNFO5jnYUhBaptqTCNsRuoerxTyR7v4Zuoe0Hc5r0pEsvBHWR2b42XntW8/Vwz+dOkU1czVfbEpqMxTrYzVi4Awh5WtEX3V2kiRYbGZvx2G3zOnzx5+MhW0juNP48fZORVyNEfHT/cGcK7IRSLIWgavVP5D1yC0= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists the members of the organization identified by the given `orgId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-organization-team-members.api.mdx b/platform-api-docs/docs/list-organization-team-members.api.mdx deleted file mode 100644 index 8aedd4120..000000000 --- a/platform-api-docs/docs/list-organization-team-members.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-organization-team-members -title: "List team members" -description: "Lists the team members associated with the given `teamId`." -sidebar_label: "List team members" -hide_title: true -hide_table_of_contents: true -api: eJy1Vk1v4zYQ/SsCTy3gtdLdRQ4+NdvdFkG/giQ9GQZ2LI1lZiVRIUdOvIL+e2dISfFXHCdFTzbJR86b4eMbNYogc2oyVYRQODUbqRRdYnVF2pRqov7QjlxES4wEEBVYzNG6CJwziQbCNHrQtPSATK+wjL4K7jL9OlYjZSq0IAddpt1Rf9sMSv3dT94y8M9wHmMrsFAgyWAybVTJA95jbMZ7R0oLlwpoqXYJbp4YlXWBVieRTrEkvdBoGW/xvtYWmQLZGkfKJUssQE0aRetKguiSMPPQhbEFUJg6/6jadjQwCWkdpSIJ/Z8UCnjs49/XaNd7BK4g02WoBGMji67OSYp7YrwP77fimcXCIZ0ccoC/LZpDsMlyN9reWY6sLjNeKes8h3mOoaZtO5Myu8qUDp3g35+dyc+OWn7nnYlhPiXJKlRVrhPPP75zAmn2Q5r5HSaSWGVF0aRDgO4tbADBWhDSmrBwpx4gb+MEHYxU7V4J/ssXdrdyvMjp6fzgykJbR8/uy+HIIqyAwB5csiY/sId58GMR7zEPpU8jFMTfkNytYfMwVjzp8Z1A363AiljcSXtIk0QVg7iW+Ky1YS7Yzuf5ZzJh3hDkN/o7nvgkh4PE0zoPu+7Ex+uC+HhIfp8gjcQL0NFrdPhkH1PO1znI0Gf4groCcP9CNvh/sdbYPeYfDjyc3sqj0lAEeW4emI/AHSa11bT2tv2JHzHai5rdcTKdyZtkT18asf/Me4M3zomK2dhd3Hh7b2Pfe+ImWGwbF0NTYBGv+o5QW5asWhJVbhLHUOlxkps6HTu8Z2pjbfa86cavRFc5kFxh9Ivgo4urSyXEet43UuZQsk32Q9UkYm9EMp57EM+EP7/24rh7IF8PXS6M396VuGMhYV8iKOnqBF0HFn1A4vWxnfxmyt1b9mF/flpgIlK5EOen8fn5+EzmKuOoAC+vznZFwVu9fZdl86TT//Y10NWT8JHiKge2efEp640oyGIq/V4ITPq+H75KeGJovz1LvsElJyObmmYODv+xedvKdGgdIplUO+kQrL4F5A6PJPZs5zxI+huuh3a8grwWhJJW9qaAQ988EmvAHA8XwEMnfQLPZGB16JevqswP1535/Bi9/Kl1MIO+OZbrTUpDZv6mX1e8DU7Pf3O9gUsnsnbGyCVCyudIscLiRZJgtXkFe569ZXe/fbllLGx7yY53+NMPUmJJe8St+YYly3pgKGMh2Lb/AjV5ArU= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists the team members associated with the given `teamId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-organization-teams.api.mdx b/platform-api-docs/docs/list-organization-teams.api.mdx deleted file mode 100644 index 4ed2bb7f3..000000000 --- a/platform-api-docs/docs/list-organization-teams.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-organization-teams -title: "List organization teams" -description: "Lists all teams in the organization identified by the given `orgId`." -sidebar_label: "List organization teams" -hide_title: true -hide_table_of_contents: true -api: eJytVttO20AQ/ZXVPrVSlFBAPOSpXCvUSkVAn6JITOyJvWB7ze44kEb+9+6sL7mZEFCfwDuHPWdmz8ywkASRlcORJITUynFPhmgDo3JSOpND+UtZsgKSRHiAUJmgGIU2EWTqLzBKqBAzUlOFoZjMfThSM8zEg0Ndhw992ZM6R+PB12F96e+VG+49d0/mYCBFQsOKFjJzHw7tb3FRxXpyoFhuily9S2RFikYFS1XG4Q0+F8qgIydTYE/aIMYU5HAhaZ4zicoIIw+dapMCVUcnx7Ise62SFF4bHc8FmvmWkBuIVFbJcFhh0BYJcWZ78h0drvHp6dQi7U3Zwj/HZhFMEO9mu1KJex5RQUX7Xl2clozKIscw5vLbXGcWLccPDw74x8YT/nR3BNrpzIijkOeJCnxeg0fLkMU2hZ48YsAJ54YNRqoiqKy8hIExwKkowrXzHX/ONt3DG726dltJb9StIw4zIDB/TNIZTTGduDY410VVjj1cKklRwiDupovJBenqVBMkd+ovfvQablK+6rZ+Oxfk8HHX651BKLjF0NJHnnHZlSOXsbUQIU+g3c/TADucthR/aYw2W8qPOnzXDCaRaeI5p1+cHoZbDAqjaO5H0ZkzPJrTwg2f4WjMlna+jzUPs8i3nJ9LQzlww8oOFn5klQOq55pFM2uGWsEvLmOi3A4HA8hVP0h0EfYtPjslfaW3eu7OR8RNAsTPJc4ZL05vriXraGTecVWrCq2KbYvEjE2b8vfEg9xJ9ctVY4THF/Lpq2yq/Z/XFa1VMO17AjldFaCtwWwHCLwd1pNfTdk5QiXeh1P9fRlwQrhyFc+3/slJ/4DPcm0pBe+menixW9e3UlP8jUZszfm/VltdX8JXGuQJuOHpBBZVX1euGPEKYynDZpW1yzZ2iTBgsZiARTcNypKPq+HLdgmVhUnCLTKFxOKOdN7cPZ0Cn3DeLrQZJAUjJC+DTxG2m2cHV4v5JN3bq2cHabvTlqRj/jCKWT9Y4S+39bz6Kt7/j6NTVLOQsvmqpLZC3h3l2AFjhNBdw/qq2GkQYL5ava3JujaUflzeOyysj4CNlve3dypybvSIe/2EmXNkI5D4mwWW5T/h/YIX -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all teams in the organization identified by the given `orgId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-organizations.api.mdx b/platform-api-docs/docs/list-organizations.api.mdx deleted file mode 100644 index 65dda34c9..000000000 --- a/platform-api-docs/docs/list-organizations.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-organizations -title: "List organizations" -description: "Lists all available organizations in a user context." -sidebar_label: "List organizations" -hide_title: true -hide_table_of_contents: true -api: eJydVU1TGzEM/Ss7PkNCgeGQU6HQDtNOywA9MRyUjZIYvPYiexNCJv+9kp0lu/ngoxeCrSfpSfskz1WAkVe9O+WIf+/31AB9TroM2lnVU7+0Dz4DYzKYgDbQN5gxEqx+AYH4TNsMssojZbmzAZ9DR+0pVyJF++VgGeRP04kRJRAUGJAk+VxZPjCSnEE2akn9VCHN1DqhZpyUVnwyPUAb9FAjsYfPx1iA6s1VmJUS1gfSdqQWC66P0JdMAb3YDw8O5GctxU+OEYuxQaxQlkbnMWP3wQtkvpnC9R8wD1IYSfFBpwStXjXgQARSnA5Y+PfDlDCTAla4vuOqwcb2lITMDrnTgSpc7ElS6fsrWHMpo9iZoaMCQro6OVaMTY3f6BRDK2N+7zK2GrbFblzq11bjFPue697hOHIt7m3TXzJbbQUWfaQPF53g1yK2jWh7Cm1VxImY2uif0FEThifAsbIdyag87wt0fwIkXfQf8gk6SFbRcczPbFL+3TwghwEWOperCZiKOxvtLBH+2wcfTVIv8zA7iH0+SIPprTBbLFp3r7I+758Hl6wugLnRL/juZzg6bIXbWBDXyyFllOCOt43pGQwyQt4SPnxmXsVFk0zLHX8l72GEsdo3568GblkpqyouiBxtMD/asmDq7ZhZF2S5uinzEbjHvCIdZnEnniEQ0mkVxny8l93FC3PsZKOOMHIEMaluXN3iTJN6n1YyKGocQul73S6UupMbVw06Hp84d0e7jcV6Ey3ZlYEgXyr7Jvjs9OpSSeaa2I30MfWkSe+1LZKx3sBxT0WQKCz+873WwMM0xIK1HbrovuzhkoWkfY+glKtz9EuwCADyKIB28c2SWQPaRAkO3deVgYlI51KeL52Tk86B3JXOhwKifpbvkwi1/f6t05yvlPi/j+eylXLslgb4MWQuVdp86ZOvXusxU5TzfM4jjLweFwu5Tm+nCGGgveRl0QzBeHyD7Ude1q3UHnG2erpltwgkqoYXkJbsUb9MFnkHUaSVfE7zHMvQ8NoY3Zbqf1zcMhbailtTWIxeP7J21ojNLYqIW/eIlttUEw9y5kQ8r/8ADVod5g== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available organizations in a user context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-pipeline-repositories.api.mdx b/platform-api-docs/docs/list-pipeline-repositories.api.mdx deleted file mode 100644 index 61000b2e6..000000000 --- a/platform-api-docs/docs/list-pipeline-repositories.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-pipeline-repositories -title: "List user pipeline repositories" -description: "Lists known Nextflow pipeline Git repositories, extracted from existing runs. Append `?workspaceId` to list repositories in a workspace context." -sidebar_label: "List user pipeline repositories" -hide_title: true -hide_table_of_contents: true -api: eJzNVE1vEzEQ/SuWz9GmQNVDLpCiUkUgqNoiDqhSnd1J4mbXdsezDdEq/52Z/Ug2HypC4sAp8frZ897zm6k0mXnUo5862AC5dRD1w0BnEFO0gax3eqS/2EhRLZ1fOfUVftEs9yvV4dW1JYUQfLTk0UIcKIagSQkyNUNf8JLPWzdXWLqYqHEI4DL1+H7lcRmDSWGSPSryKmfY3k3KOmXUFqZS74jvTvRA+wBohN4kawnetHxuexcwMBg0BRCgiKy04wUf6JVmjBWRzyXgWh9K/7Et7soC0KbKZuDIzixgoiYz5QtLrHRQs48n6JcRsM88pgsojB5VmtZBuFjemgPy1sxjYaj5dHGuNxt+CYQYvIushU+8PTuTn32K3z7z0bqAI9k1IeQ2rc0ZPkWBVMdF/fQJUhJ/UKwk2xTYhWAHNYhGjLEERf97JORHZZabgSZLORw8xMTN/G3LXlAMOz/F/9JkbBvbH+lvhMgRi5BJdguI0cxBkvu6vg54QsVOxBWixyPm704434VQOU/K5NwWzEfgEdISLa3rzF2CQcBxSQtePsijciAXXoI7h5qjkS093Lo/xP0Qc4ReugSXmDN2QRTiaDg0wSZp7sssifDMbBLrjzJ8V++om9yQJEx9FLwa30y0cOmo3omzjUt9wlujpGIXX1lPaxB/af586rL7tKLaAsvPXx9vXW1ZSNk/ERS5NuUGasASCR4nctm++L5kToXN69aZ+Q+7DSYizjV13iQXF8mZfGN3qTB1otqJIMltenU72A4eYY9ztQvq/zge2zeT5TDkhgcci67Nq9q09Qe+TJmeVA7Fgv0RTFVNTYTvmG828rmZkZLCzEYzzaX7ZiaP8Io7/36CnhS3hPXRXH8xeSnIOucvBq1QrnuQFYLJOL6ipTk6TlMI1Dt1NH72Ovf66p6xZr9HDnqivr2bom7du5t9rRH3fgmOve34k6y5EM+c3164q7c= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists known Nextflow pipeline Git repositories, extracted from existing runs. Append `?workspaceId` to list repositories in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-pipeline-secrets.api.mdx b/platform-api-docs/docs/list-pipeline-secrets.api.mdx deleted file mode 100644 index badf10182..000000000 --- a/platform-api-docs/docs/list-pipeline-secrets.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-pipeline-secrets -title: "List pipeline secrets" -description: "Lists all available pipeline secrets in a user context. Append `?workspaceId` to list secrets in a workspace context." -sidebar_label: "List pipeline secrets" -hide_title: true -hide_table_of_contents: true -api: eJzFVd9vE0kM/leW0T20uvzqXVWJvPQC4k7VIVFREBKlB+6uk0w7mZnOeFvCkv8de3Y33TQR9MQDT8mOP9ufPd/YlSKYRTU+V157NNpiP2IekKK66KkCYx60J+2sGquXOlLMwJgMbkEbuDSYtV5Z45Vpm0FWRgxZ7izhZxpkE+/RFtmn4zsXrqOHHE+KTxm5zHDATcc1Yu2tesp5DCAcToqGxWmT9ayh2lMeAiyQMEgtlbL8wdhOQsZoKeKmxLBUD0t7t85rywUGnWe6QEt6qjEwOOZzXIAaV4qWXgJrJjdLpqkLC6D66OhQrVbctoDROxsxiscfo5H8bOZ79S+7phItiRW8NzpPRQ6vokCq7aTu8gpzkmKDtIR0ncA/aMa9A4QAUqsmXKTzgDelDljIfacWMdnvB9fFY6ruKVuaJAg1plDiqtfcQKUW8Pkl2hnN1fhgNJKLIr4l6cF/59D/Mum//3ixdzw+H/Wf8n8+ufj9697H/b3jJx8+HOzvVwe9w6er39SaZ6Sg7UxxBgOR3kbsEmyMHX4FEPZJMxe5FiheWbNccxTjcz6lnwmSaPjiZ4JwFNIkzVObylbJ5AjMmf6Cj9PffawdL+V1o0zGCfJwlzafQZGJUDDS/xFpV1sLjBFmj5BXC9xqXLeOFyG4sMX8zx2vqh0UmXUkg8rdMR+B85Apg6ZlGg7PEAKGSSmaPL+QB8uTY+5kuMwwcQQxqeHWSJRA4bYdMmUwjJoT+TgeDsHrQW5cWQwi3jCPgXZbY+YsWbJTAyT3lj0XfDY5PVHCoiV5Jj2t+9Olum6RZGyHknxfJhCf1H/+bhVxdVcLSNupS+5NPxsWkvZHBKVcnWNswCIGyJMYNovvlsx60CYJcur+ujcwEelcnedgcHQ0GMmZd5EWkLTUDG2R7dZeeci0uhfmL9tLzXXI59Ab4PXC9aS+VI2Edm/VOZcstqq6hIhvg1mt5LjeTCKsQkcpggU5BRPxO6X/YG/tZHiNy63VeAumFGTS4S0EXc9yfh1Ml4cVRxNiteskz9FTx2trMGy8qX9evGEsbGr4gWZT9HZr2WUnNjcpId64a7TcqJY/yTcn4mnwDaM3Bh0= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available pipeline secrets in a user context. Append `?workspaceId` to list secrets in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-pipelines.api.mdx b/platform-api-docs/docs/list-pipelines.api.mdx deleted file mode 100644 index b03c9d7f5..000000000 --- a/platform-api-docs/docs/list-pipelines.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-pipelines -title: "List pipelines" -description: "Lists all available pipelines in a user context, enriched by `attributes`. Append `workspaceId` to list pipelines in a workspace context." -sidebar_label: "List pipelines" -hide_title: true -hide_table_of_contents: true -api: eJzNV0tv4zYQ/iuETl3AcdLdRQ4+1XkVRr1JuklaoIsAoqWxzYQSuSTlxDX83ztDPSzbsuK4e9iTLXLI+ebjPBeB4xMb9L4FWmiQIgUbPHaCGGxkhHZCpUEvGArrLONSMj7jQvKRBFaJM5EyzjILhkUqdfDqOgxSI6IpxGw0ZyF3zohR5sCGXdbXGtKYhS/KPFvNIxjEIXOKSVSxeWclU17cDTqB0mA44RrEBbLbCngn0NzwBBwYMmkRpPiBUisEKCLIou8ZmHmwaWc/jgX95WhoeYTNuMwQEWIUaSSzGAicmwIzYLVKLbBfQqQEpA07LFR4VyL+BbTKOu4yi2uRSjTedJnOwg9d9hVcZlKkM2WQaDfPFVSX9FiaSYlXgYu6H5gYM5UI5yAm4+FVSxWjSWMuLXQCiyQnPOgtAjfX3lJjONklHCS2tm7RmnRCN6RZQq9d4cS1XDH+WQElH3g9IuGjGTdEo93zlBNOksbyVf4kpvslm8FyuexU71JzgvaH+bvyBEQE6FtMxJA6MRZgiJctHgT6ywQMbo2VSbjLl04/B3X1CX9tV/uFv4okS0jpCN1bjWseiv5g/EsydEj8izdY9w4snz6uYVHjsQXXDue6goGul0nnQdhnoRlezDSfiNRHRpddwJijQI+FJ+HhmCxwE03bMV0ZgCOKTZZLs7GQGH6EDK/Fbz7hIq3FNvPOhN4fs9pNthFl4bV1TDNhxUhI4eZv4MphrN4LM9HqLOahKAKNDIbaiBl3QLFrp9xg4HYYshlitmumrgKFzl6mAB9qH09O6Gcdx80fPkKQ7tTRLtdaisg/0/GTJZHFtgo1eoKInEEbSndO5ApWGfrtgH/jCkqeewRLp6B9y/gNuhv2RbRjw4BWVjiFj9a0TYVkb3QkfL0LIW1eCWNdq8SQtwgoM9kbC8ruvKee6Pa7rTqx885aJDS/j8Q6WFc3UkoCT2lTotEPOubrAlWRqOCQxBGmfPAG5sm/Kr5NfNVE7rmZgGsoQhtyd75MttWqm9v7wZfBP5cXuFb8758NL/Hr4br/V38w9F8NtedmW82yKlwHx5D437HjK/6O4LAqMxE0P5uwRWLfuT1HnSLatT1AsEYryXc6Bj34uYH3OMZyxfuQmL0YXTjll2uNwftIXfGxk0KNRhCaHSxOmtNSDet5BW4FeNN/ajvKcXmHnc+ePcaKknqD+rUoF9QFocznpoJxxuOym3hP5aAjwtCrfQuwvlo+AR8RraSXgq1EXRqjzBbyTw2lruzMWaocTQvqBfGQuIUoMz5RYU9+hn0CmH7mpvj5SFUUG/apom5+4jsgzWkrONa1vh4T9axs6jMjcXvqnLa942OuRTeSKou7Fr4jgK5QW83And9ht4XPsHOSZ/3bQUDqS3R3RGZOTB1jxQ1pLBsCHzZeCFfyP1elEzy9OG+1SMfKHy+ILFCQ2rcAkrkiwq4lFyYv4JH3gnXj6yajIwjpfXCsflttULpB5nI9v3ZPT7snPn6UdQn3TlR0VsO1CWwT4mLlij/VOFi8DX0eY04QPot5khaFI21MtlM0nBYXixG38GDkcknLeRdJ7hULSxbF1ZC1k4efflxsJOcZ5psjcVGPgoAa7f3tf2sqa1G/PvkdqP+g8awFVD4PHgjm8OGsBVE1FR4I6kdOZy0wq0HxUJg/alhrwbg2OK5wPtKHEQTUlyNMEMBjTOuUCvKTufbaqa1KvFbEfr+8R1m+Xjs2aoW/vew+0zoiTEte4l49Q4qpqYTv6BsVYfn9D/bU09U= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available pipelines in a user context, enriched by `attributes`. Append `workspaceId` to list pipelines in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-platform-regions.api.mdx b/platform-api-docs/docs/list-platform-regions.api.mdx deleted file mode 100644 index aaeca67f9..000000000 --- a/platform-api-docs/docs/list-platform-regions.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-platform-regions -title: "List platform regions" -description: "Lists the available regions for the computing platform identified by the given `platformId`." -sidebar_label: "List platform regions" -hide_title: true -hide_table_of_contents: true -api: eJy1VdFO2zAU/RXLT5tUtWxDPORpgNiENmkImPZQVcJNbltDEhv7pqyK8u+710mahEZFPOwJYh/7nHt87m0pUa29jObSpgpXxmVeLiYyAR87bVGbXEbyp/boBW5AqK3SqVqmIBysadMLOhJ2YpPZAnW+Fu1FQieQo15pSMRyF0BrvYVcPLSI6+RhKifSWHCKqa6ThuymAdzWJISxyqkMEBxrLWVOH4TtLiKIZqlW4Ua+1t9eJzw6VrgX5gjq4LnQDogaXQET6eMNZEpGpcSdZZL6kKyqyZ73xbgnb1UMHfFzAW53wPynBYq8yMDpeMh9wKVzhHXYYr0K66WzU2JfsFRvyQ7wfOLzyQn/GfL9+kFHY0O35Mi7ytpUx8Hc2aNnSHlIapaPECOb7PgpUNcEzQv3gMo5xTVqhMy/fYFORlycNB6O2CtRY8pLlyFLUL8+7fS2OB1NKm4bNxhAiNMxPy5UIviBweN7jOkyMZcZeK/WwF1xvNwWeLS0K+eMO1D+ZeQl26YQuUGh0tS8kB6Ge4gLp3EXGuEClAN3XlDqo/mCQ0JdsjHcSGsIGrkhIjnbt/es7Lqmmrl9h3lw27a9CpfSmQ2i9dFspqyexqkpkqmHZ1I11eYg6HdhR+w77ZLx4vzmWrKmVvIdO1y71Re+N4wZ27bg72UA0Ur9z7e2Jx5fMFih85UJxxt3GxVM+5ZALlfH4BswR0PFIRrD4vslUzp0GlpyZb52GySEnat5Pk3PzqYnvGaNx0yFZDVjg8PbjcfO+oHSsovp/x68jesIf5HzQXOMZIfyyyY3/Z+FiYwG87bVT++7oVIZXJZL5eG3S6uKl+uZyIFKtGfxFMuVSj0cKfmNiTkq+Ql2B0N5q9KCkSF/W+U0879Ty4fbZg58FEd/QkZFtTMz3/XVtGJ7TlYLQm9AJXQX66sB53EMFntHDybWoNm/X90TVg3b6VX7hNtHZdG7BcS9eYKc3q5VifzNAqvqH1gy1kc= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists the available regions for the computing platform identified by the given `platformId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-platforms.api.mdx b/platform-api-docs/docs/list-platforms.api.mdx deleted file mode 100644 index b70c7d355..000000000 --- a/platform-api-docs/docs/list-platforms.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-platforms -title: "List platforms" -description: "Lists all available computing platforms in a user context. Append `?workspaceId` to list platforms in a workspace context." -sidebar_label: "List platforms" -hide_title: true -hide_table_of_contents: true -api: eJzFVU1v2zAM/SuCzkHSbUUPuWxp0Q3FCqxYO+xQBChjM45aW1IlOV1m5L+PVOzYTtKPAQN2SiQ+io+PH65kgMzL8a20OYS5cYWX04FM0SdO2aCMlmN5qXzwAvJcwBJUDrMcRWIKWwalM7F1FEoLEKVHR1Yd8FcYiom1qFNx9/HJuAdvIcGL9E4EI3J6c9d1i9n6y4E0Fh0wkYu0pnK1ZTqQFhwUGNBxDpXUdCCUcRmhB1Ix+8cS3Uru5vTNZaDV7/iy0GWBTiVCpaiDmit0hHf4WCqHFHUOuceB9MkCC5DjSoaV5TCKSGYRy3QgbK5OjuV6Pdhy6ST+MqOf2+z/PZ0p+3trtEfPHu+PjvhnR5Kv5BqV14GtYG2ukqjQ6N4zpNoPamb3mASuhONKBbUJ0HZTCwXngNNWAXv3zzyh0g7GB0e9JteDWtYDhoTEYb1InStnliSee0v05gGqmQwq5Hx3Fpsbm0brG3st+L1WlSGEOT6k6ymkgquHPvyNwG3Bb2WB3kOGPJovi9YAD+TXZnDunHF7zD8c6Ihm9oQ2gReAeSI+DPeYlE6FVZy6UwSHblKGBR2n3Gw0kgvD85ph5AhskiPbmVxaE8tmbEuXk3kRgvXj0QisGia5KdOhx0ciMFRmb1iuo0U0dRBnjBeTqwvJ4Rt21yzmRpgux602HFHWk8TnWQTRzebP52aM7p9CzFrpuYnutZA1Cw77GkFOVyXoazB3ASSxC/rJd1OmRlB5nOK5+dQaiAgrt4nzbnhyMjziO2t8KCA2Ub16Lns7dpdi1bbi/93wdTH4yB1CK5KyiapUdefsfJ0WlClfVtUMPP5w+XrN15u1yv2UKs8ptLvy2cRf/wwcZPeAq85nZgl5yRjJa//tsV9Z+C8E7n9T2vBTPjjF8eMkklQItAejKBvXSZKgDR2vvSXUm98v5zeEhf7Y7IxJfL3ZsnrVeZsKFBE35gE1FanhH/hMgWjz/AGy6fV9 -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all available computing platforms in a user context. Append `?workspaceId` to list platforms in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-workflow-tasks.api.mdx b/platform-api-docs/docs/list-workflow-tasks.api.mdx deleted file mode 100644 index 2e8a16c6d..000000000 --- a/platform-api-docs/docs/list-workflow-tasks.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-workflow-tasks -title: "List the tasks for the given Workflow ID and filter parameters" -description: "List the tasks for the given Workflow ID and filter parameters" -sidebar_label: "List the tasks for the given Workflow ID and filter parameters" -hide_title: true -hide_table_of_contents: true -api: eJylWF9v4jgQ/ypRnnYlWnq7qz7wdEDbPXRtt2rprXRVH0xiwK0Tp/YEiji++804CSTFBdM+Qezx/Oa/Z7wMgU1M2HkI50o/j6Wam/CxFaqMawZCpYM47ISXwsDvcnvIzLMJW2HGNEs4cE2Hl2GKH0hZMcFjrVCkuJIxmOL/mJtIi4xY4mLFLDCgRToJRMxTEGPBNZJq/pILzREYdM5boYmmPGFhZxnCIiOQ4lC4WrUauCZjEd8Av+RcL5zIljBI84RrETWxt7BECnxit8ZKJwyKpdMfDfSEve5GvWETkVp7BkgbaG5yCcYf7/u3Bp4ajw0Hb8g1+cfQjNLQW+xGuxBcxgGogIiD0cIF5nAbUZ8JvZv3HRJRkMQYFJFV6Asz0X9E9NUXhzMdTffAWJoAKL5Rg8Ae3cX+kULVZCo13ND+t5MT+mly/fU38ogU2jkF2mVZJkVk/dJ+MkSy3IZQoyfUlJJMUyKCKACsaDUypjWzfgGeGL/j9LvJrwdUhkFOgUibmDuo024mU2amDmO0Sks7NvB8xI1x7mHtca6bfJQI2N6qxWnMgB+BQFCiB6YPII9UkkmsXf4nEhXnknvYfhN81utMpJheLhUZ4MkMvJKRopBCym2rCCt15HYKlUVMG+ceZkHu9liU5cZTroQnCnPJp15ivokiAD1Ird39SHk6c2rBX3mUg3Irn7Boiq4Z2nWXCaTK439V+l5Ii4hfqZhLVwRxvFnK3EpjpulCwioBlFuvR7R5NGOa0sW8QwUCKNbCPglxs8GyMWXqUYDMRmgW0lZrpbtRUXWc1hBwVyS7n2fjvGgAPL2gOZMHOI1uphld1k7zYgBuK1lPTZWPpM3LDAPQk1Sb/aoXws2aTHeRZpw933ozJup//JnjdcS0J+38AFqzwJpxAO3cPwbi3gK4rznmGqvnIQdmSvbhdX/NLKhFOjuAmhLEMzVE7MMTgzyXklH02UZ2tb5kPS3/Nlu3Csz1+W/8urvvXQ2Gw/Mz/H97f309uP6J//rd/l92qf/r6ubyvNi+6A4u7Z9u79ctLdWKDfX1ZYGg7MfLr4/+BO5IUecl6VBXMgP3WfwZJqumgGF94cw2WiNOG7dlI1YQKGDSy8o1bjTj2Nmmxor2f7i6uh6LA2qjuIFD2rt654Xl37AJ399xVYTOHqOS/pzK/5bk3x39aDXYBamCgEkcwlAeIjd4XWJCLuw418NmmOtujrNb5+GRWt0mG7JWAFNetstoV/s1waKeBuvpbnAW4OUWjIXEOTGoTYzUOMBU0Ww5sZOJnRI7YbuaH9vLzSS5akM5cxquZ9XAmWt0cTgFyEyn3WaZOLZ39rHhL6jhsVCOBp92ghvJgOIgsNdr0L0ZhKRfpf4deauwfN0Ia+MTYjUW0PfIEuFK8eeiirCnOVizinSs7PHSU6UUBLtPQFIXL39TEtt+MrJh1lS+rjJGmpA2wMfqz80GFU+0XIHzx/Hp6fGJvZCwnUiYjdJyUvq0Yxsqra0G/BXamcR2mGCt+MvS6ZuXBzzdaTwgFH5H50xt2/MQLpcjZvi9lqsVLReDHEUDtpZUNTCgxkwaviXGOkX3PQA45X3miPLmjWHGJLXPYUhjpj/8uy8BO4CL54XPA67fAXZgrWk+COd4CNiBtn5a+CDanqeBPcjFy8NHod3PBbsgq0eIDeIjfWhRXHgHhfGX2/Iu+RrsfExzylPNsGnD9PU4L1Nw9YjUU2zraIhF+QqCbhTxrB4jW7ceKbau8D/Ph0jLmmX0Tdm03J1iYcpbiqF65immfSUl0DcJuFr9Dw+iC3g= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -List the tasks for the given Workflow ID and filter parameters - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-workflows.api.mdx b/platform-api-docs/docs/list-workflows.api.mdx deleted file mode 100644 index 038afd443..000000000 --- a/platform-api-docs/docs/list-workflows.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-workflows -title: "List workflows" -description: "Lists all workflow records, enriched with `attributes`. Append `?workspaceId` to list workflow records in a workspace context." -sidebar_label: "List workflows" -hide_title: true -hide_table_of_contents: true -api: eJztGk1v2zj2rwg67QCuk+m0PeSymzjOwJjEzcTJ9FAUCC3RNhuJVEkqiSfwf9/3SEqWYsqmusDuYLaXhBbfJ98npfcSa7JU8cnn+EnIh0UmnlT8ZRCnVCWSFZoJHp/El0xpFZEsiyqgSNJEyFQNIsolS1Y0jZ6YXkX3RGvJ5qWm6n4YnRYF5Wl0/09EUwVJ6CS9j7SIMiC4QytiPCJRDRolgmv6rIfxIBYFlQSFmaROnE+1tIO4IJLkVFOJerzEHH4A1FYSAGGoxreSynX8WrnTNGW4JFlUo0SPJCupQlEZT7IypSicXlGQVRWCKxr94z4jc5qp+0F0L4BWzv6koJzSRJfqp2F0Q3UpOZwaj2he6LUlWaOdRLzMsvufIraIRM60pikqSp+LTKQg/oJkig5iBUebk/jkJdbrwmglJUEdmKa5ajxXIDlfIgVe5mjOWiZ4ZlnCIqdKkaU5kZxxlpMMjf38BpHePBKJR6d6YmumM5SgssjveMqn1UnGm81mUNuk4Qf7jfKp9gKQjIKHRSylXLMFozL2HAsDV1marYWQOdH20Yd3cZN7Tp73c70mS8aNn0UAi7YuM63C+f3ytsVPLBaK6mCWNfj3cVOUyGS1n9sFyyBMIgsa1XHj4+kcarMBE1dObxzu7fEx/msT/vgb0DAByzXukqLIWGL0OvqqEORll4WYf6UJKlxIDHDNLINtIjrs9gdIHIasfTo4xODMY5Z6nkOaeuJUTtIgv4QjL+cQ+L4YrmFToukbiERq4DWRPcATkRcZWDccA3+MJIW/HvW6kDKi9F2R9kOSJZ8ar/UcIriZcpneswvWW7DMj4lWP2fSuwenAYfdQbRUVHbLY9y8A1PSR6aY9W8vT8LTS8b9lEEX9MkDnDu3M1LyZNUhmK1D+wrE7O7sanJ7Oz6HZzd30+lk+iusZnej0Xh8bp5enE4uzWJ0Oh2NL+36bvrb9OOnqS/zzyxPcyzfSgZZA8oAZu3W+cyFyCjh9oD4gi0hKfWNP5O5vHmA1NX8uhHnWpa05ncLTYX3zMBYbEGVPpw1OJBAjf+AnsNpBwXjkvKlXsUnb48Hu8RTuiBQTc4kAaOFIDyG016JnEIhoTuwPuAl07lIS3fmDfCf3/vlbuT5Nvzx23ceBO789SDlnDA+M7R3CPvASalXQgZRZsnuub1/vwO4abjw4qoyPqrgzHvYEXoYaV6yLN3R1AOISRLCNy9C82lLj2klu0sCAdUSKwW0ardA7CJ/bQzvAScEW/6RKHkzWLrbFHhCIMp7YbAlF7IfiiqThPZDaWjidN9NpQ2qXTAN9bpAmvp0wVhprpPmLqTreVt4MC/RW67B4E6RYHgncTC8lf68tFe1wC7I6tATyWnSC6sVJTMTGfCISinklW0CvSYxADe0EL7ey+RHbLKaRbhR4FyF72pKMG93NyxcQ4Kk/l0JAimmBfT4e5HHfNnVfdi0ftHVTNnuoku6tJ+96DPTs9cdyb6wxKtXq+1pHKoxvlK+zc1uU3I+P9fC2WIp23gHbg/XDQzX0aTYOZE5OIO5GluPx0VRXgriVphI7QrvjtbB4zqczA3tcaSfZ09MmwsbxE86ssC4vKK5MHc3/HFL1IO9e+PDG/ptu1bm3QclDw4XlzUu/qhw8SWMrR7Q3Kdna/tKRFKwpl2VnNt9eyWxurkYM+tHkTUFfpLQm1k6XwYHDrNi3udO1I6nffCV6L3SRjB1Z7owYOcLYcCVCwVq6UwVBl35WRi0dabxYsESRnmyDkz1RdkX5b93u2w0ZUG5iSYlZNKeVxAT3YGe4VJCMLRJJX3Md6NCZdnmkVDXqzJGGHwjNYQhtFJLoIM302cYyjaVhsOPwi3cSNthCHXaDgfvI36jFAQ6nWhde10Ym6uQ7iGnhe7h7Bahh78DwlVPl9+iBHt9jTISHBqR4lWr0zqem54RAiif+gYJ4PzRP04Aa9I/VNAkfm/wdFfGcra5wp6MquvdLmsnmf49eimn8o+u6kdX9aOr2q1ALjq8t9PAgoKX60LSxMpZvcMNry9d+KHlxovfq+HaRyGsGHkp9GrKvBT6tWleEn0bNy+Rvq2cl0iv5q6Twv9Pu9eo49c2TG0Zx+dCmy8ntpgHvaxpUzPF/5xoYr6HymXw11CA7fzS1RwbCLyGVBh7vp6ZqYbDd76OCsyCO9YuCcxASMfbPSVKmXS8/2Lq3H5L6txeA0+WdG1PQFhZiIx0vrb8jqLS8IJLPFn32s1+hJCyi9N2zmT/27zWyM+NG0cYtp6OM5rj9EHtxjOg2zcevHxwhgVg3vkGH85IGmE/i1+OekxANFtgN4JwuOnLO19TNzQY2/fVryT/ZVfyj9VMVcSFxuEu8URtElA0KaE+rM001RklksrTEr8Fff6C0yA51SuBc1hLM61SENyKj+qZCyQgH6tprFJmsLvSulAnR0ekYMMkE2U6VPQb8B8yEb8eUpmZnegaHBQtFY0QPjq9nsTIvRJuhmdpz6UpYn00yDF2cy3GqwwQPLGLi8oHvj5Zl2F8IQy6O0cnBbI9JCCqyyBjOmDz8t1+M2kr31QZ/IBlxgUX4l/bjWafFf88/PBheGwSPFzIcmJ8yE37XDYn6NRrEV+2nvi/H95zBsGfR0VGmAl8czIvznm2w4cYBCtz+/wcv7zMiaJ3Mtts8LGdaEKXSpkic3OFcFNynbr/pWb7vOfwQNfxq1lFVxfiGIe7wnU9MDK3h3t7Ku872XfOzu1hbAfy/nOG9eTcHl41zHey6x6d28O0nsnbMv2CPyRDriahgr9DN4+f+cCzLdYp3KeLpqg7taSVhn8d38Z2PKJZRNvpzlCvGh2+btCGKDMQt+KBcoi0SnSNv4ERFJB/A4OaEpM= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all workflow records, enriched with `attributes`. Append `?workspaceId` to list workflow records in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-workspace-dataset-versions.api.mdx b/platform-api-docs/docs/list-workspace-dataset-versions.api.mdx deleted file mode 100644 index c90837aa6..000000000 --- a/platform-api-docs/docs/list-workspace-dataset-versions.api.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: list-workspace-dataset-versions -title: "(Deprecated) List latest dataset versions" -description: "**This endpoint is deprecated. See [List latest dataset versions](https://docs.seqera.io/platform-api/list-latest-dataset-versions-v-2) for the current endpoint.**" -sidebar_label: "(Deprecated) List latest dataset versions" -hide_title: true -hide_table_of_contents: true -api: eJzlVsty2zoM/RUOV0nGttLHZOFVk5s+Mu20nSa5d+F6powEW0wkUiEppx6P/r0ART1sK4+77soyAYIHB+ABN9yJpeXTGU+EExac5fMRT8DGRhZOasWn/OjoKpWWgUoKLZVj+J1AYSAWDpIJuwRgsy/SOpbhAv6ESGwFxmIEOz9InSvsNIoSHduJhXswYiJ1VOCGhTb5WBQyyjDCuI4wDhHGTYTxavz6kKErcymwuDQGEEcDaHJ09FP9VATBeoeAI+xmesFAxGmLS1irY0ng2YN0qd+ylCtQ7NeDNne2EDFcJL8mfMR1gVCJhosEiaAT/ms8zuto/waI6FwII3JwuIB8brjCP7ipFxJ9JBFaCJfyXZbbwEyVORgZM5lglnIhwaCzgftSGkAYzpQw4jZOIRd8uuFuXdA5SAQsvStRKly9dPKWV9WoBZPLHK7IPyC5L8Gs+UA064xUS7SoMsvETQb1uVU1Jyi2wIzBkv/r42P62c7l22fcGWtEpBxZRVFkMvZERreWXDb7R+qbW4gd8WiIdifrA5oe6HkKYwShlg5y+3yEUHcq4W5+1aixfvUEPW4/7yc44JYK+wlEggXorDdaZyAUmUMWL6oXUmeA2vNsTf5d5WdcrBAN7UHqZEYUUFOVFozHj8V5mgqZvBBBG3Io1/rwIUvAt29Cm5OO2ohfY+gLtdDknwnrrouEkh1qvhYXeYwdNi9tWsgMHsWWQyKFb/Eha/8yvpAIM5RpL51tHTh3mFffTJqxIxU/wv0hR/R8O3SDzkTCqPCoY//nKvV7JQdrxfIFTdE4Ppnme2O02UP+ZuDuN5LJlEatzTL9gHjIvRsarYgBarl0a6+XZyAMmNMStXE6m5PQoJimmoR3CR41yeaUR20RbbTpFbSKmhEWrTpRxmZbNYrsa8mbYYRDZxJnuky6ibQnypfewr6HQcX+IX92+v2CE74G/iXxX3PZT6Klk05sRNbrgnfClfrjQ9N0tw/OEyXpdtD2wH1AQcc+B5DSlchMcKbGEbFvnO3k+ymH6+yPfdcZ+qrFX01OTibHtFZo63Lh+y4MlYPztrCH7KmHwC76TdfYf/MjI3SJg9+O0ErV052652edcBGJ0+03RftyG3XDErszxULR1s3mBs3XJqsqWq5HPl2HRFqa7HjBFiKzeB3vYL39RliJrCRovttXwsj6JTC099HCHvwImnTInnniDPLQjHy17uNpsPaJqOY0hsMMRoi1x2kcQ+F6e/cEdEtpPr6/Ql+xfX937quPPogLqfYeV/oOFNLdwHT0nwBW1R8J//xT -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - -:::caution deprecated - -This endpoint has been deprecated and may be replaced or removed in future versions of the API. - -::: - -**This endpoint is deprecated. See [List latest dataset versions](https://docs.seqera.io/platform-api/list-latest-dataset-versions-v-2) for the current endpoint.** - -Lists the latest version of each dataset associated with the given `workspaceId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-workspace-participants.api.mdx b/platform-api-docs/docs/list-workspace-participants.api.mdx deleted file mode 100644 index b80373332..000000000 --- a/platform-api-docs/docs/list-workspace-participants.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-workspace-participants -title: "List workspace participants" -description: "Lists the participants of the workspace identified by the given `workspaceId`." -sidebar_label: "List workspace participants" -hide_title: true -hide_table_of_contents: true -api: eJy1Vt9v4jgQ/lciP91JLPR2V33g6ehu91Rde60op32okHZIBnCb2KntQFmU/31nnB+EEihUd08Q+/N834zHM7MWDmZW9B/EUpsnm0KIVow7IkIbGpk6qZXoi2tpnQ3cHIMUjJOhTEHRgp76tfpkICNUTk4lRsFk5fdmcoEq+FFDrqIfXdEROkUDbPwqKs1/rxB3DQZCEiEk6NCwyLVQ9EEntJnRyY6QrC4FNxevJd+aGSj505MEKkvQyHCjzxDe4HMmDZIAZzLsCBvOMQHRXwu3SplEKoczD51qk4Arls4/izzv1Eoanh3UU/v3f4pJ4KUS8ZyhWe2ouIOZVEVMCBsYtFnsw3wk36ePW3x6OrXojqas4e9jswgmnB9m+yZjypWggAZ18rRxWmekmhHDmMNvU60s5T7tfzw7459X+fQ32Qg16VSOdyFNYxl6v3qPliHrXQo9ecSQHU4NZ7yTBUHzETXQYAywR9JhYk+ywq/oiEzpiASTCZqj4ZlF848P/k7UCC6NdXt3YziwSVGScesOPeyhjltO0SF6OFyo9FJ5uYUv/lbiGCaaCoo2XLtePjD0wwIMJ4496oyTjlm5bHh+kuIQkqMjxeC97i5teqxTECWU3SQUyDT4vzFkyqc9ZZ8qEmEhcfmGp6cZqtz/Xiplj7zS/YpvLm8uLoe0MLoc3NDPl9vr68HF7XAwuh02TTbq+YhNlcEaLMCB+de0pwEn3iFE3mr/6+Sr08WmdhDfy594ZAWtrXEranagYVkYCMSwz22l4QKigOs3WndKjdiU/AfKS2thhj5uBx99BTwYkktjtNlR/qmlqFVtOFDaBRDHekl6GG4xzIx0K990L6ia0n1k1Nb6D2Oul1RU55pb98zXc9/x+qJHr9f21r45573NQNFbN7pk3ku3Ozxd9aJq7xnftpg7l9p+rwep7IaxzqKuxWdS2pV6p+Df+53gLgbH1xp8YXwwuLsSrLNy456jXkSw6UwdRGasegR/TzyIVoo/36qEeVw6Hx6pptofLyNeqmDatwSyu5KCUoI5XSD06bLtfNPlsl562j83GySEI1fw/NE9P++e8VqqrUvAZ1vZOTmrG2PaqwvY0rveJPB/P/aV0Xb44nppzFWJ33rxwosceuAOwKL61YjXmEtpdXvc2nKErntOnrON9XoCFql05DkvF6MC51ckLUxifnNTiC0e8H3vpNTqwxOu6vFrAXHGCMGjy7sI6znpAFeNeSfd/kHpAGk9gW1Ix/xhJLOeGOHfhmUB/D14e1hvFVXNTWrVlFRHyCfQaVFpaHpjYH+HoGbu5mOCzxEiMsZhKxCDMMS0eak7HWSr+P51OeJOv13KXpUub71VFz0SjxjpJ1T0UCqZjr9ZYJ7/Ak+b2kQ= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists the participants of the workspace identified by the given `workspaceId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-workspaces-by-team.api.mdx b/platform-api-docs/docs/list-workspaces-by-team.api.mdx deleted file mode 100644 index 7f0e3cf99..000000000 --- a/platform-api-docs/docs/list-workspaces-by-team.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-workspaces-by-team -title: "List team workspaces" -description: "Lists all the workspaces of which the given `teamId` is a participant." -sidebar_label: "List team workspaces" -hide_title: true -hide_table_of_contents: true -api: eJzNVk1v4zYQ/SsETy1gWOlukINPdZpsG7TYBk66PQQGlpbGEhOKVEgqWa+g/94Z6sNyrDgfaIGebJGPM2+GM29YcS9Sx2c33IPIHV9OeAIutrLw0mg+439I5x0TSjGfAXs09s4VIgbHzJo9ZjLOwnoqH0Czr2TjIvnKJJ5ghbBexrIQ2k/5hJsCrCCjF0lr9u/e2OnmGk8iCM+IHDxYolRxjR8INjbFQxMuiVAhfMafsvzTpkLL78E+02UOVsZMJqC9XEuwiLdwX0oL6NvbEibcxRnkgs8q7jcFOZHaQxqga2Nz4Zulk2Ne15OeSRPgQSoUyX9JIRffOv/3JdjNHoFLkUrdZAKxzIIrlXf81f4+ftjxZ9ZrB/7VLnv4+7w5EDbODnu7ChiGK1goUoz5ct5KnaLlJaXdFUY7cLT/4eiIfp5Uz+9oIzbIT3vaFUWhZBziiW4dQap9F2Z1CzEFWlgqbS8bB9sOGWCFtYLiQMK5e9mGTF5VFJM2aXtRI7RU6vNzmzvBj+w/SCdXUkm/2d+ecMDaJr24XFx8mV+f48rVb/PF+RlJh5deEfjL1gJebr/cN/zZ6swb3Brs7QrCor0zwiDoeOzWTkXCFthS4Pxbrm/bhTc8B+dECoH6wRvpgCMVtg3h3Fpj95h/HKm3TgqZNp601Twin4A+3kd/RswnU+rk/xolbjqISxsKBlX7FPsT7LxEcZzdLKkFUdIzQ7KfBmkIujnjEeq6i6qg7nUU5k9UNQpbR4M+IvP2oZsJpVV4NvO+cLMoEoWcxsqUydTBPWZ1Ks2IXtAOu1TCUwuxXwjP5pcXnLh11K8od00ehgH0qSCPndTQ9yqAcKX586lrzttHH/Il9dqE423eWhbk9iWCFK6kGduA6dJFHC59N/hhyHjvUgVtWJuftxvUzpi5xs9P05OT6RGtFcb5XISaaYWX+o9R8tlO5p9oRV9//967oE2vh28+KpRA3Ud+Ic6qLZQbegAQmVn3EGjeKrjQz+MBabzTDMOjc1W1Eg7+sqquabkZJ1REiXRipag91kI5OBDns9N0lPcdbPoR/SBUSQhO4+1dDvtZesBXj3mnu/1hesBZP523zpb0gQdXVORvyuwPi1ajfmQvP99GSXXTVW+GlPrMhGJ5WzYGnJ5/x72DS1un9RKRGYgE7VCyms15HEMxvMI9ad/R0F/PrxErdtXpiRoF66OUsCUC4trcgca26BnSNxGs638Aee0kYg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists all the workspaces of which the given `teamId` is a participant. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-workspaces-user.api.mdx b/platform-api-docs/docs/list-workspaces-user.api.mdx deleted file mode 100644 index bc5f526e4..000000000 --- a/platform-api-docs/docs/list-workspaces-user.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-workspaces-user -title: "List user workspaces and organizations" -description: "Lists the workspaces and organizations to which the user identified by the given `userId` belongs." -sidebar_label: "List user workspaces and organizations" -hide_title: true -hide_table_of_contents: true -api: eJy9VcFS2zAQ/RWNTu1MSGjLcMipoYQ2U6YwEOiBYQbF3tgCRTKSHEg9/vfuyk4ck4TSHnpJbO3b1dv17tuCe5E43r/hT8Y+uExE4Phth8fgIiszL43mfX4qnXfMp8AaFBM6ZsYmQstfgnAIMOwplVEakLkDy2QM2suphJhNFuE4kXPQ7I6so/iOTUAZnbgu73CTgQ2BRnF95c/VZVcIR0gmrJiBB0uMC67xBaFVLDRL4poJn/KXCZA/0/kMrIwaUhTSwmMuLeCV3ubQ4S5KYSZ4v+B+kVF0qT0kATo1diZ8dXR4wMvyltxdhqlj0dDj4/4+/bWvPvuOrpHBKNqTVWSZklFItHfvCFJsXmom9xB5ythSWbysLsByu4GOm7qsuQhrxYKK4GHm3hSK6vyGNDuE/RFKvUI7b6VOatupScyVVbvM43D20tbhgN+DGk9EIoaZjOhoLlSOpQl25Iu/E+GCifhZLRQ15/Me+e7NhaUOcP8WxEuviM9ZzRDJrpr7zZVZeeyszwpxkiu1EzWXTk6kkn7xWqXOL0bXg/EQTy6/DS6Gx+tpXDcRMJ416k3NsWRQlq2CrPfYsTdte3syEYoOF/UYEBKhB9sG4UjEjKYNnP+biWgG9Ibjx3YigZD3q929BG7JtElkaK2xG8w/bRnhpTIxbTwTSpkn5ENwB1Fuw1dDOToCYcEOctSf/s0tqQNqVWpIzRIIHEma+rxHgtUrKtkqe2vCSwHtfClvOc0UT73PXL/XE5nsRsrkcdfBI/LpSrMhc5fBws6V8NSr7Avh2eB8xInNkuwl1baq0zrlVanoRl4rIb1PAojGKDycLKfg/smHIkg9NcG9rmvNgq79E0FKV9IyqcDUFCIKTdFOfj1l7AupwhBOzefGQFOElavu+dA9POzu01lmnJ+J0FP1uqD+rbbTa8vsJfWi6dj/sw7rj+Hh2fcyJXC3YTZ5JbNVI92EzYfQ/moDtpd4irkTrChQAAEluizpGEfQUsfiI0qoFBP6athvsXT0jP06FcrBKwV4d1EP5Xu2e7NuTWCpR5rUiISa3vDxARbNJi9vEZkCKroNxCrjIIog82tuG7rRGrmvwzFiRbu1X7RyiL6VEpYsIMbmATSWbcnQ0zsRLMvf9BAv5g== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists the workspaces and organizations to which the user identified by the given `userId` belongs. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/list-workspaces.api.mdx b/platform-api-docs/docs/list-workspaces.api.mdx deleted file mode 100644 index b225f4f68..000000000 --- a/platform-api-docs/docs/list-workspaces.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-workspaces -title: "List organization workspaces" -description: "Lists the organization workspaces in `orgId` to which the requesting user belongs." -sidebar_label: "List organization workspaces" -hide_title: true -hide_table_of_contents: true -api: eJy1VU1z0zAQ/SsanWAmkxTo9JATKQ2QgYFOWsohk5kq9iZWq1iutE4oHv93dhU7dj7awoFTZO2T9u3qvU0hUS287E/k2rp7n6kIvJx2ZAw+cjpDbVPZl1+1Ry8wAWHdQqX6t+KAaI4InYpbio3iW4FWrBMdJQHv4CEHjzpdiNyDEzMwNl34ruxIm4EL94ziKsXPhkJHZsqpJSA4ZlfIlD4IFnJQVDOtTGEi97l+bzNM8yU4HQkdQ4p6rsERnjlpB5QVXQ4d6aMElkr2C4mPGSfRKcIiQOfWLRVuts5OZVlO+bjPbOqJJJ14e3LCP3sUvtDRyNItKXJUZZnRUWDUu/MMKQ6T2tkdRMiFO+4M6k2C1rM0WOWceuQuICz9y3fo+K+K61RN3kI9Ono4DsxzY749Fdwp/kh8pb2eaaPx8TDckUBvxPq7HI9uBtdD2rn6PBgPL1iFqNEw+Ka5oSyb7a1eLmYXaCnUiu3qaVy9GWMIdHrs1c5VXMv1X56vUdNELsF7tYBA/dkXqYGH7WqVMHTOugPm747orXaSSC0KZYxdEx+Ge4hyFxpPFjoH5cANcjJNfzJlKZO/EsvuW0DgyH7qyx6ZzPeKYLWyt26bkiy8qh2ZO0PgBDHz/V5PZbobGZvHXQ8PRKer7YE1r0JEXBqFrD3xgfFicDmSTKbmesWt3bSpzXjbKc4oK9fy9yyAaGez+Fir+m6NoQc6ndtwvGprxYLTvkSQy9U83jZg1oSKgiZ2i2+XTLLQJphqbt83AfYBdW6T50337Kx7wnuZ9bhUQVLVhGPhPjVm9wkXjUz/z4yuWo7wC3uZUTR1iXOovajUMuGRzMT69Wje/SNJqEBGFcVMefjhTFnyNmV0rEparpTTasZPQ6KKtec1aXKujIdn6n01roz3Wrw88o/WUQ/TlEfpSpmcv2h5D4/bf5pySsAEVEzXML9NbBBFkGHr1MGI2HHXp+E1YdWujPdkG24/yog6FxDX9h5S6l5NEPmbCZblH2f/sB4= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Lists the organization workspaces in `orgId` to which the requesting user belongs. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/parameter-tables/actions/parameters.yml b/platform-api-docs/docs/parameter-tables/actions/parameters.yml deleted file mode 100644 index 968697b66..000000000 --- a/platform-api-docs/docs/parameter-tables/actions/parameters.yml +++ /dev/null @@ -1,21 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`attributes`" - Type: array - Location: query - Req/Opt: Optional - Description: "Additional attribute values to include in the response (`labels`). - Returns an empty value (`labels: null`) if omitted." -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Action name to validate -- Name: "`actionId`" - Type: string - Location: path - Req/Opt: Required - Description: Action string identifier diff --git a/platform-api-docs/docs/parameter-tables/actions/request-bodies.yml b/platform-api-docs/docs/parameter-tables/actions/request-bodies.yml deleted file mode 100644 index d5354365a..000000000 --- a/platform-api-docs/docs/parameter-tables/actions/request-bodies.yml +++ /dev/null @@ -1,278 +0,0 @@ -- Name: "**CreateAction**" - Type: "" - Req/Opt: "" - Description: Create action -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: source - Type: string - Req/Opt: Optional - Description: "" -- Name: launch - Type: object - Req/Opt: Optional - Description: "" -- Name: launch.computeEnvId - Type: string - Req/Opt: Optional - Description: Compute environment identifier where the pipeline will run. - Defaults to workspace primary compute environment if omitted. -- Name: launch.runName - Type: string - Req/Opt: Optional - Description: Custom run name for the workflow execution. -- Name: launch.pipeline - Type: string - Req/Opt: Required - Description: Pipeline repository URL (e.g., https://github.com/nextflow-io/hello). -- Name: launch.workDir - Type: string - Req/Opt: Optional - Description: Work directory path where workflow intermediate files are stored. - Defaults to compute environment work directory if omitted. -- Name: launch.revision - Type: string - Req/Opt: Optional - Description: Git revision, branch, or tag to use. -- Name: launch.sessionId - Type: string - Req/Opt: Optional - Description: Nextflow session identifier for resuming failed runs. -- Name: launch.configProfiles - Type: array - Req/Opt: Optional - Description: Array of Nextflow configuration profile names to apply. -- Name: launch.userSecrets - Type: array - Req/Opt: Optional - Description: Array of user secrets to make available to the pipeline. -- Name: launch.workspaceSecrets - Type: array - Req/Opt: Optional - Description: Array of workspace secrets to make available to the pipeline. -- Name: launch.configText - Type: string - Req/Opt: Optional - Description: Nextflow configuration as text (overrides config files). -- Name: launch.towerConfig - Type: string - Req/Opt: Optional - Description: Platform-specific configuration options. -- Name: launch.paramsText - Type: string - Req/Opt: Optional - Description: Pipeline parameters in JSON or YAML format. -- Name: launch.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.mainScript - Type: string - Req/Opt: Optional - Description: "Alternative main script filename (default: main.nf)." -- Name: launch.entryName - Type: string - Req/Opt: Optional - Description: Workflow entry point name when using Nextflow DSL2. -- Name: launch.schemaName - Type: string - Req/Opt: Optional - Description: Name of the pipeline schema to use. -- Name: launch.resume - Type: boolean - Req/Opt: Optional - Description: Enable resume to restart workflow execution from the last - successful process. See [Resume a workflow - run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run). -- Name: launch.pullLatest - Type: boolean - Req/Opt: Optional - Description: Pull the latest version of the pipeline from the repository. -- Name: launch.stubRun - Type: boolean - Req/Opt: Optional - Description: Execute a stub run for testing (processes return dummy results). -- Name: launch.optimizationId - Type: string - Req/Opt: Optional - Description: Optimization configuration identifier. See [Pipeline resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.optimizationTargets - Type: string - Req/Opt: Optional - Description: Comma-separated list of optimization targets. See [Pipeline - resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to each pipeline run. -- Name: launch.headJobCpus - Type: integer - Req/Opt: Optional - Description: Number of CPUs allocated for the Nextflow head job. -- Name: launch.headJobMemoryMb - Type: integer - Req/Opt: Optional - Description: Memory allocation for the Nextflow head job in megabytes. -- Name: launch.launchContainer - Type: string - Req/Opt: Optional - Description: Container image to use for the Nextflow launcher. -- Name: launch.dateCreated - Type: string - Req/Opt: Optional - Description: Timestamp when the launch configuration was created. -- Name: "**UpdateAction**" - Type: "" - Req/Opt: "" - Description: Update action -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: launch - Type: object - Req/Opt: Optional - Description: "" -- Name: launch.computeEnvId - Type: string - Req/Opt: Optional - Description: Compute environment identifier where the pipeline will run. - Defaults to workspace primary compute environment if omitted. -- Name: launch.runName - Type: string - Req/Opt: Optional - Description: Custom run name for the workflow execution. -- Name: launch.pipeline - Type: string - Req/Opt: Required - Description: Pipeline repository URL (e.g., https://github.com/nextflow-io/hello). -- Name: launch.workDir - Type: string - Req/Opt: Optional - Description: Work directory path where workflow intermediate files are stored. - Defaults to compute environment work directory if omitted. -- Name: launch.revision - Type: string - Req/Opt: Optional - Description: Git revision, branch, or tag to use. -- Name: launch.sessionId - Type: string - Req/Opt: Optional - Description: Nextflow session identifier for resuming failed runs. -- Name: launch.configProfiles - Type: array - Req/Opt: Optional - Description: Array of Nextflow configuration profile names to apply. -- Name: launch.userSecrets - Type: array - Req/Opt: Optional - Description: Array of user secrets to make available to the pipeline. -- Name: launch.workspaceSecrets - Type: array - Req/Opt: Optional - Description: Array of workspace secrets to make available to the pipeline. -- Name: launch.configText - Type: string - Req/Opt: Optional - Description: Nextflow configuration as text (overrides config files). -- Name: launch.towerConfig - Type: string - Req/Opt: Optional - Description: Platform-specific configuration options. -- Name: launch.paramsText - Type: string - Req/Opt: Optional - Description: Pipeline parameters in JSON or YAML format. -- Name: launch.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.mainScript - Type: string - Req/Opt: Optional - Description: "Alternative main script filename (default: main.nf)." -- Name: launch.entryName - Type: string - Req/Opt: Optional - Description: Workflow entry point name when using Nextflow DSL2. -- Name: launch.schemaName - Type: string - Req/Opt: Optional - Description: Name of the pipeline schema to use. -- Name: launch.resume - Type: boolean - Req/Opt: Optional - Description: Enable resume to restart workflow execution from the last - successful process. See [Resume a workflow - run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run). -- Name: launch.pullLatest - Type: boolean - Req/Opt: Optional - Description: Pull the latest version of the pipeline from the repository. -- Name: launch.stubRun - Type: boolean - Req/Opt: Optional - Description: Execute a stub run for testing (processes return dummy results). -- Name: launch.optimizationId - Type: string - Req/Opt: Optional - Description: Optimization configuration identifier. See [Pipeline resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.optimizationTargets - Type: string - Req/Opt: Optional - Description: Comma-separated list of optimization targets. See [Pipeline - resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to each pipeline run. -- Name: launch.headJobCpus - Type: integer - Req/Opt: Optional - Description: Number of CPUs allocated for the Nextflow head job. -- Name: launch.headJobMemoryMb - Type: integer - Req/Opt: Optional - Description: Memory allocation for the Nextflow head job in megabytes. -- Name: launch.launchContainer - Type: string - Req/Opt: Optional - Description: Container image to use for the Nextflow launcher. -- Name: launch.dateCreated - Type: string - Req/Opt: Optional - Description: Timestamp when the launch configuration was created. -- Name: "**LaunchAction**" - Type: "" - Req/Opt: "" - Description: Trigger Tower Launch action -- Name: params - Type: object - Req/Opt: Optional - Description: "" -- Name: "**PauseAction**" - Type: "" - Req/Opt: "" - Description: Pause or resume action diff --git a/platform-api-docs/docs/parameter-tables/avatars/parameters.yml b/platform-api-docs/docs/parameter-tables/avatars/parameters.yml deleted file mode 100644 index 1cf227918..000000000 --- a/platform-api-docs/docs/parameter-tables/avatars/parameters.yml +++ /dev/null @@ -1,5 +0,0 @@ -- Name: "`avatarId`" - Type: string - Location: path - Req/Opt: Required - Description: Avatar string identifier diff --git a/platform-api-docs/docs/parameter-tables/compute-envs/parameters.yml b/platform-api-docs/docs/parameter-tables/compute-envs/parameters.yml deleted file mode 100644 index 83eb70669..000000000 --- a/platform-api-docs/docs/parameter-tables/compute-envs/parameters.yml +++ /dev/null @@ -1,26 +0,0 @@ -- Name: "`status`" - Type: string - Location: query - Req/Opt: Optional - Description: Compute environment status -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Compute environment name to validate -- Name: "`computeEnvId`" - Type: string - Location: path - Req/Opt: Required - Description: Compute environment string identifier -- Name: "`attributes`" - Type: array - Location: query - Req/Opt: Optional - Description: "Additional attribute values to include in the response (`labels`). - Returns an empty value (`labels: null`) if omitted." diff --git a/platform-api-docs/docs/parameter-tables/compute-envs/request-bodies.yml b/platform-api-docs/docs/parameter-tables/compute-envs/request-bodies.yml deleted file mode 100644 index 1ee2cbff7..000000000 --- a/platform-api-docs/docs/parameter-tables/compute-envs/request-bodies.yml +++ /dev/null @@ -1,132 +0,0 @@ -- Name: "**CreateComputeEnv**" - Type: "" - Req/Opt: "" - Description: Create compute environment -- Name: computeEnv - Type: object - Req/Opt: Optional - Description: "" -- Name: computeEnv.credentialsId - Type: string - Req/Opt: Required - Description: "" -- Name: computeEnv.orgId - Type: integer - Req/Opt: Optional - Description: "" -- Name: computeEnv.workspaceId - Type: integer - Req/Opt: Optional - Description: "" -- Name: computeEnv.id - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.name - Type: string - Req/Opt: Required - Description: "" -- Name: computeEnv.description - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.platform - Type: string - Req/Opt: Required - Description: "" -- Name: computeEnv.config - Type: object - Req/Opt: Required - Description: "" -- Name: computeEnv.config.workDir - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.config.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: computeEnv.config.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: computeEnv.config.environment - Type: array - Req/Opt: Optional - Description: "" -- Name: computeEnv.config.environment[].name - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.config.environment[].value - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.config.environment[].head - Type: boolean - Req/Opt: Optional - Description: "" -- Name: computeEnv.config.environment[].compute - Type: boolean - Req/Opt: Optional - Description: "" -- Name: computeEnv.config.nextflowConfig - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.config.discriminator - Type: string - Req/Opt: Optional - Description: property to select the compute config platform -- Name: computeEnv.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.lastUsed - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: computeEnv.status - Type: object - Req/Opt: Optional - Description: "" -- Name: computeEnv.message - Type: string - Req/Opt: Optional - Description: "" -- Name: computeEnv.primary - Type: boolean - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**UpdateComputeEnv**" - Type: "" - Req/Opt: "" - Description: Update compute environment -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: credentialsId - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateComputeEnvPrimary**" - Type: "" - Req/Opt: "" - Description: Define primary compute environment diff --git a/platform-api-docs/docs/parameter-tables/credentials/parameters.yml b/platform-api-docs/docs/parameter-tables/credentials/parameters.yml deleted file mode 100644 index 9c0211a04..000000000 --- a/platform-api-docs/docs/parameter-tables/credentials/parameters.yml +++ /dev/null @@ -1,26 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`platformId`" - Type: string - Location: query - Req/Opt: Optional - Description: Platform string identifier -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Credentials name to validate -- Name: "`credentialsId`" - Type: string - Location: path - Req/Opt: Required - Description: Credentials string identifier -- Name: "`checked`" - Type: boolean - Location: query - Req/Opt: Optional - Description: If set credentials deletion will be blocked by running jobs that - depend on them diff --git a/platform-api-docs/docs/parameter-tables/credentials/request-bodies.yml b/platform-api-docs/docs/parameter-tables/credentials/request-bodies.yml deleted file mode 100644 index 4935fe8b6..000000000 --- a/platform-api-docs/docs/parameter-tables/credentials/request-bodies.yml +++ /dev/null @@ -1,112 +0,0 @@ -- Name: "**CreateCredentials**" - Type: "" - Req/Opt: "" - Description: Create credentials -- Name: credentials - Type: object - Req/Opt: Optional - Description: "" -- Name: credentials.id - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.name - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.description - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.provider - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.baseUrl - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.category - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: credentials.lastUsed - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.keys - Type: object - Req/Opt: Required - Description: "" -- Name: credentials.keys.discriminator - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateCredentials**" - Type: "" - Req/Opt: "" - Description: Update credentials -- Name: credentials - Type: object - Req/Opt: Optional - Description: "" -- Name: credentials.id - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.name - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.description - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.provider - Type: string - Req/Opt: Required - Description: "" -- Name: credentials.baseUrl - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.category - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: credentials.lastUsed - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: credentials.keys - Type: object - Req/Opt: Required - Description: "" -- Name: credentials.keys.discriminator - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/data-links/parameters.yml b/platform-api-docs/docs/parameter-tables/data-links/parameters.yml deleted file mode 100644 index db0c02971..000000000 --- a/platform-api-docs/docs/parameter-tables/data-links/parameters.yml +++ /dev/null @@ -1,93 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`credentialsId`" - Type: string - Location: query - Req/Opt: Optional - Description: Credentials identifier -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: "Free text search criteria — data-link name and keywords: `region`, - `provider`." -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`visibility`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter results by visibility -- Name: "`dataLinkId`" - Type: string - Location: path - Req/Opt: Required - Description: Data-link string identifier -- Name: "`nextPageToken`" - Type: string - Location: query - Req/Opt: Optional - Description: Token used to fetch the next page of items -- Name: "`pageSize`" - Type: integer - Location: query - Req/Opt: Optional - Description: Number of items to return per page. If ommitted, a default maximum - value is returned. -- Name: "`paths`" - Type: array - Location: query - Req/Opt: Optional - Description: List of paths -- Name: "`path`" - Type: string - Location: path - Req/Opt: Required - Description: Content path -- Name: "`filePath`" - Type: string - Location: path - Req/Opt: Required - Description: File path to download -- Name: "`filePath`" - Type: string - Location: query - Req/Opt: Optional - Description: File path to download -- Name: "`preview`" - Type: boolean - Location: query - Req/Opt: Optional - Description: "Whether to generate the URL for preview purposes or direct - download (default: false)" -- Name: "`dirs`" - Type: array - Location: query - Req/Opt: Optional - Description: List of paths to directories to download -- Name: "`files`" - Type: array - Location: query - Req/Opt: Optional - Description: List of paths to files to download -- Name: "`Origin`" - Type: string - Location: header - Req/Opt: Optional - Description: "" -- Name: "`dirPath`" - Type: string - Location: path - Req/Opt: Required - Description: Path to the destination directory diff --git a/platform-api-docs/docs/parameter-tables/data-links/request-bodies.yml b/platform-api-docs/docs/parameter-tables/data-links/request-bodies.yml deleted file mode 100644 index aa4406775..000000000 --- a/platform-api-docs/docs/parameter-tables/data-links/request-bodies.yml +++ /dev/null @@ -1,148 +0,0 @@ -- Name: "**CreateCustomDataLink**" - Type: "" - Req/Opt: "" - Description: Create data-link -- Name: name - Type: string - Req/Opt: Required - Description: "" -- Name: description - Type: string - Req/Opt: Required - Description: "" -- Name: type - Type: string - Req/Opt: Required - Description: "" -- Name: provider - Type: string - Req/Opt: Required - Description: "" -- Name: resourceRef - Type: string - Req/Opt: Required - Description: "" -- Name: publicAccessible - Type: boolean - Req/Opt: Required - Description: "" -- Name: credentialsId - Type: string - Req/Opt: Required - Description: "" -- Name: "**UpdateCustomDataLink**" - Type: "" - Req/Opt: "" - Description: Update data-link -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: credentialsId - Type: string - Req/Opt: Optional - Description: "" -- Name: "**DeleteDataLinkItem**" - Type: "" - Req/Opt: "" - Description: Delete data-link content -- Name: files - Type: array - Req/Opt: Optional - Description: "" -- Name: dirs - Type: array - Req/Opt: Optional - Description: "" -- Name: "**GenerateDataLinkUploadUrl**" - Type: "" - Req/Opt: "" - Description: Generate file upload URL -- Name: fileName - Type: string - Req/Opt: Optional - Description: "" -- Name: contentLength - Type: integer - Req/Opt: Optional - Description: "" -- Name: contentType - Type: string - Req/Opt: Optional - Description: "" -- Name: "**FinishDataLinkUpload**" - Type: "" - Req/Opt: "" - Description: Finish data-link file upload -- Name: uploadId - Type: string - Req/Opt: Optional - Description: "" -- Name: fileName - Type: string - Req/Opt: Optional - Description: "" -- Name: tags - Type: array - Req/Opt: Optional - Description: "" -- Name: tags[].partNumber - Type: integer - Req/Opt: Optional - Description: "" -- Name: tags[].eTag - Type: string - Req/Opt: Optional - Description: "" -- Name: withError - Type: boolean - Req/Opt: Optional - Description: "" -- Name: "**FinishDataLinkUpload_1**" - Type: "" - Req/Opt: "" - Description: Finish data-link file upload to given path -- Name: uploadId - Type: string - Req/Opt: Optional - Description: "" -- Name: fileName - Type: string - Req/Opt: Optional - Description: "" -- Name: tags - Type: array - Req/Opt: Optional - Description: "" -- Name: tags[].partNumber - Type: integer - Req/Opt: Optional - Description: "" -- Name: tags[].eTag - Type: string - Req/Opt: Optional - Description: "" -- Name: withError - Type: boolean - Req/Opt: Optional - Description: "" -- Name: "**GenerateDataLinkUploadUrl_1**" - Type: "" - Req/Opt: "" - Description: Generate data-link file upload URL (to given path) -- Name: fileName - Type: string - Req/Opt: Optional - Description: "" -- Name: contentLength - Type: integer - Req/Opt: Optional - Description: "" -- Name: contentType - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/datasets/parameters.yml b/platform-api-docs/docs/parameter-tables/datasets/parameters.yml deleted file mode 100644 index cd0c383fa..000000000 --- a/platform-api-docs/docs/parameter-tables/datasets/parameters.yml +++ /dev/null @@ -1,40 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`mimeType`" - Type: string - Location: query - Req/Opt: Optional - Description: Dataset MIME type -- Name: "`datasetId`" - Type: string - Location: path - Req/Opt: Required - Description: Dataset string identifier -- Name: "`header`" - Type: boolean - Location: query - Req/Opt: Optional - Description: Uploaded file has header -- Name: "`version`" - Type: string - Location: path - Req/Opt: Required - Description: Version number to download -- Name: "`fileName`" - Type: string - Location: path - Req/Opt: Required - Description: File name for the downloaded dataset content -- Name: "`launchId`" - Type: string - Location: path - Req/Opt: Required - Description: Launch string identifier -- Name: "`workspaceId`" - Type: integer - Location: path - Req/Opt: Required - Description: Workspace numeric identifier diff --git a/platform-api-docs/docs/parameter-tables/datasets/request-bodies.yml b/platform-api-docs/docs/parameter-tables/datasets/request-bodies.yml deleted file mode 100644 index 1b7b6d4d3..000000000 --- a/platform-api-docs/docs/parameter-tables/datasets/request-bodies.yml +++ /dev/null @@ -1,48 +0,0 @@ -- Name: "**CreateDatasetV2**" - Type: "" - Req/Opt: "" - Description: Create dataset -- Name: name - Type: string - Req/Opt: Required - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateDatasetV2**" - Type: "" - Req/Opt: "" - Description: Update dataset -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: "**CreateDataset**" - Type: "" - Req/Opt: "" - Description: Create dataset -- Name: name - Type: string - Req/Opt: Required - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateDataset**" - Type: "" - Req/Opt: "" - Description: Update dataset -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/ga4gh/parameters.yml b/platform-api-docs/docs/parameter-tables/ga4gh/parameters.yml deleted file mode 100644 index ac38a176f..000000000 --- a/platform-api-docs/docs/parameter-tables/ga4gh/parameters.yml +++ /dev/null @@ -1,15 +0,0 @@ -- Name: "`page_size`" - Type: integer - Location: query - Req/Opt: Optional - Description: Page size -- Name: "`page_token`" - Type: string - Location: query - Req/Opt: Optional - Description: Page token -- Name: "`run_id`" - Type: string - Location: path - Req/Opt: Required - Description: Run string identifier diff --git a/platform-api-docs/docs/parameter-tables/ga4gh/request-bodies.yml b/platform-api-docs/docs/parameter-tables/ga4gh/request-bodies.yml deleted file mode 100644 index f4e0c26db..000000000 --- a/platform-api-docs/docs/parameter-tables/ga4gh/request-bodies.yml +++ /dev/null @@ -1,32 +0,0 @@ -- Name: "**Ga4ghRunCreate**" - Type: "" - Req/Opt: "" - Description: "GA4GH: Launch run" -- Name: workflow_params - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow_type - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow_type_version - Type: string - Req/Opt: Optional - Description: "" -- Name: tags - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow_engine_parameters - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow_url - Type: string - Req/Opt: Optional - Description: "" -- Name: "**Ga4ghRunCancel**" - Type: "" - Req/Opt: "" - Description: "GA4GH: Cancel run" diff --git a/platform-api-docs/docs/parameter-tables/labels/parameters.yml b/platform-api-docs/docs/parameter-tables/labels/parameters.yml deleted file mode 100644 index ff139524b..000000000 --- a/platform-api-docs/docs/parameter-tables/labels/parameters.yml +++ /dev/null @@ -1,35 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter search parameter -- Name: "`type`" - Type: unknown - Location: query - Req/Opt: Optional - Description: Label type -- Name: "`isDefault`" - Type: boolean - Location: query - Req/Opt: Optional - Description: Label default flag -- Name: "`labelId`" - Type: integer - Location: path - Req/Opt: Required - Description: Label numeric identifier diff --git a/platform-api-docs/docs/parameter-tables/labels/request-bodies.yml b/platform-api-docs/docs/parameter-tables/labels/request-bodies.yml deleted file mode 100644 index 624e31def..000000000 --- a/platform-api-docs/docs/parameter-tables/labels/request-bodies.yml +++ /dev/null @@ -1,144 +0,0 @@ -- Name: "**AddLabelsToActions**" - Type: "" - Req/Opt: "" - Description: Add labels to actions -- Name: actionIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**ApplyLabelsToActions**" - Type: "" - Req/Opt: "" - Description: Replace action labels -- Name: actionIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**RemoveLabelsFromActions**" - Type: "" - Req/Opt: "" - Description: Remove labels from actions -- Name: actionIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**CreateLabel**" - Type: "" - Req/Opt: "" - Description: Create label -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: value - Type: string - Req/Opt: Optional - Description: "" -- Name: resource - Type: boolean - Req/Opt: Optional - Description: "" -- Name: isDefault - Type: boolean - Req/Opt: Optional - Description: "" -- Name: "**UpdateLabel**" - Type: "" - Req/Opt: "" - Description: Update label -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: value - Type: string - Req/Opt: Optional - Description: "" -- Name: isDefault - Type: boolean - Req/Opt: Optional - Description: "" -- Name: "**AddLabelsToPipelines**" - Type: "" - Req/Opt: "" - Description: Add labels to pipelines -- Name: pipelineIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**ApplyLabelsToPipelines**" - Type: "" - Req/Opt: "" - Description: Replace pipeline labels -- Name: pipelineIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**RemoveLabelsFromPipelines**" - Type: "" - Req/Opt: "" - Description: Remove labels from pipelines -- Name: pipelineIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**AddLabelsToWorkflows**" - Type: "" - Req/Opt: "" - Description: Add labels to workflows -- Name: workflowIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**ApplyLabelsToWorkflows**" - Type: "" - Req/Opt: "" - Description: Replace workflow labels -- Name: workflowIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**RemoveLabelsFromWorkflows**" - Type: "" - Req/Opt: "" - Description: Remove labels from workflows -- Name: workflowIds - Type: array - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/launch/parameters.yml b/platform-api-docs/docs/parameter-tables/launch/parameters.yml deleted file mode 100644 index 57209341f..000000000 --- a/platform-api-docs/docs/parameter-tables/launch/parameters.yml +++ /dev/null @@ -1,10 +0,0 @@ -- Name: "`launchId`" - Type: string - Location: path - Req/Opt: Required - Description: Launch string identifier -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier diff --git a/platform-api-docs/docs/parameter-tables/orgs/parameters.yml b/platform-api-docs/docs/parameter-tables/orgs/parameters.yml deleted file mode 100644 index dd37be08b..000000000 --- a/platform-api-docs/docs/parameter-tables/orgs/parameters.yml +++ /dev/null @@ -1,40 +0,0 @@ -- Name: "`role`" - Type: string - Location: query - Req/Opt: Optional - Description: Organization user role identifier -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Organization name to validate -- Name: "`orgId`" - Type: integer - Location: path - Req/Opt: Required - Description: Organization numeric identifier -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter search parameter -- Name: "`memberId`" - Type: integer - Location: path - Req/Opt: Required - Description: Organization member numeric identifier -- Name: "`include`" - Type: array - Location: query - Req/Opt: Optional - Description: Optional list of quota names to include diff --git a/platform-api-docs/docs/parameter-tables/orgs/request-bodies.yml b/platform-api-docs/docs/parameter-tables/orgs/request-bodies.yml deleted file mode 100644 index 24a94f662..000000000 --- a/platform-api-docs/docs/parameter-tables/orgs/request-bodies.yml +++ /dev/null @@ -1,96 +0,0 @@ -- Name: "**CreateOrganization**" - Type: "" - Req/Opt: "" - Description: Create organization -- Name: organization - Type: object - Req/Opt: Optional - Description: "" -- Name: organization.id - Type: integer - Req/Opt: Optional - Description: "" -- Name: organization.name - Type: string - Req/Opt: Required - Description: "" -- Name: organization.fullName - Type: string - Req/Opt: Required - Description: "" -- Name: organization.description - Type: string - Req/Opt: Optional - Description: "" -- Name: organization.location - Type: string - Req/Opt: Optional - Description: "" -- Name: organization.website - Type: string - Req/Opt: Optional - Description: "" -- Name: organization.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: organization.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: logoId - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateOrganization**" - Type: "" - Req/Opt: "" - Description: Update organization -- Name: fullName - Type: string - Req/Opt: Optional - Description: "" -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: location - Type: string - Req/Opt: Optional - Description: "" -- Name: website - Type: string - Req/Opt: Optional - Description: "" -- Name: logoId - Type: string - Req/Opt: Optional - Description: "" -- Name: paying - Type: boolean - Req/Opt: Optional - Description: "" -- Name: type - Type: object - Req/Opt: Optional - Description: "" -- Name: "**CreateOrganizationMember**" - Type: "" - Req/Opt: "" - Description: Add organization member -- Name: user - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateOrganizationMemberRole**" - Type: "" - Req/Opt: "" - Description: Update member role -- Name: role - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/pipeline-secrets/parameters.yml b/platform-api-docs/docs/parameter-tables/pipeline-secrets/parameters.yml deleted file mode 100644 index 8a28fbe37..000000000 --- a/platform-api-docs/docs/parameter-tables/pipeline-secrets/parameters.yml +++ /dev/null @@ -1,15 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Secret name to validate -- Name: "`secretId`" - Type: integer - Location: path - Req/Opt: Required - Description: Secret numeric identifier diff --git a/platform-api-docs/docs/parameter-tables/pipeline-secrets/request-bodies.yml b/platform-api-docs/docs/parameter-tables/pipeline-secrets/request-bodies.yml deleted file mode 100644 index 854ef1902..000000000 --- a/platform-api-docs/docs/parameter-tables/pipeline-secrets/request-bodies.yml +++ /dev/null @@ -1,20 +0,0 @@ -- Name: "**CreatePipelineSecret**" - Type: "" - Req/Opt: "" - Description: Create pipeline secret -- Name: name - Type: string - Req/Opt: Required - Description: "" -- Name: value - Type: string - Req/Opt: Required - Description: "" -- Name: "**UpdatePipelineSecret**" - Type: "" - Req/Opt: "" - Description: Update secret -- Name: value - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/pipelines/parameters.yml b/platform-api-docs/docs/parameter-tables/pipelines/parameters.yml deleted file mode 100644 index 1bb69558b..000000000 --- a/platform-api-docs/docs/parameter-tables/pipelines/parameters.yml +++ /dev/null @@ -1,63 +0,0 @@ -- Name: "`attributes`" - Type: array - Location: query - Req/Opt: Optional - Description: Additional attribute values to include in the response (`labels`, - `optimized`, `computeEnv`). Returns empty values if omitted. -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier. If omitted, lists pipelines in a user context. -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: "Maximum number of results to return (pagination). Default: 50, Maximum: 100" -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: "Number of results to skip for pagination. Default: 0" -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Search string to filter pipelines by name or description. -- Name: "`visibility`" - Type: string - Location: query - Req/Opt: Optional - Description: "Filter pipelines by visibility. Valid values: `private`, `shared`, `all`" -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Pipeline repository name (e.g., `nextflow-io/hello`) or full URL. -- Name: "`revision`" - Type: string - Location: query - Req/Opt: Optional - Description: "Git revision, branch, or tag to describe. Default: repository - default branch." -- Name: "`mainScript`" - Type: string - Location: query - Req/Opt: Optional - Description: "Alternative main script filename. Default: main.nf" -- Name: "`orgId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Organization numeric identifier. Used for organization-level validation. -- Name: "`pipelineId`" - Type: integer - Location: path - Req/Opt: Required - Description: Pipeline numeric identifier. -- Name: "`sourceWorkspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Source workspace numeric identifier. Used when accessing a shared - pipeline from another workspace. diff --git a/platform-api-docs/docs/parameter-tables/pipelines/request-bodies.yml b/platform-api-docs/docs/parameter-tables/pipelines/request-bodies.yml deleted file mode 100644 index ebf880ff7..000000000 --- a/platform-api-docs/docs/parameter-tables/pipelines/request-bodies.yml +++ /dev/null @@ -1,288 +0,0 @@ -- Name: "**CreatePipeline**" - Type: "" - Req/Opt: "" - Description: Create pipeline -- Name: name - Type: string - Req/Opt: Required - Description: Pipeline name. Must be unique within the workspace. -- Name: description - Type: string - Req/Opt: Optional - Description: Pipeline description. -- Name: icon - Type: string - Req/Opt: Optional - Description: Pipeline icon URL. -- Name: launch - Type: object - Req/Opt: Required - Description: "" -- Name: launch.computeEnvId - Type: string - Req/Opt: Optional - Description: Compute environment identifier where the pipeline will run. - Defaults to workspace primary compute environment if omitted. -- Name: launch.runName - Type: string - Req/Opt: Optional - Description: Custom run name for the workflow execution. -- Name: launch.pipeline - Type: string - Req/Opt: Required - Description: Pipeline repository URL (e.g., https://github.com/nextflow-io/hello). -- Name: launch.workDir - Type: string - Req/Opt: Optional - Description: Work directory path where workflow intermediate files are stored. - Defaults to compute environment work directory if omitted. -- Name: launch.revision - Type: string - Req/Opt: Optional - Description: Git revision, branch, or tag to use. -- Name: launch.sessionId - Type: string - Req/Opt: Optional - Description: Nextflow session identifier for resuming failed runs. -- Name: launch.configProfiles - Type: array - Req/Opt: Optional - Description: Array of Nextflow configuration profile names to apply. -- Name: launch.userSecrets - Type: array - Req/Opt: Optional - Description: Array of user secrets to make available to the pipeline. -- Name: launch.workspaceSecrets - Type: array - Req/Opt: Optional - Description: Array of workspace secrets to make available to the pipeline. -- Name: launch.configText - Type: string - Req/Opt: Optional - Description: Nextflow configuration as text (overrides config files). -- Name: launch.towerConfig - Type: string - Req/Opt: Optional - Description: Platform-specific configuration options. -- Name: launch.paramsText - Type: string - Req/Opt: Optional - Description: Pipeline parameters in JSON or YAML format. -- Name: launch.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.mainScript - Type: string - Req/Opt: Optional - Description: "Alternative main script filename (default: main.nf)." -- Name: launch.entryName - Type: string - Req/Opt: Optional - Description: Workflow entry point name when using Nextflow DSL2. -- Name: launch.schemaName - Type: string - Req/Opt: Optional - Description: Name of the pipeline schema to use. -- Name: launch.resume - Type: boolean - Req/Opt: Optional - Description: Enable resume to restart workflow execution from the last - successful process. See [Resume a workflow - run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run). -- Name: launch.pullLatest - Type: boolean - Req/Opt: Optional - Description: Pull the latest version of the pipeline from the repository. -- Name: launch.stubRun - Type: boolean - Req/Opt: Optional - Description: Execute a stub run for testing (processes return dummy results). -- Name: launch.optimizationId - Type: string - Req/Opt: Optional - Description: Optimization configuration identifier. See [Pipeline resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.optimizationTargets - Type: string - Req/Opt: Optional - Description: Comma-separated list of optimization targets. See [Pipeline - resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to each pipeline run. -- Name: launch.headJobCpus - Type: integer - Req/Opt: Optional - Description: Number of CPUs allocated for the Nextflow head job. -- Name: launch.headJobMemoryMb - Type: integer - Req/Opt: Optional - Description: Memory allocation for the Nextflow head job in megabytes. -- Name: launch.launchContainer - Type: string - Req/Opt: Optional - Description: Container image to use for the Nextflow launcher. -- Name: launch.dateCreated - Type: string - Req/Opt: Optional - Description: Timestamp when the launch configuration was created. -- Name: labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to apply to the pipeline. -- Name: "**UpdatePipeline**" - Type: "" - Req/Opt: "" - Description: Update pipeline -- Name: name - Type: string - Req/Opt: Optional - Description: Pipeline name. Must be unique within the workspace. -- Name: description - Type: string - Req/Opt: Optional - Description: Pipeline description. -- Name: icon - Type: string - Req/Opt: Optional - Description: Pipeline icon URL. -- Name: launch - Type: object - Req/Opt: Optional - Description: "" -- Name: launch.computeEnvId - Type: string - Req/Opt: Optional - Description: Compute environment identifier where the pipeline will run. - Defaults to workspace primary compute environment if omitted. -- Name: launch.runName - Type: string - Req/Opt: Optional - Description: Custom run name for the workflow execution. -- Name: launch.pipeline - Type: string - Req/Opt: Required - Description: Pipeline repository URL (e.g., https://github.com/nextflow-io/hello). -- Name: launch.workDir - Type: string - Req/Opt: Optional - Description: Work directory path where workflow intermediate files are stored. - Defaults to compute environment work directory if omitted. -- Name: launch.revision - Type: string - Req/Opt: Optional - Description: Git revision, branch, or tag to use. -- Name: launch.sessionId - Type: string - Req/Opt: Optional - Description: Nextflow session identifier for resuming failed runs. -- Name: launch.configProfiles - Type: array - Req/Opt: Optional - Description: Array of Nextflow configuration profile names to apply. -- Name: launch.userSecrets - Type: array - Req/Opt: Optional - Description: Array of user secrets to make available to the pipeline. -- Name: launch.workspaceSecrets - Type: array - Req/Opt: Optional - Description: Array of workspace secrets to make available to the pipeline. -- Name: launch.configText - Type: string - Req/Opt: Optional - Description: Nextflow configuration as text (overrides config files). -- Name: launch.towerConfig - Type: string - Req/Opt: Optional - Description: Platform-specific configuration options. -- Name: launch.paramsText - Type: string - Req/Opt: Optional - Description: Pipeline parameters in JSON or YAML format. -- Name: launch.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.mainScript - Type: string - Req/Opt: Optional - Description: "Alternative main script filename (default: main.nf)." -- Name: launch.entryName - Type: string - Req/Opt: Optional - Description: Workflow entry point name when using Nextflow DSL2. -- Name: launch.schemaName - Type: string - Req/Opt: Optional - Description: Name of the pipeline schema to use. -- Name: launch.resume - Type: boolean - Req/Opt: Optional - Description: Enable resume to restart workflow execution from the last - successful process. See [Resume a workflow - run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run). -- Name: launch.pullLatest - Type: boolean - Req/Opt: Optional - Description: Pull the latest version of the pipeline from the repository. -- Name: launch.stubRun - Type: boolean - Req/Opt: Optional - Description: Execute a stub run for testing (processes return dummy results). -- Name: launch.optimizationId - Type: string - Req/Opt: Optional - Description: Optimization configuration identifier. See [Pipeline resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.optimizationTargets - Type: string - Req/Opt: Optional - Description: Comma-separated list of optimization targets. See [Pipeline - resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to each pipeline run. -- Name: launch.headJobCpus - Type: integer - Req/Opt: Optional - Description: Number of CPUs allocated for the Nextflow head job. -- Name: launch.headJobMemoryMb - Type: integer - Req/Opt: Optional - Description: Memory allocation for the Nextflow head job in megabytes. -- Name: launch.launchContainer - Type: string - Req/Opt: Optional - Description: Container image to use for the Nextflow launcher. -- Name: launch.dateCreated - Type: string - Req/Opt: Optional - Description: Timestamp when the launch configuration was created. -- Name: labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to the pipeline. If null, empty, or - omitted, all existing labels are removed. Label IDs to be preserved must be - included in your request. diff --git a/platform-api-docs/docs/parameter-tables/platforms/parameters.yml b/platform-api-docs/docs/parameter-tables/platforms/parameters.yml deleted file mode 100644 index e5d3ba7ea..000000000 --- a/platform-api-docs/docs/parameter-tables/platforms/parameters.yml +++ /dev/null @@ -1,25 +0,0 @@ -- Name: "`orgId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Organization numeric identifier -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Optional workspace numeric identifier -- Name: "`platformId`" - Type: string - Location: path - Req/Opt: Required - Description: Platform string identifier -- Name: "`regionId`" - Type: string - Location: query - Req/Opt: Required - Description: "" -- Name: "`credentialsId`" - Type: string - Location: query - Req/Opt: Required - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/studios/parameters.yml b/platform-api-docs/docs/parameter-tables/studios/parameters.yml deleted file mode 100644 index e94a6752f..000000000 --- a/platform-api-docs/docs/parameter-tables/studios/parameters.yml +++ /dev/null @@ -1,62 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: "Optional search criteria, allowing free text search on name and - templateUrl and keywords: `userId`, `computeEnvId` and `status`." -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`attributes`" - Type: array - Location: query - Req/Opt: Optional - Description: "Optional attribute values to be included in the response - (`labels`). Returns an empty value (`labels: null`) if omitted." -- Name: "`autoStart`" - Type: boolean - Location: query - Req/Opt: Optional - Description: Optionally disable the Studio's automatic launch when it is created. -- Name: "`orgId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Organization numeric identifier -- Name: "`status`" - Type: string - Location: query - Req/Opt: Optional - Description: Optional Studio status -- Name: "`exclude`" - Type: string - Location: query - Req/Opt: Optional - Description: Optional Studio session ID to exclude in the request. -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Studio name to validate -- Name: "`sessionId`" - Type: string - Location: path - Req/Opt: Required - Description: Studio session numeric identifier -- Name: "`checkpointId`" - Type: integer - Location: path - Req/Opt: Required - Description: Numeric identifier of the checkpoint. diff --git a/platform-api-docs/docs/parameter-tables/studios/request-bodies.yml b/platform-api-docs/docs/parameter-tables/studios/request-bodies.yml deleted file mode 100644 index 5791c9a0c..000000000 --- a/platform-api-docs/docs/parameter-tables/studios/request-bodies.yml +++ /dev/null @@ -1,92 +0,0 @@ -- Name: "**CreateDataStudio**" - Type: "" - Req/Opt: "" - Description: Create Studio -- Name: name - Type: string - Req/Opt: Required - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: dataStudioToolUrl - Type: string - Req/Opt: Required - Description: "" -- Name: computeEnvId - Type: string - Req/Opt: Required - Description: "" -- Name: initialCheckpointId - Type: integer - Req/Opt: Optional - Description: "" -- Name: configuration - Type: object - Req/Opt: Optional - Description: "" -- Name: configuration.gpu - Type: integer - Req/Opt: Optional - Description: "" -- Name: configuration.cpu - Type: integer - Req/Opt: Optional - Description: "" -- Name: configuration.memory - Type: integer - Req/Opt: Optional - Description: "" -- Name: configuration.mountData - Type: array - Req/Opt: Optional - Description: "" -- Name: configuration.condaEnvironment - Type: string - Req/Opt: Optional - Description: "" -- Name: configuration.lifespanHours - Type: integer - Req/Opt: Optional - Description: "" -- Name: isPrivate - Type: boolean - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: spot - Type: boolean - Req/Opt: Optional - Description: "" -- Name: "**UpdateDataStudioCheckpoint**" - Type: "" - Req/Opt: "" - Description: Update Studio checkpoint name -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: "**StartDataStudio**" - Type: "" - Req/Opt: "" - Description: Start Studio -- Name: configuration - Type: object - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: labelIds - Type: array - Req/Opt: Optional - Description: "" -- Name: spot - Type: boolean - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/teams/parameters.yml b/platform-api-docs/docs/parameter-tables/teams/parameters.yml deleted file mode 100644 index 0ef766d98..000000000 --- a/platform-api-docs/docs/parameter-tables/teams/parameters.yml +++ /dev/null @@ -1,35 +0,0 @@ -- Name: "`orgId`" - Type: integer - Location: path - Req/Opt: Required - Description: Organization numeric identifier -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter search parameter -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Team name to validate -- Name: "`teamId`" - Type: integer - Location: path - Req/Opt: Required - Description: Team numeric identifier -- Name: "`memberId`" - Type: integer - Location: path - Req/Opt: Required - Description: Member numeric identifier diff --git a/platform-api-docs/docs/parameter-tables/teams/request-bodies.yml b/platform-api-docs/docs/parameter-tables/teams/request-bodies.yml deleted file mode 100644 index fb6541e08..000000000 --- a/platform-api-docs/docs/parameter-tables/teams/request-bodies.yml +++ /dev/null @@ -1,56 +0,0 @@ -- Name: "**CreateOrganizationTeam**" - Type: "" - Req/Opt: "" - Description: Create team -- Name: team - Type: object - Req/Opt: Optional - Description: "" -- Name: team.id - Type: integer - Req/Opt: Optional - Description: "" -- Name: team.name - Type: string - Req/Opt: Required - Description: "" -- Name: team.description - Type: string - Req/Opt: Optional - Description: "" -- Name: team.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: team.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: avatarId - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateOrganizationTeam**" - Type: "" - Req/Opt: "" - Description: Update team -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: avatarId - Type: string - Req/Opt: Optional - Description: "" -- Name: "**CreateOrganizationTeamMember**" - Type: "" - Req/Opt: "" - Description: Create team member -- Name: userNameOrEmail - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/tokens/parameters.yml b/platform-api-docs/docs/parameter-tables/tokens/parameters.yml deleted file mode 100644 index ea177f591..000000000 --- a/platform-api-docs/docs/parameter-tables/tokens/parameters.yml +++ /dev/null @@ -1,5 +0,0 @@ -- Name: "`tokenId`" - Type: integer - Location: path - Req/Opt: Required - Description: Token numeric identifier diff --git a/platform-api-docs/docs/parameter-tables/tokens/request-bodies.yml b/platform-api-docs/docs/parameter-tables/tokens/request-bodies.yml deleted file mode 100644 index 15e24aac7..000000000 --- a/platform-api-docs/docs/parameter-tables/tokens/request-bodies.yml +++ /dev/null @@ -1,8 +0,0 @@ -- Name: "**CreateToken**" - Type: "" - Req/Opt: "" - Description: Create token -- Name: name - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/trace/parameters.yml b/platform-api-docs/docs/parameter-tables/trace/parameters.yml deleted file mode 100644 index 8a9c9eb9a..000000000 --- a/platform-api-docs/docs/parameter-tables/trace/parameters.yml +++ /dev/null @@ -1,10 +0,0 @@ -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`workflowId`" - Type: string - Location: path - Req/Opt: Required - Description: Workflow string identifier. diff --git a/platform-api-docs/docs/parameter-tables/trace/request-bodies.yml b/platform-api-docs/docs/parameter-tables/trace/request-bodies.yml deleted file mode 100644 index 0dd7ab25b..000000000 --- a/platform-api-docs/docs/parameter-tables/trace/request-bodies.yml +++ /dev/null @@ -1,1788 +0,0 @@ -- Name: "**CreateTrace**" - Type: "" - Req/Opt: "" - Description: Create workflow execution trace -- Name: launchId - Type: string - Req/Opt: Optional - Description: "" -- Name: sessionId - Type: string - Req/Opt: Optional - Description: "" -- Name: runName - Type: string - Req/Opt: Optional - Description: "" -- Name: projectName - Type: string - Req/Opt: Optional - Description: "" -- Name: repository - Type: string - Req/Opt: Optional - Description: "" -- Name: workflowId - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateTraceBegin**" - Type: "" - Req/Opt: "" - Description: Signal workflow execution start -- Name: launchId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.requiresAttention - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.status - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.ownerId - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.repository - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.id - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.submit - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.start - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.complete - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.runName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.sessionId - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.profile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.workDir - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.commitId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.userName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.scriptId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.revision - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.commandLine - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.projectName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.scriptName - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.launchId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.configFiles - Type: array - Req/Opt: Optional - Description: "" -- Name: workflow.params - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.configText - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.nextflowVersion - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.defaultBranch - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.version - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.homePage - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.gitmodules - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.description - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.name - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.mainScript - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.author - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.icon - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.version - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.build - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.timestamp - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.stats.computeTimeFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.errorMessage - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.errorReport - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.projectDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.homeDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.container - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.containerEngine - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.scriptFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.launchDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.duration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.exitStatus - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.resume - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.success - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.logFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.outFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.operationId - Type: string - Req/Opt: Optional - Description: "" -- Name: processNames - Type: array - Req/Opt: Optional - Description: "" -- Name: towerLaunch - Type: boolean - Req/Opt: Optional - Description: "" -- Name: "**UpdateTraceComplete**" - Type: "" - Req/Opt: "" - Description: Signal workflow execution completion -- Name: workflow - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.requiresAttention - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.status - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.ownerId - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.repository - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.id - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.submit - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.start - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.complete - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.runName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.sessionId - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.profile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.workDir - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.commitId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.userName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.scriptId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.revision - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.commandLine - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.projectName - Type: string - Req/Opt: Required - Description: "" -- Name: workflow.scriptName - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.launchId - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.configFiles - Type: array - Req/Opt: Optional - Description: "" -- Name: workflow.params - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.configText - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.nextflowVersion - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.defaultBranch - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.version - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.homePage - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.gitmodules - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.description - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.name - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.mainScript - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.author - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.manifest.icon - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.version - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.build - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.nextflow.timestamp - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats - Type: object - Req/Opt: Optional - Description: "" -- Name: workflow.stats.computeTimeFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedCount - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredCountFmt - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.ignoredPct - Type: number - Req/Opt: Optional - Description: "" -- Name: workflow.stats.cachedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.failedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.stats.succeedDuration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.errorMessage - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.errorReport - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.deleted - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.projectDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.homeDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.container - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.containerEngine - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.scriptFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.launchDir - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.duration - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.exitStatus - Type: integer - Req/Opt: Optional - Description: "" -- Name: workflow.resume - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.success - Type: boolean - Req/Opt: Optional - Description: "" -- Name: workflow.logFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.outFile - Type: string - Req/Opt: Optional - Description: "" -- Name: workflow.operationId - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].id - Type: integer - Req/Opt: Optional - Description: "" -- Name: metrics[].process - Type: string - Req/Opt: Required - Description: "" -- Name: metrics[].cpu - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpu.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].mem - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].mem.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].vmem.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].time - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].time.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].time.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].time.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].time.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].time.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].reads - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].reads.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].writes - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].writes.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].cpuUsage.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].memUsage.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage - Type: object - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.warnings - Type: array - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.mean - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.min - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q1 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q2 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q3 - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.max - Type: number - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.minLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.maxLabel - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q1Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q2Label - Type: string - Req/Opt: Optional - Description: "" -- Name: metrics[].timeUsage.q3Label - Type: string - Req/Opt: Optional - Description: "" -- Name: progress - Type: object - Req/Opt: Optional - Description: "" -- Name: progress.pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes - Type: array - Req/Opt: Optional - Description: "" -- Name: progress.processes[].index - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].name - Type: string - Req/Opt: Optional - Description: "" -- Name: progress.processes[].pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].terminated - Type: boolean - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: "**UpdateTraceHeartbeat**" - Type: "" - Req/Opt: "" - Description: Signal workflow execution heartbeat -- Name: progress - Type: object - Req/Opt: Optional - Description: "" -- Name: progress.pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes - Type: array - Req/Opt: Optional - Description: "" -- Name: progress.processes[].index - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].name - Type: string - Req/Opt: Optional - Description: "" -- Name: progress.processes[].pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].terminated - Type: boolean - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: "**UpdateTraceProgress**" - Type: "" - Req/Opt: "" - Description: Store workflow task execution metadata -- Name: tasks - Type: array - Req/Opt: Optional - Description: "" -- Name: tasks[].hash - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].name - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].process - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].tag - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].submit - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].start - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].complete - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].module - Type: array - Req/Opt: Optional - Description: "" -- Name: tasks[].container - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].attempt - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].script - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].scratch - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].workdir - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].queue - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].cpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].memory - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].disk - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].time - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].env - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].executor - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].machineType - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].cloudZone - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].priceModel - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].cost - Type: number - Req/Opt: Optional - Description: "" -- Name: tasks[].errorAction - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].exitStatus - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].duration - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].realtime - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].nativeId - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].pcpu - Type: number - Req/Opt: Optional - Description: "" -- Name: tasks[].pmem - Type: number - Req/Opt: Optional - Description: "" -- Name: tasks[].rss - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].vmem - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].peakRss - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].peakVmem - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].rchar - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].wchar - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].syscr - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].syscw - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].readBytes - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].writeBytes - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].volCtxt - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].invCtxt - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].exit - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].id - Type: integer - Req/Opt: Optional - Description: "" -- Name: tasks[].taskId - Type: integer - Req/Opt: Required - Description: "" -- Name: tasks[].status - Type: string - Req/Opt: Required - Description: "" -- Name: tasks[].dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: tasks[].lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: progress - Type: object - Req/Opt: Optional - Description: "" -- Name: progress.pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes - Type: array - Req/Opt: Optional - Description: "" -- Name: progress.processes[].index - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].name - Type: string - Req/Opt: Optional - Description: "" -- Name: progress.processes[].pending - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].submitted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].running - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].succeeded - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].cached - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].failed - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].aborted - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].stored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].ignored - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].retries - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].terminated - Type: boolean - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].loadMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakRunning - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakCpus - Type: integer - Req/Opt: Optional - Description: "" -- Name: progress.processes[].peakMemory - Type: integer - Req/Opt: Optional - Description: "" -- Name: containers - Type: array - Req/Opt: Optional - Description: "" -- Name: containers[].requestId - Type: string - Req/Opt: Optional - Description: "" -- Name: containers[].sourceImage - Type: string - Req/Opt: Optional - Description: "" -- Name: containers[].targetImage - Type: string - Req/Opt: Required - Description: "" -- Name: containers[].buildId - Type: string - Req/Opt: Optional - Description: "" -- Name: containers[].scanId - Type: string - Req/Opt: Optional - Description: "" -- Name: containers[].mirrorId - Type: string - Req/Opt: Optional - Description: "" -- Name: containers[].cached - Type: boolean - Req/Opt: Optional - Description: "" -- Name: containers[].freeze - Type: boolean - Req/Opt: Optional - Description: "" -- Name: containers[].requestTime - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/users/parameters.yml b/platform-api-docs/docs/parameter-tables/users/parameters.yml deleted file mode 100644 index 1b5cd1071..000000000 --- a/platform-api-docs/docs/parameter-tables/users/parameters.yml +++ /dev/null @@ -1,10 +0,0 @@ -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: User name to validate -- Name: "`userId`" - Type: integer - Location: path - Req/Opt: Required - Description: User numeric identifier diff --git a/platform-api-docs/docs/parameter-tables/users/request-bodies.yml b/platform-api-docs/docs/parameter-tables/users/request-bodies.yml deleted file mode 100644 index 39bac6e1c..000000000 --- a/platform-api-docs/docs/parameter-tables/users/request-bodies.yml +++ /dev/null @@ -1,68 +0,0 @@ -- Name: "**UpdateUser**" - Type: "" - Req/Opt: "" - Description: Update an user entity -- Name: id - Type: integer - Req/Opt: Optional - Description: "" -- Name: userName - Type: string - Req/Opt: Required - Description: "" -- Name: email - Type: string - Req/Opt: Required - Description: "" -- Name: firstName - Type: string - Req/Opt: Optional - Description: "" -- Name: lastName - Type: string - Req/Opt: Optional - Description: "" -- Name: organization - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: avatar - Type: string - Req/Opt: Optional - Description: "" -- Name: avatarId - Type: string - Req/Opt: Optional - Description: "" -- Name: notification - Type: boolean - Req/Opt: Optional - Description: "" -- Name: termsOfUseConsent - Type: boolean - Req/Opt: Optional - Description: "" -- Name: marketingConsent - Type: boolean - Req/Opt: Optional - Description: "" -- Name: lastAccess - Type: string - Req/Opt: Optional - Description: "" -- Name: dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: deleted - Type: boolean - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/parameter-tables/workflows/parameters.yml b/platform-api-docs/docs/parameter-tables/workflows/parameters.yml deleted file mode 100644 index 5b90b072a..000000000 --- a/platform-api-docs/docs/parameter-tables/workflows/parameters.yml +++ /dev/null @@ -1,76 +0,0 @@ -- Name: "`attributes`" - Type: array - Location: query - Req/Opt: Optional - Description: "Additional attribute values to include in the response (`labels`, - `optimized` status). Returns an empty value (`labels: null`) if omitted." -- Name: "`workspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Workspace numeric identifier -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter search parameter -- Name: "`force`" - Type: boolean - Location: query - Req/Opt: Optional - Description: Force the deletion even if any workflows are active -- Name: "`sourceWorkspaceId`" - Type: integer - Location: query - Req/Opt: Optional - Description: Source Optional workspace numeric identifier -- Name: "`runName`" - Type: string - Location: query - Req/Opt: Optional - Description: Workflow run name to validate -- Name: "`sessionId`" - Type: string - Location: query - Req/Opt: Optional - Description: Workflow session ID to validate -- Name: "`workflowId`" - Type: string - Location: path - Req/Opt: Required - Description: Workflow string identifier -- Name: "`fileName`" - Type: string - Location: query - Req/Opt: Optional - Description: Filename to download -- Name: "`taskId`" - Type: integer - Location: path - Req/Opt: Required - Description: Task numeric identifier -- Name: "`next`" - Type: string - Location: query - Req/Opt: Optional - Description: Workflow log cursor -- Name: "`sortBy`" - Type: string - Location: query - Req/Opt: Optional - Description: Field to sort by -- Name: "`sortDir`" - Type: string - Location: query - Req/Opt: Optional - Description: Sorting direction (asc|desc) diff --git a/platform-api-docs/docs/parameter-tables/workflows/request-bodies.yml b/platform-api-docs/docs/parameter-tables/workflows/request-bodies.yml deleted file mode 100644 index 7317af4c7..000000000 --- a/platform-api-docs/docs/parameter-tables/workflows/request-bodies.yml +++ /dev/null @@ -1,139 +0,0 @@ -- Name: "**DeleteWorkflowMany**" - Type: "" - Req/Opt: "" - Description: Delete workflows -- Name: workflowIds - Type: array - Req/Opt: Optional - Description: "" -- Name: "**CreateWorkflowLaunch**" - Type: "" - Req/Opt: "" - Description: Launch workflow -- Name: launch - Type: object - Req/Opt: Optional - Description: "" -- Name: launch.computeEnvId - Type: string - Req/Opt: Optional - Description: Compute environment identifier where the pipeline will run. - Defaults to workspace primary compute environment if omitted. -- Name: launch.runName - Type: string - Req/Opt: Optional - Description: Custom run name for the workflow execution. -- Name: launch.pipeline - Type: string - Req/Opt: Required - Description: Pipeline repository URL (e.g., https://github.com/nextflow-io/hello). -- Name: launch.workDir - Type: string - Req/Opt: Optional - Description: Work directory path where workflow intermediate files are stored. - Defaults to compute environment work directory if omitted. -- Name: launch.revision - Type: string - Req/Opt: Optional - Description: Git revision, branch, or tag to use. -- Name: launch.sessionId - Type: string - Req/Opt: Optional - Description: Nextflow session identifier for resuming failed runs. -- Name: launch.configProfiles - Type: array - Req/Opt: Optional - Description: Array of Nextflow configuration profile names to apply. -- Name: launch.userSecrets - Type: array - Req/Opt: Optional - Description: Array of user secrets to make available to the pipeline. -- Name: launch.workspaceSecrets - Type: array - Req/Opt: Optional - Description: Array of workspace secrets to make available to the pipeline. -- Name: launch.configText - Type: string - Req/Opt: Optional - Description: Nextflow configuration as text (overrides config files). -- Name: launch.towerConfig - Type: string - Req/Opt: Optional - Description: Platform-specific configuration options. -- Name: launch.paramsText - Type: string - Req/Opt: Optional - Description: Pipeline parameters in JSON or YAML format. -- Name: launch.preRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.postRunScript - Type: string - Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run - scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). -- Name: launch.mainScript - Type: string - Req/Opt: Optional - Description: "Alternative main script filename (default: main.nf)." -- Name: launch.entryName - Type: string - Req/Opt: Optional - Description: Workflow entry point name when using Nextflow DSL2. -- Name: launch.schemaName - Type: string - Req/Opt: Optional - Description: Name of the pipeline schema to use. -- Name: launch.resume - Type: boolean - Req/Opt: Optional - Description: Enable resume to restart workflow execution from the last - successful process. See [Resume a workflow - run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run). -- Name: launch.pullLatest - Type: boolean - Req/Opt: Optional - Description: Pull the latest version of the pipeline from the repository. -- Name: launch.stubRun - Type: boolean - Req/Opt: Optional - Description: Execute a stub run for testing (processes return dummy results). -- Name: launch.optimizationId - Type: string - Req/Opt: Optional - Description: Optimization configuration identifier. See [Pipeline resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.optimizationTargets - Type: string - Req/Opt: Optional - Description: Comma-separated list of optimization targets. See [Pipeline - resource - optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview). -- Name: launch.labelIds - Type: array - Req/Opt: Optional - Description: Array of label IDs to assign to each pipeline run. -- Name: launch.headJobCpus - Type: integer - Req/Opt: Optional - Description: Number of CPUs allocated for the Nextflow head job. -- Name: launch.headJobMemoryMb - Type: integer - Req/Opt: Optional - Description: Memory allocation for the Nextflow head job in megabytes. -- Name: launch.launchContainer - Type: string - Req/Opt: Optional - Description: Container image to use for the Nextflow launcher. -- Name: launch.dateCreated - Type: string - Req/Opt: Optional - Description: Timestamp when the launch configuration was created. -- Name: "**CancelWorkflow**" - Type: "" - Req/Opt: "" - Description: Cancel workflow diff --git a/platform-api-docs/docs/parameter-tables/workspaces/parameters.yml b/platform-api-docs/docs/parameter-tables/workspaces/parameters.yml deleted file mode 100644 index 5971e69b0..000000000 --- a/platform-api-docs/docs/parameter-tables/workspaces/parameters.yml +++ /dev/null @@ -1,40 +0,0 @@ -- Name: "`orgId`" - Type: integer - Location: path - Req/Opt: Required - Description: Organization numeric identifier -- Name: "`name`" - Type: string - Location: query - Req/Opt: Optional - Description: Workspace name to validate -- Name: "`workspaceId`" - Type: integer - Location: path - Req/Opt: Required - Description: Optional workspace numeric identifier -- Name: "`max`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination max results -- Name: "`offset`" - Type: integer - Location: query - Req/Opt: Optional - Description: Pagination offset -- Name: "`search`" - Type: string - Location: query - Req/Opt: Optional - Description: Filter search parameter -- Name: "`participantId`" - Type: integer - Location: path - Req/Opt: Required - Description: Participant numeric identifier -- Name: "`userId`" - Type: integer - Location: path - Req/Opt: Required - Description: User numeric identifier diff --git a/platform-api-docs/docs/parameter-tables/workspaces/request-bodies.yml b/platform-api-docs/docs/parameter-tables/workspaces/request-bodies.yml deleted file mode 100644 index 2b1e87147..000000000 --- a/platform-api-docs/docs/parameter-tables/workspaces/request-bodies.yml +++ /dev/null @@ -1,120 +0,0 @@ -- Name: "**CreateWorkspace**" - Type: "" - Req/Opt: "" - Description: Create workspace -- Name: workspace - Type: object - Req/Opt: Optional - Description: "" -- Name: workspace.id - Type: integer - Req/Opt: Optional - Description: "" -- Name: workspace.name - Type: string - Req/Opt: Required - Description: "" -- Name: workspace.fullName - Type: string - Req/Opt: Required - Description: "" -- Name: workspace.description - Type: string - Req/Opt: Optional - Description: "" -- Name: workspace.visibility - Type: string - Req/Opt: Required - Description: "" -- Name: workspace.dateCreated - Type: string - Req/Opt: Optional - Description: "" -- Name: workspace.lastUpdated - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateWorkspace**" - Type: "" - Req/Opt: "" - Description: Update workspace -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: fullName - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: visibility - Type: string - Req/Opt: Optional - Description: "" -- Name: "**CreateWorkspaceParticipant**" - Type: "" - Req/Opt: "" - Description: Create workspace participant -- Name: memberId - Type: integer - Req/Opt: Optional - Description: "" -- Name: teamId - Type: integer - Req/Opt: Optional - Description: "" -- Name: userNameOrEmail - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateWorkspaceParticipantRole**" - Type: "" - Req/Opt: "" - Description: Update participant role -- Name: role - Type: string - Req/Opt: Optional - Description: "" -- Name: "**FindDataStudiosWorkspaceSettings**" - Type: "" - Req/Opt: "" - Description: List workspace Studios settings -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: fullName - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: visibility - Type: string - Req/Opt: Optional - Description: "" -- Name: "**UpdateDataStudiosWorkspaceSettings**" - Type: "" - Req/Opt: "" - Description: Update workspace Studios settings -- Name: name - Type: string - Req/Opt: Optional - Description: "" -- Name: fullName - Type: string - Req/Opt: Optional - Description: "" -- Name: description - Type: string - Req/Opt: Optional - Description: "" -- Name: visibility - Type: string - Req/Opt: Optional - Description: "" diff --git a/platform-api-docs/docs/pause-action.api.mdx b/platform-api-docs/docs/pause-action.api.mdx deleted file mode 100644 index e0a8909fa..000000000 --- a/platform-api-docs/docs/pause-action.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: pause-action -title: "Pause or resume action" -description: "Pauses or resumes the pipeline action identified by the given `actionId`." -sidebar_label: "Pause or resume action" -hide_title: true -hide_table_of_contents: true -api: eJytVU1PGzEQ/SuWT60UkrSNOOREQFRClUoUqHpAkXB2J4nBuza2N2G12v/eGXuXzZeglXqBtT2eefP85qXiXqwcHz9wkXipc8fnPZ6CS6w0tOZjPhWFA8e0ZRZckeGnXwMz0oCSObB4j8kUci+XElK2KEPESm4gZ4/x/CZ97PMe1wasiOs28ySc45kRVmTgwRKciue4wJj2OgZIQmOEX/NDiDEHc97KfNVBsRho4aWQFrCctwX0uEvWkAk+rrgvDRWIl3hd995qbrV9dkYk0JV9KcCWR3V/t4EsR2KsTPZrH9WSuYdVOFpqmwkft85HWH0eoYLzlzot6U6iMTr39CmMUTIJxA2eHJWujpPrxRMkHnN76RVtXGfGl5RtFhNjFewSyziDDw2O7n4djujfflu3P9gZ+6lZiwAvjYbD47hLkbIGNJb9a7zdkzxwlJMTKyDVHbZhLKnFywi0DTz1cF3H1mo7a/pr2h0Nv53osNUhy7VnQim9RTwU7iAprPRl0OAlCAt2UqDkxg9zeiMU6FqTdo0OTQc5jvmgmZ5B1eq1HhhSN6kA7KYVdWEVRq+9N248GAgj+4nSRdp38IKA+lIfSewunLCpEp40w64onk2mN5zgtGjviNxI1C7mN66oYitIWi9CEO7Ej++tGp+2PrBAjzbr5Hj9KjJDDFc1zcNSh9QN6Q1CgvQReKJCJuggMZgUg3xRsn1idulA0UgVBmWpL7oDBEKsxjpf+ufn/SHt0bNkIgiuGeZgMp17NX51CHVn3P6r4TX8e3j1A6MEegmCDM1WjXY65+3x8Y7bRfngG69JaRhWVQvh4JdVdU3b0ZFIVKl0YqFonpZCOXinsw/86iTYZyiPLHEjVEGRQYMbYSXV/0csn2aNDXxm79j3SUjNpsjLXSwt1DcO6znGrkGkmImwxeOriODsnpJ0148si34P4o1JkoDx78buOsP09u6eJqux8UyndMeKLf0a4d8AVZv45mSHtFdxJfJVERyOx5w0h2J/jA/GNnR1kgzUSoi418+Qo15abjytiZi6/gPGnMEV -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Pauses or resumes the pipeline action identified by the given `actionId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/refresh-data-link-cache.api.mdx b/platform-api-docs/docs/refresh-data-link-cache.api.mdx deleted file mode 100644 index aecf0dc2a..000000000 --- a/platform-api-docs/docs/refresh-data-link-cache.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: refresh-data-link-cache -title: "Refresh data-link cache" -description: "Refreshes the data-link cache for the given `workspaceId` or `credentialsId`. Forces immediate re-discovery of available cloud storage resources." -sidebar_label: "Refresh data-link cache" -hide_title: true -hide_table_of_contents: true -api: eJzNlFFv0zAQx7+K5eeSFpj20CfGYKgCiYkN8YAm7eZcGlPHzmynpary3blzkqXtpsEDQjy19l3s3/9/59vJCMsg599lDhFeGG1XQd5MZI5BeV1H7aycyy9YeAwlBhFLFA+ZQoGideF82l/qNVpxu3F+FWpQuMhvBYVulcccbdRgAm1l4sJ5RUfpqsJcQ0Th8UWug3Jr9FvhCgFr0AbuDAplXJOLEJ2HJecF1/C3mZxIV6MH5lvkI+E7QvtEZOcMRkk1eKgwomeJO2lpQcl7hJSjWeF9Q3fLY93fhkRhmwq9VkInJYVGn4lFIVylY8R8QmiDQ50n2goQTUAvlLMRf0ZGDhSpQM53Mm5rBtEUWqKnEHlYQey2Tk9k204eaA/se573fEwl07y2ywPgC23Yih6xRxbRjRUNAhT5GzSbv9GxTIUNNSo+Ihd7LE8K6i4lfGohOrx2NmDg+KvZjH8OcT9/lO1EnsxePxEaqiusiwKMcRvM2RYZUDVex20q6FsEj/6siSUtb/hWqnbpuCOWGFMDcEhOR4XTpH7aq2cR6NdDgzTeUHYZYx3m0ynUOksdmAW8J55Mu0eWX6WIuDQQuYbiPHXs2eVCMs0Ae8VGdU7sIz/4xjcOfvL6LiXRTvfnYuiOH5uYTNC2cOlzHQ2OFHzt7wBZrub31yVze4KKfNih+H3JVGRtUnMW7s0YIBB2rrvnZXZ6ms14r3YhVmD5yL6F+9d5PDmOWXeJhvrrPx05fbH4OU9rA/QQSW1ybdc32sEYJXN7lUOzUUeUZA7n7XZ3EPCrN23L29175hYkLOagFi6IHp+x6C9PpyfVrXD7aGCuwTScKXlI/Tnuvx5Oz+g5HqmjohteeM2S0kTZGygf3l9TKhw+3KOHmirYh8Bu946meqeMa7dCSzUfUCKv6d62bX8BIRaiwg== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Refreshes the data-link cache for the given `workspaceId` or `credentialsId`. Forces immediate re-discovery of available cloud storage resources. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/remove-labels-from-actions.api.mdx b/platform-api-docs/docs/remove-labels-from-actions.api.mdx deleted file mode 100644 index 19a652139..000000000 --- a/platform-api-docs/docs/remove-labels-from-actions.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: remove-labels-from-actions -title: "Remove labels from actions" -description: "Removes the given list of labels from the given pipeline actions." -sidebar_label: "Remove labels from actions" -hide_title: true -hide_table_of_contents: true -api: eJytVcFOGzEQ/RXL55CEFnHIqQEVCbUqCKh6iHKY7M4mBu/a2N6EaJV/74y9S7IEQQ+9INZ+M/PmzfOkkQGWXk5mUsMCtZfzgczRZ07ZoEwlJ/IOS7NGL8IKxVKtsRJa+SBMIVKEKJwpD26tsqhVhQIyzuCHciCNRQf8dZ2/ZvwZo68oeJqAhLPgoMSAjhk1sqIPwm+Me/IWMqTogVRM6rlGt5Vvqf7pgKKqS3QqEyrHKqhCoSOwz1ZYgpw0MmwtJ1ZVwGW8KowrIaSj8zO525EMDqmKDxcm33JMv1RiL1xsRbRQSpQZylkFDgBrtcpi26NHz1HNMQWzeMSMA61jkYJCH2OzpJY/gIJzwD2rgOXhuQ9OVUviPEgz/LeoD3qnREEFzaip9yZTEDDNKHV913Ybkdy6ckhzDa7GeOAtTTP18WV8dqzdzQ9xIn4Z0WlFQWfjr+/gOteIygQBWpsN1eGiHrPaqbCNLrlAcOimdVjR55wnRxZaGXaaNXEoFvhOjlpHjpJxR2l4bAx0685ztdMEXYVg/WQ0AquGmTZ1PvT4TGyGyhy57j7eiFsNgaUUl4wX09tryVw6qvc8+STKIeHXeXDFzqP8vYggOkn/XHVDetyEKAE76m7v0O8vUFoeWc87s84c80NvzMbzHb+jwsT67ajbNpj3Zx2yXiqjnZDAPEcqysn66h1qRrZXOpqsMN/2F0SEpU91Tofn58Mxn/HgSohPpl0CaWn0dg687o0e3Wb/CP/L8moHFPAljKwG2j9EMDbatM6ayT2Vdo3yO4juIuVX7EICNc0CPP52erfj47TD2HO58rDQ/IYK0B4/6OeTDfcu1SfcHi3RNeiakdGia3CK68fnQ3QRcsrGxFLoZSp/8sDZ97FH+6339G5v7h/Yve32LE3OMQ42LA39pdr8u5BkI0A8a0i+alnDkrEpJ3sd+k/lzdOITLttV20PGJLgEfFgnrAi0TstAn8TXUr+F4ekaxo= -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Removes the given list of labels from the given pipeline actions. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/remove-labels-from-pipelines.api.mdx b/platform-api-docs/docs/remove-labels-from-pipelines.api.mdx deleted file mode 100644 index 111e86850..000000000 --- a/platform-api-docs/docs/remove-labels-from-pipelines.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: remove-labels-from-pipelines -title: "Remove labels from pipelines" -description: "Removes the given list of labels from the given pipelines." -sidebar_label: "Remove labels from pipelines" -hide_title: true -hide_table_of_contents: true -api: eJylVU1PGzEQ/SuWzyEbWsQhpwIqEmpVIqDqAXGY7M4mBu/a2N6EaJX/3hl7l2wIKpW4RLE9H2/evJltZYCFl9N7qWGO2suHkSzQ507ZoEwtp/IGK7NCL8ISxUKtsBZa+SBMKZKHKJ2pBq9WWdSqRj+WI2ksOuBAV8VrqJ/R7ZK8Zr0pWVpwUGFAx2BaWdOBPNbGPXkLOZL/SCrG89yg28i3KP/0hqJuKnQqF6rAOqhSoSNjny+xAjltZdhYDqzqgIv4VBpXQUhXpydyuyUGHFIWH85NsWGf/VQJv3CxGNGZUqDcUMw6sANYq1UeC88ePXu1hxDM/BFzdrSOaQqKeKDXnr+rwg+MwTngqlXAyv9fHaPU0k/HoUBBBc1WZ96bXEHAvnOJi5uOg2jLhCiH1O/gGowX3prap+q+TE4OGb3+IY7ELyN6BsnpZPL1HbteTaI2QYDWZk15OKnHvHEqbKJ2zhEcurMmLOn4wP0kYS0NK9Ca2CoL/CazV61mSctZaioLBt2q12LjNBkvQ7B+mmVg1TjXpinGHp8Jz1iZAzXexhcx0xCYTnHB9uJsdiUZTQ/2lhWRaBlCfu0JZ+y1y+d5NKKb9Oeyb9TjOkQSWGk3O+V+f4HKctveaOp+8jCUBh23PFqliam7TncVMOSPimOqVE4bIhlzEyGPY7BP3JAumgSlo8ZK8233QECY9ZTneHx6Op7wHXetgjhF3V5Im2RvA9nBMtkD3O4m83PLrGtLwJeQWQ20jQhbrLHtFHUvhyi6jcoTEFVFtC9Zf2TWtnPw+Nvp7Zav005jrRXKw1zz9JSgPf6jlA823rtgn3BzsFRXoBu2jNJcgVOcPw4OwUUoKBoDS64XKf3RHUff+R7su72hm13f3rFqu21amYJ9HKyZGvql3PylYO84DPGuJfrqRQMLtk0xWeOwPyJvRiIi7TddvRkgJMKjxZ15wppI77kIfCa4FPwvdrNung== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Removes the given list of labels from the given pipelines. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/remove-labels-from-workflows.api.mdx b/platform-api-docs/docs/remove-labels-from-workflows.api.mdx deleted file mode 100644 index 8ef43bfa7..000000000 --- a/platform-api-docs/docs/remove-labels-from-workflows.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: remove-labels-from-workflows -title: "Remove labels from workflows" -description: "Removes the given list of labels from the given workflows." -sidebar_label: "Remove labels from workflows" -hide_title: true -hide_table_of_contents: true -api: eJylVcFOGzEQ/RXL55CkLeKQUwEVCbUqCKg4RDlMdmcTg3dtbG9CtMq/d8beTTYEQaVeEGu/Gb9582bSyAALLydTqWGO2svZQOboM6dsUKaSE3mHpVmhF2GJYqFWWAmtfBCmEClCFM6Uvdu1cc+FNms/lANpLDrgRNf5LtWvGHZFUY8dlJAWHJQY0DGZRlb0QRGczFvIkOIHUjGflxrdRr5l+dgBRVWX6FQmVI5VUIVCR2CfLbEEOWlk2FhOrKqAi3hVGFdCSEdnp3K7JQUc0is+XJh8wzGHTyX+wsViRAulRJmhnFXgALBWqywWPnryHNUcUzDzJ8w40DqWKSj0fNvpd537HhicA65aBSz75z44VS2I9SA18N+iPqieEgUVNKPOvTeZgoBdn1Lld23FEcvlK4fU3eBqjAfemsqnWr6OT4/1u/kpTsRvIzq9KOh0/O0dXOcdUZkgQBMBeocf9ZjVToVNdMoFgkN3Xoclfc64e2SjpWG/WRMbY4Hv5KhTdpSMO0odZHegW3XGq50m7DIE6yejEVg1zLSp86HHF6IzVObIevfxRtxqCKymuGS8OL+9lkym43rP7U+q9BnvWsIvdkbl73kE0Un656rr09M6RA3YVnd7m/54hdJy194YaNo5ZNY3yHQ82/I4FSYyaPvdFsLMP6uRFVMZbYUE5lZCFq1/qF9fNXK/0tFphfm+vyAiLH5658vw7Gw45jPuXQlxctpdkLbHwdZZ9xbIAeFmP43/t8Da7gR8DSOrgTYQcYs1Nq2vpjvB5aBbojwG0Vuk+pJNSKimmYPHP05vt3yc1hg7Llce5ppHqADt8YNKPlly73J9xs3RHl2BrhkZDboCp/j9OD1EFyGnbEwshV6m508eOPs+9mjFHUze7c39A3u3XaClyTnGAWvEf+lt/nHg6DgS8awh+apFDQvGppzsdDgclDeDEZl2667a9BiS4BHxYJ6xItE7LQJ/E11K/hfx7Gwt -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Removes the given list of labels from the given workflows. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/seqera-api.info.mdx b/platform-api-docs/docs/seqera-api.info.mdx deleted file mode 100644 index 33572e2f1..000000000 --- a/platform-api-docs/docs/seqera-api.info.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: seqera-api -title: "Seqera API" -description: "Seqera Platform services API" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Heading from "@theme/Heading"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; - - - - - - - - - -Seqera Platform services API - -
- - - - - - - -
- - - - - - - - - - -
- Security Scheme Type: - - http -
- HTTP Authorization Scheme: - - bearer -
- Bearer format: - - jwt -
-
- - -
-

- Contact -

- [info@seqera.io](mailto:info@seqera.io) - - URL: [https://seqera.io](https://seqera.io) - -
- \ No newline at end of file diff --git a/platform-api-docs/docs/sidebar.ts b/platform-api-docs/docs/sidebar.ts deleted file mode 100644 index 47090dd23..000000000 --- a/platform-api-docs/docs/sidebar.ts +++ /dev/null @@ -1,1308 +0,0 @@ -import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; - -const sidebar: SidebarsConfig = { - apisidebar: [ - { - type: "doc", - id: "docs/seqera-api", - }, - { - type: "category", - label: "actions", - items: [ - { - type: "doc", - id: "docs/list-actions", - label: "List actions", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-action", - label: "Create action", - className: "api-method post", - }, - { - type: "doc", - id: "docs/list-action-types", - label: "List action event types", - className: "api-method get", - }, - { - type: "doc", - id: "docs/validate-action-name", - label: "Validate action name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-action", - label: "Describe action", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-action", - label: "Update action", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-action", - label: "Delete action", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/launch-action", - label: "Trigger Tower Launch action", - className: "api-method post", - }, - { - type: "doc", - id: "docs/pause-action", - label: "Pause or resume action", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "avatars", - items: [ - { - type: "doc", - id: "docs/create-avatar", - label: "Create the avatar image", - className: "api-method post", - }, - { - type: "doc", - id: "docs/download-avatar", - label: "Download the avatar image", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "compute-envs", - items: [ - { - type: "doc", - id: "docs/list-compute-envs", - label: "List compute environments", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-compute-env", - label: "Create compute environment", - className: "api-method post", - }, - { - type: "doc", - id: "docs/validate-compute-env-name", - label: "Validate compute environment name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-compute-env", - label: "Describe compute environment", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-compute-env", - label: "Update compute environment", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-compute-env", - label: "Delete compute environment", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/update-compute-env-primary", - label: "Define primary compute environment", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "credentials", - items: [ - { - type: "doc", - id: "docs/list-credentials", - label: "List credentials", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-credentials", - label: "Create credentials", - className: "api-method post", - }, - { - type: "doc", - id: "docs/validate-credentials-name", - label: "Validate credential name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-credentials", - label: "Describe credentials", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-credentials", - label: "Update credentials", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-credentials", - label: "Delete credentials", - className: "api-method delete", - }, - ], - }, - { - type: "category", - label: "data-links", - items: [ - { - type: "doc", - id: "docs/list-data-links", - label: "List data-links", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-custom-data-link", - label: "Create data-link", - className: "api-method post", - }, - { - type: "doc", - id: "docs/refresh-data-link-cache", - label: "Refresh data-link cache", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-data-link", - label: "Describe data-link", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-custom-data-link", - label: "Update data-link", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-custom-data-link", - label: "Delete data-link", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/explore-data-link", - label: "Explore data-link path", - className: "api-method get", - }, - { - type: "doc", - id: "docs/explore-data-link-tree", - label: "Explore data-link tree", - className: "api-method get", - }, - { - type: "doc", - id: "docs/explore-data-link-1", - label: "Explore data-link path", - className: "api-method get", - }, - { - type: "doc", - id: "docs/delete-data-link-item", - label: "Delete data-link content", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/download-data-link", - label: "Download data-link file at path", - className: "api-method get", - }, - { - type: "doc", - id: "docs/generate-download-url-data-link", - label: "Generate download URL", - className: "api-method get", - }, - { - type: "doc", - id: "docs/generate-download-script", - label: "Generate download script", - className: "api-method get", - }, - { - type: "doc", - id: "docs/generate-data-link-upload-url", - label: "Generate data-link file upload URL (to given path)", - className: "api-method post", - }, - { - type: "doc", - id: "docs/finish-data-link-upload", - label: "Finish data-link file upload to given path", - className: "api-method post", - }, - { - type: "doc", - id: "docs/finish-data-link-upload-1", - label: "Finish data-link file upload to given path", - className: "api-method post", - }, - { - type: "doc", - id: "docs/generate-data-link-upload-url-1", - label: "Generate data-link file upload URL (to given path)", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "datasets", - items: [ - { - type: "doc", - id: "docs/list-datasets-v-2", - label: "List datasets", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-dataset-v-2", - label: "Create dataset", - className: "api-method post", - }, - { - type: "doc", - id: "docs/list-latest-dataset-versions-v-2", - label: "List latest dataset versions", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-dataset-v-2", - label: "Update dataset", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-dataset-v-2", - label: "Delete dataset", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/describe-dataset-v-2", - label: "Describe dataset", - className: "api-method get", - }, - { - type: "doc", - id: "docs/upload-dataset-v-2", - label: "Upload new dataset version", - className: "api-method post", - }, - { - type: "doc", - id: "docs/download-dataset-v-2", - label: "Download dataset content", - className: "api-method get", - }, - { - type: "doc", - id: "docs/list-dataset-versions-v-2", - label: "List all dataset versions", - className: "api-method get", - }, - { - type: "doc", - id: "docs/list-launch-dataset-versions", - label: "Describe launch datasets", - className: "api-method get", - }, - { - type: "doc", - id: "docs/list-datasets", - label: "(Deprecated) List available datasets", - className: "menu__list-item--deprecated api-method get", - }, - { - type: "doc", - id: "docs/create-dataset", - label: "(Deprecated) Create dataset", - className: "menu__list-item--deprecated api-method post", - }, - { - type: "doc", - id: "docs/list-workspace-dataset-versions", - label: "(Deprecated) List latest dataset versions", - className: "menu__list-item--deprecated api-method get", - }, - { - type: "doc", - id: "docs/update-dataset", - label: "(Deprecated) Update dataset", - className: "menu__list-item--deprecated api-method put", - }, - { - type: "doc", - id: "docs/delete-dataset", - label: "(Deprecated) Delete dataset", - className: "menu__list-item--deprecated api-method delete", - }, - { - type: "doc", - id: "docs/describe-dataset", - label: "(Deprecated) Describe dataset", - className: "menu__list-item--deprecated api-method get", - }, - { - type: "doc", - id: "docs/upload-dataset", - label: "(Deprecated) Upload new dataset version", - className: "menu__list-item--deprecated api-method post", - }, - { - type: "doc", - id: "docs/download-dataset", - label: "Download dataset content", - className: "api-method get", - }, - { - type: "doc", - id: "docs/list-dataset-versions", - label: "(Deprecated) List all dataset versions", - className: "menu__list-item--deprecated api-method get", - }, - ], - }, - { - type: "category", - label: "ga4gh", - items: [ - { - type: "doc", - id: "docs/ga-4-gh-run-list", - label: "GA4GH: List runs", - className: "api-method get", - }, - { - type: "doc", - id: "docs/ga-4-gh-run-create", - label: "GA4GH: Launch run", - className: "api-method post", - }, - { - type: "doc", - id: "docs/ga-4-gh-run-describe", - label: "GA4GH: Describe run", - className: "api-method get", - }, - { - type: "doc", - id: "docs/ga-4-gh-run-cancel", - label: "GA4GH: Cancel run", - className: "api-method post", - }, - { - type: "doc", - id: "docs/ga-4-gh-run-status", - label: "GA4GH: Retrieve run status", - className: "api-method get", - }, - { - type: "doc", - id: "docs/ga-4-gh-service-info", - label: "GA4GH workflow execution service API info", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "labels", - items: [ - { - type: "doc", - id: "docs/add-labels-to-actions", - label: "Add labels to actions", - className: "api-method post", - }, - { - type: "doc", - id: "docs/apply-labels-to-actions", - label: "Replace action labels", - className: "api-method post", - }, - { - type: "doc", - id: "docs/remove-labels-from-actions", - label: "Remove labels from actions", - className: "api-method post", - }, - { - type: "doc", - id: "docs/list-labels", - label: "List labels", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-label", - label: "Create label", - className: "api-method post", - }, - { - type: "doc", - id: "docs/get-allowed-dynamic-labels", - label: "GetAllowedDynamicLabels", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-label", - label: "Update label", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-label", - label: "Delete label", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/add-labels-to-pipelines", - label: "Add labels to pipelines", - className: "api-method post", - }, - { - type: "doc", - id: "docs/apply-labels-to-pipelines", - label: "Replace pipeline labels", - className: "api-method post", - }, - { - type: "doc", - id: "docs/remove-labels-from-pipelines", - label: "Remove labels from pipelines", - className: "api-method post", - }, - { - type: "doc", - id: "docs/add-labels-to-workflows", - label: "Add labels to workflows", - className: "api-method post", - }, - { - type: "doc", - id: "docs/apply-labels-to-workflows", - label: "Replace workflow labels", - className: "api-method post", - }, - { - type: "doc", - id: "docs/remove-labels-from-workflows", - label: "Remove labels from workflows", - className: "api-method post", - }, - ], - }, - { - type: "category", - label: "launch", - items: [ - { - type: "doc", - id: "docs/describe-launch", - label: "Describe Launch record", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "orgs", - items: [ - { - type: "doc", - id: "docs/list-organizations", - label: "List organizations", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-organization", - label: "Create organization", - className: "api-method post", - }, - { - type: "doc", - id: "docs/validate-organization-name", - label: "Validate organization name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-organization", - label: "Describe organization", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-organization", - label: "Update organization", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-organization", - label: "Delete organization", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/list-organization-collaborators", - label: "List organization collaborators", - className: "api-method get", - }, - { - type: "doc", - id: "docs/list-organization-members", - label: "List organization members", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-organization-member", - label: "Add organization member", - className: "api-method put", - }, - { - type: "doc", - id: "docs/leave-organization", - label: "Leave organization", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/delete-organization-member", - label: "Delete member", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/update-organization-member-role", - label: "Update member role", - className: "api-method put", - }, - { - type: "doc", - id: "docs/describe-organization-quotas", - label: "Describe organization quotas", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "pipelines", - items: [ - { - type: "doc", - id: "docs/list-pipelines", - label: "List pipelines", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-pipeline", - label: "Create pipeline", - className: "api-method post", - }, - { - type: "doc", - id: "docs/describe-pipeline-repository", - label: "Describe remote pipeline repository", - className: "api-method get", - }, - { - type: "doc", - id: "docs/list-pipeline-repositories", - label: "List user pipeline repositories", - className: "api-method get", - }, - { - type: "doc", - id: "docs/validate-pipeline-name", - label: "Validate pipeline name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-pipeline", - label: "Describe pipeline", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-pipeline", - label: "Update pipeline", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-pipeline", - label: "Delete pipeline", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/describe-pipeline-launch", - label: "Describe pipeline launch", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-pipeline-schema", - label: "Describe pipeline schema", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "pipeline-secrets", - items: [ - { - type: "doc", - id: "docs/list-pipeline-secrets", - label: "List pipeline secrets", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-pipeline-secret", - label: "Create pipeline secret", - className: "api-method post", - }, - { - type: "doc", - id: "docs/validate-pipeline-secret-name", - label: "Validate secret name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-pipeline-secret", - label: "Describe pipeline secret", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-pipeline-secret", - label: "Update secret", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-pipeline-secret", - label: "Delete secret", - className: "api-method delete", - }, - ], - }, - { - type: "category", - label: "platforms", - items: [ - { - type: "doc", - id: "docs/list-platforms", - label: "List platforms", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-platform", - label: "Describe platform", - className: "api-method get", - }, - { - type: "doc", - id: "docs/list-platform-regions", - label: "List platform regions", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "service-info", - items: [ - { - type: "doc", - id: "docs/info", - label: "General Seqera service features and version.", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "studios", - items: [ - { - type: "doc", - id: "docs/list-data-studios", - label: "List Studios", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-data-studio", - label: "Create Studio", - className: "api-method post", - }, - { - type: "doc", - id: "docs/list-mounted-data-link-ids", - label: "List mounted data-links", - className: "api-method get", - }, - { - type: "doc", - id: "docs/list-data-studio-templates", - label: "List available Studio templates", - className: "api-method get", - }, - { - type: "doc", - id: "docs/validate-data-studio-name", - label: "Validate Studio name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-data-studio", - label: "Describe Studio", - className: "api-method get", - }, - { - type: "doc", - id: "docs/delete-data-studio", - label: "Delete Studio", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/list-data-studio-checkpoints", - label: "List Studio checkpoints", - className: "api-method get", - }, - { - type: "doc", - id: "docs/get-data-studio-checkpoint", - label: "Get Studio checkpoint", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-data-studio-checkpoint", - label: "Update Studio checkpoint name", - className: "api-method put", - }, - { - type: "doc", - id: "docs/extend-data-studio-lifespan", - label: "ExtendDataStudioLifespan", - className: "api-method post", - }, - { - type: "doc", - id: "docs/start-data-studio", - label: "Starts a Studio", - className: "api-method put", - }, - { - type: "doc", - id: "docs/stop-data-studio", - label: "Stop Studio", - className: "api-method put", - }, - ], - }, - { - type: "category", - label: "teams", - items: [ - { - type: "doc", - id: "docs/list-organization-teams", - label: "List organization teams", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-organization-team", - label: "Create team", - className: "api-method post", - }, - { - type: "doc", - id: "docs/validate-team-name", - label: "Validate team name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-organization-team", - label: "Describe team", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-organization-team", - label: "Update team", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-organization-team", - label: "Delete team", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/list-organization-team-members", - label: "List team members", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-organization-team-member", - label: "Create team member", - className: "api-method post", - }, - { - type: "doc", - id: "docs/delete-organization-team-member", - label: "Delete team member", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/list-workspaces-by-team", - label: "List team workspaces", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "tokens", - items: [ - { - type: "doc", - id: "docs/token-list", - label: "List tokens", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-token", - label: "Create token", - className: "api-method post", - }, - { - type: "doc", - id: "docs/delete-all-tokens", - label: "Delete all user tokens", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/delete-token", - label: "Delete token", - className: "api-method delete", - }, - ], - }, - { - type: "category", - label: "trace", - items: [ - { - type: "doc", - id: "docs/create-trace", - label: "Create workflow execution trace", - className: "api-method post", - }, - { - type: "doc", - id: "docs/update-trace-begin", - label: "Signal workflow execution start", - className: "api-method put", - }, - { - type: "doc", - id: "docs/update-trace-complete", - label: "Signal workflow execution completion", - className: "api-method put", - }, - { - type: "doc", - id: "docs/update-trace-heartbeat", - label: "Signal workflow execution heartbeat", - className: "api-method put", - }, - { - type: "doc", - id: "docs/update-trace-progress", - label: "Store workflow task execution metadata", - className: "api-method put", - }, - ], - }, - { - type: "category", - label: "users", - items: [ - { - type: "doc", - id: "docs/user-info", - label: "Describe current user", - className: "api-method get", - }, - { - type: "doc", - id: "docs/validate-user-name", - label: "Check that the user name is valid", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-user", - label: "Describe a user entity", - className: "menu__list-item--deprecated api-method get", - }, - { - type: "doc", - id: "docs/update-user", - label: "Update an user entity", - className: "api-method post", - }, - { - type: "doc", - id: "docs/delete-user", - label: "Delete a user entity", - className: "api-method delete", - }, - ], - }, - { - type: "category", - label: "workflows", - items: [ - { - type: "doc", - id: "docs/list-workflows", - label: "List workflows", - className: "api-method get", - }, - { - type: "doc", - id: "docs/delete-workflow-many", - label: "Delete workflows", - className: "api-method post", - }, - { - type: "doc", - id: "docs/create-workflow-launch", - label: "Launch workflow", - className: "api-method post", - }, - { - type: "doc", - id: "docs/generate-random-workflow-name", - label: "Generates a random name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/validate-workflow-constraints", - label: "Validate run name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-workflow", - label: "Describe workflow", - className: "api-method get", - }, - { - type: "doc", - id: "docs/delete-workflow", - label: "Delete the Workflow entity with the given ID", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/cancel-workflow", - label: "Cancel workflow", - className: "api-method post", - }, - { - type: "doc", - id: "docs/download-workflow-log", - label: "Download workflow files", - className: "api-method get", - }, - { - type: "doc", - id: "docs/download-workflow-task-log", - label: "Download workflow task files", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-workflow-launch", - label: "Describe workflow launch", - className: "api-method get", - }, - { - type: "doc", - id: "docs/get-workflow-log", - label: "Get workflow log", - className: "api-method get", - }, - { - type: "doc", - id: "docs/get-workflow-task-log", - label: "Get workflow task logs", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-workflow-metrics", - label: "Get the execution metrics for the given Workflow ID", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-workflow-progress", - label: "Retrieve the execution progress for the given Workflow ID", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-workflow-star", - label: "Check workflow star status", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-workflow-star", - label: "Star workflow", - className: "api-method post", - }, - { - type: "doc", - id: "docs/delete-workflow-star", - label: "Unstar workflow", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/describe-workflow-task", - label: "Describe a task entity with the given ID", - className: "api-method get", - }, - { - type: "doc", - id: "docs/list-workflow-tasks", - label: "List the tasks for the given Workflow ID and filter parameters", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "workspaces", - items: [ - { - type: "doc", - id: "docs/list-workspaces", - label: "List organization workspaces", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-workspace", - label: "Create workspace", - className: "api-method post", - }, - { - type: "doc", - id: "docs/validate-workspace-name", - label: "Validate workspace name", - className: "api-method get", - }, - { - type: "doc", - id: "docs/describe-workspace", - label: "Describe workspace", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-workspace", - label: "Update workspace", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-workspace", - label: "Delete workspace", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/list-workspace-participants", - label: "List workspace participants", - className: "api-method get", - }, - { - type: "doc", - id: "docs/leave-workspace-participant", - label: "Leave workspace", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/create-workspace-participant", - label: "Create workspace participant", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-workspace-participant", - label: "Delete workspace participant", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/update-workspace-participant-role", - label: "Update participant role", - className: "api-method put", - }, - { - type: "doc", - id: "docs/find-data-studios-workspace-settings", - label: "List workspace Studios settings", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-data-studios-workspace-settings", - label: "Update workspace Studios settings", - className: "api-method put", - }, - { - type: "doc", - id: "docs/list-workspaces-user", - label: "List user workspaces and organizations", - className: "api-method get", - }, - ], - }, - { - type: "category", - label: "identities", - items: [ - { - type: "doc", - id: "docs/list-managed-identities", - label: "List managed identities", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-managed-identity", - label: "Create managed identity", - className: "api-method post", - }, - { - type: "doc", - id: "docs/describe-managed-identity", - label: "Describe managed identity", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-managed-identity", - label: "Update managed identity", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-managed-identity", - label: "Delete managed identity", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/list-managed-credentials", - label: "List managed credentials", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-managed-credentials", - label: "Create managed credentials", - className: "api-method post", - }, - { - type: "doc", - id: "docs/update-managed-credentials", - label: "Update managed credentials", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-managed-credentials", - label: "Delete managed credentials", - className: "api-method delete", - }, - ], - }, - ], -}; - -export default sidebar.apisidebar; diff --git a/platform-api-docs/docs/sidebar/sidebar.js b/platform-api-docs/docs/sidebar/sidebar.js deleted file mode 100644 index b2dfbda10..000000000 --- a/platform-api-docs/docs/sidebar/sidebar.js +++ /dev/null @@ -1,343 +0,0 @@ -/** - * Manually defined sidebar to preserve API operation order and categorization. - */ - -module.exports = { - apisidebar: [ - { - type: "doc", - id: "info/seqera-api", - }, - { type: "doc", id: "info", label: "API service info", className: "api-method get" }, - { - type: "category", - label: "Credentials", - link: {type: 'doc', id: 'info/credentials-info'}, - items: [ - { type: "doc", id: "list-credentials", label: "List credentials", className: "api-method get" }, - { type: "doc", id: "create-credentials", label: "Create credentials", className: "api-method post" }, - { type: "doc", id: "validate-credentials-name", label: "Validate credential name", className: "api-method get" }, - { type: "doc", id: "describe-credentials", label: "Describe credentials", className: "api-method get" }, - { type: "doc", id: "update-credentials", label: "Update credentials", className: "api-method put" }, - { type: "doc", id: "delete-credentials", label: "Delete credentials", className: "api-method delete" }, - { - type: "category", - label: "Managed identities", - link: {type: 'doc', id: 'info/identities-info'}, - items: [ - { type: "doc", id: "list-managed-identities", label: "List managed identities", className: "api-method get" }, - { type: "doc", id: "list-managed-credentials", label: "List managed credentials", className: "api-method get" }, - { type: "doc", id: "create-managed-identity", label: "Create managed identity", className: "api-method post" }, - { type: "doc", id: "create-managed-credentials", label: "Create managed credentials", className: "api-method post" }, - { type: "doc", id: "describe-managed-identity", label: "Describe managed identity", className: "api-method get" }, - { type: "doc", id: "delete-managed-identity", label: "Delete managed identity", className: "api-method delete" }, - { type: "doc", id: "delete-managed-credentials", label: "Delete managed credentials", className: "api-method delete" }, - ], - }, - ], - }, - { - type: "category", - label: "Compute", - link: {type: 'doc', id: 'info/compute-envs-info'}, - items: [ - { type: "doc", id: "list-compute-envs", label: "List compute environments", className: "api-method get" }, - { type: "doc", id: "create-compute-env", label: "Create compute environment", className: "api-method post" }, - { type: "doc", id: "validate-compute-env-name", label: "Validate compute environment name", className: "api-method get" }, - { type: "doc", id: "describe-compute-env", label: "Describe compute environment", className: "api-method get" }, - { type: "doc", id: "update-compute-env", label: "Update compute environment", className: "api-method put" }, - { type: "doc", id: "delete-compute-env", label: "Delete compute environment", className: "api-method delete" }, - { type: "doc", id: "update-compute-env-primary", label: "Define primary compute environment", className: "api-method post" }, - { - type: "category", - label: "Platforms", - link: {type: 'doc', id: 'info/platforms-info'}, - items: [ - { type: "doc", id: "list-platforms", label: "List platforms", className: "api-method get" }, - { type: "doc", id: "describe-platform", label: "Describe platform", className: "api-method get" }, - { type: "doc", id: "list-platform-regions", label: "List platform regions", className: "api-method get" }, - ], - }, - ], - }, - { - type: "category", - label: "Data Explorer", - link: {type: 'doc', id: 'info/data-links-info'}, - items: [ - { type: "doc", id: "list-data-links", label: "List data links in a user or workspace context", className: "api-method get" }, - { type: "doc", id: "create-custom-data-link", label: "Create data link in a user or workspace context", className: "api-method post" }, - { type: "doc", id: "refresh-data-link-cache", label: "Refresh data link cache for workspace or specific credentials", className: "api-method get" }, - { type: "doc", id: "describe-data-link", label: "Describe a DataLink", className: "api-method get" }, - { type: "doc", id: "update-custom-data-link", label: "Update data link in a user or workspace context", className: "api-method put" }, - { type: "doc", id: "delete-custom-data-link", label: "Delete data link in a user or workspace context", className: "api-method delete" }, - { type: "doc", id: "explore-data-link", label: "Explore data-link content", className: "api-method get" }, - { type: "doc", id: "explore-data-link-1", label: "Explore data-link content at path", className: "api-method get" }, - { type: "doc", id: "explore-data-link-tree", label: "Explore data-link tree", className: "api-method get" }, - { type: "doc", id: "delete-data-link-item", label: "Delete data-link content", className: "api-method delete" }, - { type: "doc", id: "download-data-link", label: "Download data-link file at path", className: "api-method get" }, - { type: "doc", id: "generate-data-link-upload-url", label: "Generate file upload URL", className: "api-method get" }, - { type: "doc", id: "generate-data-link-upload-url-1", label: "Generate file upload URL to given path", className: "api-method get" }, - { type: "doc", id: "generate-download-url-data-link", label: "Generate data-link file download URL", className: "api-method get" }, - { type: "doc", id: "generate-download-script", label: "Generate download script", className: "api-method get" }, - { type: "doc", id: "finish-data-link-upload", label: "Finish data-link file upload", className: "api-method post" }, - { type: "doc", id: "finish-data-link-upload-1", label: "Finish data-link file upload to given path", className: "api-method post" }, - ], - }, - { - type: "category", - label: "Datasets", - link: {type: 'doc', id: 'info/datasets-info'}, - items: [ - { type: "doc", id: "list-datasets-v-2", label: "List available datasets", className: "api-method get" }, - { type: "doc", id: "create-dataset-v-2", label: "Create dataset", className: "api-method post" }, - { type: "doc", id: "list-latest-dataset-versions-v-2", label: "List latest dataset versions", className: "api-method get" }, - { type: "doc", id: "update-dataset-v-2", label: "Update dataset", className: "api-method put" }, - { type: "doc", id: "delete-dataset-v-2", label: "Delete dataset", className: "api-method delete" }, - { type: "doc", id: "describe-dataset-v-2", label: "Describe dataset", className: "api-method get" }, - { type: "doc", id: "upload-dataset-v-2", label: "Upload new dataset version", className: "api-method post" }, - { type: "doc", id: "download-dataset-v-2", label: "Download dataset content", className: "api-method get" }, - { type: "doc", id: "list-dataset-versions-v-2", label: "List all dataset versions", className: "api-method get" }, - { type: "doc", id: "list-launch-dataset-versions", label: "Describe launch datasets", className: "api-method get" }, - { type: "doc", id: "list-datasets", label: "(Deprecated) List available datasets", className: "menu__list-item--deprecated api-method get" }, - { type: "doc", id: "create-dataset", label: "(Deprecated) Create dataset", className: "menu__list-item--deprecated api-method post" }, - { type: "doc", id: "list-workspace-dataset-versions", label: "(Deprecated) List latest dataset versions", className: "menu__list-item--deprecated api-method get" }, - { type: "doc", id: "update-dataset", label: "(Deprecated) Update dataset", className: "menu__list-item--deprecated api-method put" }, - { type: "doc", id: "delete-dataset", label: "(Deprecated) Delete dataset", className: "menu__list-item--deprecated api-method delete" }, - { type: "doc", id: "describe-dataset", label: "(Deprecated) Describe dataset", className: "menu__list-item--deprecated api-method get" }, - { type: "doc", id: "upload-dataset", label: "(Deprecated) Upload new dataset version", className: "menu__list-item--deprecated api-method post" }, - { type: "doc", id: "download-dataset", label: "Download dataset content", className: "api-method get" }, - { type: "doc", id: "list-dataset-versions", label: "(Deprecated) List all dataset versions", className: "menu__list-item--deprecated api-method get" }, - ], - }, - { - type: "category", - label: "Pipelines", - link: {type: 'doc', id: 'info/pipelines-info'}, - items: [ - { type: "doc", id: "list-pipelines", label: "List pipelines", className: "api-method get" }, - { type: "doc", id: "create-pipeline", label: "Create pipeline", className: "api-method post" }, - { type: "doc", id: "describe-pipeline-repository", label: "Describe remote pipeline repository", className: "api-method get" }, - { type: "doc", id: "list-pipeline-repositories", label: "List user pipeline repositories", className: "api-method get" }, - { type: "doc", id: "validate-pipeline-name", label: "Validate pipeline name", className: "api-method get" }, - { type: "doc", id: "describe-pipeline", label: "Describe pipeline", className: "api-method get" }, - { type: "doc", id: "update-pipeline", label: "Update pipeline", className: "api-method put" }, - { type: "doc", id: "delete-pipeline", label: "Delete pipeline", className: "api-method delete" }, - { type: "doc", id: "describe-pipeline-launch", label: "Describe pipeline launch", className: "api-method get" }, - { type: "doc", id: "describe-pipeline-schema", label: "Describe pipeline schema", className: "api-method get" }, - ], - }, - { - type: "category", - label: "Actions", - link: {type: 'doc', id: 'info/actions-info'}, - items: [ - { type: "doc", id: "list-actions", label: "List actions", className: "api-method get" }, - { type: "doc", id: "create-action", label: "Create action", className: "api-method post" }, - { type: "doc", id: "list-action-types", label: "List action event types", className: "api-method get" }, - { type: "doc", id: "validate-action-name", label: "Validate action name", className: "api-method get" }, - { type: "doc", id: "describe-action", label: "Describe action", className: "api-method get" }, - { type: "doc", id: "update-action", label: "Update action", className: "api-method put" }, - { type: "doc", id: "delete-action", label: "Delete action", className: "api-method delete" }, - { type: "doc", id: "launch-action", label: "Trigger Tower Launch action", className: "api-method post" }, - { type: "doc", id: "pause-action", label: "Pause or resume action", className: "api-method post" }, - ], - }, - { - type: "category", - label: "Labels", - link: {type: 'doc', id: 'info/labels-info'}, - items: [ - { type: "doc", id: "add-labels-to-actions", label: "Add labels to actions", className: "api-method post" }, - { type: "doc", id: "apply-labels-to-actions", label: "Replace action labels", className: "api-method post" }, - { type: "doc", id: "remove-labels-from-actions", label: "Remove labels from actions", className: "api-method post" }, - { type: "doc", id: "list-labels", label: "List labels", className: "api-method get" }, - { type: "doc", id: "create-label", label: "Create label", className: "api-method post" }, - { type: "doc", id: "update-label", label: "Update label", className: "api-method put" }, - { type: "doc", id: "delete-label", label: "Delete label", className: "api-method delete" }, - { type: "doc", id: "add-labels-to-pipelines", label: "Add labels to pipelines", className: "api-method post" }, - { type: "doc", id: "apply-labels-to-pipelines", label: "Replace pipeline labels", className: "api-method post" }, - { type: "doc", id: "remove-labels-from-pipelines", label: "Remove labels from pipelines", className: "api-method post" }, - { type: "doc", id: "add-labels-to-workflows", label: "Add labels to workflows", className: "api-method post" }, - { type: "doc", id: "apply-labels-to-workflows", label: "Replace workflow labels", className: "api-method post" }, - { type: "doc", id: "remove-labels-from-workflows", label: "Remove labels from workflows", className: "api-method post" }, - ], - }, - { - type: "category", - label: "Secrets", - link: {type: 'doc', id: 'info/secrets-info'}, - items: [ - { type: "doc", id: "list-pipeline-secrets", label: "List pipeline secrets", className: "api-method get" }, - { type: "doc", id: "create-pipeline-secret", label: "Create pipeline secret", className: "api-method post" }, - { type: "doc", id: "validate-pipeline-secret-name", label: "Validate secret name", className: "api-method get" }, - { type: "doc", id: "describe-pipeline-secret", label: "Describe pipeline secret", className: "api-method get" }, - { type: "doc", id: "update-pipeline-secret", label: "Update secret", className: "api-method put" }, - { type: "doc", id: "delete-pipeline-secret", label: "Delete secret", className: "api-method delete" }, - ], - }, - { - type: "category", - label: "Pipeline runs (workflows)", - link: {type: 'doc', id: 'info/workflows-info'}, - items: [ - { type: "doc", id: "list-workflows", label: "List workflows", className: "api-method get" }, - { type: "doc", id: "delete-workflow-many", label: "Delete workflows", className: "api-method post" }, - { type: "doc", id: "create-workflow-launch", label: "Launch workflow", className: "api-method post" }, - { type: "doc", id: "generate-random-workflow-name", label: "Generates a random name", className: "api-method get" }, - { type: "doc", id: "validate-workflow-constraints", label: "Validate run name", className: "api-method get" }, - { type: "doc", id: "describe-workflow", label: "Describe workflow", className: "api-method get" }, - { type: "doc", id: "delete-workflow", label: "Delete the Workflow entity with the given ID", className: "api-method delete" }, - { type: "doc", id: "cancel-workflow", label: "Cancel workflow", className: "api-method post" }, - { type: "doc", id: "download-workflow-log", label: "Download workflow files", className: "api-method get" }, - { type: "doc", id: "download-workflow-task-log", label: "Download workflow task files", className: "api-method get" }, - { type: "doc", id: "describe-workflow-launch", label: "Describe workflow launch", className: "api-method get" }, - { type: "doc", id: "get-workflow-log", label: "Get workflow logs", className: "api-method get" }, - { type: "doc", id: "get-workflow-task-log", label: "Get workflow task logs", className: "api-method get" }, - { type: "doc", id: "describe-workflow-metrics", label: "Get the execution metrics for the given Workflow ID", className: "api-method get" }, - { type: "doc", id: "describe-workflow-progress", label: "Retrieve the execution progress for the given Workflow ID", className: "api-method get" }, - { type: "doc", id: "describe-workflow-star", label: "Check workflow star status", className: "api-method get" }, - { type: "doc", id: "create-workflow-star", label: "Star workflow", className: "api-method post" }, - { type: "doc", id: "delete-workflow-star", label: "Unstar workflow", className: "api-method delete" }, - { type: "doc", id: "describe-workflow-task", label: "Describe a task entity with the given ID", className: "api-method get" }, - { type: "doc", id: "list-workflow-tasks", label: "List the tasks for the given Workflow ID and filter parameters", className: "api-method get" }, - ], - }, - { - type: "category", - label: "GA4GH-WES", - link: {type: 'doc', id: 'info/ga4gh-info'}, - items: [ - { type: "doc", id: "ga-4-gh-run-list", label: "GA4GH: List runs", className: "api-method get" }, - { type: "doc", id: "ga-4-gh-run-create", label: "GA4GH: Launch run", className: "api-method post" }, - { type: "doc", id: "ga-4-gh-run-describe", label: "GA4GH: Describe run", className: "api-method get" }, - { type: "doc", id: "ga-4-gh-run-cancel", label: "GA4GH: Cancel run", className: "api-method post" }, - { type: "doc", id: "ga-4-gh-run-status", label: "GA4GH: Retrieve run status", className: "api-method get" }, - { type: "doc", id: "ga-4-gh-service-info", label: "GA4GH workflow execution service API info", className: "api-method get" }, - ], - }, - { - type: "category", - label: "Workflow trace", - link: {type: 'doc', id: 'info/trace-info'}, - items: [ - { type: "doc", id: "create-trace", label: "Create workflow execution trace", className: "api-method post" }, - { type: "doc", id: "update-trace-begin", label: "Signal workflow execution start", className: "api-method put" }, - { type: "doc", id: "update-trace-complete", label: "Signal workflow execution completion", className: "api-method put" }, - { type: "doc", id: "update-trace-heartbeat", label: "Signal workflow execution heartbeat", className: "api-method put" }, - { type: "doc", id: "update-trace-progress", label: "Store workflow task execution metadata", className: "api-method put" }, - ], - }, - { type: "doc", id: "describe-launch", label: "Launch records", className: "api-method get" }, - { - type: "category", - label: "Studios", - link: {type: 'doc', id: 'info/studios-info'}, - items: [ - { type: "doc", id: "list-data-studios", label: "List Studios", className: "api-method get" }, - { type: "doc", id: "create-data-studio", label: "Create Studio", className: "api-method post" }, - { type: "doc", id: "list-mounted-data-link-ids", label: "List mounted data links", className: "api-method get" }, - { type: "doc", id: "list-data-studio-templates", label: "List Studio templates", className: "api-method get" }, - { type: "doc", id: "validate-data-studio-name", label: "Validate Studio name", className: "api-method get" }, - { type: "doc", id: "describe-data-studio", label: "Describe Studio", className: "api-method get" }, - { type: "doc", id: "delete-data-studio", label: "Delete Studio", className: "api-method delete" }, - { type: "doc", id: "list-data-studio-checkpoints", label: "List Studio checkpoints", className: "api-method get" }, - { type: "doc", id: "get-data-studio-checkpoint", label: "Get Studio checkpoint", className: "api-method get" }, - { type: "doc", id: "update-data-studio-checkpoint", label: "Update Studio checkpoint name", className: "api-method put" }, - { type: "doc", id: "extend-data-studio-lifespan", label: "ExtendDataStudioLifespan", className: "api-method post" }, - { type: "doc", id: "start-data-studio", label: "Start Studio", className: "api-method put" }, - { type: "doc", id: "stop-data-studio", label: "Stop Studio", className: "api-method put" }, - ], - }, - { - type: "category", - label: "Organizations", - link: {type: 'doc', id: 'info/organizations-info'}, - items: [ - { type: "doc", id: "list-organizations", label: "List organizations", className: "api-method get" }, - { type: "doc", id: "create-organization", label: "Create organization", className: "api-method post" }, - { type: "doc", id: "validate-organization-name", label: "Validate organization name", className: "api-method get" }, - { type: "doc", id: "describe-organization", label: "Describe organization", className: "api-method get" }, - { type: "doc", id: "update-organization", label: "Update organization", className: "api-method put" }, - { type: "doc", id: "delete-organization", label: "Delete organization", className: "api-method delete" }, - { type: "doc", id: "list-organization-collaborators", label: "List organization collaborators", className: "api-method get" }, - { type: "doc", id: "list-organization-members", label: "List organization members", className: "api-method get" }, - { type: "doc", id: "create-organization-member", label: "Add organization member", className: "api-method put" }, - { type: "doc", id: "leave-organization", label: "Leave organization", className: "api-method delete" }, - { type: "doc", id: "delete-organization-member", label: "Delete member", className: "api-method delete" }, - { type: "doc", id: "update-organization-member-role", label: "Update member role", className: "api-method put" }, - { type: "doc", id: "describe-organization-quotas", label: "Describe organization quotas", className: "api-method get" }, - ], - }, - { - type: "category", - label: "Workspaces", - link: {type: 'doc', id: 'info/workspaces-info'}, - items: [ - { type: "doc", id: "list-workspaces", label: "List organization workspaces", className: "api-method get" }, - { type: "doc", id: "create-workspace", label: "Create workspace", className: "api-method post" }, - { type: "doc", id: "validate-workspace-name", label: "Validate workspace name", className: "api-method get" }, - { type: "doc", id: "describe-workspace", label: "Describe workspace", className: "api-method get" }, - { type: "doc", id: "update-workspace", label: "Update workspace", className: "api-method put" }, - { type: "doc", id: "delete-workspace", label: "Delete workspace", className: "api-method delete" }, - { type: "doc", id: "list-workspace-participants", label: "List workspace participants", className: "api-method get" }, - { type: "doc", id: "leave-workspace-participant", label: "Leave workspace", className: "api-method delete" }, - { type: "doc", id: "create-workspace-participant", label: "Create workspace participant", className: "api-method put" }, - { type: "doc", id: "delete-workspace-participant", label: "Delete workspace participant", className: "api-method delete" }, - { type: "doc", id: "update-workspace-participant-role", label: "Update participant role", className: "api-method put" }, - { type: "doc", id: "find-data-studios-workspace-settings", label: "List workspace Studios settings", className: "api-method get" }, - { type: "doc", id: "update-data-studios-workspace-settings", label: "Update workspace Studios settings", className: "api-method put" }, - { type: "doc", id: "list-workspaces-user", label: "List user workspaces and organizations", className: "api-method get" }, - ], - }, - { - type: "category", - label: "Users", - link: {type: 'doc', id: 'info/users-info'}, - items: [ - { type: "doc", id: "user-info", label: "Describe current user", className: "api-method get" }, - { type: "doc", id: "validate-user-name", label: "Check that the user name is valid", className: "api-method get" }, - { type: "doc", id: "describe-user", label: "(Deprecated) Describe a user entity", className: "menu__list-item--deprecated api-method get" }, - { type: "doc", id: "update-user", label: "Update an user entity", className: "api-method post" }, - { type: "doc", id: "delete-user", label: "Delete a user entity", className: "api-method delete" }, - ], - }, - { - type: "category", - label: "Teams", - link: {type: 'doc', id: 'info/teams-info'}, - items: [ - { type: "doc", id: "list-organization-teams", label: "List organization teams", className: "api-method get" }, - { type: "doc", id: "create-organization-team", label: "Create team", className: "api-method post" }, - { type: "doc", id: "validate-team-name", label: "Validate team name", className: "api-method get" }, - { type: "doc", id: "describe-organization-team", label: "Describe team", className: "api-method get" }, - { type: "doc", id: "update-organization-team", label: "Update team", className: "api-method put" }, - { type: "doc", id: "delete-organization-team", label: "Delete team", className: "api-method delete" }, - { type: "doc", id: "list-organization-team-members", label: "List team members", className: "api-method get" }, - { type: "doc", id: "create-organization-team-member", label: "Create team member", className: "api-method post" }, - { type: "doc", id: "delete-organization-team-member", label: "Delete team member", className: "api-method delete" }, - { type: "doc", id: "list-workspaces-by-team", label: "List team workspaces", className: "api-method get" }, - ], - }, - { - type: "category", - label: "Tokens", - link: {type: 'doc', id: 'info/tokens-info'}, - items: [ - { type: "doc", id: "token-list", label: "List tokens", className: "api-method get" }, - { type: "doc", id: "create-token", label: "Create token", className: "api-method post" }, - { type: "doc", id: "delete-all-tokens", label: "Delete all user tokens", className: "api-method delete" }, - { type: "doc", id: "delete-token", label: "Delete token", className: "api-method delete" }, - ], - }, - { - type: "category", - label: "Avatars", - link: {type: 'doc', id: 'info/avatars-info'}, - items: [ - { type: "doc", id: "create-avatar", label: "Create the avatar image", className: "api-method post" }, - { type: "doc", id: "download-avatar", label: "Download the avatar image", className: "api-method get" }, - ], - }, - ], -}; \ No newline at end of file diff --git a/platform-api-docs/docs/start-data-studio.api.mdx b/platform-api-docs/docs/start-data-studio.api.mdx deleted file mode 100644 index aed668252..000000000 --- a/platform-api-docs/docs/start-data-studio.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: start-data-studio -title: "Starts a Studio" -description: "Starts the given Studio session ID." -sidebar_label: "Starts a Studio" -hide_title: true -hide_table_of_contents: true -api: eJytV2Fv8jYQ/iuRP20ShaxvVU18Gm9LNbSuRUC1SRWqTGLArWOntkOLUP777uwEkpDSt6/2BRL7fHd+7p67y45YujKk/0iMzWKuDJl3SMxMpHlquZKkT6aWamsCu2bBim+YDKZOMjDMGJAIRtdd0iEqZZriiVFcnrmmlnpZ2E+ppgmzTKOxHZHwAnKFDjjTIRyNpdSuybEHNYMyS5jmUcBjJi1fcqbhhGavGdcMjFudsQ4x0ZollPR3xG5TZ8pqLlckzzt7629Kv5iURuxg/zVjenvkwD+lYLvtI1tcWrZyW0ulE2r90uUFWJ97V5mx31W8xTN1UwMZKPdMRaA2TGseg9tBpOSSrzIPcQBaXTx8zAKrggW+AOYsxmCAtAX/UDtNU8Ejd6z3bNDE7thftXhmkcUoaYyj5czgbs0oLshMCLoQrASZCnG/dPE8rWiVZviXcMmTLCH9sHMaqW/nJIdb/NSphCVKb3/moMqky9kKMFRriunALUtMazIRJjdcK5kUeDeBoHHMfTjHNUgaijoNbHMXxJgO69oT+n7L5Ao40j8PL37vHKsRfMkgVeWfKtPmyyiAAsstOkEO7L2qpUE+zxv0aF6m5S7wxsQoNi3QNnOqCfUJLgHzUlVFfaGUYFQee9B6L1ekJp6MoC1vFhG3ABak8SE7D8Njvt7/9RW+HQw8kme1mGaLhFsgLRaRSikEKtvMjORSYTk+za2ammMo8qrmtryr2Pq0IHjZtogziSmGXQQw9Us6k9I/GavStPLo7gulTWn3tMi4iP22e7yhXMAG3Pz9DPWebajGim3+fwOtSYFXdIXEGLpiraAJauxDGlPbsl1JVBQ4sxyaTe49mzBq2ilTAng1GV6PZtOnycPd0/3DDHZuRzfD6Xhw9zT8dzyCXViaju9nT5Ph1e3g78FsdH/30VX2Bj8kQBn6kwzxHECKgNRF+K2FBWX3D6SyAbQF9YadyIlfHIvfKXsD1TbuBG9rGCiwlRU9nhunYYm7AXS5/f5gPMLNmBukdbxvgfse/qW+V+VhGedPmfZxQlTAG2LW1SBzDIwyze3WtcrvjGqmBxkW8cc5DgQwF60Vjk1p5qziDNQnvWIi6+32BM57Lv1dtdCbcpbKtADxtbWp6fd6NOXdSKgs7hr2ClHpuvGrMVC5nWAsqMVcDa5QHiEm6E7p7RTh8lev+ry/PVospx9XcpwQksw93JQseH6zDiIMw+Qw+wzfaZIK1jpouIEhLEaA8NDUw1qbfiwDMG+24db2eSBbo0mGzY5Wkdw3rsdwXvabojnwsmYWoS9QRRg/AxzDxyNmCmHMWxq5vK0HsxpCSF0uXPdbqj8OG+AIZoK381v38rIb4lqqjE2on9r8tFvM8TTYz+SNLr5nzw+O/EUaWPZue6mg3DUb5/+uyOHDV0WH9BsNDtIYAF2Dmyi32y2oYQ9a5Dku+zEck7skPOkvqTDshNOfDOmt3r6w7dF3wIaKDCUdF6D1cD9HfMmXXyZFgfm1Cd2P+1bOSXJbdar0+YCmG8jWjMagCr30+1fel7MZajmcPyqL+DnkTwyiiKX2pGy1Vo1dc1oUHzGJivGIpm/YmOHXueq/ZFwFcWs74JNcZa6IEq8SCwOt15VGHal+X9TBgKRxEjP1wiQkTomNxXfEJc//A4hSJGI= -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Starts the given Studio session ID. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/stop-data-studio.api.mdx b/platform-api-docs/docs/stop-data-studio.api.mdx deleted file mode 100644 index 38e6e2fa1..000000000 --- a/platform-api-docs/docs/stop-data-studio.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: stop-data-studio -title: "Stop Studio" -description: "Stops the given Studio session ID." -sidebar_label: "Stop Studio" -hide_title: true -hide_table_of_contents: true -api: eJytVV1v6kYQ/SvWPvVKBNI2ygNP5SZEQr1NEBC1UhRFiz3AJmZ3sztOLrL83zuztrEdoLmt+oTZmZ1z5utsLlCuvRg+CI9ZoowXjz2RgI+dsqiMFkMxR2N9hBuI1uoNdDQPjpEH78khmlz3RU8YC07yhUlSXbmWKEtXMlvp5BYQHEPlQtMfcqtC0JWeUAxlJW7EIX4HT2dbcCqOVAIa1UqBoxsOXjPlgLDRZdATPt7AVophLnBnAxQ6pdeiKHp79HfjXryVMTT4rxm43QGBP2vH49gHWEojrINpZdxWYnl0eUHoj0zVW6MpG77xy/k5/3Tx7n6nq7GhKBrZKq1NVRyqO3j27JK3QJvUH8SzWc6z5VYhAufUrq9HiZmf6JXhDldMzfIZYuT+OG4gqpJVJ0yT19KYFKQWRTvyYYk7WI35BFbpeximJ4CqXQ6mJO9w5DKtyy9PE2ZbnyFfcM648LXMVJqU5vB5I1VKBsr8+xnHPXuTjsfA//8AqDDlPJr5n5cpUmEI0Ms1HC1aKj3e20TiEXNrktjhDBVNcFEym4GsZuJUAa9m4+vJYv40u799urtfkOXb5GY8n45un8Z/TSdkpaP59G7xNBtffRv9MVpM7m5PpbIHpFU6mWto/SkHjlCuALmw08X5r0eWoBaUSBuMZJqad0j6IrhfHLrfGrwxmU560fuGNIrVqtIN5UOEFVsj4xr7aDphY6K8XFLvyMOF870u9P/rGtZt/nTRTs9Dq3ZjHrpOycICxplTuAty+hWkAzfKSDyHD48sMqS1G8NKbLOAyro6FINK4wf5fn+LAc9Q0Ar3Vstz5lLy3iBaPxwMpFX9ODVZ0vfwSk3pB0X/oNHBEk1TiTyp0RX7c4UFs6nJzrlaZeZtyvvkGbEW1CA4wYlXLHzc1Dvw/I6hQqpWmKpSFQuG/Ywgp6ti8JUzt1nGoc3d5NspU6dVGsR8ZX5rDESEK1fi/Ny/vOyf85k1HrcyTEn14PDoR/snscMvbwbtx97bqmII33FgU6mCKgfqedXt5kXviWH3JaCGU1c2RJDd8nwpPdy7tCj4uHwDeQzqzRDDlUw9/APlT17Io2RfYHfwCL/JNGPPMDUk0Yrx/yWXn2bVJn75WLkf51YdSr1rk6o5N8UsHsl5AzKhUMyytI/iGCy2bh4oR2dFp0GSZXcVPox+iH6UFXUveCzMC2jqYE0S+T8TLIq/AeQJaS8= -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Stops the given Studio session ID. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/token-list.api.mdx b/platform-api-docs/docs/token-list.api.mdx deleted file mode 100644 index 72166a429..000000000 --- a/platform-api-docs/docs/token-list.api.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: token-list -title: "List tokens" -description: "Retrieves the list of all available API access tokens." -sidebar_label: "List tokens" -hide_title: true -hide_table_of_contents: true -api: eJydVE1PG0EM/SurOadJaCkHTgVEK1SkIj5OKAdn10kGZmcWjzcQrfLfa89uwiYginrKxn62n+3naQzDPJrje8PhEX00k4EpMOZkK7bBm2NzjUwWlxgzXmDmbOQszDJwLoMlWAdTh9nJ1UUGeY5RQCnN0AxMqJBAk1wUkuZW7ZcSLR7CWAUfUeo25ut4rD+7Rf/8FlgePKNn9UJVOZunbKOHqJDGxHyBJegXryqUoDB9wFzzV6S12bYFusZecUAEK4FZxjLZCZ9qS1joGDyUqEP4OOcUos1Pal700kaZk58bnV9FKGQ1IVONaylV9IBW2pojCXIWqARuTUeHYvC1SxPdBiY6ElrCyyX6uRb8Ph6Y0vrN34PBHgGJchD5LmLxHrttzUIYfmEr+SVC/5wRtqQ/FyRRbFm5mpO0+7RisfccuvCeM153m1eUwA7f2/0pFJluBJNWPi2C/hJLKQjzT+xxA3zTcr+Jc6JAb5h/e0e1G8VnPrCeSHgWPgqPmNdkeSXkGnOKQEiteu4nayFZIi+CXskcE0dQlxl1ytVwWiLFFF2TE9+CuYrHoxFUdpi7UBfDiE9SfWiD2b/gm+TJrhyw7jE7U7zerNHaG2o3Osl2Kn2C28FoRaWSYPJ/mkBiaT9+bhTy8MypZetnIYV3U+xYaNl/EdR2rYimA6sEIE8S2G2+37KowLp0SbPw49UhRHRybZ2D4dHRcKy2KkQuISmovbCk1Gw78B1+zasI//817KbI+MKjyoH1SiO103T77j/BC+GnlqaRlwbvyK3XapajINWQfC6BbPtSiIQkAKGQbahAHnHVnWSlYlqCq9Ort389O8L7dX4rWNhd+d6KU/bNG+pXvdxCMyHSkQvVQUeC2xdhIifzF0G4MgI= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the list of all available API access tokens. - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-action.api.mdx b/platform-api-docs/docs/update-action.api.mdx deleted file mode 100644 index f2cc43d03..000000000 --- a/platform-api-docs/docs/update-action.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-action -title: "Update action" -description: "Updates the details of the action identified by the given `actionId`. The `source` of an existing action cannot be changed." -sidebar_label: "Update action" -hide_title: true -hide_table_of_contents: true -api: eJzFWOtv2zYQ/1cI7UsG2LKbdd2WT0vTbsiWtkEeGLYgQGjpZLORSJWk7HqG//fdkXrQlhO7Q7F9aWPyeC/d/e6xiiyfmujkLuKJFUqa6H4QpWASLUr6HZ1Et2XKLRhmZ8BSsFzkhqnM/fRvmEhBWpEJSNlk6S6mYg6SPfj78/QhZjd4+mBUpRN4oOdcMvgsjBVy2rBJuJTKsgmwZMblFNI4GkSqBM09l1aXU0ePlyXXvAALmixYRRJ/IFEjFQkEGVByO4u2rfI8mLGaNGgt0Eio4VMlNKA8qysYRCaZQcGjk1VklyUJ8I+i9XrQylwo/WhKnkAn9lMFetmT+0dDyGRVgBbJpuyeLCEtTN1VpnTBrT969RKl33tVwdjXKl3Sm50mVs5nrCZFRolCntLSA16WuUicf0cfDb1a9VVQk4+Q0MNS09ewAgzdest7ThlEOa9kMtvPQKT959vuunC8GKqciWnlIyHwWEzyElWUlYW3cn5+AMczT81AzoVWskBWAUO2mIEGF8OlKCEXEthC5DnTlYzZG8h4lVvMBcXaL85KLQqulyzZxTljqhDWUjCjqsjl/U639bSsjFUFSWXkZ4Yf3ylFUrNcLTB5IKmI2PFtdN3P+LKxSkOpjLAKFb+9umBHEE/jAXuYWVuak9FoKuysmsRo00jCZ0syh0KNZpDn6uFbJ5R0eSP0fpkU8yzFlEqcOMrH2s+tORTmuoBUUKhmIke84XiPTsBE3HT8LjcvNiVsex3mwggf3c9r+quwrKEesInmGHwDRr7nU5JdGXAcDRhTY9I+lu9r77H6TRhs9FU1mKogDMoQWRFB8ZObOqwp5i+1cu4IBHGtOQGLsFCYnRm4hQNET5jbqrKZTqUX4QLNeZhQYel0QHv1NSQa7FdRgNihHxw/ElTwRywiczScT1ABPAkTrw0yl2ZfUY0udb9MF++2G/TiF3z2TV9zlIU37EjNQWsMBVMT+KD3iWXVAvSZOz4goXNuqTQMTQkJhlWyJVE5Qh9Srl6awwxogaIrspil7LfrD+8pIf48fXfBfEnyrDVcVfLaMdjP/DRNGWf+BP3MbY1n4GSQ42U29HWkoUKUpTxUSDBXj5QwrYsxgBNMLjAxuwZgd5eIHFymDAHODglCPQtzf9SgW6oSExv4hL1FjKhWNj5MclWlIy94xNM55j+k36BtQ+Q3bPgNa37+a9Hp1zGdZ+hlxrHa9E1jMz4Hh305EK79H5YWXBxuZo62SAxB1JreNRZTmBPQtJh+wh7oPpbZgxOC4KiXhxXJP9piSG/QCVhFfLnE6oKNj9mIkjfXF8cevF2Dc5gIomq63bYh8AzCeuBAPGQ3USoHLnv83kqHLp6eOOBflmu7o7CzTGMHQIJzbiwzVUKRkFV5ExR1DFx5XrxjgR/uCwMg4WjS0Gv1jf9vyIcNQ4qEOtarPL+gacAeYOslEtf60wuGiOcK4LY7Wzu7lsR/J1tNMLEO8arPIMorfOO6JtcwgZ8vjrosQrSvtGRpVRRL9xXyJrgJJwvxdztr7IuMDwH90/1pnaZd0+VHIBZKO/RbNQ4bho9HVEjmAhZ9K264nm5WzKdb4oIPDRDSI7awHOcy+kohM+yAHLf/3CIsx5Cfp4cU/qdnpSdbAcednb/xfQ82aFNJfwHmQxeg1PsTjxnw9Dc1OSur/VK/O+5jSVVMEN9R6tnlrSGcV4nzd9Pct1BFgthHNQmlvoMCE+Pd5N9I9m8biQ5bnhJJ9beAKZ8sMXvibpzDdgRHfwkHtPstKcO5aAo1TvZFesb1EEcz6pkG8scuCa2BRDfEYIGe2Bs8RCwtSo/+Hnh2TI8L7MESLymmGT6ywuYQlBM/c17V83JIEa4fuvv19srAF4QSuy7ftx+PX/an8w+/syF7T+OMn8bx0cvxuE/3Gr/Lv5jdO43uIvSLwQ9Bq53nJ/KGcNeqo3XCW62VvqrtI/Od5t/tsLBZ3TBa61DwLVCftRufkkoLu3Rbm9eAk54+rewMf97TVgO7zZmidQ/OeW7LQ1fRqN5QjVbNgmdNCxPEimb/U+kc6Rro4aWIHcx0+NOLmWt3w5oemp0RPTu9PI9Ij0bNa/Kq91CobOskktjsblyZckR44v/4pYndjwsfTvS1rrrNzdvPnLq6bqfShX23SqFlSXe+ufLoztv9QnfUrQa6s3ZyD162M3J3Fky5oejNsfSuubrfGhfDi/4UF96Gc1UnaGMKCuwJZpjgdGP8CM43m/PuIuxlu9Og+QzcEPSLocN8y+d3hGFjVG8Nm+7F/9xuLzpGO0t2GAJN/bsb32/VoPGO6jDegdgBUocwi8B0/HI4/mF4/NPNi+9Pvn9xcvxjPP7hxV8uSoXMlAvyOu/rXKHk2JdGlJQCO66amEALc5aYbaZomJjoYpG7Cpapn7sLVKTuG/HuRfzqVTxuhq6CyyBnPDbXu+RtDVcdcP7P++waMmgJQN2QkG7NQl5Z1UDXreIH0Um7y6ZPryi67qLVasIN3Op8vaZjv2cm/EuFoekCv2zGcwPP+GDPFnqnko+w7C265zyviNLB5ZxrQfK/UJejq7pUfcueWcrvVKnpB+Uy1KVRtfXd+r5uoygXUDd/feY1GN4Qk+55r6zSlt+/OMUJrLTP0obV6/L2hmpAvZsvVEpPNF8QeOC/TtN6O+MqNp2tMHnltHJFOPIsKRf5ZsHZKjDOqJ2+wFBxFDfqEeR63brG0m/yy3r9DwaBL8c= -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the details of the action identified by the given `actionId`. The `source` of an existing action cannot be changed. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-compute-env-primary.api.mdx b/platform-api-docs/docs/update-compute-env-primary.api.mdx deleted file mode 100644 index 9f14a1301..000000000 --- a/platform-api-docs/docs/update-compute-env-primary.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-compute-env-primary -title: "Define primary compute environment" -description: "Selects the compute environment identified by the given `computeEnvId` as the primary compute environment in the given workspace context." -sidebar_label: "Define primary compute environment" -hide_title: true -hide_table_of_contents: true -api: eJzNVU1v2zAM/SuGThuQJtkW9JDT2qwDigFrkLbYoQhQxmYStbakSnLSwPB/HynbifOBdr3t4sTyE/n49EgVwsPCieGDiHVmco9nqFZOTDsiQRdbabzUSgzFLaYYexf5JUY1MiKktFplqHwkE3rKucQkmm0CaiFXqKLHGnylVtfJYwRVBGNlBnZzOpJqbV9r++wMxJxUeXz1XdER2qAF5nWdELN7k4DH0TbNuIpNOAMWMvRoub5CKHohfJsQgSRXZ8AvxWHJoxPkIDVLUHmGVsa7mi2zsviSS4tEydscO8LFS8xADAvhN4YTO2+lWoiy7Gy5bMvbUXnJMZDf5/Jnq8Pp5EfJJKm1QEuf5tpm4Kul8wGln1Zc0flLnWx4T9BWef4LxqQyDur2nhznLo6D69kTmYFie+lTXrjKjN9wtEkVmLJQmZTGGa0cOt77tT/gn/26bn5FZ9FvHTUMaNOg3z/GXUIS1aQp7T/z3Z3Jg8jQOVggW/uwDGPZUl5WRBvgqZPbVWyttpO6vrrcQf/biQobs0ZKs39SvSY+DHcY51b6TTDnJYJFe5GTD4cPUz4jcu5Ss8GNDkUHjw5Fr92nvaLt5rJntt53aFeN8XOb0sal98YNez0wshunOk+6Dl+IW1fqI7vdhi/ROAXP9olGjI8uxteCmTXEb1nnSrM2/a1snLHxJr/PAohWqj8/G2M+rX0QhM9vsnPm1StkhsUuSu6NuQ6ha/1rhkzpPfIshYzR1WA2D8TBPPvCtOUg/8g09Mxcf999ICKsapXnS/f8vNvnNT6hDIL36sb+gXOp3pxzh7RbXfhfDdv6LPm1Z1KgGUUFB+GK2pIHV0dHDA9GbONKss6SvUw7imIGDu9tWpa8XA099moiHcxS7tg5pA7fEOm9kXiS+DNujsbuCtKckcHbK7CSCXyQzKdJPWk+Rx+8Nk7SrBdBbdr8Gvp78pZTwi8REuos5lxBRhWzszsOtAtxNC35Lqp2XMQxGv8mtj2Uxje3d9zJ9Q2S6YT3WFjzTUjPQFcHpcKACGuFSEEt8jBcRRWT+x72x8bBmAhVnRSETBQQd/oZFRmp0cfzOwtTln8BY70bPQ== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Selects the compute environment identified by the given `computeEnvId` as the primary compute environment in the given workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-compute-env.api.mdx b/platform-api-docs/docs/update-compute-env.api.mdx deleted file mode 100644 index db07fcd86..000000000 --- a/platform-api-docs/docs/update-compute-env.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-compute-env -title: "Update compute environment" -description: "Updates the details of the compute environment identified by the given `computeEnvId`." -sidebar_label: "Update compute environment" -hide_title: true -hide_table_of_contents: true -api: eJzNVlFr4zgQ/itCT3eQOr3bUrg8XZvrQTl2t3Rb9qEUqtjjWK0tqZKcbDD+7zsj27ET+1r2YOFeQix9Y33zzcwnV9yLteOLBx7rwpQeTkBtHH+c8QRcbKXxUiu+4PcmER4c8xmwBLyQuWM6DY9tIMNAabUqQHkmE/yVqYSErXYBtZYbUOypBV+pzXXyFPEZ1wasoEOuk/0xyz0IAUZYUYAHSywrrvABgcP3IEgSRyN8xo+JLyfYidxkQpUFWBn3VC3RsfBaSgvIxdsSZtzFGRSCLyrud4YOdt5KteZ1Pdtz2Wr74oyIoafyWoLdjbh87YBs+vDRYVJ5WIPFrVTbQvhm6fwMj39suILzlzrZUcz7eZdBXdbG4VtjjQcoT9HCmFzGoRLzZ0evqMZ89OoZYgo0lurmJTjabXQ4lug4+0+wZYRkmMu/NU7EPpbOsxWwUklkybbSZ1KxvcQRr5E2Foh0E7mjrnnv4KapEjYIGwrPltgMaww8ABRix0SaYrrMlkrRNpFIc711EZWfe+lzmOjZ21bemkCH/RQWnNHKNcL9fno2rtznf9gJ+6RZVxwMOjs9HeMuRfJfStkzeuAFOCfWQOP+doU74NQc7IW4slbb2zY/Sj8w/zCRYTfzTGmaRtQU+QT0H2P0X2WTDjZKDtQk/9dscdNBXFrpd8GqLkFYsBclutLi4ZEmFn0s0+Rz2CrB2miLz4fWO6+G1laTK4DddO5X2hwDMu+NW8znwsgoznWZRA5eUdJI6lHzfwk77CYXnjyELQnPLm6uORHq+H4hwZrkh6z3+dOJnUHR8yqAcKX583fnTs9bH0SiQtz29nT1TRQmh94r+lE9muW90mSkqQ4UWsHbTIj6e0mSZDLG66oBU7eIOHTLoYBD2bBhZB4MNtV/9htIhNRvzvktOj+PTmnNaOcLoQYZNTYwZWrHdKu+fX/evdoWzsM3Pze5wFsJWYfsq7bvjq78GV8cXKrYHRkmSbiqWgkH9zava1puLjdqx0Q6scppulKsH7yR53tX3yTdF9iNrteNyEtChvbdCCuJwA+S+eW2dYVf2Q9+HkzSbBeF2g35dfQPRK0fEZ+BSHB4iHMDWTbMTu7oRf0rRs5G3xxNxEUcg/FvYod2c3N/R7PafigUOqEQK7b0wYO/ga0OQgULCGsVz/FaLIMP8uaVNNni0BiOjCAkNakH9lBA3OkXUHW9l8fTM+lS198BCrexyA== -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the details of the compute environment identified by the given `computeEnvId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-credentials.api.mdx b/platform-api-docs/docs/update-credentials.api.mdx deleted file mode 100644 index 3ffb07908..000000000 --- a/platform-api-docs/docs/update-credentials.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-credentials -title: "Update credentials" -description: "Updates the details of the credentials identified by the given `credentialsId`." -sidebar_label: "Update credentials" -hide_title: true -hide_table_of_contents: true -api: eJztWt1P4zgQ/1ciP91J5WMXhFZ9Ouhxu4gVu6KL7mGFbt3ETQ1JHGyH0q3yv9+MnTRxklI46InCvkBij8fz7XH6mxNNQ0X634kvWcASzWmkyGWPBEz5kqeai4T0yUUaUM2UpyfMC5imPFKeGJvX2jqPm6cxZ4E3mpnZkN+yxPtRIzoJfmyTHhEpkxS5nwQL/oOaCD2SUkljpplE8eYkgRegdDgBFUfxUqonpClzjZuntORJWMkngVqym4wDDelrmbEeUf6ExZT050TPUtzKLiJ53lvsPhXyWqXUZ9XeNxmTs9bmf5eEXpLFTHLf3bu1F080C83UWMiYajt0sA+7X1pRmdJHIpjhmuV6ZsaOXkEP3HwBjBONq2iaRtw3Nt+5Urh03pZDjK6YjwtTiR7SnCmcrQcHvFam+24tY+hvQUWJsXM/Lx7g35jefWZJCH7rv3/fa5q8VxjcoXu3u9tB6Bij5buaYA1mB01ePcLAV6gSnWL80Z+ZZOX/f0B7SeEtFCKMcDjkepKN7ENE8WHE9SjzrxmqrBQG5PUHVfiA8oTJLclwGz3doiE6BacC5os45toyYrTcULJU4GLFbiBRgCbN9EKaLT8SGUag2iOXoOOIKnYho6Zd0V6QGpBCGCekw3gQDiwUctZa2WnoCLIxqBl5JETEaGJyiQZfkmhmcwmII6r0hXKoF2ZeRDjG6pbmJn5aHIqCQPVTmBgxTE48gck1m6nVKRJwjMOYJ1QL2bVZgy+q2FxScJyd2WrjzvfAQ2mKvDBx955fIggu32dKnbJZZyYpBmVAd872yFRC9DrMsCgP9Sxih4brcUJHUWf4oCk0JBGODfeGzM+A1+wUrZ4v8mwN2mYKEqMoM+2yQZWCat8ZNk1da/J/5PpTNmrqUMvoDdHjECU+R4k7dSnKYYcyNIq+jM2B/dxqjqj2J2fL9FTABqrq0nmz+sGxW3B7IH3Tbg2TzZ+sOhzhNNEnHU7EGh5xtmJyaDL3Qapgu+Eoc4yeLp3vHmVriuWlPnxMLCPvkMN0Vy2rOWxQanRekJeqLk7pNWgJZkyAU9H9dmiKfeafvIMZxuaEypV19DC0bndSF9uRdWiDi8fYWi5xm+S3MPfg5NPimnX0cvfm3emHVqHCFmwN2j5WGwzadCKhQ3ukSsPhp9ZZaJvPNWgFDVDH1ef+o84I0xSxaoLXIOWDI2M9h+IR10dGt44ehT3gFvUyjvaPKGwrWZxrxv96rj9r0wkmgfv2ORTEQ9l1H6yXyGmzZDz1oHYOz6Gx6MBatGnu2r1vQ6JmABIPjMQdwY/339eX7pAon2m7l5+u5RB9OVlQfPhYg46b2sHjtEjYG6h/L7Wt2Iwa2Xn5fxtl8dVpuazX25hIbPV4r+oq9FZusb8O4Q3LvKUfTl/xt7LX8oFsMyJs6U3s18f4N/Ux/tc3mrV+o3nhRnyWX1cdUzg33lq5qUE/6uMtyM55ATox12UXXGMGVCoSZW33fnffmNDBsXw59ba8M+GVkBVYtL+726Y7osF/AbjUMSsxWAwqymqsSkl4b5AeSyngSLT6ofpG8r0ODUvMk5cI7UG2iinIk1vnG+ub5D1icH7JwwyRGN8v0Ukx0xOBOCmIU2J9Dy87NVTOztwBRuUEecrbEjyVITiETLROVX9nh6Z82yBItu1n320uSBPAZFPD+xpRjSgJb4D03uHXExM1pbxDNK81VV3qhbVwR1LAnUxQGiIYsQ9/lfiLq6k2dkC3nVdgp+M7Gqf2B48GAglBRFV6FOisxburymK4ggIVEJ8FbqaiqRAx1VgJAKklcDVZy9tqsFHiqqjJETU2FsZEThEypl3lBHQpBxkKYvNrrG9i33Vw3a0Q/hzncNs/qgkQBKPD7vNu++Bge9f0JELpmJrUKYxq87wO82uKOa+ScA1AwSKSNLvTO2kE7SeKmVmwk00EF7vYI30XIwjhOgGtkG4+Lzye5zhsoXuYH1DMi/o5hkXsHgVXAPs6pb02weFiB29plCGlSadbKjnu/0hZfjsvatrv3iqwY6dcxSBNZnWBSnldK+aIM5vAkYbpA1JamoGVZesbcqp4tCoxHqd2BR5Xqb6Xtl7wvl58wzwtgI8xtL4wKOkUz1f4a8QVxjQWmIhjcxLRJMxM3SaWJeYddUtToxTV2ybXIBA0huIbXujzfGEfe8EHu+T5v3f/O3A= -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the details of the credentials identified by the given `credentialsId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-custom-data-link.api.mdx b/platform-api-docs/docs/update-custom-data-link.api.mdx deleted file mode 100644 index a568d1327..000000000 --- a/platform-api-docs/docs/update-custom-data-link.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-custom-data-link -title: "Update data-link" -description: "Updates the data-link associated with the given `dataLinkId`. Allows modification of name, description, and associated credentials." -sidebar_label: "Update data-link" -hide_title: true -hide_table_of_contents: true -api: eJzNWNtuGzcQ/RVinxpAWttNkAc91bGTQkBqG3acPgRGRe9SEmPucsOLFVUQ0I/oF/ZLOjPcC7UrX1IEaF5sLTnLuZ05nNlN4vjCJpNPSc4dHytZ3tnkZpTkwmZGVk7qMpkk1xXsCsvcUrBWjnFrdSZhI2cr6Za0u5D3omQzFHoPMtN8lrJjpfTKskLnci4zjmcyPWclL8SIRYpGjJd5fGpmRC5KJ7myaTJKdCUMvT3NW5tOvHW6OK3VgVDFDZzrhEGnNgkqAeHOHhCR6FLF3TLp+3na+madkeWCSdI/l8KgAUZ88RJsSibOeDFKbLYUBU8mm8StK1QT3kq221GreaXNna14JjrVX7ww64Hu3xtBVvpCGJnFytk5iXGFZgzUytKJhTCwNdem4C4svX4FhtwEq4V1b3S+xnce8thTPFktjXoyDeeWDl/iVaXq1B18tvjmZmiGvv0sMoc5MJgqJ4XF3RCIfoz67p+JFSGCgQu7OEvZb5BkdiuYLyUYR2CTJQm10WXwlrfCMDL6K9i/7Wl4yoCApzwG5F5b+FdZ+IIpUS7ccsKODg8PWbYE1GUIOtIb4Rah+lzN0WtsekrKeZYJaxGJu2YgxBInnRJ1DhHc4ZzLkECQ2PYRSwu20qUNmfn58HCIiCtPOtk/f/3N+ujIvx8q5DMC81g5sl9FiXQAcbvlFv5CukDDPYiYEcNzR4DlRUsr4Lj2BoCChU9ZeiYuEZPAVrvU95NIF+mI3frsTjjC7YtvR9xphLS+hpSdeaUIAx0xM+6dHufSZvpeQFbZ3OgiqoEdvgzJJp8vxfxpay7jAA2RP2KyzJTPGyxeX04Z5Vo0wZjZl5ODg2I9DlGZwcrC9lf4n7ACqNa+dClCiUtI4yxELxj4MEXhfspOvDHgpVoz66tKG2fZrFaArNX3UgCd4v0WRPBu+zrGtfE9N5g4u7vZL6oPeNyW0EvYGtp3orTPW+zt44yr1k6+shQXrRdKhHh40/34A/wyvH0cZ3g0PlrxBcCe6aLyDsUR0RDvRx0GXfAUVMEPOrH5HxQ1T0EP3iyxGnx+uS8kF00oCGKLZ2E9BClIP1hOM2/Hgls3PkKfhUfCGK+AzI4AIMC8a7wEyqYurAbsNWEfEG9kEjeG430rnShovWPFT8hDNRVEOb4ZfQf2OonofE878Z8YqF/hj6Ay0p7tIPR/xsyeiyuydUCiyTFmD/2Pr0e35I5lvKwvSHiWNq64t0Xl1oSSyt/CHRWRaIgbrR6H2/VWxVm41VoJXg77s6WADPRqm4HacBbQEW+PoxZFezfI11Lm8PwMbR8lHCSVBC+s485bNld8kbLpnM3wKocC2TEiHBwuhFzMuVeOKQlt070Uq6A7nLMPb0bw/LxU66av5Uqdz6l9fkqywc3H4/fTU9ifnoVfexCQXgX928F0ETb2XIEnkGCo+BmdOcMWb1YrgKniCi5ep7sVtlpCAPZPD4wbOFgomAtyigXQvuWLZxTfW2NAbS1OgJLlPVcyjxHV3dWDrb14P3Ua2zPYebWvA3vD86aJ+4Z2Kya1xr0neezBOMRmUwwu68axNfzl0PDzZkBjpXaM49gH9pD0q6H0mXbvoA3IqdPcaeTjzOFJcxQbseOLKYPmh0OB5e012744YnGv1L33o8YQK1Jk3kCJU6m9EQBSc+xhLJ18usEqgTF2qXHUBWalyRa3koMOXQebbq7dEhWb+2bw9UaB8NK5CnswXsmUCDsNdJ1KPYD6Fe2wC8UdjpEsXNkQdCrZxtYr6vnI8dji1nfU2MyoRHAkBCvhx7tmQP28chQgTMJlN6G+/cqLKvBxPUA/UJjtcm/YaoOPw/Zck2V1DmoH0aOnfMdISmDzWpga1YwAtBvXOJqAIalo9J7rX7oNMASTEvQcpa9fp4d0A2nrCl5GjobxrYNw38hNh+Mf5INMnXKctw8qBZ08OkYB2tRo3fmsNEom0XcYwNQSYoAymw2OcNdGbbe4HL6PIIibak8mc1ApHgnI87+e7DX6TqwH32qAyz1KEvxhWJCcGoVvMuuny5pRXrDHhtmHzGoa2HId29OYGwVze4PNBVzO2AqChUHgJNgxphmmO2DAgfi5KryBHVHlHpWNieni+gNWdv1lCfCErxi+wk4B/pKtmsIS+m5c2ySKlwtPjJmEI5EH+C6N9GgjbkZ2owHYIYkP+k6U220bHIfPGJft9l/dBEcT -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the data-link associated with the given `dataLinkId`. Allows modification of name, description, and associated credentials. - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-data-studio-checkpoint.api.mdx b/platform-api-docs/docs/update-data-studio-checkpoint.api.mdx deleted file mode 100644 index 4ab8137ed..000000000 --- a/platform-api-docs/docs/update-data-studio-checkpoint.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-data-studio-checkpoint -title: "Update Studio checkpoint name" -description: "Updates the name of the given Studio checkpoint ID." -sidebar_label: "Update Studio checkpoint name" -hide_title: true -hide_table_of_contents: true -api: eJzNV0tv4zYQ/isCT1vAsdM2CLA+NXF2gaBAGuSBPQQ5MNLYYiKTCjmy4xr67ztD6mVbdZygh73YEjmPb74ZDkdrgXLmxPhBOCwSZZx4HIgEXGxVjspoMRb3eSIRXIQpRFrOITJT/zxTC9DRrVeL4hTil9wojdHlxVAMhMnBSrZwmTQ2LiTKID9pxEk0l5bMIljGsRbsg1QcOBfUB0IxjlxiKrbBVe4r4UgXc7AqjlQCGtVUgSUNC6+FskA40BYwEI7AzqUYrwWucu8KrdIzUZaDxnsbzzsArnY81vy0JoaHgCA5mHm8U2PnEsPS6ckGrKWxLy6XMbSoXguwqx1YP2rBfko+4v0xgAeH5yZZsU5sSJpSR48yzzMV+0SPnh27Xu8aN0/PEPtMWy4LVOB4N8TUkwWBCjNe6iuYUEo3ARFJl9vc+gWXG+2Cmz+Oj/lvk59//iY4B8fROngQssDUMFEMY2KBfpPq7VYu/LPiHx/doC4ahxILf7j2c0KqhyRl8F/kbcLa2e9YYrkjVGSl7KI/WKXiYZudBaWMERNzKqu5KBzYKwb8/8XfmOzjIDjv26nw7a26ezJ9qaeG5X36+gxVCe2hC+jEMRUwz3HlTym1NjXnKJSWmfo31Ihe0HPCjLwdscrRQlpOqvuQbo15+5TcBnjvHaYLNHyESOqk75Scy6Q+aJ88LRSPk7MDEl8L7s3MN2uNvakOdwP8z57jXd8+kTYYySwzS0iGwouf7IpfGfxuCp0MomVKdxp373AdRsZu9fJIOW9zyvK83WicXV/yZqKcfMogIYmg2/TsX5nDr7ukTIyeEkLskNKhwU8CcSXioqXCNJI6gjflkFx2RWsiHKuEChz+qlzwyYa4sIqOHw8j5yAt2LOCu8DDI9+FNKmkhmeavMC6v4/FqBqfRutmbilHLQe03p0oSr4RwC7qkaew1K1Eipi78WgkczWMM1MkQwevVMdDZXbnHr8TXWcSuTdGE5bnEhSMsQ7hljkMfHQDaShhj/U0wO9PXohWwsP3uus+L9Hzxrm5aWeBb29ynmfQ3uWd/qi4gbKnukEFwIzwvViYGRXTxBmEuU5k7Otkk6cuO1XH927/ajcICJMc/Pw+PD0dHvuubhzOpe4AD1NFzzRbXeMbiDsT0Cen44p/hDcc5ZmkQY6vNOvvrFBR7UA+EOPuLNwpKt7aGFQp9SmFxtrr9ZN0cG+zsuTlMCVyrdX9SYynMnOwJ7R3ZsjeGF5gtTOm0mVVsKQvTbrlFPv/IJYvN1UT+C06ZOTvxVYtSr3qgqoxtxzzvP0pZId+C3wC3Uaay0eST0EmFCvTGEQmAdLRHRtqTez0Vg4vaJzFMeS4V7bb8K7v77g1VB8Bc5OwipVL/rqhX4/WeIZ8x/Fra5FJPSt8JxbBZFkNj50+tNV3fFC9fFBVe4k78wK6LBt6kN+Zl7L8Cbu5IeQ= -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the name of the given Studio checkpoint ID. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-data-studios-workspace-settings.api.mdx b/platform-api-docs/docs/update-data-studios-workspace-settings.api.mdx deleted file mode 100644 index 2ea2c1a23..000000000 --- a/platform-api-docs/docs/update-data-studios-workspace-settings.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-data-studios-workspace-settings -title: "Update workspace Studios settings" -description: "Updates the Studios settings of the workspace identified by the given `workspaceId`." -sidebar_label: "Update workspace Studios settings" -hide_title: true -hide_table_of_contents: true -api: eJzNVt9P2zAQ/lcsP21SaboNIa1PK4NpaBKgFtgDQpqbXFuDExvbgXVR/vfdOT9LO5DQJu0lSs7nu+++u3x2wb1YOj6+5o/a3jkjYnD8ZsATcLGVxkud8TG/NInw4JhfAZv5PJHaMQfey2zpmF4Ee7ufyQQyLxcSEjZfh7WlfICM/WhdTpIfQz7g2oAVlOIkaZMcCS/qFN8b91mdCrcYYUUKHixhLniGH7hV2yWGGHBJYI3wK/60gjO7FJn8FbKxLE/ByrgDatHfwn0uLSASb3MYcBevIBV8XHC/NpREZh6WwXWhbSp8ZTrY52U5aJH0SnwWT1vb3wdzU20H5w91sqY9f0qdB8ZZ7Y2xYo1hM097hDFKxoGv6NbRxmIbhZ7fQkwbjaVeeonDM264aL2ct9g9XiLWXKnTPy1uoNyx/iCdnEsl/Xp7ecABeaQxPp+eXE0ujtEy+zqZHh/RMHvpFTlfdRGwZ625GryWlmlNR0k+m40IBmd05qpC349G2/y+PMcM97Em0OtpLwPC96P9bQxn39geO9WsiYx++7uwHorkNe3vWLnmKTgnlhB4fnYqGsft3vZ6cWytttOGmqrC/dGHHRU22sEy7ZlQSj8inuD9cdv7KK/KAQYKUqrxP60WFx3EuQ1TjgJ3CMKCneQoIePrG/q3Uf1WmvTS5CErqcuYRyiBLiqCEJZRp+VR0VOkMmpEO3LVaHJKZx8aOc2twlgr740bR5EwchgrnSdDB/fI9lDqLR2bhRV2roQnIWKfyZ9Nzk84YW1KmRGXFS/9glpqKCOvVY6+58EJLdXLl0bibh994I96NO007vinSI2CTno6WegUp7NtVtCa+/rSykhJIr7QAWvdtLpkqvElNohbiV2onWniRBwmbpPpPr84dFIFOV/oT90CCSC2qcrzbnhwMByRzWjnU5H1Sq/kp3ccPz2wn6Iuuj/hXx30dZs9/PSRUQKPRYQeKCjqAb6mM5ygjZuzvHcfQevmudorpRlknLYVckGRimIuHFxaVZZkxjGx9DPh64OwUsypizjsiXT0jr/SQigHz7DyZlorwFv28j1iZ621UWRrGjShcvrC1ztYt9cXukW8CtMLd4lXAOqzXd6g+wpEgsGItsrjcwVk74LidBG2hJSKqnZM4hiMf9a3r27nlxf0/9c3mFQntMWKR7oc4TOA1YGXICvBVnAlsmUeZJdXIUktxKbYPBGXUNROOnCOgseFvoMMZ6lhx9M38VKWvwHGBulZ -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the Studios settings of the workspace identified by the given `workspaceId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-dataset-v-2.api.mdx b/platform-api-docs/docs/update-dataset-v-2.api.mdx deleted file mode 100644 index b910b2e99..000000000 --- a/platform-api-docs/docs/update-dataset-v-2.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-dataset-v-2 -title: "Update dataset" -description: "Updates the name and description of the dataset identified by the given `datasetId`." -sidebar_label: "Update dataset" -hide_title: true -hide_table_of_contents: true -api: eJzNVdFO2zAU/RXLT5tU2o4hpOVpwJiEJm2owPaAKuEmt63BsY3ttFRR/n2+dtKUpCriYdJeELWPc8859rm3pI4tLE3uacYcs+AsnQ5oBjY1XDuuJE3onfZ7YIlbApEsB8JkRnYgRM3DXv0FwjOQjs85ZGS2CTsLvgJJHmrAVfYwpAOqNBiG56+ybZFvEfH72O9rZnwxBwbplRQre9xamSerWQr+1IBy5PdcgNnQLus/DZDIIgfD05aXwfI2XULOaFJSt9H4ZS4dLMD4rbkyOXNx6fSEVtVgW34roSmumVv2atcyiHWGy0WnsIHnghvwop0pYA+ReMqXnUYwWHeusg0i9pcpgnekxmKNVHkx0uERprXgaTB69GjxXNkvqWaPkDo03eC1OA4Wd6PoHrGO3D7xAXXcCehe6yQS9ICqa0NYsFpJGysfj0/6en/9IEfkpyKNOn/oZDzu485Z1pjxHi9aRvc0B2vZAjAMhy1qgAdduDRGmUmtD+UH5p/3KGwyQaRyhAmh1p5PQH/Zc/9FlAMEBOSo8T9V6zctpIXhbhOyfA7MgDkrfHSS+ym+cx/0pcI+oItQFVOV0FHTlEblNngVZhfMqukLhREeuXRO22Q0YpoPU6GKbGjh2Xs55KqXzpuwQ64Fc5h0coF4cnZ9RZFJQ/QGnYqqd+luhWPFpo3g71kA+ZX4z/emhzyuXXAHb2DSpvnyheVaQJuyxsku2zZ0XM5VIFD7XOtA4m9JRMN46nt4BOMjYWl4JK/t2zXNvxMuQhOcq6/thieC3sc6n4anp8MxrmllXc7kjp4Y/WYqdCmW7Uv9VwOmvigHL26kBfPt2vMMesv6ge1MvQFN2t7un8HS60FAWc784p0RVYXLcdbgu8u4ZTOB+ZkzYeGAvLcm0V6eT7DpTbsVEwUiwztdMcORwDvJfJjUuf9IDk6pvaTqRSY3u2wasq1/1dSDl8AyHwikF/cvIomjW/xKe77XpnDcxhNnaQraHcTu9o7ru1vMXz0rc5XhEcPWOHT930BVBU9CrMNaSQWTiyI0NRo/iWllr8PeCXcQtdcM/1wC4lY9gayqrTcOf6MvVfUXMYRFsw== -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the name and description of the dataset identified by the given `datasetId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-dataset.api.mdx b/platform-api-docs/docs/update-dataset.api.mdx deleted file mode 100644 index 3e476d8f9..000000000 --- a/platform-api-docs/docs/update-dataset.api.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: update-dataset -title: "(Deprecated) Update dataset" -description: "**This endpoint is deprecated. See [Update dataset](https://docs.seqera.io/platform-api/update-dataset-v-2) for the current endpoint.**" -sidebar_label: "(Deprecated) Update dataset" -hide_title: true -hide_table_of_contents: true -api: eJzdVslu2zAQ/RWCpySwrbQNAtSnJl2AoEAbZEEProHS0thmIpEsSSU1BP17Z0gt3uCiORW9GBI5o3nvcebRFfdi4fh4wjPhhQPv+HTAM3CplcZLrfiYn5zcLaVjoDKjpfIMnzMwFlLhIRuxWwA2uTeYD6z5yPRo6b1x4yTJdOpGDn6CFSOpE5MLP9e2GAojkzLkDJuc4dPw9THDTeaXwNLSWsBabdHRycl39V3FMi6EZOCFzB3T8/gaP8NkhnlyLiFjs1XYWcgnUOxHE3CV/RjxAdcGIRHBqwwpxu9+iBG4a4QVBXiwJE3FFb5g1LO2j86IFDBnwCVpY4Rf8m3BvrVxTJUFWJn2oCwGW/hZSgtY19sSBtylSygEH1fcrwzVQb6wCKGklfBx6fyM1/WgA9PROQilocSct1It/hJHTMKq0xgMzl/qbEUR+6vEE2VNLJZINVJRnjKEMblMg+TJg6O0areinj1AGg7A0gF5CY52I+UdXFtkd3EPuJc+h+0Dvmnw1RSxqUJYcEYrFyu/Pj3bpfv1MxuyL5q17DDp7PR0N+5SZC/Rokc04QU4JxZAQ3lYojbwoAofrdX2puFH9APyN3sYttPBlPZM5Ll+Rjwh+u2e4y8jHWCQQ0Ec/1G2oWNa5+raHtBspF+FSb8EYcFelDhK48mUGh9tYKnJI0wZnYG2eNJ5gUuqNV+ok9ZHk6qb0JpTFfvU2klpc/xEa5FohaM012XW++TOGN+GHXbd2Cd7T/Hs4vqKE8SWwS2JGgVa59FpRBV5M+f0PgtBuBIfPrVm8/Dsg5B0WDf93H/8JQqTQz+QrejbaPv5lGquA4DmSBoeBPxPFEkwifI2wdRPIg39tCnfumjYUjIPbjnX7/oNBELaxzqvRufno1NaM9r5Qqg1Pkcfuu44ZptX2jbequ/w//OCbHrGwy9PqPCKQcmC9FUzBJP+QnSYMN68Hrv/E7jT31XYrUuUnZKraoaL9zava1rGNrM0g/j4JKwUM2oYHJZMOnrGCZyL3MGBYzi6aazkmP3hBt7LrVkUasUJQl7SGz4+wmrr7qdb+EWwDt3GL8DUy1pPMXgJIsNPkWhx/33EMLyjr/T5O35MfGLGRZqC8Qdj1y3x+v6O3KP5T1DojFKseKY/F/gboOogSTClsFbxXKhFGdybx0+S14hNq9qypkBqrxjYRSHiTj+CqutOG0/vpEtd/wa6zcqK -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - -:::caution deprecated - -This endpoint has been deprecated and may be replaced or removed in future versions of the API. - -::: - -**This endpoint is deprecated. See [Update dataset](https://docs.seqera.io/platform-api/update-dataset-v-2) for the current endpoint.** - -Updates the details of the dataset identified by the given `datasetId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-label.api.mdx b/platform-api-docs/docs/update-label.api.mdx deleted file mode 100644 index 1542a84a3..000000000 --- a/platform-api-docs/docs/update-label.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-label -title: "Update label" -description: "Updates the label identified by the given `labelId`." -sidebar_label: "Update label" -hide_title: true -hide_table_of_contents: true -api: eJy9Vk1v2zAM/SuGThuQJd1W9JDT2q4Dig1Y0Q/sUAQoYzOJWllSJTltYPi/T5Ts2KmNdCuGXYKEfKIeHz+UkjlYWja9ZQLmKCybjViGNjVcO64km7IbnYFDm7gVJgGT8Ayl4wuOWTLfBPuSr1Emd8F9nt2N2YgpjQYoxHm2DfKD/N6nwUCODg1dXDLpf3hMfdr7Od2rwa3YSzIhQiKLHA1PWyLGAw0+Ftygv82ZAkfMpivMgU1L5jaa4nPpcBmgC2VycNF0dMiqarQl8aTMg9WQYkvksUCz6TH51QCH2fzN7bNIHq07UdmGzgwlXQQJkxrp46TKh5SO8KC14GmQe3Jv6VDZZ6Dm95jSQW2oOI6jJW9MfIuyznC5ZNWIrUEUwx5uv+ICCuE63rlSAkGSmMxxJ3C36pc17Yr8u6UKBquVtJHQp4ODvgY/v/+7jHn2R3UZ/TdpYvKkjUccDqV/AtlbKt8KfctytBaWSAO+X54G2E+vw//MGGV6zD8PFK7ZA4lULgEh1JPnQ3CLaWG424QdcIJg0BwXfuantzMaCb8gVop2hy4CR1oHUzaJa2pS1tuiollDs252SWGER62c03Y6mYDm41SoIhtbfPQ8xlz1BvkqeJILAY46IDklfHJ8cc6IRUPyijSN+nSpbiWiG5uxDzUPIG+JX741vXX/5ELyVKvLdujPniHXAtt5bDTf9lpr6LRYPT5cLlTgUhenTolyeC1b0o6nfr1HMHUWpKGzdpXs6uebi4swJwv1pXXQXPgyxHs+jo+Oxgdk08q6HGQntdj78TF5SbBsm/utL09dEYfPbqIF+B3uWYRsyrqLto/diE2bV8fXeuWZkrMs52DxxoiqInPc/9RcGbcwFzROCxAW91B/5XUYpPiAm94D1BQ/9OIaDKf7/5LLu8t6C7xP9jyfg5RqI8hNl0tDtZGumnnoCiHzgYha9J5GAh+uKUZ7urew6PGNJ47TFLXbi+3uhYuba5qv+snMVUZHDDzRfwH/GYiqoEcY22ArPWm5LMJ6YzEkTSPsDvOL4Q1JDUrhOyUgrtUDyqraKuPoN+lSVb8Bo0g5hg== -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the label identified by the given `labelId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-managed-credentials.api.mdx b/platform-api-docs/docs/update-managed-credentials.api.mdx deleted file mode 100644 index b154e5b3b..000000000 --- a/platform-api-docs/docs/update-managed-credentials.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-managed-credentials -title: "Update managed credentials" -description: "Updates the managed credentials identified by the given `managedCredentialsId` within the given `managedIdentityId`." -sidebar_label: "Update managed credentials" -hide_title: true -hide_table_of_contents: true -api: eJztWttu2zgQ/RWBTy3gS9oUQeGnTbzZNkjbFHHzVARbWqJlNrKoklRc1dC/7wwpWVfH9ibejZO+tBY5HM4ZzgwvOQuiqa/I4CvhHgs115wpct0hHlOu5JHmIiQDchV5VDPl6ClzZjSkPvMcVzIzggbKsWMnHJrHiZHy+S0LnW+Z8LCQPfO+OXOupzxskTuzNiQg1CMdIiImKZpw5i2N+NjQCIIRlXTGNJOIZEFC+IABDaUgyRFORPWU1DFmijMsOnHCeMYkdwtwEm2S7EfMYXIy0DJmHaLcKZtRMlgQnUQ4Kw8185kE0YmQM6pt09EbkqadumkVv2xkXdnruzRQSL+w6EfMZNIw6UL6NOS/zAKtsGWbua+t6UzpE+ElOGa9B2ITEk42Dmd0BcwQahxOoyjgrjGv/12hjkXTIDH+zlyNISQx2kz4Qy983QIUWZJUWvLQB0kGWDFhlJo2M+U4hqgG6+y8Tq7HQSU9ZxhLCb1B4qg4ioTUyvkGaiDYUzC9FNIwbbGOX+2idAqrYNq77ece/jujPz+w0IdwGrx+3akBgRntWlfkXh0ctAhWMNY9knYq7iorO6rrKrxH55i49FcsWf7/34BeUvjyhfADbPahUMRj+yOg+GPM9Th2bxhCxgXokJu3Klt3ykMmu5LhNHrehWgJtenymCtmM66tIkbzCSWLBA5W7AcUGpCJYr20pusGIsYUUIfkGjCOqWJXMqj7Ff0FGQu1B5eftDgPQoH5QiaNka2ODqCMeSUnj4UIGA1NYlPvIgwSm9ggHFClr1RFeunmZXphgnQ1N/HT0ICdUIOovo8SY4ZJxHsouWGJWp+WHsc4nPGQatGamzW9CLE+JNOYfLKFrtrfgRWKItSFxeLw4S2C4HJdptQ5S1ozSTEoA7q1t0PmEqK3ogz3ipFOAnZstJ6GdBy0hg+6Ana1ANtGhyPmxqArOUevp8s82wHaWEFiZGWmWTaoUnMhW8OmjrVk/zuu38fjOoZSRu8JjmO0+BItbsWSlcMWMDQILibmpPPQMMdUu9NPq3AqUANVdWW/Gb1x7GbaNpSv+63mssW9ocOxgYb6rGURsYYHnK3pHJnM3QgKnnUqYE5xpfPFr25lO4rllWu4TSyjbp9Dd1stKy3YMEd0mYnnUJe79A5QghtD0JTdHlqQAsqbP3mLMozNKZVr6+ixb5e9krp4HNkFGhw8wWPlimWT/Bb6Nk4+LW5Yy1nuzrw7f9soVHgE2wHabdFg0EZTCSe0LSGNRu8be6E9fO4AFRyA6Jb2vTPG1E0sDsE7sHLjyNjNpnjC9YnB1nJGYRvc3B7H1v4OjW0kS+Wa8Z/u6w966ASXwG3/EgrisWy7D5ZL5LxeMu67UVc2z5Hx6NB6tO7u0r1vT6JmCBYPjcUtwY/336eX7pAoH2jzLD/fySb6eLIge/jYAcZ9PcFjtwjZM6h/j/VYsR81svXy/zzK4pNDueqstzeR2DjjPamr0HO5xf7ehPcs81Y+nD7ht7Kn8kC2HxG28ib2+zH+WT3G/36j2ekbzSN34oP8dbXiisqNt1RuKmymNu6V59Aqs6RMg4FKPuF+bLlShksyY5rm98IaQcXzOP6kgZMLORMhV1G7egWj4WHWqA7vC0g7FR3GnKVtoCZ2NaSl8wIVdQVoetmreK9JCfuYwy+LreKPXVr2kH2CqLKnTIOKRKgs1tcHb5oevTh3us4n4eTUIxj05uCgKXdCvZypRLYgKpV5QDOIQrB+Pf8nF7wz8U+lFHDMsPgQvrH8sAVhzsNzQqEdqIBiDvakNqFMRJuCeMLgTCCRAQWf1xj4sIpTgdw9yH1i8wk++gXVsL9okPTSfin8lv0VplxKcGZ5m/P9YqTlkKnWkRr0+zTiPcPd6dkH9x4XjaSyRcn5HFCN/BRniPLO8eczk685qhEugnVoGdvSpzgjyVhuphwYIWixP/7KmS/f59p4Cxf3suC4nf6ks8j+qakgUGWsphoZDPlcRUZlHL3ldxXbsrmk1LKtlhSmQqYgJxVtORenVEuLzlIJLRpru0052EqVCD95OBHGg5XdwXh+3RrhinOwKBM2fyZ3TQJV17+86pBDHPtw2j+KDjAEg8fO86p3dNQ7MIdFoTTEG6rMXGxrRlthrJu7KDL6/6LLZlGp2U/djwK4RCCm2FLWbOpVWL4dMmhjyFYxDlqZqpAjU/AVKlwssqhKU2y2VFFMSqjp2XY5gUH1ul921wZE0lZoNyYIc6bqLQ1ilDEZfEslx9m3tOTFZVZsXzob0oFbDcsaaZiU7coNbjodD0L3MnI9K/jf21ld+RSpkFPYiLGsgG+t6NAa18XNvKSqsbEhUDsCT1SRvlO2vH98vvqC9SsjBs/gdgaNks7xeAH/GquF8ZXlzmLbggQ09GOzDRKrEisQrdbwWs0un+yrfoFANxJf8M0pTZdusm9Q4Jc0/QfJA6vu -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the managed credentials identified by the given `managedCredentialsId` within the given `managedIdentityId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-managed-identity.api.mdx b/platform-api-docs/docs/update-managed-identity.api.mdx deleted file mode 100644 index c13839885..000000000 --- a/platform-api-docs/docs/update-managed-identity.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-managed-identity -title: "Update managed identity" -description: "Updates the details of the managed identity associated with the given `managedIdentityId`." -sidebar_label: "Update managed identity" -hide_title: true -hide_table_of_contents: true -api: eJzFWEtz2zYQ/isY9tBkRpQUN5ODTnXstHY7SVw/Th5PBBKgBJskaACUrGj037sLgC9RjmRPOr14LGCx++3rw4LrwNCZDia3gWA8N8IIroO7QcC4jpUojJB5MAluCkYN18TMOWHcUJFqIhP7M6M5nXFG/PEVoVrLWIA4I0th5lZoJhY8J1Mve+5Fz9l0GAwCWXBF0dA5q0197kqCVEEVzbjhCsGugxx+gLRUMzg1CASifCy5QtEu9q9qRnPx3VogeZlxJWKPNhFcIQIdz3lGg8k6MKsC1Yrc8BlXsJVIlVHjlj68DzabQW27502Fo6Bm3oPxeTtOu6Eo/lgKxSESRpX8ZdDu3HGuzUfJVnhmD4TSxpr4Q2g+lqA+N3iWFkUqYhu20b1GBes+Ghnd89hgehSm0VYP7G6FZv8BwQ5x8VUx3Qx8wmr92iiRz3ravoDUc1Vt1RQpNYholyoOprGLaArdocJadBCkOmn/zCSN2r91WqqsvVDOePOz14lnFyek2iUIwiKDtCVitj/MS6keToU6IBb8ySSpXBI8QRhUZGykWhFoIQxPnJYaWvFXTfScQrWSRKSc6BUsZkPyGTZJxAnNCY20TEuoMewJWGAkBnGMKQUKyVBwThdYgpSFSyVAksYx19oFXPHLMr+yuPZjPmaMUOJWACU1hD/xuETeEg52noQpLfN4XkkVSkhFjASBhXwApaR2HAKHOLgekivOye2F4hZ/IbUJVZl7FfruzdyYQk9GIyZjPdT8EdhsKOSoylIYp7JkI2d4RNmC5jFnv4BvIegLK32h1/fWeQ6rP8d1mkCiCE3THa652McyK1JgVva/eJp7VCfbJfy8qwL/pS2HXPmX7hbBdCJ3rbw7W1K2VF/rSgU2dLpC1OXccJIH9dZp3U3LOYdY1wAhNvondQ85T4jMhIGsDuDGTmiZGo2RmXoKmFrUpebqy0HkeAOSSKMEokOurs4wmjm44QOOtDQHFCSXzFHSHLJ9mOozkLSqQfP5BaGMKXABmbivtZDK7L0pfjvq2UDEeHZITl0wJmR6dOSCgBb+KXl5ANRrJJHWNfGIx7ZIkUBQGcbEUw1u1Sl2bQnKPG1nBaT3FcZ3Ggaby7kAk4UoeCpyTu5lBAwANabLyFXDkJxAYUF5yQVXSjCoJhKtrJr6VKedLNCMPlmQV+I7f034r+2V+iSyMsM7OgKw4IRF17Qn4HIw0ZEmuhpOwaWac1lqbOomge/G4yaDf8noqzWnX8Qh3qJ0R211dxJmyw+A+vtIFnQGI9PZcwYjKVNO855FaEc7z5FpF+vUZge62XGWcJXTRhDWqSO+XGzchjiKBjCapGj2OAJPaWz+hIx6Iv3R4BDqgscwHsVbzFl5v2P6aRnbms1Po1Mjv/URfOtziB03Wf/J0EXhZpeuzZ2vgks3t4LgZntwtgu6gAi7wedo/L4/D3/9m4TkiyTV0AuH3o/HfbmPUAJ+Rn7JiNwgug0yYDSAjvPcnsnZC/ZquB2NT0pJden9Q/ct8t92eFg9rYBBDQ4Bcgl4UFwDDyk7msNj6iOHKlTHJTxbJrd3+I6Al9Zc4nMMCs4+vnArGDVvxNG69/zZ4DTL1aJ6opUqhTPVRUsLMbSXanPb9lna7pCLar49QXlyfHEeIKYK8hVG2EWrDbwOGFqsHnW2J60QrLh//qio6n5pbCgwc5fNu+nTE8V56JlnDD5UxtWLouGX5mmw4wXQTOf1/N062ZlxW+vdCbDZ2B6Ymp3WDNIsNld8s9bczW17eLOOO9dhs9u9qZr17sUw7lNx29FnyNP2KyZC5Im0efRl7ssB87+vUrDuBEw+Xhh7FMgIlXWrsF170KYitVdWIn9vNgAIlrCz82744cNwXE3kUA+o0iffcVKPzbaxrhvG+G+/o/jyN1AfOMeK3E546P7aN3DnI88gmPS/YNy54kDR9Tqimt+odLPBZfdxBfuaCU2jFHktgYuL/8DdAz697AT9wFetbzsLmtqisySwoEqg9RcieXPpyfgtOfBDzE5gfpHmqzauCnA/nJs7P50A/yBgJ3fiYIXXqK3R07tN8FuTO3EMU31hfijbJu2Lm2ukO/8RKIPhGRYVXeL3JfhrIctmdrFra6CPfFbauydwKrEnaZdbt7jUOrUzKFA9VuJaPvB8s6ljZPA3xmWz+ReluTeI -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the details of the managed identity associated with the given `managedIdentityId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-organization-member-role.api.mdx b/platform-api-docs/docs/update-organization-member-role.api.mdx deleted file mode 100644 index 9cf4b3785..000000000 --- a/platform-api-docs/docs/update-organization-member-role.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-organization-member-role -title: "Update member role" -description: "Updates the role of the member identified by the given `memberId`." -sidebar_label: "Update member role" -hide_title: true -hide_table_of_contents: true -api: eJytVU1PGzEQ/SuWT62UZNMWccipgKiEqhYU4IQi4exOEsOubWwvkK72v3fG9uaDoIBaLsnanhm/efNm3HAv5o6Pbri2+D/p8QJcbqXxUis+4temEB4c8wtgVpfA9Cx8V1BNwTJZgPJyJqFg02U4mMtHUOw2np8VtwPe49qAFRTwrFiFPLdzoeSfsP0rGI8xPBobYUUFHiyharjCBTohOnTucUmgjPAL/hLpZkCm6gqszNf4LNpbeKilBcTgbQ097vIFVIKPGu6Xhi6RysM8mM60rYSPW4cHvG17KyRdZu8Hk7j6cEyT6A7OH+tiST7bICKtsWx1IJ0le4yWawysPHkJY0qZB6zZnSPXZheHnt5BTo7GUjm9BEenFHzDynkr1RytALMNqnpSAXzkINxblmKqUQ/aktye+2TafxSW+HXv8vHS063EchANlme1F9W1VtQ4ZdyS0TbbYcMZrVzM5evwYJfE85+sz35r1vGFTgfD4a7dsSj+hd01ohvM1zkxh5DhXtI7wx3eN4k4tVbbccqP0g/Iv72SYdedTGnPRFnqJ8RD5g7y2kq/DI14DMKCPapR7aObCYkPu3ShqaNNHTBSI4x4RoMka0LDtlmsIa67tmkzG/vcgX3smry2JXouvDdulGXCyEFe6roYOHhAbAOpdxrsMpywi1J46gt2Qvbs6OKME7IO+CXxHDnbhL+ijW7kqeloPQ1GuBM/fnQdd/fkAyFUv/G65U6fRWWi/mMfJOm2NBpmOlyUqpHwEsC3UiFiZI4zNxqTlEQepLRN0yY5qCZZhtEw09/XBwiEOI73fBkcHg6GtGe085UISkxDLXZNN6lShbZgNmtNf8yjkErg4dlnphQ4SxFZyLBJUkpvUo+Puumf1ERbG2M4wMWqLzAt8mqaqXBwbcu2pW0slyUJ4ydOGSmmVBAUXSEdfaOAZ6J0sCffT+PUpZ/Z26/Mq3mlTaGWnFCUNa3w8x6Wq8eN3pj/x7TvsfkHaCua2wnaLkAUGInYi8cnEU//ioKs3XdmHuUWPY7yHIzfa7s5Wi6ur6gd0/tW6YJcrHiisuNvQKoDPfE5or2Gl0LN6zAheQxJzSu2e/9Fr4ekXuUC5RQsrvQ9KJRUR42nNfHStn8BP5Qy+Q== -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the role of the member identified by the given `memberId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-organization-team.api.mdx b/platform-api-docs/docs/update-organization-team.api.mdx deleted file mode 100644 index f63b203b0..000000000 --- a/platform-api-docs/docs/update-organization-team.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-organization-team -title: "Update team" -description: "Updates the details of the team identified by the given `teamId`." -sidebar_label: "Update team" -hide_title: true -hide_table_of_contents: true -api: eJzNVUtv2kAQ/ivWnlqJYpqiSOXUJE2lqIdEhJwQUgZ7gE1s72Z3TUIt//fO7BpMgBIpyqEXyzuv/ebbeVTCwdyKwVg4hNyKSUekaBMjtZOqEANxp1NwaCO3wChFBzKzkZr5I3tEMsXCyZnENJquvHgul1hE96y9Su+7oiOURgMc7yrdRLw2cyjkHy8ekSmZaTCQo0PDeCpR0IHMlZmTW0dIRqPBLcQuxO1QUVHmaGTS4jJkb/CplAbpdmdK7AibLDAHMaiEW2m+RBYO5950pkwOLohO+6KuOxskIaOjUDiTj4cwCe5o3blKV+xz4NbS0xo1hhQmURSxcGwOWmcy8QTFD5Z9qn0AavqACTtqww/mJFrWhuQ3VtYZWcxFvZP5AT0swYHhJ99TktZJl+GmGjiDYYO8ZvVrurzAalXYgOmk19tn4fo333rS6++rDpdcRLbROi779g+FPYf0PaS2CYxFjtbCHLm5jnO9NjzK2KUxygw3sD1d/d63A4Ss2y4qlIsgy9Qz4fHW3/etf5YhHWpkzDDnJP/TdElpMSmNdCs/KM4RDJqzkvpxMJ5wt9AUWSieNbr0t3KrDkRMo8TGlR8odeznXVyFpq4FxzTL9ewpTUYOC+e0HcQxaNlNMlWmXYtPxGlXqr3Ov/Wa6CYDx/0bXbB9dHZzJRjQGu8tExaS30a9yZ9vFM1w4PPUG5Ek/PxaT4aHZ+dJ4ocYtqPh8gVynWHbtmtCd9FuxG2TbnWuLGbKg2qeoMmNk3krbSZRJrQvgjHXDyS+fl5Tuk0klZDM/LibqR+tgoDwe4R7vnZPT7s9lmllXQ7FVo6hu/062sVXtRX8IZuseSaHLy7WGdAiIEQ+s6qpsjEvLEumg/XiCouVBM3+oHJYUA5sWlVTsHhnsrpmMb2j4ZKm3yUYCVNmn6oxlZb/6ZFmkFk8kuOnYdOHn6O3t+LBZBohFCvBKLKST/T7iKvNMuad+C5M/16P78DS0FlPyHKBkFIcJisoL8L1X0YconXeG2KcSvA4SxLU7qjt9mS5uRtxWzb7OFcpuxh45lVPX49TeTZ8t3tZJTIo5qUfeSKE5CaG1zNgp+d9UgeZoOrxFiP1iEVdt8TwmXmp67/qVWZ/ -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the details of the team identified by the given `teamId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-organization.api.mdx b/platform-api-docs/docs/update-organization.api.mdx deleted file mode 100644 index 56f740bc9..000000000 --- a/platform-api-docs/docs/update-organization.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-organization -title: "Update organization" -description: "Updates the details of the organization identified by the given `orgId`." -sidebar_label: "Update organization" -hide_title: true -hide_table_of_contents: true -api: eJzNVlFv2zgM/iuCnu6ANOntigKXp2u7HVAM2IqufSoKjLGZRJ1saZLcNmf4v4+k7Thugg4Y9tCXxBJJ6SP56ZNqnWAV9fxOu0D/9xOdY8yC8cm4Us/1rc8hYVRpjSrHBMZG5ZYypAAozf/AnsrkWCazNJirxUbMK/OIpfpKXpf516meaOcxiPNlvl34884a5OIhQIEJAyOqdUkDcpUlyGoYkIe01i9R7i6jyqrAYLIBUiD/gN8rE5B2TqHCiY7ZGgvQ81qnjedNTJlwJa5LFwpI7dTpiW6a+zYcYzp3+YZjXtm9krxUF0DLZY5WLhOHgffWZOI3e4gcW+8DcYsHzDjQB65YMhjZuqys/ST12HrGFEy50s2kK9QBwwjoAbt1LZyDxidcRJMOL2zdynEfD5g8bPhrMC2cswjc35KSgIXFvgs5+oCEoO8LRbcx9Z4rWPt5KawYbzjRSA1nAkMGORYm46lHsBUlJnaqI/0uIIqJ+xxKsEz15yOOPXqEwAWMv7ZIMolRMgtuGFlz3zTD7D7NrztmNOw2pqVMRO/K2Pb83fHJAbZ9VEfqk1M9ryjo5Ph43+8c8l9h4YDoTlNNIqxQsnyVnL3jPh12SvEhBBeuu/w4fUH+94EMe6FQpUuKGu+eMH/LOfyzn8P7qgWICi0WjPqN4idjxKwKJm3kdJ0jBAxnFans/O6etY8Eee1Ysn0lu7IAz/WM74tZLdrcaF4kPPa6XQVLHuuUfJzPZuDNNLOuyqcRv1Nnp8btCfgXsagrC4nlV12wvzq7utSMoAf4hSvUZrsLc5sw76g7bRfhESc+t/LxXy/sD09JqsKVvx6U/cMzFN7iWG0HnSlfjMcZbKcHSR3mtkq669YK6DDTJbFVoIZ1Zukkv659XZm4Lj+rIPfDZHRzt87MPciEe+Pu7PaE6GesXHxL9+9gICDc2nafv6anp9Nj0XkXUwFC3a40rdiNHgYvcdbDKfidb4uudgmf08xboJcCAZRE646w3QNnouftc4JotaYE2FDXpOt4G2zT8DTxIfBZoE+6GUx7CRGrcxP5m3q2BBvxlcT+uO4O8J/q5y+Tg9B7LpQbzShsxSP6/Iab7YOILhrKAYktQfC1tosWxZHcRUPsnuA0kz7iLMvQp1d9d1Xg6vaGT1T3EipcziEBnviRRb8C00lR5KDKXK0tlKtK5Em3S/L5g/HxfXFcdy/7cSGoYeJx475h2TTbuiQeywXc/AA3s8Bz -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the details of the organization identified by the given `orgId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-pipeline-secret.api.mdx b/platform-api-docs/docs/update-pipeline-secret.api.mdx deleted file mode 100644 index c204a4b4b..000000000 --- a/platform-api-docs/docs/update-pipeline-secret.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-pipeline-secret -title: "Update secret" -description: "Updates the pipeline secret identified by the given `secretId`." -sidebar_label: "Update secret" -hide_title: true -hide_table_of_contents: true -api: eJytVV1v2jAU/SuWnzaJAtuqPvDUD3VSNWlDtNUeKqRekgtx68Su7UBRlP8+XzsBChlVp71UxT6+Pvf4nJuKO1hYPnrgWmiUosATi4lBZ/m0x1O0iRHaCVXwEb/XKTi0zGXIWjSLaCZSLJyYC0zZbB0QC7HEgj3G/Zv0sc97XGk0QNVu0k29cVPpNgA9SIOBHB0aolXxwv/w4LaOBwgio8FlfJ9hrMGKMkcjki0p45EGX0ph0F/sTIk9bpMMc+Cjiru1phtE4XARoHNlcnBx6eyU13VvQ2OlzLPVkOCWyUuJZn1A5XcL7GbzkdunkTxad6nSNZ3p7LoMcrIG6gslytcsHB0AraVIgvSDJ0unqkMKavaESXgBQw/lBFraXYIscQdmnRHFglThTjiJf3nJScOjJuBb8cOC1aqw8Yavw9PDrn79YCfsp2JtF/7Q6XB4iLuE9F963jJ64DlaCwskxx+XogUeFePaGGUmTX/UfmD+raPDNg2sUI6BlGrl+RDcm700wq1DAC4RDJqL0vt99DAlN/h0ZIoSpMsYGNrig/0ED6o2NDU5Ds2yzVRppD+QOaftaDAALfqJVGXat/jiKfWF6kgW7bCxBEf+ZFeEZxfjG06EWr63JG+Uapf1Ri26sTU//Z4FkF+J/3xvnf+0ckEHerbJ1vrXr5BriTum3OhPWZyrcFXzDA1jovheMySNSPxki2DyECTBQ2+F2pXH20jIENK5Ot9ueCKkcrznS//srD+kNa2syyFYsBkkMTLN+NxnWG19/B+mbiO+w1c30BL80PKMQmdV452O6d/jo83I9S+c+QYIV1UzsHhvZF3Tcpx9ZKlUWJhJytMcpMUjDb0zGTvZPuP6YPi2FggOXIIRdP8HuXyaNGPgMzv27ejk1CxCsd4l03LdiFdPPTZDSH0lIhe3ryKFkzsqsj1+MLPo0xNPXCQJancUuzsaxvd3lKvmg5GrlI4YWNGX0P8NTFVQJMQ1rFVcQrEow4TjsSSlEN6GeC+0oalOLbxXAuJOPWNR1xtpHP0mXer6D1F38Y4= -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the pipeline secret identified by the given `secretId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-pipeline.api.mdx b/platform-api-docs/docs/update-pipeline.api.mdx deleted file mode 100644 index b44be2fce..000000000 --- a/platform-api-docs/docs/update-pipeline.api.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -id: update-pipeline -title: "Update pipeline" -description: "Updates the details of the pipeline identified by the given `pipelineId`." -sidebar_label: "Update pipeline" -hide_title: true -hide_table_of_contents: true -api: eJztWm1z2zYS/isY9kuakWTHTdOr5qZzju3eqLUTj1+uc3U9I4hcSUhIggFAKTqN/vvtAnwBJcqiM5n2PtyXxAQWu4vF7rOLhdaB4TMdDB+CTGQQixR08NgLItChEpkRMg2GwX0WcQOamTmwCAwXsWZyaj/LVUxEkBoxFRCxycpOzcQCUjYuKUbRePBH+kf68uU7aeDlyyEbTdk45hOIR5EeM6HZOM3jeNxjkGRm1WNSMZkIYyDCoc9CG5HOaoF2pWZcAVOQyAVEAzZKwziPoGY7ZA9/t3/3RdR/9VOv/jj56XHMjGS4UClUvpbgGA/YpROANBPcpwINCoWwJNeGRoSThVLvJONZBmnEOIuRCdkmrhYneWxEFtem0j2Wa9TxqBo4ctRHPEIbBb1AZqA42X4UVda/LohxOuOKJ2BA0bmtgxQ/kKy2M5IIOraMm3mwfZYlH5bmCSgR1genSLSCT7lQgHKNyqEX6HAOCQ+G68CsMhIjUgMzUEg6lSrhxg29eR1sNr1Kl6VUH3XGQ0+ZTzmo1Y42v5WEe9R5jvhHpz1o81ZGK1qzZ+e5NSgriJFVKJFramgJHmQsQmv8ow+a1q13lZCTDxDSwkzRURmBQTMsN19RaaPQnZ44ACQfsKvCnfJUoDpsKcxcpDZ+KiMOgs0Wk84yvGHLRYTPWk7k7P7m0q6NeZ6G88NmENFhCZeWF0P2UzHLnbM3jn5Dp5JkuYGLdDHqwPHMUTNIF0LJNEFWHkO2nAMCRQOxliKOmcrTATuHKccoteFaWR1DXiRcrVjYxnlaQpNVFbm863T4Z3jaMiGp9vgZOnF11tNYLhGFIMyr4yp1fcaRKcikFkai4nhw7AUMZoMeG8+NyfTw6GiG/pVPBrinoxQ+G5LZF/JoDnEsx99aoaTLuVCHZVLwsgjRIrTiCG4KO1fboXBVCUSCAm4qYnCAjUZQhJy+4dvMvGxK2LY6LITuFA//FIaV1D02URydz+YXTH4kG/HYctSgdQG7h1i+K6zHijW+s9GpYr7IE0onU0yXmDbwyHXh1uTz10pac3iCuFKcEFIYSPSuAtsYEJwSPeWaSpVmOGVOhHU0a2HCtpXVAferbiFUYL6KAsQO7WD52ZTHPwLjC9w4n6ACOOIHXuVkNsy+ohp16D5PF2e2O7TiM469aWuOsnCGvSjLCV0QOKd3gWXkEtSZHe4Q0DE3lOL6OoMQ3SrckigtoXMpWxDobhuogKKuIjBK2S+3799RQPz79OqSudTqWCu4ydNby+Aw89OIaiA3gnbmpsAzsDLI8Om07/JISYUoS3EokWAhP1LAVCZGBw4xuABrsVsA9nCNyMGxykKAM32CUMdCP74o0S2SoR5o+ITl0wBRLSttGMYyj46cYKyyFhj/EH2De+sjv37Jr1/wc6dFo19n63yKVmYcs83u1ticL8BiXwyEa3/FThMuum8zxr2k6IKoNa0rd0xu7gqaAtOHbEzzg3Q6tkIQHNWqW5L8rUqGtAaNgFnEpUvMLimiTcNLzm8vTxx42zKtmwii2rnCOAZ+PrAg7rObSBkDT3f4XaQWXRw9ccC/DFemJbGzqcIKgATHHEs/nYfkCdM8Lp2i8IEbx4vXLPDgnukAIcct9Z1W37j/+rxfMiRPKHwd712XdMUzHfZ6jcSF/rSCIeLZBLhtzmqfdUnizsnkEwysLlZ1EURxhWts1WQLJnAXtRd1FCHa5yplUZ4kK3sKcenchJOJ+E91nTrkGe89+v31aRGmddGlZa4w8fjSup5VabC+v/iIEslCwHJ3F3dczZoZc39JnPC+BkJ6xJbqbuozwwrIcvvTd1Te0Dsk/v13vr2lgOXORueu7sECbZbSX4DxUDso1f7EYw48+kVOzrL8sNTvTnaxJE8miO8o9ez6XhPOy9DauyzuK6giQeyDnPhSryDBwLiafIlkt7aUaLFln0jKvwnM+GSF0eNd57AcMQjT0KHcr0gZ3otmUODkrkjHuLjE0U37TAHZo01CtUGi66OzwI7YOxxELE0yh/4OeFpuj0uswUInaUDNiMAIE4OXTtyd86a69Xe4kZZ7a5SLf4nnNrSgzhm1ylo7ZVRnbPWymk2yS1/Ck60tcpoVwkDZKmnatdmXKu262Wy2u0gukWZYrbr7zsnx8W535v2vX68R03JtPkDZyAxPnVp7j+dQf2Zv58WapsyOrdN0t+qsHRG3F0DF5M9CafMkxSV/gkCqWWddkHYvH78/2I1btWIvT7rdT0QsTLsdI7AFdkvVYUNaG+fOXVGqQ2XRNW1v0d0abvLW7A5pnlCn/v313ehq9PvFOY4Vf5++vbzAr/t3p/86HV3ar8c6UssYfb8rpsSzLmjWpd/3RbGz4HHePlOWIe3HJnRx2dg7vUKZItw3PaLuVCZjvtcxnp++fIS0SHs+OTfSDtcNzS9roj5lwrIC22PFWTssebqeVcrVCm/7z+7Mdg5wKE9JAIlet+H8W6xHvqDzXmeUhwDrAY0FiPXwJ41YEj658QulpNrR/LuWDFW+yrBUGlt0LVEfS/3jLvV57rYDDIGHmpn/q7u1bc8wVxY4H9bBW8BqQZ3mZo6fj/SqkoCZS3qJQgexz080FXjPV+s6jW7o0YaqieJxKlcx0pbXBp6Jgb0i1HeHnULs1s6wsv/FzoienV6PAtKlVPWWbOX27StcbZ0klu9HNqYtEY64P34uA/fD0lj70Bnc1K9HF585dWTqV519RXE17PJ7/V2/llAo1+PNV416vHpCqIfqMqYeq5rz3sqqDV6PeY1sX3Sz8/xQTj1udYT9id1GrT/rt05rQY1Gp7cfr03pjTY6jN54s/9WT/jtKj85Vv0lzwxeS8g3mOvquBdOv/dRvHmWDQr3uZ3na0at6d13gfKi8HD8uHXNPG65AB63XMo8v/NTEdbQJ6/7xz/0T368e/X98PtXw5O/DY5/ePV784KCcinRpVNpQ6PAgCLCKKQOBR+FsghBF8QEYDy0ANYMbD+c0eIitnl/Kv9RT1Ced50inHs1ePNmcFy2WROeepHmckp129nWcV3D6P9/mPAn/zChAFd66qCej7A1kvWEdZEW/N+R9IKhd7+iCJAUZA/Bej3hGu5VvNnQsPtpAGWLSGjqo6KDT3ms4YmTP/TDgVZNPwKK2fpxQlF7Bja7LLgSpMAzlXlxU+Trb9mBn1e0qlWW3enK16dU1zPh5rHoGxEyoIaO4Mzp0b8jNjWDnQqDfp/hVpyGIWTmSVo/7V/f31HiLH5UkciIlii+JCjFf62uxXOULV5obI0olM5yW48EjiWlWd7M0ltZ2W6q1RroMZbiTn6EdLOpjGPom+yy2fwXR1buuw== -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the details of the pipeline identified by the given `pipelineId`. - -**Note**: If `labelIds` is `null`, empty, or omitted, existing pipeline labels are removed. Include `labelIds: [,]` to override existing labels. Labels to be preserved must be included. To append a list of labels to multiple pipelines, use `/pipelines/labels/add`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-trace-begin.api.mdx b/platform-api-docs/docs/update-trace-begin.api.mdx deleted file mode 100644 index 4c9ef23a2..000000000 --- a/platform-api-docs/docs/update-trace-begin.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-trace-begin -title: "Signal workflow execution start" -description: "Updates the workflow execution trace for the given `workflowId`." -sidebar_label: "Signal workflow execution start" -hide_title: true -hide_table_of_contents: true -api: eJytWW1P4zgQ/itVPt1JBUIX2N1+Ol5PaNmCaLmVDiGdm7jFu4mTdRxehPLfb8Z2YidxaXu3X1BxxjPj8bw8M34LJFkWwfg+kIJENHgYBjEtIsFyyTIejIO7PCaSFgP5SAfPmfixSLLnAX2hUYkEA7VrsMiEIliyJ8oH/9R0l/E/u8EwyHIqCFJfxg3DGe47oUvGgSAngqRUUoGKvAUc/gFCywVIGOqSE/kYdBX8VitVSMH4csBiyiVbMCqAVNCfJRMU5EpR0mFQRI80JcH4LZCvOQrRm4KqGrbkFjmoZwX/LKl49UpWhANeplSwqC27J4txSZfqE9grJVIvHR2A9AetKi3kSRa/4p62KGWuwRztNTCEwCbKgCOXSE7yPGGRsvLe9wL3vPUVyObfaYQbc4F3Ihkt8GtCSh494uV0zYInzgUFvrUJq2FzL0hu7XsP2qQp4fEV41SLQGETtCkcruTmV0GLQrsC/C7nKUN9yoIK8x25nzGBjvi+1kZ0cSzRBkwf2WyZZ1lCCQ9A20ISWRa+o1G4NdR7enfy9XI2Oz+Dtdu7yeRy8if8mt6dnp6fn6nVi+PLK/Xj9Hhyen6lf99Nvkyuv02Uokwm1HHFqZYJ0rNnTkXLsiudAD2AxNc8eW0sLWieFUxm4tXjseCaim9KXq4oX0JkjPePhn0qY2SPARoFMCB3JAP7a4OJLcjh1vMEYnfzHfjPKZxV+dRGm4YBL5OEzNHIOo57pkpIIXVm+YVMa69tW/lT6LNy49Zt4g++KwFHXrCky3c/9DGu48HnABhxTPZkHvj4NCG2Aa3OPJvxFfSJFSb61h7GTRFdo35eYakmi7Q3jLwCtOYecr8+buZzeY+8uvMFW17AvbnZhAhBsDIwSVNPlqkqU90KXxomccwwc5Hkxkltxvm0vBl98QQjfAY7sgWWgbXpnQMLzEp/QX3tX9TIZ5eYLkiZyBNBwDybbHjanPdjltIbstzsPpdMpllcGpu793no19spmp37Hx14NnCPp3g5p4TxqeK9kWORUj5mYiPOLOrb7fCwR1g5ZWbxtb58PIK53vWOsMUlzUuW9KqLjxBTKVSMNN80/7fOMal1N4XaGyXtQ2C9KQE/ArOLtHsZXgNHBHBQfJqV3A0Wfx3+MMIdCwJRvtUOtuSZ2G5LUUYR3W6LcxJzdk+1t1xX0TjHW0XinmcVjdbmJnK/AqSat5WH6yXSSt2Y3BxkY3qj8cb0WvuzUncmG6H0+gxbbjIn2WpXK0qmKjJQfFm0GayIEcoR1rhAyAHEG2eBlg4XSvRXKokCJeSJ/i81Wry/AbeaMxUiE18BTJkK0fM6RXALwNgHUlUJQDTqE+oBeAZerMJXWKpWYy8uoSbQNV/P+dKAnRVY5cIAwRXYZJX4eDsfpC9MTrud0HupBhqrMqV+D1IOXRT+j0m2vOhjW19Fg+6olJvTukOEdl3yFCbXv+p2Vd83ao74cEsQJ7NnKq7UlazxZzvZuDWNelVV3UmEtnCe8UIrAuin3/Rff/l1Pf76NlhJ+3Lt9rPqKDfaZkBs21pnNONzzmcio8c7kawwpcdQ2hRoKSA48BnjhMT/ZfLhDihSk1bWjhbSlfnHUf9cJ6KO5h8811h77oBnckASsBvoU6mmMSoFk69q6nVCiaDiuESXvn/AiVBKAUTiyAwAj5qS4adgT43c9t7sHVR7czNIgx7vqZ6ilWj/4FHKvBjv7ZGc7UZJVsa7Bf0J+uyyrDfPmqovg5uESEwIg1OkHxzfXAaoTa3sFG2r7eSq3JgKJdbTLxUjighW9I+LOtV8f5bKCHhnt3b2df5CcKCADD2DJnfaYyZ6xrFbYxx3cGI9Hecl9r96LgKxNzrYCT/ujD7P9g/Hh/vj0afd8OP+30EzC3mPxM4/3qNqJgmOfDsxsIvNZMAuNQMAu2T7frtm+3tHRNPH2zXbr7f5NW15SxnbfHe5dldtK+3ydVrm+3r9wWmJO32u3eq2t70G1h1PthpV++GpT2sbT7vm9pcuVzcsmmXeObLbE9rVuvVz/C5y+XRaNo+ipvmyC06TtdrJ3Baq2yQ5V+I2Q2Gn1Qm7jUzYbVPCfhPiRlSn93A6wU7L4Rin22l0dVWIPmz1D2G7PQjb6D/sg/uwD91DDzAPWxi7ga860fQuysHBLdIeinVqrQtee4HWifIGfbYCqgadnsUaa3ZD9aKTURxk6fi8axkXLoYWDJqMW8M//W8D+CyvBtc5S603oNaAz0Fkbo5oIS5jV8YXmSo1pgabioUlal0xw9LIQJQhVkbTvWK7ULrlETAESxQqXmR/2A9uExXs7x4d7YbqKFkhIW2pjKUzxRTckiS+ZzNdWHoDqwbW/IpnN1OPJSSbvTwBD1FjYI3KNJaoH/2Gwbj12KbhxAO6IGbg++DtbU4KCoiuqnBZP4chyIhZYTx/QZKCvnOgNY9lXmV/UKzf7fe4J5KUSKkwyRMRTE/wt9Llt1uDCn8fvPt66FWq7hn4q6uNq6yxY/WALSS0nBiuoJ8mONVa7MyQjWXQQ7H4IKl3HEO45fJdWhcs3tzN8ArNMyJUN9wiyDPWfvirdM2UUfQzGnnWb4B8WepspVlWZorpdjttJKcO5bUGuIuimGU/KAeXqY0j8X+0S1X9C9/iY7o= -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the workflow execution trace for the given `workflowId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-trace-complete.api.mdx b/platform-api-docs/docs/update-trace-complete.api.mdx deleted file mode 100644 index 762b4ae3f..000000000 --- a/platform-api-docs/docs/update-trace-complete.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-trace-complete -title: "Signal workflow execution completion" -description: "Updates the workflow execution trace for the given `workflowId`." -sidebar_label: "Signal workflow execution completion" -hide_title: true -hide_table_of_contents: true -api: eJztW1tP5DoS/iutPO1KDJgG5pzTT8t1hWZgEJcdaRHSMYm78UziBMdpQCj/fV22E9uJuzu9O9KKAy+QdsrlclXZrip/eY0EnpXR5DYSHMckutuIElLGnBaC5iyaRDdFggUpR+KBjJ5y/nOa5k8j8kziCghGqtdomnNFMKNzwkZ/NnSnyZ+b0UaUF4RjoD5NWobX0O8wz4qUCCJpCsxxJh85yPIaMflD0lpGkoSCOAUWD1FXxu+NXKXglM1GNCFM0CklXJJy8lhRTuTQgldkIyrjB5LhaPIaiZcCBtGdorre8MYtCymhHfixIvwlOLIiHLEqI5zG/ti9sSgTZKZeSZVlWOimz7ty9DstKinFQZ68QB9/KKWxUWxUNjK0klOcS6ZMQA9cFCmNla63fpTQ7bUvQ37/g8TQseBgGUFJCW8bXcOz1dmtZJ9lmCVfKSO6D/Q+Bz1JgStmnkpSltrC8rm6zygMUJWEm/fA/Yhy8K/lYpihy30Bk6J6DqbLfZ6nBLOolmMILKqyb8WNiEhLgNxXNwdnp9fXx0ey7fLm/Pz0/J/y6erm8PD4+Ei1nuyfflUPh/vnh8df9fPN+Zfzb9/PlaBUpMRxrys9phw9f2KEgzevNixYFSffWPqiHbCGhiIvqcj5S8ALpbspvhl+/krYTHr7ZPvzRp/KKDmggFYAWGefBJX61wrja5A3fja8B/w4lHMVJBnYaSNiVZrie1CyXps9VaW4FHrD+IVMG6/1tfw7Cmm5dWufeCdkEunIU5p2+W6jEONmPYQcAFYcFb0xd0N82iU2gFbvJsP4cjKnpVl9KyfjbhFdpf6xQFPtLuJ3GAcH0JIHyMPypLhi8UNvouNxUHY2pbMTaTd3N8GcY9jtqSBZYJepa3NilaF9FScJhZ0LpxfO1macT493TZ4Di1G+lnqkU9jXV+7XTLKAXelf8szsG2oc0ktCprhKxQHHUj1DOsyH837IM3KBZ8PsOaMiy5PK6Ny1515Ybucg7Nh/vBvowAKeEuScYcquFO9BjoUr8ZDzQZxp3Nfb3l6PsHaOmelZY3yYgjHvakdYw0j3FU17p0uIELZSeWJkxdD935vHeSO7OaiDq8SfBJw3lQwLJbOTrGuMoIJjLAOb5DCvmLtYwufwzhh6TLFc5Wv1oDOW8/W6lFUck/W6ODMxcw+c9pbrIhpneotI3PksotHSXMTuWxlS3fvCS/NiYUcdTG4mMpjeSDyYXkt/VOmEY1Dk3cxhzU5mJmv18lbJlVoZMHxV+gwWrBHCIKxxAyEnIB68C3gynKihz4jAKijBc/I/ieHx/i65NZwJ5zk/k8GUOSF6XqcILmVgHApS1REA0Who0ECAZ8KLRfEVHFWLYy8m5JlAVrw9ZjMT7CyIVU5MILggNlk0fLKeD5JnKq66mdCyrUYmVlVGwh6kHLoswy/TfHbSj21DJ5rMjioxnNatDfjnUuBgcv2rSVfhFCfyfbw0fnMzWukeaqIrc1E6MMPzMw7tgI0qV2ogLqoByTnmTNKvGaJmYLxB22ZGBxI+bg+kGw+k2xkoIH4ePJOv+J6kC6Lr58UvH7eXvBsvebez6J3jrpekzCsekyOsN8SMZB9Wf3dWn3+Y/T2aXaVIH2Z/b2aHuHRA6vth97+Y3Z+4tNuH4d+f4WUof9PJcD9M/z5MLwO7D9O/T9NDdPdh+/do+0A56syUompdBZpxv6K2wC8KwhIYyhIuv2KAq3+/Grq06Fcxtg53VdcezF1X3AcS60r7QGJ8n/PhsyxFzgcTm2uFoQoEo3oR3TJq6cLJYTGgJKtruEB+RjIfDbKsQ0Hwz8u1TAo91pAIyNeTSJc7B92gLyq1soQ8D5xOc7vbW8Ify+gvtIwE4fIQwOFLn3e4zJzDRkEBL8zpckSE9Ab5fiFB96zysJeXBkeo+vtYSdVQFjkzK3uMEPzzYYnfvkS/DIK4GtSnRvvyzUXnNXOFHUgSW5CeAx5deqZ31KEnDPqQNLuhKR/g5L+BX7pXUJm5Cr1bdQWVLbwzdWZwrC9PO5LvBIzV3LaNWC5GOJXakfIAeUniilPxotC3BwRzwvcruLS6vQNkakbEQw7o3aJSMgIKdxJtKfTv1qvVdL0VW0xvSfi8AfRWXEZW0YMQRTnZ2sIF3YzTvEo2S/IoRdqkedSF1l6pN6OLFAtYCqNDoB/tX5xGIFAj7xWoV6vKlbrVFowYGSCu2kAUkWzRDyfNIvvxJJQewGyXFoZ7/IxhOip27+NjXZCqARcbD/bQpy7e07o0XC7aXw2cUy6y8e4n9Nun8R/X23uTve3J+PdN9Nv2v6MWwrmMxMI2l1G1AEhnfAt0tI0toNE2tbhF22ThirbNwhKdIVr4oW2zMEOfX4sm9ISxmMEu126rRQC6fB2k323Tfucg+Wofnme7uqi8Hu7OknXwdfbFvE9r8XK2zYXFuVzdZdE2s86UXSibbW0Qa47fxS6f2keaBQQ1mDHb4GDDFjtZ7SC/utguxyQuhgt1EFqoi79CXXQV6mOn3BXVgUw5ALYOUspRThcg1ZVVAZFaSZtfLqoJ+aAl1Mcktd29ph6eCNUuNKhF3eiNpmeo2sJ3PNK6C75xDlUXc9NbaJ1V3oJmvAXVYGUCjQ1EprtUTzo7igOIcXze1YyLckEWw2J23Aa1on+2OBXLq4WjOE3eFylOYaEBktxq8AdyoBzOFDViwxZz3M1EF2uQqcUgXWpBupKCdKEEmToIcssc7kJ+7rW1RQ2nadxv2uk01S3Q4G0IO39T0jbXum9D2vY28m2Iay/R3oa87t3P25DYvbJ4GxJ7lfa3IDJkKm4VuC1QIa/8hJziEvJKR8gWhpAt+yCnqINsyQY5BRnklFuQWyxBfikEdQodyC1jIL9IgbxK321btEP9YPT/NlG3atREBL9i6vUdZIeUTXOVXJrE2+SokJSuSl8hGaZSd4ZYhUka1O6nxm5CTDKo7EzUsP+wL2o3/Nve/Px5E6l6Ul6KTN8UGXNcSS3hNPTZrskTgUXv85q2oPErvv01abiQOcZWkcrAECRVM341VYRb8+XxRjTxPvdtU9k7CD4h97qNXl/vcUlueFrX0Ky/yQVPTGhpYt4pTkuyZE4rvtgNyvuTQObufxQ8x2kFlKoaMcecagDwWrL87dKUhP4+WvoJc1Cops7OXlxpXGGNKqXrSg3K0x8CdSmfJjjUUny6BjaWQa+EBV9F6x77crEWYimtWym6uLmG7NF8yyzzWujC8RNk/fKvkjVXStEAbawS0BSzWaXzFM0Slh32azqdGo6aVFAb0l0UxXX+kzDpMo1yBPwGvdT1fwBjMw35 -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the workflow execution trace for the given `workflowId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-trace-heartbeat.api.mdx b/platform-api-docs/docs/update-trace-heartbeat.api.mdx deleted file mode 100644 index 73f7441f6..000000000 --- a/platform-api-docs/docs/update-trace-heartbeat.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-trace-heartbeat -title: "Signal workflow execution heartbeat" -description: "Update the workflow execution trace heartbeat for the given `workflowId` to signal that execution is ongoing." -sidebar_label: "Signal workflow execution heartbeat" -hide_title: true -hide_table_of_contents: true -api: eJztV1Fv4zYM/iuGnnZAlmh3hz7kaW13w4phWNGm2ENR4BibSdTakivJbQMj/32kbMd2krXOodiAbS9FY30SP1HkR7IUHpZOTG+FtxCjuBuJBF1sVe6V0WIqbvIEPEZ+hdGzsQ+L1DxH+IJxwetR2BStEKyfI/hoYWyALtUT6uhrs+Mi+Rp5Ezm11JASgJDtGcpFRi+N0suxGAmTowX+fpFsrc/Yyi+NEQLlYCFDj5aZl0LTDwK31giimHwOfiV2b/RHcw3nLRmNVILaq4VCS1CLj4WySLa9LXAkXLzCDMS0FH6ds5Fqk9hsRj27LieKreHHAu36oOUAjHSRoVVx3/aeLaU9LsMS+TWjm4dPJ5/J+l1FFZ0/M8ma9/RNzXYepgbTUbGhU7XnLZDnqYqDtyf3jveV+yTM/B7j4HTLb+MVOl6lX0uLzg1Aok7YZW/d69NHsSEnFPNMec8vMAhvC62POT2OEZPBp8dA7hgKXoBKB4NhbuzwWzpv7GAwZdkRaIsU0egGolMDyXlevA3nKK3gv2Fm7Hrghhzh4eqoJ+UdRzBi+HGMrIkpznseAmuB01t5zAZkgNIJvgy8TqUpe3Iz+j+N/k1pRKUrUxr6zOfGpAj6v5hm7BLlU2wq12VdXX5CT9FA638JAA/727e9wlVd9sIB/doePrjc6Dq1P0q5X0Z///X9KmZGdGF5KLlfoV8RZP4E+nyI4hkk31LdW2fcbplRU/EOV/hirbF7zD8dcG7T6kXa+AhS6smID8Md9YZW+XXo7s7IG2hPC2rlprd33PlQ67cy3B7mRdUN8pKYhGZ0UrZt4Gay6jSNDu1T0zEWNqUdK+9zN51MIFfjODVFMnb4SJzGyuz1btdhJbpMwXPwRueMj04vLwQzaghfs38rX3Vpb93FFptOL6R8ANGX6p+fm7S4f/bBEfxuV22f9+UFsjzF3f5rWxpkT/hlR9ZlT7RlK8myFVzZkVPZiqXsSKHsCJ3sypTsi5DckRjZFRDZlwfZq7G323Ipm2LYBNnon7toV6+rweB9rr6541dWemFCkNQZVMcaB9dbYchBrch3NZjTH+KQ/v0Q7wY2KYBKg/YuzI/tAhHh/Kjs/DA+ORnLoOTG+QyCetTPcV2NcQfGwW669XiXrTD97RNlnXoeX/wkT0GFAhu8U9bS0Qy/IzHtzZDtdSjFV+QHhpblHBze2HSz4c/VpMdhmygH8xBfC0gdvuKBN+bAg4QfcL03aj5BWjAySNATWMX2j+Ty3VVdCD5Erw7GB0k17bBed9l0yda+pDgP7kzoLOZXAc4rFt/P+Jj2gL3CxbN2teOUMjv3r2K79eHyZsbaWk/ImUl4i4VnHvTpb+BqglOCjoZvpUhBL4tQ5kR1JOco9IV8R7jDpQ56g8IlIGbmATWFTOMcz7/ZL5vNn1tG92w= -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Update the workflow execution trace heartbeat for the given `workflowId` to signal that execution is ongoing. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-trace-progress.api.mdx b/platform-api-docs/docs/update-trace-progress.api.mdx deleted file mode 100644 index c9be0bd90..000000000 --- a/platform-api-docs/docs/update-trace-progress.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-trace-progress -title: "Store workflow task execution metadata" -description: "Store the execution metadata for one or more tasks in the given `workflowId`." -sidebar_label: "Store workflow task execution metadata" -hide_title: true -hide_table_of_contents: true -api: eJztWW1v2zYQ/iuCPm1AXtj0bfOnJW66BW1ekDgr0CBAaYmx2ciiSlJOPMP/fXekJFI2bctFgQHbviQWeSSPx7vjcw/nsaYjFffuYi1pwuL7vThlKpG80FzkcS++0UKySI9ZxJ5ZUmJrNGGaplTT6EHISOQsgn8TI0bVo4p4buRHfMry6MuTkI8PmXg6S78cxHuxKJikOMtZCrPfFjAPG+DSV1KMJFMKZAoqKazBJCo2j3P4AFk3EYhw1K2gehwvK/ypEouUljwfRTxlueYPnEkQlexbySWDpbUs2V6skjGb0Lg3j/WswEXsoHix2GutqwrQ0C38rWRyFlzZCEZ5OWGSJ+21V9biuWYj0wV2nFBtm968gtXvrapM6RORznBMeyljsaioTBZVsjBTImDSXOMIWhQZT4ytD78qHDZf1UEMv7IEB8JccDKaM2V68SA9MSolxQ1zzSam3RnyDmxGdYnnhqPASKD85tnHVI0DNt+rLB7ogPEJ+kaoDxw42K7K4YTr1S7P3Oh8+5rDoiivqdxBPBGTIgMn7T5iItIyY5usuuKE5jwpz8FLQlukGkYWeqtPvTwyGzQOFLZVAkGZhA8F/T/lYQXA7crwiSVFqTrqNWGQPGadAgNCjqvHjqLG7t1EWT4N7sLmPBHe/IQmYziagWkPmSATZfoZ8uMal+YJOxcpy0IexCCFVLGVp1Ri5lGF0Bhbz/vYuT+lEsNFrZHSXKOvxX1U4sqtZXxK+V4Akw3BLLhbKYU8TmyOCVqD6xsb7N1ONi1tru94CpLRbIdDy2HuKWbloHnBAVc36YemKIeZicsCHLCjqFTbt26Vm7Yn3SRaMPp43XlilP6z++QyGVPZUfZpB1k1g5yxg+xTdx9IT2aadTXHk4TsucuAqcj6+nl7zrTSPJ/uII0B0jE0eNplTnDyMssoep9BLIvmku1o+eVoXUkwF6ef4Ovm9uT8bDA4fQe/r28vLs4ufodf/eP+H6apf3l+9fHUdr8/PvtofhyfXF5jk5dsBqBblSAw+uHy68N5ahYI0eAlGdhuRpW2KPG7J1m0FTT3ag2dtkOhguUprtXxjjWgo63sJnlZ5vkusycJY2nn2RO4oToLP1CedRamQyG771JhEdFVmI/yHaQlA1foEPxWOhM07XdBJjZ8UPx8F3RiUvlOR4ojdtAIxXfTyCJnthHNb44AnqfsueN21iP4/8Po3xNGUJpPeL6Uk4dCZIzm/8Uw828Yn8t4x6B4A8y9XoBqGvtlXueiG4rVEdNnEzpi2wvuih9YA5WVKGXC7FThAtstFeofljxL182d0HxN14RjubGmcyXkPO96kIz9xcJ91U4HPJSGwoW5dzb9+hjsuaw9tuuKbzESbU7JNEARllcp94iQVfrm8sOPo2q2Qzyz2ofLFlCrdoNXAwg7zOaRbEE+Yo057IbRHiDzKrTlE5p+D03luzwUu6qTu9eCG3dwit63ovnLwGHVjGWUCx3RDKwD+qC4YkkJ5cfMsJQnjEomj0s9hs97ZPAmTI8FspxFaXREtrIXHxqi9XDuLL04LBz3qZic1sRnKTMYMNa6UL3DQ1rwA0MpHCj2DVQ64GKFgrwxPdFVRjW6emSq/+j46ixGhWp9b9C81lS+1o21cMWasDTxZYSgxf54XwfR1ydt7IDHdu3oytNnitSYxyPe1Zyfc86KXG2+G4bPNRliz33WfB6E1NGrffJ2/+jXwYvXvdcveke/HJC3Lz7HDYe3ScTxdpukaq7url7/vsXFOa0aCo44gs3TuebVXFNDp7mmikVzDZY8I44aIzXxRWpai1SklRfuDVfl2loUlTe/Y6b8E3CElM8oWbqILNFD/rqOFSI+50N8Rof4fI23qKFpSE3CkIpiITWBQjx6hPjkB2moDdIQF6ShJUhDOpAWpUDahAHx6ADiFfukLuWJLdSJK7uJK6qr2rlV5m7yqVYpu14QI9UvTxvkTFq4mHiol7QwLXHXJ3F4lHhokzgsSTykSDwcSHwUR9oYjSwhMOLjK9JGT6RVgtw11QQJpIB/aqM+nLXvQj9m64v7JWh314JiXprwEZifAD3g5ZobvOXnGQuzvMhv0JUX9pWx7B5rGGW/WsBpk3MaUuxBmOxeXaXVrYPXzLYLCa83SDOqEjbGSQwOaF92/hUHUIBnBmw/iN9cB3J5YFW7zouDN28OiIHukK4m1MCIysHsE2Z935pHysBj5rLqcwdSfvgjaHXPavasD4sMvAMVNwaYVzChfo/di3utd88mMUCSGJvEfBfP50Oq2K3MFgtsto+T6GtwZSANBif+QDPFNmxwy9NlUN9HBqssvY5OaWZuMpPEplRyS8PtpMtP1xXm+zna+JYbVKounfKZr42vbGVK48hjuBnwOgf9rEDfarFvLkw3wQpGxedhO+IYslGhN8r6UPDqdoARXD3qAsrAIZI+QSP+NboKYxRbuFHDm2c0H5U2C9gpEXXRNmhbAmlmU0FrgLsYiYF4ZDm4TG0cjd9ol8Xib1Zfutg= -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Store the execution metadata for one or more tasks in the given `workflowId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-user.api.mdx b/platform-api-docs/docs/update-user.api.mdx deleted file mode 100644 index 839cfd7dd..000000000 --- a/platform-api-docs/docs/update-user.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-user -title: "Update an user entity" -description: "Update an user entity" -sidebar_label: "Update an user entity" -hide_title: true -hide_table_of_contents: true -api: eJylVttu2zgQ/RWBT13AF9nrpLt6apK2QNCiCXJ52cAPY4m2mUiiSlK5VNC/7wxFWddkU+yLIQ3PXHXmmAUzsNMsuGO55kqz9YTJjCswQqbnEQvYbRaB4bd4yCYsAwUJNwQM7gqW4gtCyBOxEyZSfMvA7PE54jpUIqM4FAUhXponXInQExFPjdgKG1Lxn7lQHFMZlfMJ0+GeJ8CCgpmXjKKL1PCdhW6lSsBUpuMVK8t15c61OZXRC/mMZM1tA54DYphQYsTUEByyLBahbXZ+r8mnaBXQlHbH0CRidKZef1DbmNsVKDf3PKTAmaLRGcE1eYvoXU20QiI8gefvPN3hBIOVf8igjRLpjrBVGV3g8uioj2ylqTzQdSuUNiN5Fv5Yohh+AyzVDlLxC6qxv8Oh85n6+DEHeAQDqjXQ/tF5NHqYSiJaeKjMATZSxhxSQiCZE32xRaqcyVQ7XgxhCagHbjDqmyia2kkYcq2H1bS+CRFyagROl2aBL2eK4+9IC685UaJqM3/DKeIx7zocSqdBCBNztzSfN5+NRGvZ309r0BnNwLa49FfDtbv45k29H9KrFw2dVr4/xJ1C9H/XMsFRw+4d21gDhyRptf5FKamuXH/Uvq38z5EOa4n0kGAexLF8wnoIrnmYK2FerD6eclBcneRE7Ls1yVVPnyppgtQjDfBIFdETycbNXpL4ZtKOxkpqwOZWoudFpbclo2zqsRbjXKEwsL0xmQ7mc8jELIxlHs00/4nFzoQciPK1PfEuYzBEGO+M8N7J5TmjUutOrmnw1RDb/RzmSBmZ023LKQtCS/Xwtabi/ZOxE6IPetWo9pdnSLKY14rpt/WwIbTTPXv2iVcus1AmrKNrDb6Rr8bWVanG3h3KwVxLTt9i/xUPtq7AVH9hI5JSHQxFpLK3ZQNXarma+h+ny79vFkfB0SJY/jXzPy7+YT2peAvYkYc3I9aS4JZbpFtpv63bCEcR4sR/sYe4KLAHB6Z1htCuc5eZbT7Wn5XSfmoOsBCidZVnMTs+nvlko21IwKqBu3m8tkC9/xfHVMOfzTyLQVittlUVbrfq68+EBe42gxuwp+3Do6LYgOa3Ki5LMiN1Fe03Pj6CErChSeECRkLTMw5zC7HmgyoOAsc+XDkJ+8N7/WI0WrQzQkpdPkKc0xs+PvCX5iJWrhG55xBhHCqsOjyr0k9vKETjPNDaclJ7ECUz8yZ23RKry4vrG1p7dxVLZEQ+Cp7oloe/tlBpx2HVxNoK5Gq6y600syomiQR0NaanKbar0VHgp7KIG/nA07I8TMbQOw2mLP8FCc+1NQ== -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Update an user entity - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-workspace-participant-role.api.mdx b/platform-api-docs/docs/update-workspace-participant-role.api.mdx deleted file mode 100644 index 7624b2f10..000000000 --- a/platform-api-docs/docs/update-workspace-participant-role.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-workspace-participant-role -title: "Update participant role" -description: "Updates the role of the given participant in the given workspace." -sidebar_label: "Update participant role" -hide_title: true -hide_table_of_contents: true -api: eJy1VcFu2zAM/RVBpw1I424reshpbbEBw4CtyFrsUPTA2kyi1pY0SW6aGf73kZKdOE3XAMF2CRyJpB4fycdGBph7ObmRS+MevIUcvbwdyQJ97pQNymg5kde2gIBehAUKZ0oUZha/5+oRtbDggsqVBR2E0oOLdcixHElj0QHH+1KsI/7sDS43IaYUn8wpKFQY0DG4Rmr6Q27Gzcl9JBWjshAW8jnU724OWv2OLwldV+hULlSBOqiZQkf2Dn/VyiGhCK7GkfT5AiuQk0aGleVHlA44j6Yz4yoI6ej0RLbtaI1kndsePOsU/yeYQQX2wBkQ/e8B3SZ39OHcFCv2+fvjsY3q2AWic6KQuaHoOrArWFuqPNYxu/fs3+yCMXf3mLOjddxfQVH30i0HH1j54JSekxVSytzrZqljBlBURNVIVkApQPwsodb5IkHRKfajwiXPxNMR+x89gmPa/eGBggqMT/70NnY7lXJ9lgbj2TxMO4JattyuUDzw1mifUn9/fLJL/Pev4kh8M6Knl5xOjo937c6hOKQYG0Q3kojxMMeY5qs16g13yjRk45Nzxk27/Dj9iPzDCxn26iK0CQLK0iwJD5t7zGunwirKyDmCQ3dW02RMbm65YUljFoYVydYRIw/NRGYkND5roty02UYas2Yw9202mDu62prCNnNJyDy6x17FaldS8EUI1k+yDKwa56Wpi7HHXwR/rMzOvP6IN+KyhMDjJi7YXpxdfpEMvs/tB5ci0TrMcM0svyi7Web/d9GITtLH536Q75chcsYlnm4m+dMTVDZNVJqsru9bVpqZiQ91BevwMsB9qTAxijjtjLnbII/dtk3TkBxqOFVGxZmZj5sLAsIcp3fejU9Px8d8Zo0PFcRm7YQyTdfWxurKtIW12fT+P9l9XRkCPoXMlqwPhC5m2XQdd8OrzZPppF9xg31Mp9vrZth3fPtc/2NO1B8LIoBjN80deLx2ZdvyMRXW8TzQJ4mZgjsuHbVnoTx/0zTMoPT4Cilvpt3IvxX7F+6L2XeHoFcsjFDW/I8+H3C13vO84Q7CtGfpHgBoyP/BsPYu3wOAbZe+vSWHBUJB4biiyeYigTm64kibGDuizoklj7M8RxtetR1q5+X1FYtJt/QrU7CLgyW3Iv1GuCZyk9YznzW0IfW8jitAppAsPbCtXM+UKib1IiHU4tHiyjygpjbv+Qn8n3lp2z8iwcj1 -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the role of the given participant in the given workspace. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/update-workspace.api.mdx b/platform-api-docs/docs/update-workspace.api.mdx deleted file mode 100644 index e68ab50a9..000000000 --- a/platform-api-docs/docs/update-workspace.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: update-workspace -title: "Update workspace" -description: "Updates the details of the workspace identified by the given `workspaceId`." -sidebar_label: "Update workspace" -hide_title: true -hide_table_of_contents: true -api: eJzNVm1v2zYQ/isCsQ8NIL9kDYJWwLA6L8OCDW3gJB0w111piZaZ0CJLUklcTf99d9Qb/VKnCPJhXwTxeHe8e/jw7gpiaWpINCEPUt8ZRWNmyDQkCTOx5spymZGI3KiEWmYCu2BBwizlwgRy7patWcATllk+5ywJZiu3l/J7lgVfWpWL5EufhEQqpil6vkha3381OrCvqKZLZpnGuAqSwQL0pE5BPyQcA1LULshmlB90SjP+zbkOsnzJNI+7qDToa/Y155rBsVbnLCQmXrAlJVFB7ErhITyzLHWqc6mX1Fai4yNSlmEbiZfP3njanF4+mGllzow9kckKbb53dO7gDWpt8BVLcJtZtKFKCR47vAa3Bg2L7Sjk7JbFaKg0XpzlQJCowaLVMlbzLCUlxJoL8f57m2tR7ti/54bPuOB2tb0dEgY4IlUvxxcfR9fnILn6fTQ+P0PCWm4FKn/sPMCdteINlo1rOErUWb8IJzBKZqZK9OfhcBvfD3+8HJItnXDRxTLpkAwrtNfgwZT3uuXJj1AJXMMpdIYg1dk3N7ukj3+yLAViR0dDfJUWniQm/3lCe99Gvb8/fUqmr36NvNW/k94/IPrFEx0cFIfh6zflTyTczxXvuMPhcIfyBnfW9XcZvCyZIABg0Klm8E12OWyRRb2e5ZAWGAlqbEW+HzbyaNuVRV965pCY+XSuCIt8Br2jXZQ9oclzqoBPyCUzhqbsae41ittP3MviXGuptyJ/veOxNf0iyKQNqBDyAeJx2m+3tc/yKh2outWj+V+mCpuGxbl25IQmd8KoZnqUI50nU6zv0AEXEhukyt2p2GEiMoA2aAaFa4bloOvZg8LrSiVB7/q+6aC5FmC6sFaZaDCgivdjIfOkb9hXQLbP5VbrunI7waWgFhkanKJ+MLq8IBhaE/kVQlfB4MffIoEnkrqx4XrmlEBS/fzWcP/2wTq48ErGXVs7f6RLJVjXbbxn0xaOTraeQSv2q0D72Evs23PpYq3vqE4Zc3wKDcSWA+i1MhKMxo5g60j7+ALHuHBldy7fdRtYpuCaqnMO+8fH/SHKlDR2STMv9aqGdOPWZpBFx/MXHtfqy7Ts0Q6UoDDvQIAu0aJm5QSHMwOqUTOkecMkSP2BCeizgOTQqChm1LAbLcoSxXDvGh8D/N5TzaueBOxNuMF/eApzKgzbk/ercf2CD4KnZ8GdadVCmq2QOVTkuILfO7ZqR1CcBJ8V0xPz4DMC8oEtp6C+YDQBZwhbpXFaBdK7Rj+dh61CiElVFqM4Zsru1fWr0+XNNT7oegpdygRNNH3AARe+LljpcHF1wskK6IpZmruySSqX+PzpevXYqBYuqZ1wAI+cxrW8Y1lZtuhYXCMuZfkfPpFw/Q== -sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Updates the details of the workspace identified by the given `workspaceId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/upload-dataset-v-2.api.mdx b/platform-api-docs/docs/upload-dataset-v-2.api.mdx deleted file mode 100644 index 44054bc6e..000000000 --- a/platform-api-docs/docs/upload-dataset-v-2.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: upload-dataset-v-2 -title: "Upload new dataset version" -description: "Uploads CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. Each upload increments the version number." -sidebar_label: "Upload new dataset version" -hide_title: true -hide_table_of_contents: true -api: eJzNVktv4zYQ/isETy3g2NkHcvCpeexijUW7QR7bQ2AgtDS2mEiiQlJ2DcP/fWdIypIjxnGBHnqyRc5wvpn55rHhViwMHz/wVFhhwBo+HfAUTKJlZaUq+ZjfV7kSqWGXtz+Z0uwOfxJVWigts4olGoQFJlgJK7YEbVCJqTmzGbDwJpMpCsu5hJTN1u5mIZdQsscgMEkfh+yLSDJWO1tMlvhsgUrGSTfPlnUxAz3kA64q0ILwTdIdwiv/2M+PeF8JLQqwqIe+bXiJHyi3UvrZVCIB1BpwSc691KDX/LXLfzeCZBK0TFoXnHmTZFAIPt5wu67oZYnxWIDGq7nShbD+6Owz324HO/M7bxvjlbBZz3ZwgxmrZbl4ZVjDSy01oNNW1xAB4rX2zGYgUgftgMOTMpUJ5tGwVQYYcu3i7rOBWZvLHFzShSwN5to/ybRaDdkVzEWd2zF7JEiP0fDMlMpBlAhr6n0AYy9UuiaRuPfOYpDEFwPhSL5AYxLza0cU6hMKKh33bKrZEySkW2lii5Vg6JYe7serk7eZLAVGCCPIrbQkzP8kkzcezFfUv/W2tiSznxF3YCpVGm/t4+lp38cf3/c9ElWVU/TxdvRkSOR4d0JpvC/Ykq9PlkFz+5djzNv3V10/ImKZMN882yK5H0TAvl03GCHXWdILx5I2zA9cLBEN6WCEZE7EpoqqDWiHHyl2OBQyPRLB7smYr9547CbgixXljlL3+PSknCuSz4Wx91VKzh5kJkmcWIl4UIl4/Ca2AlIp7txp5LbbBo8MhI552nGn6b0+wVdW7Tu715+9zE0oE6oiFP0cK5QLHAXRHnC4YrpcKcAYsTiCFI3gQTe/aK10D/mnSIk384mVyjKR52qFeEjcQFJradduLl2A0KDPaxwD44cpNUccWpmimVYp57QbEWM+asbzaLMr5O3I92dquKCXzaxzueKZtZUZj0aiksMkV3U6NPCCmIZS9Zr/rbth17mwlHp2SfLs/HrCCVED2DU9H6su7F24yGLT+13dOyE88X++NqR6WlkXCEnsJ/UQ24CCzL4HkNyVCQ4rL+wGU+KIse981+VQrs7sH+1FtyvxD8Ozs+EpnVH0C+F4Faao57Dbcpq1plF8BXfTMvV/uTuFfFn4x46qHCd6p8I93Trb4ICPu2tLYBzSIiN+ouRmM8Pbe51vt3Ts1wviYSqNmOVUhXORGzgQpPe2rSjgZ1j3NrqlyGuS5LT9HG//v11+DqDdbWIt0Cl9aElI/2XUfrsJbe53dnBljOIJh6Jcd9E0ONuMb6c01cNIR3j+/tKDOHETptWPbWaUCa90niRQ2Y54r4nv9b/rH7d31DzClliolHToYffuoP1LnROH7n43etV9HPio08hfJ3GnnqFEDjcxsPRN/m+3vwBhzYy/ -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Uploads CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. Each upload increments the version number. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/upload-dataset.api.mdx b/platform-api-docs/docs/upload-dataset.api.mdx deleted file mode 100644 index 52cab8d31..000000000 --- a/platform-api-docs/docs/upload-dataset.api.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: upload-dataset -title: "(Deprecated) Upload new dataset version" -description: "**This endpoint is deprecated. See [Upload new dataset version](https://docs.seqera.io/platform-api/upload-dataset-v-2) for the current endpoint.**" -sidebar_label: "(Deprecated) Upload new dataset version" -hide_title: true -hide_table_of_contents: true -api: eJztVktvGzcQ/isET7Yhad008EGn+pGgRtHGsOT0oAgItRxZtFfLNcmVKwj6750huQ9Za9nJOSetyG8437xnw524t3w44VI4YcFZPu1xCTY1qnBK53zIT07GC2UZ5LLQKncMvyUUBlLhQA7YCIBN7opMC8lyeGbxIbYCY/GB6dHCucIOk0Tq1A4sPIERA6WTIhNurs2yLwqVlF6+H2X7q/6HY4aXzC2ApaUxgHorAoOTk2/5tzyotB5yOfrKED3Gn1TnjtBOs9QAUmTC04p0mJ57iYqlkghWcwWSzdb+5l6tIGffI+Bafh/wHtcFsiZ/XEv0SFB9FRB4WwgjluBQA3pyw3P8g6hnbR5tIVJAmR5X5MpCuAV/6d9/KxzLyyUYlTakDIINPJXKAOp1poQet+kCloIPN9ytC9KDLoF7DyV3CheOzj7y7bZXk6nNOUglmsSsMyq//0EeQWhH6wKE9MJe5VMJZr2nMzgT/T9XGbCFsKyW2lMx0zoDkaOOaSAE1l1ouSZItyX+0YjEF2N2EH5ZZk5h5Fzis5AcRMd7OvXsAVIfZUNZ4BRYuqWH941vxWCmcoHmoju4U47A/G9SeRvIfEb5UdC1Jcyue/2BLXRug7YPp6f7Nn75a9ciURSZSn2aJg+WIO83J5bH28AmkfYj36tu//Hhf/3+qm1HBwyz4M+QBB2x73WQfb0G0EO+DcgLnyWNmydcrJANyaCHVEZZStVRWjCeP6bYYVco+U4G9ZNdtgblXTeRX1eF1Sl1h09f53NN+ExYd1dIMvZgZhKi7xTyQSHK41e5LUEqMfanHbftBvdOR5guS1vmxLL9GgJ85fSuse2+GzG3sUyoihD6satQLnA0dfaAwxXTzpUlWCvu35EUFfCgmZ+M0WaP+e8dJV7NHZZrx0SW6WfkQ/BmBNcNGXBSKrf2M+gChAFzXmKTH06m1C5xQC00Ta9C2zC06I4ndRRtsmlFdJtUG0GyqWt+Gwc19WYwq2rg+bDyas7jPB+kmS5lM+z3mv7I37CbuAOwS8Kz85trTlQrS3x/DG5t21N7ljRWY8K3CA/Ck/Dxucq/h2fnfaaoUEg8hiGyILVvESRzFfoogimHROpzaNf4tsmxsr3aP5qLdgPjvw3OzgandEZhWQqfgnF6Hl3VMT5mr29YL7lvmgz/tbvxul4d/OeIuMpbnSgUwaRpZRYFhrubW70Z4017jYqlgPm6oIrCVzabGd7emWy7peOw71CBSGXFLKNSnYvMwoGAHdiGOu14hHV7z1qJrCSQL6OVMIrU/iCFo9vY947ZG6tpJ6N4KPJ1m0/FtO1aWhR/itahNfUnODVB3U5p+YibBzot3F8GDn0/CBv5rgWSTApC52kKhWvB92bNTlO++TIaU+OKy+xSS5Khh/27veaT2jnuBrud8EXn8+Q7jcYU9YixfoQc07TygaP/ZP92+z/XBOJI -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - -:::caution deprecated - -This endpoint has been deprecated and may be replaced or removed in future versions of the API. - -::: - -**This endpoint is deprecated. See [Upload new dataset version](https://docs.seqera.io/platform-api/upload-dataset-v-2) for the current endpoint.** - -Uploads the CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/user-info.api.mdx b/platform-api-docs/docs/user-info.api.mdx deleted file mode 100644 index f7a93478c..000000000 --- a/platform-api-docs/docs/user-info.api.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: user-info -title: "Describe current user" -description: "Describe current user" -sidebar_label: "Describe current user" -hide_title: true -hide_table_of_contents: true -api: eJyVVU1T2zAQ/SsenUMSKHDIqXy1k2mnMAWmB4bDxt44IrJlpHWAevLf2ZWd1EkMhUtiS2/3vf10pQhSr0Z3qvTovLrvKVugA9I2HydqpG75eJxPreoph76wuUeGV+pgOJS/BH3sdCFwBl/+YFhsc8Kc5BaKwug4OBs8eIFUysczzECe6KVANrKTB4yJDQsn1KRrAtEj/w4fS+0wEY1sqA0j5e4XZChy3/eikxaTZmEpe+2pqXUZUH10fKiWLZcMz+D5J+YpzdTocLhm8OR0ngq2lrEJPDg62ka2aGoLNp1q56mDZ3/YRWTgE2DrUsj1X6hr8QGDjdpt47sMYAEErpXQ7atx0nmZW9LTpg9agIm1BiEXBKHL/OWUm+1MOqzunl1YBm6OxF7fRUnWTuIYvd9V06pJAoR7pDm7kgt+OXPIvx0hvGUkRLdF8jmjBA1uGqylSyI0GWzG7nxyTjbkDzF5N+IEp1Aa+mPd3BcQ4/hjXd/iOw+9MEHh/d3MOQMEctg16aeQRDKZ6OkzI98e5owLBOkHZngF3G2tVgAXztld5V86dtRqvUXclhEYY59Yj8A9xqXT9MLiKnWK4NCdlDIOd/fL+61xWScsYhvHsUdhX3GLIs2sLM4UQyQgDtRAbvd0vUf5cSG7VmhKx4tEzYgKPxoMoND92Ngy6Xt8ZJl9LfhN4utwE10ZIKlndCb46ORqrETkKoZrSXmdvnYk6wwKo0gJMGmmAOKT+uHbqlMenijkJkgX8ybdjQqh/Z9ACVfzNDZg6RWIQ69sBt8OudmwgfbrvwsWIpmrefb7x8f9oZwV1lMGodXysC3frM7WymuSQfhMg8KADsMUVFVN5ervYl05Tu+MmeSwqibg8daZ5VKOeQ6ctA0/LsBpmEiOuGvYACGR7xiXeo4MUbKYCumMBZhSyHcGRsq47qLvFzeMhc3ibRUreG+uIH9p+WaZAXFj55iz1F4jguSdiXhKXgHTSbxF -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Describe current user - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-action-name.api.mdx b/platform-api-docs/docs/validate-action-name.api.mdx deleted file mode 100644 index aeb59d418..000000000 --- a/platform-api-docs/docs/validate-action-name.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-action-name -title: "Validate action name" -description: "Confirms the validity of the given action name. Append `?name=`." -sidebar_label: "Validate action name" -hide_title: true -hide_table_of_contents: true -api: eJzNVF1v0zAU/SuWn0taYJpExVc3BpqQxsQGPKBpc52b1ptje7azUkX979zrJGu6lo0XJJ4S+x7fe879qnkUs8DHP7mQUVkT+MWA5xCkV47OfMwPrSmULwOLc2B3QqtcxSWzRTrP1B0Y1rxlRpSQsYlzYHJ29Y6Ob14vbeUvG8Al3by9yviAWwde0N1xjiG+k1cRYZJgJ4hCiBMefyJ4oldzeovQhfU3wQkJ+HDAFRG8rcAv+UPaPzogM1UJXkmmcjBRFQo8goOcQyn4uOZx6cixMhFmyVRYX4rYXO3v8dVqcB/dNNQeCTtZp4JF2+QLle2KGKJXZob+MeUegsPsQyD7i9EefTYdf/nMnrETy6RFoiby1YDvjUbbuAORMw9ILkQM2qERJpzTSqakD68DYeseJ3qiPOTUCiWEIGZArdBStdNrkOTPeapcVA3RDrhDEz5VUdPVkffWf231oWWVmL/cobDrCWZsZEJru0A+Cf1qG/2hauQAAw0lafxP1aIxgKw8Tk1q5AMQHvykinM8XlDxscvnluZgBimqIBMfthM57PcQ+LtuICqvETWP0YXxcCicyqS2VZ4FuMU8Zspu9eZZsrBTLSL1ODskPJucHnNi0ZE8oyw1ivtU70VTxK6d6TxNILxpfj5203O9iCkzyhQ2PW8z1LKgsE8RJLlKQmjBVF5MCjnbFN+XjBVWOg1vYd+vDUiEMtfEeZ7t72cjunM2xFKk7mhHvNtF/aX2kGi97rR/sx7bVEf4FYdOC9w3yDVprtv2WC9sFNY1CFZxjoLIWtdTEeCb16sVXTfLitomV0FMNbV+IXSAR5Q9sUF3cryB5daSRnoVITkt0r8P/+dN+kjktlrrkBd08IpipnHDDIHIUQDlonkzkRJc7L3a2h0bQ/rp6ByxYnMoHgxB8t6ahFn2fGNdEuLc3oDB2nTEI50xEO6L3wdInM4= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Confirms the validity of the given action name. Append `?name=`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-compute-env-name.api.mdx b/platform-api-docs/docs/validate-compute-env-name.api.mdx deleted file mode 100644 index 2d012ccf2..000000000 --- a/platform-api-docs/docs/validate-compute-env-name.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-compute-env-name -title: "Validate compute environment name" -description: "Confirms the validity of the given compute environment name in a user context. Append `?name=`." -sidebar_label: "Validate compute environment name" -hide_title: true -hide_table_of_contents: true -api: eJzNVW1v0zAQ/iuWP3fpgGkSFW9dGWhCGhMb8AFNm5tcWm+J7dmXjirqf+fOSba+bYAQiE+tfY99z+N77lJLVJMgB99kaktXIeyAmQV53pMZhNRrh9oaOZAja3LtyyBwCmKmCp1pnAubx/VEz8CI9gJBF2hvTQkGhVElCG2EElUATxCD8B0TMXQOTCYuXzPg5Yu5rfxFChe8enWZyJ60Drzi3EcZZf/CCRXCqElxaGbHhCSYU57+IHiWUEs+T/Bb66+DUynQ4Z7UzP+mAj+X66q+dkBhqhK8ToXOiLbONfhEHOXClhoRsl4jmRiE35FJ+UI6hVLJQS1x7pibptAEPIVy60uFzdb+nlwsencCTKPuEeajh1igveMqKIOojKYbDIQgFL14k3Qrs4BemwnxoOJ7CM6aAIHjT3f3+GeVwMcPYkcc20arQbnoyb3d3U3cgcqEB6IQkJJ2aIIp5wqdxhr3rwJj6yVOfER7yNiZJZFXE2BTtlTt+ApSvs95NgrqhmgH3KKJjmoseOvQe+s/tfoosojMn21R2FlQGItCFYW9JT4R/XwT/bZq5FBJCuBy/K9qKRggrTz1b+yZA1Ae/LDCKS3PufjUUFPLbTeBmFVxSPaXB0S/8xgbCfysa8DKFwSdIrow6PeV00la2CpLAtzQYybabhj5NEbESaGQvSlGjBfDkyPJVDqmp/xUjexlvnfKOWPnaV6PI4h2mj/vula7usX4PNrkNh5vn6llwWl/RpDl6pQGQQPmGqs01nhV/LJkKrMuYqfn9s19gIjwyzV5niT7+8ku7zkbsFTRIu086Obfg8NnnXV9771/PrrbkjC67wpFQ4w0xbepWy+tfWzoFTo3UcmnpJ4hdT1WAT77YrHg7WYMsscyHdS44GbJVRHgEeV/f7xv1XoN842PECWoGCl5yv+6gj8f848wbI1zT+2cF14ztzgLqBigMuojfvbmzDBNweHSqY3BtjJB3h+eEVatNutac8bb25Ay86W7yQIRcWavwZANOuLIa0pEw+wHYhANiA== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Confirms the validity of the given compute environment name in a user context. Append `?name=`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-credentials-name.api.mdx b/platform-api-docs/docs/validate-credentials-name.api.mdx deleted file mode 100644 index 169080821..000000000 --- a/platform-api-docs/docs/validate-credentials-name.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-credentials-name -title: "Validate credential name" -description: "Validates the given credentials name. Append `?name=`." -sidebar_label: "Validate credential name" -hide_title: true -hide_table_of_contents: true -api: eJzNVE1vEzEQ/SuWz2EToKpExFdaCqqQCqIFDqhqnd1J4tZru/ZsS7TKf2fGu9tsmqjlwIHTrj3PM+/NVy1RzaMc/5J5gAIsamWiPB/IAmIetEftrBzLH8roQiFEgQsQc30LVvQeCKtKyMTEe7CFuHzHxzevl64KF2vUBd++vczkQDoPQbHr46Ln/HDt8ISghPMq0A9CYIa1ZAeEv3PhOnqVA70eSM38bioIS/mQ9c8OKGxVQtC50CnATEMgcMwXUCo5riUuPTvWFmGeTDMXSoXN1f6eXK0G99FtQ+2RsIcPEiPQidtW466wEYO2cwpCaQ8QvbMRIttfjPb4s+n9y2fxTJw4kTtia1GuBnJvNNrGHahCBCCGESlohyaY8t7oPKV/eBUZW/c48RNNArglSohRzYHboaXqpleQsz8fuIaoG6IdcIcmeqrR8NVRCC58a/WRZZWYv9yhsOsOYR0KZYy7Iz4J/Wob/aFq5IAAAyVr/E/VkjFCXgWNy9TNB6AChEmFCzqec/Gp1ReOJ2IOKapikxz2Bm3Y7yMIt91kVMEQcoHo43g4VF5nuXFVkUW4oVxm2m016WmyiK9GITe7OGS8mHw9lsykI3rKmWpU9+neC+eIXUvzeZpAdNP8fOzG6OoOU3a0nbn0vM1Sy4LDPkWQ5eqcNlAD5hKrPJV4U3xfMlVZmzTFM/d+bSAinLkmzvNsfz8b8Z13EUuVOqSd9W4z9XadaOd/g2y97rh/vSrbRCP8xqE3itYOMU2K67ZBNlc3SetahOq4IEmMqOupivA9mNWKr5u9xY1T6KimhgdgRq/hEV1PLNOdPK9hubWviV7FSMk79e/DP7FUHwnfFmwd95wPQXPgNHmUJlAFqeCENG8meQ4ee6+21sjGvH46OiOs2pyNB7OQvLcmZZc931SchDhz12CpQB1x5DMFotXxB/Hnpcw= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Validates the given credentials name. Append `?name=`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-data-studio-name.api.mdx b/platform-api-docs/docs/validate-data-studio-name.api.mdx deleted file mode 100644 index 4afd84389..000000000 --- a/platform-api-docs/docs/validate-data-studio-name.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-data-studio-name -title: "Validate Studio name" -description: "Confirms the availability of the given name for a Studio in the user context. Append `?workspaceId=` to validate the name in a workspace context." -sidebar_label: "Validate Studio name" -hide_title: true -hide_table_of_contents: true -api: eJzNVE1v2zAM/SuCzpmTbUWBBRi2tvtAL12BdtthKFDWphMtiuRKdLog8H8vKduJ27TdjjvZEik+8vGRG00wi3r6S0eqC+OjvhrpAmMeTEXGOz3VJ96VJiyjojkqWIGxcGOsobXyZbqbmRU65WCJqvRBgbpIoZRxyVxHDCr3jvAPZeqoqtAV6vrDnQ+LWEGOp8X7a0VercCaAgjToxSNA4Da+m1j6JH2FQaQ/E4LzvBH9/ITELTYZ/yc3SoI/EMYpMKNlqDsPkBmHyM13tYY1vpx5T+30KZAR6Y0GNgp5nNcgp5uNK0rCWg4r1kycf1LoPbq8EA3zWiL6tqUXoDraEulD/h4CjFSMG7G8blbAWPlXcQo9jeTA/k8DPxtoV6pM98S6GikTDkgObZICrgtXXstZroZ6YPJZD/YMRQqIFcQ9wM5T22w7vnbJ3LpO5ecwVp/h737u313EZ81OUMljKKu+MSkFL26WvFtpcGM64h5HVifqefHCAHDUU1zPl4JXyyIuRfZzJCSRsSkx53+x0PaMax67dTBstecqIrT8Rgqk+XW10UW8ZYLyozfb2eyqHMLJLJQJ+Kvjs5PtWTRJ3khrW17N0x122lB7BUg55vkxDftz5decL/vKBVvXOnTc0MWd1kI7N8SlHJNjrFzFk4hJwn2sPhhySxLY5PeS/9xZ+BEhLkW53V2eJhN5K7ykZbgJGQ3Ff3oqoH4Hye60Z1w/9Nl1HVKjuPKAk84l5oo23Tq2m1X5qXXF4tgznyIdbO5gYjfg20auW7Xg6iuMFGmkdVago34AjHP7Konc1vgem8Nclq1eGpZWf8O+/zOegG5a/IO8koOwQhmmtLBkH79fMmu8HAoHg1BoqozgVsPQjOxyePSL9AxuX0GJGfGbZrmHncQaZ4= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Confirms the availability of the given name for a Studio in the user context. Append `?workspaceId=` to validate the name in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-organization-name.api.mdx b/platform-api-docs/docs/validate-organization-name.api.mdx deleted file mode 100644 index 93b765f31..000000000 --- a/platform-api-docs/docs/validate-organization-name.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-organization-name -title: "Validate organization name" -description: "Confirms the validity of the given organization name. Append `?name=`." -sidebar_label: "Validate organization name" -hide_title: true -hide_table_of_contents: true -api: eJzNVE1v2zAM/SuCzp2TbUWBBftKu24oBrTF2u0yFC1jM4lSWVIlOW1m5L+PlO3FTYr1NGAnW+Ij+Ug+sZYRZkGOfkrr6Xu1JwsMuVcuKmvkSB5ZM1W+DCLOUSxBq0LFlbDTdJ6pJRpBjmDUL2APYaDETIydQ1OImw98fPd2ZSt/TbBrPr6/yeSetA598jgpKMsPDgwRz3qhTglLQAeefiJ6JllLjkAOpjEqpnhXoV/JbeJn26xEtE0BlIfQIZ9jCXJUy7hyHDJEr8xMrtfUA4/BWRMwsP3VcJ8/W+G/ihfi1IrcmogmyvWe3B8Od3GHUAiPRDFEStqhCQbOaZUneoNFYGzd48QuymPBgykxBJghz6alaicLzDme89zHqBqiHfCJmshVRc1Xx95b/62tjyzrxPz1ExV2ExLGRgFa23vik9BvdtGfqqYcLARqLLnI/7RcMgbMK086Too6RPDox1Wc0/GKp09ym1uW5QxTVmCTHPADGfQVhH7ZybLymiDzGF0YDQbgVJZrWxVZwDvqYqbsjj4vkkWca4hT60txxHgxPj+RTKFjeMEtasrt8/xTMWfsxMznSQLRTfPzmSID9V8u7mNqizJTm9zb9rQsOO1zBLlclWNowTxbyNNsHxffL5nGq9jGaT9uDESEO9fkeZkdHGRDvnM2xBKSNNpn3u2F3R2zTbfeiO2f7ay25xEf4sBpoOVDpFPxdSuSdotSeZ1MaJZzKotNdT2BgN+9Xq/5ullbLJ5CBZhoVv8UdMC/VPbcUnuS4S2uNhuTwBVDksqW4BVnTsInoggFiYcpNT7jPEcXe147r/jRc/lyfElYeKzQLUWm6K0JzKoXm9qTEJf2Fg21qCMe+UyJ6OX+BjMOTwU= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Confirms the validity of the given organization name. Append `?name=`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-pipeline-name.api.mdx b/platform-api-docs/docs/validate-pipeline-name.api.mdx deleted file mode 100644 index b347df4c6..000000000 --- a/platform-api-docs/docs/validate-pipeline-name.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-pipeline-name -title: "Validate pipeline name" -description: "Confirms the validity of the given pipeline `name` in a user context. Append `?name=`. Append `?workspaceId` to validate the name in a workspace context." -sidebar_label: "Validate pipeline name" -hide_title: true -hide_table_of_contents: true -api: eJzVVdtuEzEQ/RXLz2kSoKpExC0tBUVIpaItPKCqcXZnE7de27W9KSHKvzPj3U02F6WoAgmeEnvO7JwZHx/PeRBjz3vfuZUWlNTg+XWLp+ATJ22QRvMePzE6ky73LEyATYWSqQwzZrK4HsspaFZns6EWOQyZ1EywwoNjidEBfoQ261sLOmXDt4R4/WpmCndTp93Q3pthA/Rg3J23IoFBOmTBlGVFgFiT0GWJJWxZh7e4seAEcR+kyP5rlXle1TrDZARZ4fBPAEfdzzl9EsGNsoiR1P19AW7GN2fybVlYFzk4mTCZgg4yk+DabJAxk8sQIG0tmfvVkFb810aERXwygVzw3pyHmSVCEkNjcBjKjMtFKLeODvli0VqyNm78GN/Pbiy0/BnHspPylYeUYQ1mGsgDBVNQdQu48XSOuhz7Horna+NpnjnRKrTENNSnZ0JHplhpJx0fnNRjLI5CduCt0R5VjfHn3UP62RjMJ3bAzkx5CDrwRYsfdrvbuGORMgdIwQcsWqMRJqxVMonT6dx6ws4bnChFOkjpiuVIXoyBLlhF1YxuIaHvWUeiDbIkWgN39ISpMijaOnXOuC9VfxhZROYvdnRYXwemTWBCKfOAfCL65Tb6fVG2AwwU5NTjP9otBj0khUMvijf4GIQD1y/CBJfXdPh4vSeGLGAMsaqgEO8sna5TC4xUBG5ae0HhFOImIVjf63SEle1EmSJte7jHSbal2ZLuRYywcyUCCZOdEJ71zweceNQ0L2hOZc9Nssu2qWItaFqPIgh3yj8f6st1+xDibKTOTEyvZlSxoLKPEaR2ZYKeVILpgEUSD3i9+WbLeMZSxbudmXerABKhyZV1nrWPjtpd2rPGh1xEfVQOUBvxug9uUp2v1PbfPTzVOdKyY5VAr8NBxIHOK/U131mcW60/FMkE50Xx+XwkPFw5tVjQdmmVpMpUejFSdLcyoTzsGdtfept2dncHs61nE79aEJKT/f8+7T/4RO2hWr+VTyT5xEdqD6HqEqz4XNPCSSIUnQy1ASJFIyAVlDn9JAEbGllbtrzmfx9PLxEr1t1mw13i16uQ0LPGt1GREXFp7kCjKmvigdZYCK34FyRYlOo= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Confirms the validity of the given pipeline `name` in a user context. Append `?name=`. Append `?workspaceId` to validate the name in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-pipeline-secret-name.api.mdx b/platform-api-docs/docs/validate-pipeline-secret-name.api.mdx deleted file mode 100644 index 7a35a2f39..000000000 --- a/platform-api-docs/docs/validate-pipeline-secret-name.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-pipeline-secret-name -title: "Validate secret name" -description: "Confirms the validity of the given pipeline secret name in a user context. Append `?name=`. Append `?workspaceId` to validate the name in a workspace context." -sidebar_label: "Validate secret name" -hide_title: true -hide_table_of_contents: true -api: eJzVVdtuEzEQ/RXLz20SoKpExC2UgiqkUtECD6hqnd1J4tZru2NvS7TKvzPj3U02F1oe4SmxfTznzPHMbCWjmgY5/Cm99mC0hf0AGUIM8nJP5hAy1D5qZ+VQHjk70VgEEWcg7pXRuY5z4SZpPdX3YEUbRNRBhFUFCG2FEmUAFJmzEX7Fnhh5DzYX128Z8PrV3JV4VV+54p031x3Ig8Pb4FUGJ/m1iK5mVhES7YpgCVuyyD3pPKBi+Sc5JfC9uXnWqDxPjKcUgqBeIf2JgOxGJTkwXemQE0azDXcl4FxumvNjSW/LAlBnQudgo55oQAKHbAaFksNKxrnnwJo0TtPRxGGhYr11eCAXi70lu62lPUJ73vG5480uxhBR2ynFp4dFCN7ZAIHPnw8O+Gc98JfPYl+cutpMG+ViTx4MBtu49yoXCCQuRCJt0QRT3hudJfP7N4GxVUcTX9EIOVdeASGoKXDBNVLd+AYyjueRXzDqWmgL3JETXdXR8NYxosOvTX50skjKX+zIsK0NYV0Uyhj3QHoS+uU2+kNZpwMCDBSc4z+aLR1SJ5VIvZkK+T0oBByVcUbLS358qvKZ436YQmJVfCT7mwOg3y0mwPu2M0o0BJ/F6MOw31de9zLjyrwX4I4M7Wm3o0j5RJwZFbnYxRHjxejsRLKcVu0521Wn3tW8zJ4Z27rm9TiBaKf+87Fto5uHmCzSduLS9caqRgXTPiWQ09UZhAbM76yy9M7ryXdTpqfWJnXxxL1bHZAQdq7medY7POwNeM+7EAuVyqTp9XY4dUfnptBqVXL/4zRuHpKXfW8UjTVyIjlaNVW44zNE/rV1SMUyI98YVlVjFeAbmsWCt+vhyNWZ66DGhlttokyARwx8YmLvFHsL862PAskrGSl5cP89/Z8n9yPMTVGsKC95gZo5U3uTQ6BySoC9qO+Msgx87NzamlVrQ+HT8QVh1XrvbfRait4cKTvvxKZ3SYgLdwuW3qYVHnlNRDSffgP7le+B -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Confirms the validity of the given pipeline secret name in a user context. Append `?name=`. Append `?workspaceId` to validate the name in a workspace context. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-team-name.api.mdx b/platform-api-docs/docs/validate-team-name.api.mdx deleted file mode 100644 index c84d4710b..000000000 --- a/platform-api-docs/docs/validate-team-name.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-team-name -title: "Validate team name" -description: "Confirms the validity of the given team name. Append `?name=`." -sidebar_label: "Validate team name" -hide_title: true -hide_table_of_contents: true -api: eJytlG1v0zAQx7+K5VcglabAtBcVT9000IQ0pq3wpqo2N7kk3hLbs52OEuW7c+ck6yNMSLxqY//t+935f1dzLzLHxzPuQZSOzwc8ARdbabzUio/5qVaptKVjPge2FIVMpF8xnYbvTC5BMTrJlChhyCbGgErY7Uf6fP9upSt7Q9s39P3hdsgHXBuwgi4/T/D6H3Sj8DBF0QVqUGCExT8eLGHVnE6iUNsMDwy4JCgjfM53Sb/ZTCj5K9zNVFWClTGTCSgvUwkW9RYeKmkB43pbwYC7OIdS8HHN/cpQEKk8ZEGaalsK3y4dH/GmGTyRqBYzgDxUYFd7JNO+IMzrtmaYIT8Qz3krVYa3zwnOGa0cONp/Mzqin50Ev7JX7EKzWCOm8rwZ8KPRaF93IhJGqYLzGLRXo0wYU8g4FCi6c6StN5jW1ZnxEpwTGZAdOlS9uIOY7jOWXtDLFrQXHsgJj0pf0NKZtdpedfnhThPI3x7IsPcGU9ozURT6EXlI7iCuLDovWOIEhAU7qdAE49mciod+yTX5KYPASP4Y8whN46I6WKeJgsGjzecAu+xdVtkCD+TeGzeOImHkMC50lQwdPCDSUOq9R74OO+yyEJ7Mwk5JzyaX55yAet5rKm9bqk3qp2pRxN4Z9L0IIlxp/3zubXj36EMdpEp1ON6VtqOgsM8BUroyBteJyRciDr7YTn4zZbSGLEIXpPrTegNBqHJtnNfD4+PhiNaMdr4UwVZdr/TtvZ4Ru5j12qD/f9Z0Rfbw00emENiySBmyrTuPzGiwOJSO+wHTzkFMsDcKvmaOiZG2rhfCwXdbNA0tt91P9kmkE4uCeicVhYO/5Pin2XAQ9R5W64GD4ookwV9LYSVF/MfoL666Jn/Jnh+XB5G6RaFWm0g9alvEZo7CHESC1xBfuzeJYzB+49TeONrq5C9nU9SK7XbZaY9w+0EifKmgmOp7UPhaPaCnbwJsmt+MMGQp -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Confirms the validity of the given team name. Append `?name=`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-user-name.api.mdx b/platform-api-docs/docs/validate-user-name.api.mdx deleted file mode 100644 index d8fed1059..000000000 --- a/platform-api-docs/docs/validate-user-name.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-user-name -title: "Check that the user name is valid" -description: "Check that the user name is valid" -sidebar_label: "Check that the user name is valid" -hide_title: true -hide_table_of_contents: true -api: eJzNVMFu2zAM/RVB5yzJtqLAfFradUMxoCvWdpeiB8ZmYiWKpUp0usDIv4+U7TRZMmzHXWxLfCIfH5/VaIJ51NmjriOGqJ8G2nkMQMZV14XO9A+wpgDCBw7fwAr1QHsI/EECzx4bXclu1r4G2lT8/Vxj2PCiwJgH4yUZ70oKJTBFTq27vIyKeYkr0FmjaeMlVaRgqrnebplNwOhdFTFK/N34TF6Hab99VW/UjVO5qwgr0tuBPhuPj3EXUKiATC0SF+3RDAPvrclTy6NFFGyzx0mOmICFaLTCGGGOolJH1U0XmEs+H0Q3Mi3RHniiJz5qyMrWVQgufO/648g2MX9/osN+IqpypMBa98J8EvrDMfpT3baDhUKLK2nyP22XgxHzOhjaJCddIAQMk5pKXj7J9A87uywxXyoqgfiBqt75ycTWT0yMjVk6Me4cE0+QZHqU3D3aNx2Gde/gOljGlEQ+ZqMReDPMrauLYcRnFn5o3JGV71JE3VqgmQsrdSl4Nbm91sK6b+pOVG0V2m9tJ5JU7P0v62kC8U778ZkzA49ML14oKWmqmUvHO0U7FlL2bwSlXZNj7MBiB8iTHQ6b32+ZHWEkJmU/vgaYiCjX1nk7PD8fjmXPu0grSG7qboR/GdcB650whD9p5C3wZcKZE8OmG2V/UTGJfpiseMnFJdY0U4j4EOx2K9vtPSQjLkyEqRVbz8BGPCq8+z/+eEudpLbEzevVx+BaIMkDawhGKiYnM0GEgkcrVNozkzxHT3unjn5LybJz85ere8bCoX9+80vK3oWg2uzlZlkS4t4tsWJpeuIkay7Ev+IvJjUROw== -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Check that the user name is valid - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-workflow-constraints.api.mdx b/platform-api-docs/docs/validate-workflow-constraints.api.mdx deleted file mode 100644 index e7daf5d40..000000000 --- a/platform-api-docs/docs/validate-workflow-constraints.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-workflow-constraints -title: "Validate run name" -description: "Check that the given run name of a workflow has a valid format. When the session ID is given: check that no other workflow in the system exists with the combination of both elements." -sidebar_label: "Validate run name" -hide_title: true -hide_table_of_contents: true -api: eJzVVU1v2zAM/SuCzpnTbUWB5bR+bQgGdMW6rYehB8ZmYjW25Up008DIfx8p27HTdG2x03ZpI5Ei+R4f6VoTLLye/NIr65bzzK68vhnpBH3sTEnGFnqiT1OMl4pSIP6DamHusVCuKlQBOSo7V6C61yoFz8d7yEyi5tblQJG6TtlfXnr0nkOq6ZkyvokzUXEfvbDKsp/rw5n24doT5gofjCevVobScB3bfGYKkDKljBk/VphhjgX5SI+0LdEF6zRhGD+lKCC8boOf2sKTA8PO7FuCYzSETtiotUDjN4zyQn6NtBEm7ip0a/2Yny5gzwnZhgLOxt6eIeagJ7WmdSlROa0pFnqzGW0TtdRwoa9LNaDytcm4rw59yajRi/3dwaH8203w9Yt6oy4sU1sQ06g3I314cLDvdwKJcshFem7wtGgavsXfdJ6r6cLweyjLzMShHeNbL0HqQbESyzhMRIo5Y4MFihBbDHZ2i7HEK530lEyDoHN8illNhjK5OnfOum8tcLZsAqT3T0Dv1MI6JAUZ08z1BO8P+95nVQMHk05ykToXfXL+nggokmGrBoL9V8lho8e4cobWYRBOEBy644pSPt6IiHhKUisDtcCQFcSkx93MjodiRHffTVTlMnZLiUo/GY+hNFGc2SqJPN4x75Gxe2K/ChZ1mQGJoNSp+Kvjy6mWMroqr4SmBvKw1i1qydjNhZxnwYlvmh+fGqlO9O2KAjWmmNvwvKWorULSvlSgwDUx+tZZ+gtx6O8u+CFkbrERm6T92Bu4EGGuyfM2OjqKDuSutJ5yCPJoF0e31baae1xl3evs/93kbS8JH2hcZryzhYxAat0KsP+CsftWgqyTlCkTc13PwOMPl202ct3sVxFmYjzMMpmuOWQen6HvpUX/ZJVLXO98SNi/Ei8t2/8vcv9x8z+Tffh16fPfyMEZKSDMNnOFkPBsCCvNw+M4xpIGr/YW1c5G+Hz+nX1hdwAfDVyI3pqgWA9ic4eCx3e7xIK71FVPcuZEvJx+A0LaBK4= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Check that the given run name of a workflow has a valid format. When the session ID is given: check that no other workflow in the system exists with the combination of both elements. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/validate-workspace-name.api.mdx b/platform-api-docs/docs/validate-workspace-name.api.mdx deleted file mode 100644 index 9c0487af9..000000000 --- a/platform-api-docs/docs/validate-workspace-name.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: validate-workspace-name -title: "Validate workspace name" -description: "Confirms the validity of the given workspace name within the organization identified by the given `orgId`. Append `?name=`." -sidebar_label: "Validate workspace name" -hide_title: true -hide_table_of_contents: true -api: eJzNVctu2zAQ/BWCpxZwLbcNAtToy0nTIiiQBknaHAwjpqW1xUQmGZKy6wr69+5Ski0/0KC3nCSRQ+7s7Oyq4F7MHO8P+VLbB2dEDI6POjwBF1tpvNSK9/mpVlNp5475FNhCZDKRfsX0NHzP5AIUWx9nSsyBLaVPpQr72s6Ekn8E3cVkAsrLqYSETVat42NEnSfjLhsYAyph4090zYf3K53bu/Xdd7T4cdzlHa4N2HDleYIEfxEn4eG2QV4gEFFGWHzxYCnFgtNxRIdYuCspNyN8yncT/tHmrPI5WBlvuFvEW3jMpQUM7m0OHe7iFOaC9wvuV4aCSOVhFqBTbefCV0vHR7wsO2smqqIZiDzmYFd7TG63dfW60h9z5QeCOm+lmmGIETF0RiuH9cT9N70jeuxk+Z29YheaxRq5Ks/LDj/q9fZxJyJhlC84j0EbNMKEMZmMg0rRvSNs0eK0kWjI5+CcmAFZq6aqJ/cQ033GUi29rIg2wAM54VHpM1o6s1bbqzo/3CkD87cHMmxcwpT2TGSZXiKfgH63j/6SV+kAgwzmlOMzzRY3HcS5xS4Mvj4BYcEOcnRyfzii4qPpU02dMYMQlUze5xE630VF8H8ZbTo+ansK7KLpl9xmeCr13rh+FAkju3Gm86Tr4BF17Uq9Z9frsMMuM+HJ9uyU8Gxwec6JVUP6mlSrFGhTX4tAERt70/ckgHClevnaNNT90gelpJrqcLxWrGZBYZ8iSOlKlKAGU7lFHMq9nXw7Zay4zEI/T/XnzQYSIeWqOK+7x8fdHq0Z7fxcBLfUXd9Mq52hucu12JjvOU7gulYefvvIZAJnGCYbRCtqvw1p0jqE9puJ2/rJoFiN6dAZKYpEB4piIhz8tFlZ0nI1E8mKiXRiklF7TUXm4B9S/XNiHiT9AKvNLEZwTpBg2IWwksL+J4UXV/UweMme/pMcpFQvCrVqU2qoVnKWIwSmIBK8hvhVe4M4BuNbp/bG1tZ8+HZ2g1ix3X87/RZuP8gIyxUQN/oBFJasIejpmwiW5V/d0Okn -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Confirms the validity of the given workspace name within the organization identified by the given `orgId`. Append `?name=`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/scripts/extract-api-tables.mjs b/platform-api-docs/scripts/extract-api-tables.mjs deleted file mode 100644 index e6cae5346..000000000 --- a/platform-api-docs/scripts/extract-api-tables.mjs +++ /dev/null @@ -1,187 +0,0 @@ -import fs from 'fs'; -import path from 'path'; -import YAML from 'yaml'; -import { fileURLToPath } from 'url'; -import { parse } from 'yaml'; - -const __filename = fileURLToPath(import.meta.url); -const __dirname = path.dirname(__filename); - -const SPEC_PATH = path.resolve(__dirname, './specs/seqera-api-1.85-decorated.yml'); -const OUTPUT_DIR = path.resolve(__dirname, '../docs/info/parameter-tables'); - -// Utility to safely dereference $ref fields -function resolveRef(ref, spec) { - const parts = ref.replace(/^#\//, '').split('/'); - return parts.reduce((obj, key) => (obj ? obj[key] : null), spec); -} - -function formatParameter(param) { - return { - Name: `\`${param.name}\``, - Type: param.schema?.type || 'unknown', - Location: param.in || 'unknown', - 'Req/Opt': param.required ? 'Required' : 'Optional', - Description: (param.description || '').replace(/\n/g, ' '), - }; -} - -function formatRequestBody(schema, spec, required = [], parentPath = '') { - const properties = schema?.properties || {}; - const rows = []; - - for (const [key, prop] of Object.entries(properties)) { - const resolved = prop.$ref ? resolveRef(prop.$ref, spec) : prop; - const fullKey = parentPath ? `${parentPath}.${key}` : key; - - // Add row for this field - rows.push({ - Name: fullKey, - Type: resolved.type || 'object', - 'Req/Opt': required.includes(key) ? 'Required' : 'Optional', - Description: (resolved.description || '').replace(/\n/g, ' '), - }); - - // Recurse into nested object - if (resolved.type === 'object' && resolved.properties) { - const childRequired = resolved.required || []; - rows.push(...formatRequestBody(resolved, spec, childRequired, fullKey)); - } - - // Handle arrays of objects - if (resolved.type === 'array' && resolved.items) { - const items = resolved.items.$ref - ? resolveRef(resolved.items.$ref, spec) - : resolved.items; - - if (items.type === 'object' && items.properties) { - const childRequired = items.required || []; - rows.push(...formatRequestBody(items, spec, childRequired, `${fullKey}[]`)); - } - } - } - - return rows; -} - - -function formatResponseBody(schema, spec, required = []) { - const properties = schema?.properties || {}; - return Object.entries(properties).map(([key, prop]) => { - const resolved = prop.$ref ? resolveRef(prop.$ref, spec) : prop; - return { - Name: ` ${key}`, - Type: resolved.type || 'object', - 'Req/Opt': required.includes(key) ? 'Required' : 'Optional', - Description: (resolved.description || '').replace(/\n/g, ' '), - }; - }); -} - -function writeYaml(filePath, data) { - fs.mkdirSync(path.dirname(filePath), { recursive: true }); - fs.writeFileSync(filePath, YAML.stringify(data), 'utf-8'); - console.log(`✅ Wrote: ${filePath}`); -} - -const specContent = fs.readFileSync(SPEC_PATH, 'utf-8'); -const spec = parse(specContent); - -const taggedOps = {}; - -for (const [pathKey, pathItem] of Object.entries(spec.paths)) { - for (const method of Object.keys(pathItem)) { - const op = pathItem[method]; - if (!op.tags) continue; - - for (const tag of op.tags) { - if (!taggedOps[tag]) taggedOps[tag] = []; - - taggedOps[tag].push({ - path: pathKey, - method: method.toUpperCase(), - operationId: op.operationId, - summary: op.summary, - parameters: [...(pathItem.parameters || []), ...(op.parameters || [])], - requestBody: op.requestBody, - }); - } - } -} - -for (const [tag, operations] of Object.entries(taggedOps)) { - const paramRows = []; - const bodyRows = []; - const responseRows = []; - - operations.forEach((op) => { - op.parameters.forEach((p) => { - const param = p.$ref ? resolveRef(p.$ref, spec) : p; - paramRows.push(formatParameter(param)); - }); - - if (op.requestBody?.content?.['application/json']?.schema) { - const schema = op.requestBody.content['application/json'].schema; - const resolved = schema.$ref ? resolveRef(schema.$ref, spec) : schema; - const reqList = resolved.required || []; - - const sectionLabel = { - Name: `**${op.operationId}**`, - Type: '', - 'Req/Opt': '', - Description: op.summary || '', - }; - bodyRows.push(sectionLabel); - bodyRows.push(...formatRequestBody(resolved, spec, reqList)); - } - - operations.forEach((op) => { - const response = op.responses?.['200']?.content?.['application/json']?.schema; - if (!response) return; - - const resolved = response.$ref ? resolveRef(response.$ref, spec) : response; - const reqList = resolved.required || []; - - const sectionLabel = { - Name: `**${op.operationId}**`, - Type: '', - 'Req/Opt': '', - Description: op.summary || '', - }; - responseRows.push(sectionLabel); - - if (resolved.properties) { - responseRows.push(...formatResponseBody(resolved, spec, reqList)); - } else { - responseRows.push({ - Name: ' (no properties)', - Type: resolved.type || 'object', - 'Req/Opt': '', - Description: 'No properties defined in response schema or unable to resolve.', - }); - } - }); - }); - - const safeTag = tag.replace(/\s+/g, '-').toLowerCase(); - const tagDir = path.join(OUTPUT_DIR, safeTag); - - // Deduplicate parameters by name and location - const seenParams = new Set(); - const uniqueParams = paramRows.filter((param) => { - const key = `${param.Name}|${param.Location}`; - if (seenParams.has(key)) return false; - seenParams.add(key); - return true; - }); - - if (paramRows.length > 0) { - writeYaml(path.join(tagDir, `parameters.yml`), uniqueParams); - } - if (bodyRows.length > 0) { - writeYaml(path.join(tagDir, `request-bodies.yml`), bodyRows); - } - if (responseRows.length > 0) { - writeYaml(path.join(tagDir, `responses.yml`), responseRows); - } -} diff --git a/platform-api-docs/scripts/overlays_archive/base-1.66-to-1.85-changes-overlay.yaml b/platform-api-docs/scripts/overlays_archive/base-1.66-to-1.85-changes-overlay.yaml deleted file mode 100644 index 50c3eebbc..000000000 --- a/platform-api-docs/scripts/overlays_archive/base-1.66-to-1.85-changes-overlay.yaml +++ /dev/null @@ -1,1263 +0,0 @@ -overlay: 1.0.0 -x-speakeasy-jsonpath: rfc9535 -info: - title: Overlay seqera-api-old-base.yml => seqera-api-1.85.0.yml - version: 0.0.0 -actions: - - target: $["info"]["version"] - update: 1.85.0 - - target: $["paths"]["/compute-envs"]["get"]["parameters"] - update: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`, `resources`). Returns an empty value (ex. `labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/ComputeEnvQueryAttribute" - - target: $["paths"]["/datasets"]["get"]["parameters"][*] - remove: true - - target: $["paths"]["/datasets"]["get"]["parameters"] - update: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Search query - schema: - type: string - - name: sortBy - in: query - description: "Sort field supports (`name`, `modified`), defaults to `name`" - schema: - type: string - - name: sortDir - in: query - description: "Sort direction supports (`asc`, `desc`), defaults to `asc`" - schema: - type: string - - name: visibility - in: query - description: "Visibility option supports (`visible`, `hidden`, `all`), defaults to `visible`" - schema: - type: string - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/DatasetQueryAttribute" - - target: $["paths"]["/datasets"] - update: - delete: - tags: - - datasets - summary: Delete dataset - description: Deletes the dataset identified by the given `datasetId`. - operationId: DeleteDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteDatasetsRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteDatasetsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "204": - description: DeleteDatasets 204 response - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteDatasetsResponse" - security: - - BearerAuth: [] - - target: $["paths"] - update: - /datasets/hide: - post: - tags: - - datasets - summary: Hide dataset - description: Hide the given `datasetIds` - operationId: HideDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Dataset ids to be hidden. - content: - application/json: - schema: - $ref: "#/components/schemas/ChangeDatasetVisibilityRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - - target: $["paths"] - update: - /datasets/labels/add: - post: - tags: - - labels - summary: Add labels to datasets - description: Adds the given list of labels to the given datasets. Existing labels are preserved. - operationId: AddLabelsToDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateDatasetsLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - - target: $["paths"] - update: - /datasets/labels/apply: - post: - tags: - - labels - summary: Replace datasets labels - description: Applies the given list of labels to the given datasets. Existing labels are replaced - include labels to be preserved in `labelIds`. Only simple labels can be attached to datasets - operationId: ApplyLabelsToDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateDatasetsLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - "400": - description: "Invalid request, if trying to associate resource labels" - security: - - BearerAuth: [] - - target: $["paths"] - update: - /datasets/labels/remove: - post: - tags: - - labels - summary: Remove labels from datasets - description: Removes the given list of labels from the given datasets. - operationId: RemoveLabelsFromDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateDatasetsLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - - target: $["paths"] - update: - /datasets/show: - post: - tags: - - datasets - summary: Show dataset - description: Show the given `datasetIds` - operationId: ShowDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Dataset ids to be shown. - content: - application/json: - schema: - $ref: "#/components/schemas/ChangeDatasetVisibilityRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - - target: $["paths"]["/datasets/versions"]["get"]["parameters"][*] - remove: true - - target: $["paths"]["/datasets/versions"]["get"]["parameters"] - update: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: mimeType - in: query - description: Dataset MIME type - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Search query - schema: - type: string - - target: $["paths"]["/datasets/{datasetId}/metadata"]["get"]["parameters"] - update: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/DatasetQueryAttribute" - - target: $["paths"] - update: - /datasets/{datasetId}/versions/{version}/disable: - post: - tags: - - datasets - summary: Disable a dataset version - description: "Disable a dataset version, the dataset version cannot be used for runs, and cannot be enabled again" - operationId: DisableDatasetVersion - parameters: - - name: datasetId - in: path - description: The dataset string id the version belongs to - required: true - schema: - type: string - - name: version - in: path - description: The version number to disable - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - - target: $["paths"]["/orgs/{orgId}/workspaces/validate"]["get"]["operationId"] - update: ValidateWorkspaceName - - target: $["paths"]["/orgs/{orgId}/workspaces/{workspaceId}/settings/studios"]["put"]["responses"]["200"] - remove: true - - target: $["paths"]["/pipelines"]["get"]["parameters"][*] - remove: true - - target: $["paths"]["/pipelines"]["get"]["parameters"] - update: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns an empty value (`labels: null`, etc.) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: sortBy - in: query - description: Sort field (`NAME` by default) - schema: - $ref: "#/components/schemas/PipelineListParams.SortBy" - - name: sortDir - in: query - description: Sort direction (`ASCENDING` by default) - schema: - $ref: "#/components/schemas/PipelineListParams.SortDir" - - name: search - in: query - description: Filter search parameter - schema: - type: string - - name: visibility - in: query - description: Filter visibility parameter - schema: - type: string - - target: $["paths"]["/pipelines/{pipelineId}"]["put"]["description"] - update: "Updates the details of the pipeline identified by the given `pipelineId`. \n **Note**: If `labelIds` is `null`, empty, or omitted, existing pipeline labels are removed.\n Include `labelIds: [,]` to override existing labels. Labels to be preserved must be included.\n To append a list of labels to multiple pipelines, use `/pipelines/labels/add`." - - target: $["paths"]["/workflow/{workflowId}/log"]["get"]["operationId"] - update: GetWorkflowLog - - target: $["paths"]["/workspaces/{workspaceId}/datasets/{datasetId}/metadata"]["get"]["parameters"] - update: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/DatasetQueryAttribute" - - target: $["components"]["schemas"]["AbstractGridConfig"] - update: - allOf: - - $ref: "#/components/schemas/ComputeConfig" - - properties: - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - - target: $["components"]["schemas"]["AbstractGridConfig"]["properties"] - remove: true - - target: $["components"]["schemas"]["Action.TowerActionConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["Action.TowerActionEvent"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["ActiveConnection"]["required"] - remove: true - - target: $["components"]["schemas"]["AgentSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - workDir: - type: string - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - launchDir: - type: string - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - userName: - type: string - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - hostName: - type: string - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - port: - type: integer - format: int32 - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - headQueue: - type: string - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - computeQueue: - type: string - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - maxQueueSize: - type: integer - format: int32 - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - headJobOptions: - type: string - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - propagateHeadJobOptions: - type: boolean - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - preRunScript: - type: string - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - postRunScript: - type: string - - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"][1]["properties"] - update: - nextflowConfig: - type: string - - target: $["components"]["schemas"] - update: - AssociateDatasetsLabelsRequest: - type: object - properties: - datasetIds: - type: array - items: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - - target: $["components"]["schemas"]["AwsBatchConfig"]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["AwsBatchConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["AwsCloudConfig"]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["AwsCloudConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["AwsSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["AzBatchConfig"]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["AzBatchConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["AzCloudConfig"]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["AzCloudConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"] - update: - AzCloudPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - containers: - type: array - items: - type: string - instanceTypes: - type: array - items: - type: string - - target: $["components"]["schemas"] - update: - AzureCloudKeys: - type: object - allOf: - - $ref: "#/components/schemas/AzureSecurityKeys" - - properties: - discriminator: - type: string - subscriptionId: - type: string - storageName: - type: string - tenantId: - type: string - clientId: - type: string - clientSecret: - type: string - writeOnly: true - - target: $["components"]["schemas"]["AzureEntraKeys"]["allOf"][1]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["AzureReposSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["AzureReposSecurityKeys"]["properties"] - update: - token: - type: string - - target: $["components"]["schemas"]["AzureSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["BitBucketSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"] - update: - ChangeDatasetVisibilityRequest: - type: object - properties: - datasetIds: - type: array - items: - type: string - - target: $["components"]["schemas"]["CodeCommitSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["CodeCommitSecurityKeys"]["properties"] - update: - token: - type: string - - target: $["components"]["schemas"]["ComputeConfig"]["discriminator"]["mapping"] - update: - local-platform: "#/components/schemas/LocalComputeConfig" - - target: $["components"]["schemas"]["ComputeConfig"]["oneOf"][*] - remove: true - - target: $["components"]["schemas"]["ComputeConfig"]["oneOf"] - update: - - $ref: "#/components/schemas/AwsBatchConfig" - - $ref: "#/components/schemas/AwsCloudConfig" - - $ref: "#/components/schemas/SeqeraComputeConfig" - - $ref: "#/components/schemas/GoogleLifeSciencesConfig" - - $ref: "#/components/schemas/GoogleBatchConfig" - - $ref: "#/components/schemas/GoogleCloudConfig" - - $ref: "#/components/schemas/AzBatchConfig" - - $ref: "#/components/schemas/AzCloudConfig" - - $ref: "#/components/schemas/LsfComputeConfig" - - $ref: "#/components/schemas/SlurmComputeConfig" - - $ref: "#/components/schemas/K8sComputeConfig" - - $ref: "#/components/schemas/EksComputeConfig" - - $ref: "#/components/schemas/GkeComputeConfig" - - $ref: "#/components/schemas/UnivaComputeConfig" - - $ref: "#/components/schemas/AltairPbsComputeConfig" - - $ref: "#/components/schemas/MoabComputeConfig" - - $ref: "#/components/schemas/LocalComputeConfig" - - target: $["components"]["schemas"]["ComputeEnv.Status"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["ComputeEnvQueryAttribute"]["enum"] - update: - - resources - - target: $["components"]["schemas"]["ComputeEnvQueryAttribute"]["x-enum-varnames"] - update: - - resources - - target: $["components"]["schemas"] - update: - ComputeEnvResources: - type: object - properties: - cpus: - type: integer - format: int32 - nullable: true - memory: - type: integer - format: int32 - nullable: true - gpus: - type: integer - format: int32 - nullable: true - diskSize: - type: integer - format: int32 - nullable: true - estimatedPrice: - type: number - format: float - nullable: true - instanceType: - type: string - nullable: true - - target: $["components"]["schemas"]["ComputeEnvResponseDto"]["properties"] - update: - resources: - nullable: true - allOf: - - $ref: "#/components/schemas/ComputeEnvResources" - - target: $["components"]["schemas"]["ContainerRegistryKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["DataStudioCreateRequest"]["required"][*] - remove: true - - target: $["components"]["schemas"]["DataStudioCreateRequest"]["required"] - update: - - computeEnvId - - name - - target: $["components"]["schemas"]["DataStudioCreateRequest"]["properties"]["dataStudioToolUrl"]["minLength"] - remove: true - - target: $["components"]["schemas"]["DataStudioCreateRequest"]["properties"] - update: - remoteConfig: - nullable: true - allOf: - - $ref: "#/components/schemas/StudioRemoteConfiguration" - - target: $["components"]["schemas"]["DataStudioDto"]["properties"] - update: - remoteConfig: - $ref: "#/components/schemas/StudioRemoteConfiguration" - - target: $["components"]["schemas"]["DataStudioWorkspaceSettingsResponse"]["required"] - remove: true - - target: $["components"]["schemas"]["DatasetDto"]["properties"] - update: - hidden: - type: boolean - - target: $["components"]["schemas"]["DatasetDto"]["properties"] - update: - runsInfo: - $ref: "#/components/schemas/DatasetRunsInfo" - - target: $["components"]["schemas"] - update: - DatasetQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - - target: $["components"]["schemas"] - update: - DatasetRunsInfo: - type: object - properties: - runsCount: - type: integer - format: int64 - lastUsed: - type: string - format: date-time - - target: $["components"]["schemas"]["DatasetVersionDto"]["properties"] - update: - dateCreated: - type: string - format: date-time - - target: $["components"]["schemas"]["DatasetVersionDto"]["properties"] - update: - disabled: - type: boolean - - target: $["components"]["schemas"] - update: - DeleteDatasetsRequest: - type: object - properties: - datasetIds: - type: array - items: - type: string - - target: $["components"]["schemas"] - update: - DeleteDatasetsResponse: - type: object - properties: - success: - type: array - items: - type: string - failed: - type: array - items: - type: string - - target: $["components"]["schemas"]["EksComputeConfig"]["allOf"][1]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["EksComputeConfig"]["allOf"][1]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["EksComputeConfig"]["allOf"][1]["properties"]["workDir"] - remove: true - - target: $["components"]["schemas"]["EksComputeConfig"]["allOf"][1]["properties"]["preRunScript"] - remove: true - - target: $["components"]["schemas"]["EksComputeConfig"]["allOf"][1]["properties"]["postRunScript"] - remove: true - - target: $["components"]["schemas"]["EksComputeConfig"]["allOf"][1]["properties"]["nextflowConfig"] - remove: true - - target: $["components"]["schemas"]["GitHubSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["GitHubSecurityKeys"]["properties"] - update: - token: - type: string - - target: $["components"]["schemas"]["GitLabSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["GiteaSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["GiteaSecurityKeys"]["properties"] - update: - token: - type: string - - target: $["components"]["schemas"]["GithubActionConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["GithubActionEvent"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["GkeComputeConfig"]["allOf"][1]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["GkeComputeConfig"]["allOf"][1]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["GkeComputeConfig"]["allOf"][1]["properties"]["workDir"] - remove: true - - target: $["components"]["schemas"]["GkeComputeConfig"]["allOf"][1]["properties"]["preRunScript"] - remove: true - - target: $["components"]["schemas"]["GkeComputeConfig"]["allOf"][1]["properties"]["postRunScript"] - remove: true - - target: $["components"]["schemas"]["GkeComputeConfig"]["allOf"][1]["properties"]["nextflowConfig"] - remove: true - - target: $["components"]["schemas"]["GoogleBatchConfig"]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["GoogleBatchConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["GoogleCloudConfig"]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["GoogleCloudConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["GoogleLifeSciencesConfig"]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["GoogleLifeSciencesConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["GoogleSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["K8sComputeConfig"]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["K8sComputeConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["K8sSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["Launch"]["properties"] - update: - commitId: - maxLength: 40 - type: string - - target: $["components"]["schemas"]["ListComputeEnvsResponse.Entry"]["properties"] - update: - labels: - type: array - nullable: true - items: - $ref: "#/components/schemas/LabelDbDto" - - target: $["components"]["schemas"]["ListComputeEnvsResponse.Entry"]["properties"] - update: - resources: - nullable: true - allOf: - - $ref: "#/components/schemas/ComputeEnvResources" - - target: $["components"]["schemas"]["ListDatasetVersionsResponse"]["properties"] - update: - totalSize: - type: integer - format: int64 - - target: $["components"]["schemas"]["ListDatasetsResponse"]["properties"] - update: - totalSize: - type: integer - format: int64 - - target: $["components"]["schemas"] - update: - LocalComputeConfig: - title: Local execution configuration - type: object - properties: - discriminator: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - nextflowConfig: - type: string - - target: $["components"]["schemas"] - update: - LocalSecurityKeys: - title: Local security keys - type: object - properties: - discriminator: - type: string - password: - type: string - writeOnly: true - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - workDir: - type: string - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - launchDir: - type: string - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - userName: - type: string - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - hostName: - type: string - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - port: - type: integer - format: int32 - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - headQueue: - type: string - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - computeQueue: - type: string - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - maxQueueSize: - type: integer - format: int32 - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - headJobOptions: - type: string - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - propagateHeadJobOptions: - type: boolean - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - preRunScript: - type: string - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - postRunScript: - type: string - - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"][1]["properties"] - update: - nextflowConfig: - type: string - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - workDir: - type: string - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - launchDir: - type: string - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - userName: - type: string - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - hostName: - type: string - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - port: - type: integer - format: int32 - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - headQueue: - type: string - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - computeQueue: - type: string - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - maxQueueSize: - type: integer - format: int32 - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - headJobOptions: - type: string - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - propagateHeadJobOptions: - type: boolean - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - preRunScript: - type: string - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - postRunScript: - type: string - - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"][1]["properties"] - update: - nextflowConfig: - type: string - - target: $["components"]["schemas"]["PipelineInfo"]["properties"] - update: - revisionName: - type: string - nullable: true - - target: $["components"]["schemas"]["PipelineInfo"]["properties"] - update: - commitId: - type: string - nullable: true - - target: $["components"]["schemas"] - update: - PipelineListParams.SortBy: - type: string - enum: - - CREATED - - MODIFIED - - NAME - - target: $["components"]["schemas"] - update: - PipelineListParams.SortDir: - type: string - enum: - - ASCENDING - - DESCENDING - - target: $["components"]["schemas"]["PlatformMetainfo"]["discriminator"]["mapping"] - update: - google: "#/components/schemas/GooglePlatformMetainfo" - - target: $["components"]["schemas"]["PlatformMetainfo"]["discriminator"]["mapping"] - update: - azure-cloud: "#/components/schemas/AzCloudPlatformMetaInfo" - - target: $["components"]["schemas"]["PlatformMetainfo"]["oneOf"][*] - remove: true - - target: $["components"]["schemas"]["PlatformMetainfo"]["oneOf"] - update: - - $ref: "#/components/schemas/AwsBatchPlatformMetainfo" - - $ref: "#/components/schemas/AwsCloudPlatformMetainfo" - - $ref: "#/components/schemas/GooglePlatformMetainfo" - - $ref: "#/components/schemas/GoogleCloudPlatformMetaInfo" - - $ref: "#/components/schemas/AzBatchPlatformMetainfo" - - $ref: "#/components/schemas/AzCloudPlatformMetaInfo" - - $ref: "#/components/schemas/EksPlatformMetaInfo" - - $ref: "#/components/schemas/GkePlatformMetaInfo" - - $ref: "#/components/schemas/K8sPlatformMetaInfo" - - $ref: "#/components/schemas/GridPlatformMetainfo" - - $ref: "#/components/schemas/SeqeraComputePlatformMetainfo" - - $ref: "#/components/schemas/LocalPlatformMetainfo" - - target: $["components"]["schemas"]["S3SecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["SSHSecurityKeys"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["SecurityKeys"]["discriminator"]["mapping"] - update: - azure-cloud: "#/components/schemas/AzureCloudKeys" - - target: $["components"]["schemas"]["SecurityKeys"]["discriminator"]["mapping"] - update: - local: "#/components/schemas/LocalSecurityKeys" - - target: $["components"]["schemas"]["SecurityKeys"]["oneOf"][*] - remove: true - - target: $["components"]["schemas"]["SecurityKeys"]["oneOf"] - update: - - $ref: "#/components/schemas/AwsSecurityKeys" - - $ref: "#/components/schemas/GoogleSecurityKeys" - - $ref: "#/components/schemas/GitHubSecurityKeys" - - $ref: "#/components/schemas/GitLabSecurityKeys" - - $ref: "#/components/schemas/BitBucketSecurityKeys" - - $ref: "#/components/schemas/GiteaSecurityKeys" - - $ref: "#/components/schemas/SSHSecurityKeys" - - $ref: "#/components/schemas/K8sSecurityKeys" - - $ref: "#/components/schemas/AzureSecurityKeys" - - $ref: "#/components/schemas/AzureCloudKeys" - - $ref: "#/components/schemas/AzureReposSecurityKeys" - - $ref: "#/components/schemas/ContainerRegistryKeys" - - $ref: "#/components/schemas/AgentSecurityKeys" - - $ref: "#/components/schemas/CodeCommitSecurityKeys" - - $ref: "#/components/schemas/AzureEntraKeys" - - $ref: "#/components/schemas/SeqeraComputeSecurityKeys" - - $ref: "#/components/schemas/S3SecurityKeys" - - $ref: "#/components/schemas/LocalSecurityKeys" - - target: $["components"]["schemas"]["SeqeraComputeConfig"]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["SeqeraComputeConfig"]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["SeqeraComputeSecurityKeys"]["allOf"][1]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["ServiceInfo"]["properties"]["navbar"] - update: - deprecated: true - - target: $["components"]["schemas"]["ServiceInfo"]["properties"]["navbar"] - update: - allOf: - - $ref: "#/components/schemas/NavbarConfig" - - target: $["components"]["schemas"]["ServiceInfo"]["properties"]["navbar"]["$ref"] - remove: true - - target: $["components"]["schemas"]["ServiceInfo"]["properties"] - update: - seqeraComputeEnabled: - type: boolean - - target: $["components"]["schemas"]["ServiceInfo"]["properties"]["scmsServerUrl"] - remove: true - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - workDir: - type: string - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - launchDir: - type: string - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - userName: - type: string - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - hostName: - type: string - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - port: - type: integer - format: int32 - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - headQueue: - type: string - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - computeQueue: - type: string - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - maxQueueSize: - type: integer - format: int32 - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - headJobOptions: - type: string - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - propagateHeadJobOptions: - type: boolean - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - preRunScript: - type: string - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - postRunScript: - type: string - - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"][1]["properties"] - update: - nextflowConfig: - type: string - - target: $["components"]["schemas"] - update: - StudioRemoteConfiguration: - required: - - repository - type: object - properties: - repository: - type: string - revision: - type: string - nullable: true - commitId: - type: string - nullable: true - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"]["discriminator"]["description"] - remove: true - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"]["discriminator"]["readOnly"] - remove: true - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - workDir: - type: string - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - launchDir: - type: string - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - userName: - type: string - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - hostName: - type: string - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - port: - type: integer - format: int32 - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - headQueue: - type: string - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - computeQueue: - type: string - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - maxQueueSize: - type: integer - format: int32 - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - headJobOptions: - type: string - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - propagateHeadJobOptions: - type: boolean - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - preRunScript: - type: string - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - postRunScript: - type: string - - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"][1]["properties"] - update: - nextflowConfig: - type: string - - target: $["components"]["schemas"]["UserInfo"]["required"] - remove: true - - target: $["components"]["schemas"]["WorkflowLaunchRequest"]["properties"] - update: - commitId: - type: string - - target: $["components"]["schemas"]["WorkflowLaunchResponse"]["properties"] - update: - commitId: - type: string - - target: $["components"]["schemas"]["SeqeraComputePlatformDescriber"] - remove: true diff --git a/platform-api-docs/scripts/overlays_archive/ce-param-descriptions-overlay-final.yaml b/platform-api-docs/scripts/overlays_archive/ce-param-descriptions-overlay-final.yaml deleted file mode 100644 index d8664cf96..000000000 --- a/platform-api-docs/scripts/overlays_archive/ce-param-descriptions-overlay-final.yaml +++ /dev/null @@ -1,1041 +0,0 @@ -overlay: "1.0.0" -info: - title: "Compute environment parameter descriptions" - version: "2.0.0" - description: "Comprehensive descriptions for all compute environment parameters - path, query, request body, and platform configs" - -actions: - # ===== PATH AND QUERY PARAMETERS ===== - - # GET /compute-envs - List compute environments - - target: "$.paths./compute-envs.get.parameters[?(@.name=='status')]" - update: - description: "Filter by compute environment status." - schema: - type: string - enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID"] - - - target: "$.paths./compute-envs.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier. If omitted, lists compute environments in a user context." - - # POST /compute-envs - Create compute environment - - target: "$.paths./compute-envs.post.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier. If omitted, creates compute environment in a user context." - - # GET /compute-envs/validate - Validate compute environment name - - target: "$.paths./compute-envs/validate.get.parameters[?(@.name=='name')].description" - update: "Compute environment name to validate for uniqueness and format." - - - target: "$.paths./compute-envs/validate.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier. If omitted, validates compute environment name in a user context." - - - target: "$.paths./compute-envs/validate.get.parameters[?(@.name=='orgId')].description" - update: "Organization numeric identifier. Used for organization-level compute environment name validation." - - # GET /compute-envs/{computeEnvId} - Describe compute environment - - target: "$.paths./compute-envs/{computeEnvId}.get.parameters[?(@.name=='computeEnvId')].description" - update: "Compute environment alphanumeric identifier." - - - target: "$.paths./compute-envs/{computeEnvId}.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - - target: "$.paths./compute-envs/{computeEnvId}.get.parameters[?(@.name=='attributes')]" - update: - description: "Additional attribute values to include in the response. Returns `labels: null` if omitted." - schema: - type: array - items: - type: string - enum: ["labels"] - - # PUT /compute-envs/{computeEnvId} - Update compute environment - - target: "$.paths./compute-envs/{computeEnvId}.put.parameters[?(@.name=='computeEnvId')].description" - update: "Compute environment alphanumeric identifier." - - - target: "$.paths./compute-envs/{computeEnvId}.put.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - # DELETE /compute-envs/{computeEnvId} - Delete compute environment - - target: "$.paths./compute-envs/{computeEnvId}.delete.parameters[?(@.name=='computeEnvId')].description" - update: "Compute environment alphanumeric identifier." - - - target: "$.paths./compute-envs/{computeEnvId}.delete.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - # POST /compute-envs/{computeEnvId}/primary - Set primary compute environment - - target: "$.paths./compute-envs/{computeEnvId}/primary.post.parameters[?(@.name=='computeEnvId')].description" - update: "Compute environment alphanumeric identifier." - - - target: "$.paths./compute-envs/{computeEnvId}/primary.post.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - # ===== REQUEST BODY PARAMETERS - CreateComputeEnvRequest ===== - - # CreateComputeEnvRequest - Add required fields - - target: "$.components.schemas.CreateComputeEnvRequest" - update: - required: ["computeEnv"] - - # CreateComputeEnvRequest - Top level - - target: "$.components.schemas.CreateComputeEnvRequest.properties.computeEnv" - update: - description: "Compute environment configuration object." - - - target: "$.components.schemas.CreateComputeEnvRequest.properties.labelIds" - update: - description: "Array of label IDs to assign to the compute environment." - - # ComputeEnv_ComputeConfig_ - Add required fields - - target: "$.components.schemas.ComputeEnv_ComputeConfig_" - update: - required: ["name", "platform", "config"] - - # ComputeEnv_ComputeConfig_ - Main compute environment fields - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.credentialsId" - update: - description: "Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See [Create credentials](https://docs.seqera.io/platform-api/create-credentials)." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.orgId" - update: - description: "Organization numeric identifier (read-only, set by system)." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.workspaceId" - update: - description: "Workspace numeric identifier (read-only, set by system)." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.id" - update: - description: "Compute environment alphanumeric identifier (read-only, generated by system)." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.name" - update: - description: "Unique name for the compute environment. Must consist of 1-100 alphanumeric, dash, or underscore characters." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.description" - update: - description: "Description of the compute environment. Maximum length: 2000 characters." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.platform" - update: - description: "Compute platform provider." - enum: ["aws-batch", "aws-cloud", "google-batch", "google-cloud", "azure-batch", "azure-cloud", "k8s-platform", "eks-platform", "gke-platform", "slurm-platform", "lsf-platform", "uge-platform", "moab-platform", "altair-platform", "local-platform", "seqeracompute-platform"] - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.config" - update: - description: "Platform-specific configuration. Structure depends on the selected platform." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.dateCreated" - update: - description: "Creation timestamp (read-only, set by system)." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.lastUpdated" - update: - description: "Last update timestamp (read-only, updated by system)." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.lastUsed" - update: - description: "Last usage timestamp (read-only, updated by system)." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.deleted" - update: - description: "Deletion status flag (read-only, updated by system)." - - - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.status" - update: - description: "Current status of the compute environment (read-only)." - enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID"] - - # UpdateComputeEnvRequest - No required fields for update - - target: "$.components.schemas.UpdateComputeEnvRequest.properties.name" - update: - description: "New name for the compute environment. Must be unique within workspace." - - - target: "$.components.schemas.UpdateComputeEnvRequest.properties.credentialsId" - update: - description: "Updated credentials identifier. Changing credentials may affect running workflows." - - # ===== COMMON CONFIG FIELDS (ComputeConfig base) ===== - - - target: "$.components.schemas.ComputeConfig.properties.workDir" - update: - description: "Work directory path for storing intermediate workflow files." - - - target: "$.components.schemas.ComputeConfig.properties.preRunScript" - update: - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.ComputeConfig.properties.postRunScript" - update: - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.ComputeConfig.properties.environment" - update: - description: "Environment variables to set in the compute environment." - - - target: "$.components.schemas.ComputeConfig.properties.nextflowConfig" - update: - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - - - target: "$.components.schemas.ComputeConfig.properties.discriminator" - update: - description: "Platform type discriminator (read-only, set based on platform selection)." - - # ConfigEnvVariable - - target: "$.components.schemas.ConfigEnvVariable" - update: - required: ["name", "value"] - - - target: "$.components.schemas.ConfigEnvVariable.properties.name" - update: - description: "Environment variable name." - - - target: "$.components.schemas.ConfigEnvVariable.properties.value" - update: - description: "Environment variable value." - - - target: "$.components.schemas.ConfigEnvVariable.properties.head" - update: - description: "Apply this variable to the Nextflow head job." - - - target: "$.components.schemas.ConfigEnvVariable.properties.compute" - update: - description: "Apply this variable to the Nextflow compute jobs." - - # ===== AWS BATCH CONFIG ===== - - # Add required fields for AWS Batch - - target: "$.components.schemas.AwsBatchConfig" - update: - required: ["region", "workDir"] - - - target: "$.components.schemas.AwsBatchConfig.properties.region" - update: - description: "AWS region where resources will be created (e.g., `us-east-1`)." - - - target: "$.components.schemas.AwsBatchConfig.properties.computeQueue" - update: - description: "AWS Batch compute queue for running jobs." - - - target: "$.components.schemas.AwsBatchConfig.properties.dragenQueue" - update: - description: "AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)." - - - target: "$.components.schemas.AwsBatchConfig.properties.dragenInstanceType" - update: - description: "EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)." - - - target: "$.components.schemas.AwsBatchConfig.properties.computeJobRole" - update: - description: "Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs." - - - target: "$.components.schemas.AwsBatchConfig.properties.executionRole" - update: - description: "IAM role ARN for ECS task execution." - - - target: "$.components.schemas.AwsBatchConfig.properties.headQueue" - update: - description: "AWS Batch queue for the Nextflow head job." - - - target: "$.components.schemas.AwsBatchConfig.properties.headJobRole" - update: - description: "Role ARN to grant fine-grained IAM permissions to the Nextflow head job." - - - target: "$.components.schemas.AwsBatchConfig.properties.cliPath" - update: - description: "Path to the AWS CLI installation in the container." - - - target: "$.components.schemas.AwsBatchConfig.properties.volumes" - update: - description: "EBS volumes to mount (format: `/host/path:/container/path`)." - - - target: "$.components.schemas.AwsBatchConfig.properties.waveEnabled" - update: - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - - - target: "$.components.schemas.AwsBatchConfig.properties.fusion2Enabled" - update: - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - - - target: "$.components.schemas.AwsBatchConfig.properties.nvnmeStorageEnabled" - update: - description: "Enable NVMe instance storage. Requires Fusion file system." - - - target: "$.components.schemas.AwsBatchConfig.properties.logGroup" - update: - description: "CloudWatch Logs group for container logs." - - - target: "$.components.schemas.AwsBatchConfig.properties.headJobCpus" - update: - description: "Number of CPUs allocated to the Nextflow head job." - - - target: "$.components.schemas.AwsBatchConfig.properties.headJobMemoryMb" - update: - description: "Memory allocation for the Nextflow head job, in megabytes." - - - target: "$.components.schemas.AwsBatchConfig.properties.fusionSnapshots" - update: - description: "Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system." - - - target: "$.components.schemas.AwsBatchConfig.properties.forge" - update: - description: "Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#batch-forge-compute-environment) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines." - - - target: "$.components.schemas.AwsBatchConfig.properties.forgedResources" - update: - description: "Resources created by Batch Forge (read-only)." - - - target: "$.components.schemas.AwsBatchConfig.properties.preRunScript" - update: - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.AwsBatchConfig.properties.postRunScript" - update: - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.AwsBatchConfig.properties.nextflowConfig" - update: - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - - # ===== AWS CLOUD CONFIG ===== - - # Add required fields for AWS Cloud - - target: "$.components.schemas.AwsCloudConfig" - update: - required: ["region", "workDir"] - - - target: "$.components.schemas.AwsCloudConfig.properties.region" - update: - description: "AWS region for EC2 instances (e.g., `us-east-1`)." - - - target: "$.components.schemas.AwsCloudConfig.properties.imageId" - update: - description: "The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance." - - - target: "$.components.schemas.AwsCloudConfig.properties.instanceType" - update: - description: "EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used." - - - target: "$.components.schemas.AwsCloudConfig.properties.vpcId" - update: - description: "VPC ID where instances will be launched. If omitted, the default VPC is used." - - - target: "$.components.schemas.AwsCloudConfig.properties.subnets" - update: - description: "List of subnet IDs for instance placement. If omitted, all subnets of the VPC are used." - - - target: "$.components.schemas.AwsCloudConfig.properties.securityGroups" - update: - description: "Security group IDs that control network access." - - - target: "$.components.schemas.AwsCloudConfig.properties.ebsAutoScale" - update: - description: "Enable automatic EBS volume scaling." - - - target: "$.components.schemas.AwsCloudConfig.properties.volumes" - update: - description: "Additional EBS volumes to attach." - - - target: "$.components.schemas.AwsCloudConfig.properties.allowBuckets" - update: - description: "Comma-separated list of S3 buckets accessible to the compute environment." - - - target: "$.components.schemas.AwsCloudConfig.properties.ec2KeyPair" - update: - description: "EC2 key pair name for SSH access to instances." - - - target: "$.components.schemas.AwsCloudConfig.properties.instanceProfileArn" - update: - description: "The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run." - - - target: "$.components.schemas.AwsCloudConfig.properties.subnetId" - update: - description: "Subnet ID for instance placement (single subnet)." - - - target: "$.components.schemas.AwsCloudConfig.properties.arm64Enabled" - update: - description: "Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs." - - - target: "$.components.schemas.AwsCloudConfig.properties.gpuEnabled" - update: - description: "Enable GPU instances to run compute jobs." - - - target: "$.components.schemas.AwsCloudConfig.properties.ebsBootSize" - update: - description: "EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default." - - - target: "$.components.schemas.AwsCloudConfig.properties.logGroup" - update: - description: "CloudWatch Logs group for container logs." - - - target: "$.components.schemas.AwsCloudConfig.properties.waveEnabled" - update: - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - - - target: "$.components.schemas.AwsCloudConfig.properties.fusion2Enabled" - update: - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - - - target: "$.components.schemas.AwsCloudConfig.properties.forgedResources" - update: - description: "Resources created by Cloud Forge (read-only)." - - - target: "$.components.schemas.AwsCloudConfig.properties.preRunScript" - update: - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.AwsCloudConfig.properties.postRunScript" - update: - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.AwsCloudConfig.properties.nextflowConfig" - update: - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - - # ===== GOOGLE CLOUD CONFIG ===== - - # Add required fields for Google Cloud - - target: "$.components.schemas.GoogleCloudConfig" - update: - required: ["region", "workDir"] - - - target: "$.components.schemas.GoogleCloudConfig.properties.region" - update: - description: "Google Cloud region (e.g., `us-central1`)." - - - target: "$.components.schemas.GoogleCloudConfig.properties.zone" - update: - description: "Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list." - - - target: "$.components.schemas.GoogleCloudConfig.properties.projectId" - update: - description: "Google Cloud project ID." - - - target: "$.components.schemas.GoogleCloudConfig.properties.instanceType" - update: - description: "Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used." - - - target: "$.components.schemas.GoogleCloudConfig.properties.imageId" - update: - description: "ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release." - - - target: "$.components.schemas.GoogleCloudConfig.properties.bootDiskSizeGb" - update: - description: "Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used." - - - target: "$.components.schemas.GoogleCloudConfig.properties.serviceAccountEmail" - update: - description: "Service account email for IAM access to instances." - - - target: "$.components.schemas.GoogleCloudConfig.properties.arm64Enabled" - update: - description: "Enable ARM64 instances." - - - target: "$.components.schemas.GoogleCloudConfig.properties.gpuEnabled" - update: - description: "Enable GPU instances." - - - target: "$.components.schemas.GoogleCloudConfig.properties.waveEnabled" - update: - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - - - target: "$.components.schemas.GoogleCloudConfig.properties.fusion2Enabled" - update: - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - - - target: "$.components.schemas.GoogleCloudConfig.properties.forgedResources" - update: - description: "Resources created by Cloud Forge (read-only)." - - - target: "$.components.schemas.GoogleCloudConfig.properties.preRunScript" - update: - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.GoogleCloudConfig.properties.postRunScript" - update: - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.GoogleCloudConfig.properties.nextflowConfig" - update: - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - - # ===== GOOGLE BATCH CONFIG ===== - - # Add required fields for Google Batch - - target: "$.components.schemas.GoogleBatchConfig" - update: - required: ["location", "workDir"] - - - target: "$.components.schemas.GoogleBatchConfig.properties.location" - update: - description: "Google Cloud location (region) for Batch jobs (e.g., `us-central1`)." - - - target: "$.components.schemas.GoogleBatchConfig.properties.spot" - update: - description: "Use Spot instances." - - - target: "$.components.schemas.GoogleBatchConfig.properties.projectId" - update: - description: "Google Cloud project ID." - - - target: "$.components.schemas.GoogleBatchConfig.properties.network" - update: - description: "VPC network name." - - - target: "$.components.schemas.GoogleBatchConfig.properties.subnetwork" - update: - description: "Subnetwork name within the VPC." - - - target: "$.components.schemas.GoogleBatchConfig.properties.serviceAccount" - update: - description: "Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)." - - - target: "$.components.schemas.GoogleBatchConfig.properties.bootDiskSizeGb" - update: - description: "Boot disk size in GB for compute instances." - - - target: "$.components.schemas.GoogleBatchConfig.properties.cpuPlatform" - update: - description: "Google Cloud Batch CPU platform." - - - target: "$.components.schemas.GoogleBatchConfig.properties.usePrivateAddress" - update: - description: "Use private IP addresses only (no external IPs)." - - - target: "$.components.schemas.GoogleBatchConfig.properties.enableRequesterPaysBuckets" - update: - description: "Allow access to [Requester Pays](https://cloud.google.com/storage/docs/requester-pays) Google Cloud Storage buckets." - - - target: "$.components.schemas.GoogleBatchConfig.properties.waveEnabled" - update: - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - - - target: "$.components.schemas.GoogleBatchConfig.properties.fusion2Enabled" - update: - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - - - target: "$.components.schemas.GoogleBatchConfig.properties.machineType" - update: - description: "Machine type for compute instances (e.g., `n1-standard-4`)." - - - target: "$.components.schemas.GoogleBatchConfig.properties.sshDaemon" - update: - description: "Enable SSH daemon for debugging." - - - target: "$.components.schemas.GoogleBatchConfig.properties.sshImage" - update: - description: "Container image for SSH daemon." - - - target: "$.components.schemas.GoogleBatchConfig.properties.debugMode" - update: - description: "Debug level (0-3) for troubleshooting." - - - target: "$.components.schemas.GoogleBatchConfig.properties.copyImage" - update: - description: "Container image for copying files." - - - target: "$.components.schemas.GoogleBatchConfig.properties.labels" - update: - description: "Comma-separated list of labels to apply to Batch resources." - - - target: "$.components.schemas.GoogleBatchConfig.properties.headJobCpus" - update: - description: "Number of CPUs allocated for the Nextflow head job." - - - target: "$.components.schemas.GoogleBatchConfig.properties.headJobMemoryMb" - update: - description: "Memory allocation for the Nextflow head job in megabytes." - - - target: "$.components.schemas.GoogleBatchConfig.properties.nfsTarget" - update: - description: "NFS server target for shared storage." - - - target: "$.components.schemas.GoogleBatchConfig.properties.nfsMount" - update: - description: "NFS mount path in containers." - - - target: "$.components.schemas.GoogleBatchConfig.properties.headJobInstanceTemplate" - update: - description: "Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job." - - - target: "$.components.schemas.GoogleBatchConfig.properties.computeJobsInstanceTemplate" - update: - description: "Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs." - - - target: "$.components.schemas.GoogleBatchConfig.properties.preRunScript" - update: - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.GoogleBatchConfig.properties.postRunScript" - update: - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.GoogleBatchConfig.properties.nextflowConfig" - update: - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - - # ===== AZURE BATCH CONFIG ===== - - # Add required fields for Azure Batch - - target: "$.components.schemas.AzBatchConfig" - update: - required: ["region", "workDir"] - - - target: "$.components.schemas.AzBatchConfig.properties.region" - update: - description: "Azure region (e.g., `eastus`)." - - - target: "$.components.schemas.AzBatchConfig.properties.deleteJobsOnCompletion" - update: - description: "Automatically delete Batch jobs after completion." - enum: ["on_success", "always", "never"] - - - target: "$.components.schemas.AzBatchConfig.properties.deletePoolsOnCompletion" - update: - description: "Automatically delete Batch pools after completion. Default: `false`." - - - target: "$.components.schemas.AzBatchConfig.properties.forge" - update: - description: "Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation." - - - target: "$.components.schemas.AzBatchConfig.properties.waveEnabled" - update: - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - - - target: "$.components.schemas.AzBatchConfig.properties.fusion2Enabled" - update: - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - - - target: "$.components.schemas.AzBatchConfig.properties.headPool" - update: - description: "Batch pool for the Nextflow head job." - - - target: "$.components.schemas.AzBatchConfig.properties.tokenDuration" - update: - description: "Duration of the SAS token created by Nextflow. Default: `12h`." - - - target: "$.components.schemas.AzBatchConfig.properties.managedIdentityClientId" - update: - description: "The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage." - - - target: "$.components.schemas.AzBatchConfig.properties.preRunScript" - update: - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.AzBatchConfig.properties.postRunScript" - update: - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.AzBatchConfig.properties.nextflowConfig" - update: - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - - # ===== AZURE CLOUD CONFIG ===== - - # Add required fields for Azure Cloud - - target: "$.components.schemas.AzCloudConfig" - update: - required: ["location", "workDir"] - - - target: "$.components.schemas.AzCloudConfig.properties.location" - update: - description: "Azure location/region (e.g., `eastus`)." - - - target: "$.components.schemas.AzCloudConfig.properties.resourceGroup" - update: - description: "Azure resource group for VMs." - - - target: "$.components.schemas.AzCloudConfig.properties.instanceType" - update: - description: "Azure VM size (e.g., `Standard_D2s_v3`)." - - - target: "$.components.schemas.AzCloudConfig.properties.vmImage" - update: - description: "VM image URN or ID." - - - target: "$.components.schemas.AzCloudConfig.properties.networkId" - update: - description: "Virtual network resource ID." - - - target: "$.components.schemas.AzCloudConfig.properties.subscriptionId" - update: - description: "Azure subscription ID." - - - target: "$.components.schemas.AzCloudConfig.properties.managedIdentityId" - update: - description: "User-assigned managed identity resource ID." - - - target: "$.components.schemas.AzCloudConfig.properties.managedIdentityClientId" - update: - description: "Managed identity client ID for authentication." - - - target: "$.components.schemas.AzCloudConfig.properties.logWorkspaceId" - update: - description: "Log Analytics workspace ID for monitoring." - - - target: "$.components.schemas.AzCloudConfig.properties.logTableName" - update: - description: "Custom table name in Log Analytics." - - - target: "$.components.schemas.AzCloudConfig.properties.dataCollectionEndpoint" - update: - description: "Data collection endpoint for logs." - - - target: "$.components.schemas.AzCloudConfig.properties.dataCollectionRuleId" - update: - description: "Data collection rule ID for log routing." - - - target: "$.components.schemas.AzCloudConfig.properties.waveEnabled" - update: - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - - - target: "$.components.schemas.AzCloudConfig.properties.fusion2Enabled" - update: - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - - - target: "$.components.schemas.AzCloudConfig.properties.forgedResources" - update: - description: "Resources created by Cloud Forge (read-only)." - - # ===== KUBERNETES CONFIG ===== - - # Add required fields for K8s - - target: "$.components.schemas.K8sComputeConfig" - update: - required: ["server", "sslCert", "workDir"] - - - target: "$.components.schemas.K8sComputeConfig.properties.server" - update: - description: "Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)." - - - target: "$.components.schemas.K8sComputeConfig.properties.sslCert" - update: - description: "SSL certificate to authenticate the connection with the Kubernetes cluster." - - - target: "$.components.schemas.K8sComputeConfig.properties.namespace" - update: - description: "Kubernetes namespace for workflow execution. Default: `default`." - - - target: "$.components.schemas.K8sComputeConfig.properties.headServiceAccount" - update: - description: "Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)." - - - target: "$.components.schemas.K8sComputeConfig.properties.computeServiceAccount" - update: - description: "Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`." - - - target: "$.components.schemas.K8sComputeConfig.properties.storageClaimName" - update: - description: "PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode." - - - target: "$.components.schemas.K8sComputeConfig.properties.storageMountPath" - update: - description: "Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`." - - - target: "$.components.schemas.K8sComputeConfig.properties.podCleanup" - update: - description: "Pod cleanup policy after job completion." - enum: ["on_success", "always", "never"] - - - target: "$.components.schemas.K8sComputeConfig.properties.headPodSpec" - update: - description: "Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`." - - - target: "$.components.schemas.K8sComputeConfig.properties.servicePodSpec" - update: - description: "Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`." - - - target: "$.components.schemas.K8sComputeConfig.properties.headJobCpus" - update: - description: "Number of CPUs allocated for the Nextflow head job." - - - target: "$.components.schemas.K8sComputeConfig.properties.headJobMemoryMb" - update: - description: "Memory allocation for the Nextflow head job in megabytes." - - - target: "$.components.schemas.K8sComputeConfig.properties.preRunScript" - update: - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.K8sComputeConfig.properties.postRunScript" - update: - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.K8sComputeConfig.properties.nextflowConfig" - update: - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - - # ===== EKS CONFIG ===== - - # Add required fields for EKS - - target: "$.components.schemas.EksComputeConfig" - update: - required: ["region", "clusterName", "workDir"] - - - target: "$.components.schemas.EksComputeConfig.properties.region" - update: - description: "AWS region where EKS cluster is located." - - - target: "$.components.schemas.EksComputeConfig.properties.clusterName" - update: - description: "EKS cluster name." - - - target: "$.components.schemas.EksComputeConfig.properties.waveEnabled" - update: - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - - - target: "$.components.schemas.EksComputeConfig.properties.fusion2Enabled" - update: - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - - # ===== GKE CONFIG ===== - - # Add required fields for GKE - - target: "$.components.schemas.GkeComputeConfig" - update: - required: ["region", "clusterName", "workDir"] - - - target: "$.components.schemas.GkeComputeConfig.properties.region" - update: - description: "Google Cloud region where GKE cluster is located." - - - target: "$.components.schemas.GkeComputeConfig.properties.clusterName" - update: - description: "GKE cluster name." - - - target: "$.components.schemas.GkeComputeConfig.properties.waveEnabled" - update: - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - - - target: "$.components.schemas.GkeComputeConfig.properties.fusion2Enabled" - update: - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - - # ===== ABSTRACT GRID CONFIG (Base for HPC platforms) ===== - - - target: "$.components.schemas.AbstractGridConfig.properties.workDir" - update: - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - - - target: "$.components.schemas.AbstractGridConfig.properties.preRunScript" - update: - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.AbstractGridConfig.properties.postRunScript" - update: - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.AbstractGridConfig.properties.nextflowConfig" - update: - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - - - target: "$.components.schemas.AbstractGridConfig.properties.launchDir" - update: - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - - - target: "$.components.schemas.AbstractGridConfig.properties.userName" - update: - description: "Username for SSH connection to HPC head node." - - - target: "$.components.schemas.AbstractGridConfig.properties.hostName" - update: - description: "Hostname or IP address of HPC head node." - - - target: "$.components.schemas.AbstractGridConfig.properties.port" - update: - description: "SSH port. Default: `22`." - - - target: "$.components.schemas.AbstractGridConfig.properties.headQueue" - update: - description: "The name of the queue on the cluster used to launch the Nextflow execution." - - - target: "$.components.schemas.AbstractGridConfig.properties.computeQueue" - update: - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - - - target: "$.components.schemas.AbstractGridConfig.properties.maxQueueSize" - update: - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - - - target: "$.components.schemas.AbstractGridConfig.properties.headJobOptions" - update: - description: "Additional submit options for the Nextflow head job." - - - target: "$.components.schemas.AbstractGridConfig.properties.propagateHeadJobOptions" - update: - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - - # ===== HPC CONFIGS (Slurm, LSF, UGE, Altair PBS) ===== - - - target: "$.components.schemas.LsfComputeConfig.properties.unitForLimits" - update: - description: "Unit used for memory limits. Must match the LSF_UNIT_FOR_LIMITS value in `lsf.conf` file." - enum: ["KB", "MB", "GB", "TB", "PB", "EB", "ZB"] - - - target: "$.components.schemas.LsfComputeConfig.properties.perJobMemLimit" - update: - description: "Define whether memory limit is interpreted as per-job or per-process. Must match `LSB_JOB_MEMLIMIT` in `lsf.conf` file." - - - target: "$.components.schemas.LsfComputeConfig.properties.perTaskReserve" - update: - description: "Define whether memory reservation is made on job tasks or per-host. Must match `RESOURCE_RESERVE_PER_TASK` value in `lsf.conf` file." - - # ===== SEQERA COMPUTE CONFIG ===== - - # Add required fields for Seqera Compute - - target: "$.components.schemas.SeqeraComputeConfig" - update: - required: ["region", "workDir"] - - - target: "$.components.schemas.SeqeraComputeConfig.properties.region" - update: - description: "Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)." - - - target: "$.components.schemas.SeqeraComputeConfig.properties.defaultDataRetentionPolicy" - update: - description: "If true, intermediary files are deleted after 28 days to manage storage cost/usage." - - # ===== AWS BATCH FORGE CONFIG ===== - - - target: "$.components.schemas.ForgeConfig.properties.type" - update: - description: "Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)." - enum: ["SPOT", "EC2"] - - - target: "$.components.schemas.ForgeConfig.properties.minCpus" - update: - description: "Minimum CPUs provisioned in the compute environment." - - - target: "$.components.schemas.ForgeConfig.properties.maxCpus" - update: - description: "Maximum CPUs provisioned in the compute environment." - - - target: "$.components.schemas.ForgeConfig.properties.gpuEnabled" - update: - description: "Enable GPU instances." - - - target: "$.components.schemas.ForgeConfig.properties.ebsAutoScale" - update: - description: "If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system." - - - target: "$.components.schemas.ForgeConfig.properties.instanceTypes" - update: - description: "Comma-separated list of allowed EC2 instance types." - - - target: "$.components.schemas.ForgeConfig.properties.allocStrategy" - update: - description: "Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances." - enum: ["BEST_FIT", "BEST_FIT_PROGRESSIVE", "SPOT_CAPACITY_OPTIMIZED", "SPOT_PRICE_CAPACITY_OPTIMIZED"] - - - target: "$.components.schemas.ForgeConfig.properties.imageId" - update: - description: "Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used." - - - target: "$.components.schemas.ForgeConfig.properties.vpcId" - update: - description: "VPC ID for networking." - - - target: "$.components.schemas.ForgeConfig.properties.subnets" - update: - description: "List of VPC subnets to isolate EC2 resources from each other, or the internet." - - - target: "$.components.schemas.ForgeConfig.properties.securityGroups" - update: - description: "List of security group IDs to define a set of firewall rules that control EC2 compute node traffic." - - - target: "$.components.schemas.ForgeConfig.properties.fsxMount" - update: - description: "FSx for Lustre mount point." - - - target: "$.components.schemas.ForgeConfig.properties.fsxName" - update: - description: "FSx for Lustre file system name." - - - target: "$.components.schemas.ForgeConfig.properties.fsxSize" - update: - description: "FSx for Lustre file system size in GB." - - - target: "$.components.schemas.ForgeConfig.properties.disposeOnDeletion" - update: - description: "If true, delete AWS resources when compute environment is deleted." - - - target: "$.components.schemas.ForgeConfig.properties.ec2KeyPair" - update: - description: "EC2 key pair for SSH access." - - - target: "$.components.schemas.ForgeConfig.properties.allowBuckets" - update: - description: "List of additional S3 buckets accessible to compute environment." - - - target: "$.components.schemas.ForgeConfig.properties.ebsBlockSize" - update: - description: "EBS volume size in GB." - - - target: "$.components.schemas.ForgeConfig.properties.fusionEnabled" - update: - description: "(Deprecated) Enable Fusion file system (v1)." - - - target: "$.components.schemas.ForgeConfig.properties.bidPercentage" - update: - description: "Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`." - - - target: "$.components.schemas.ForgeConfig.properties.efsCreate" - update: - description: "If true, creates new EFS file system." - - - target: "$.components.schemas.ForgeConfig.properties.efsId" - update: - description: "Existing EFS file system ID." - - - target: "$.components.schemas.ForgeConfig.properties.efsMount" - update: - description: "EFS file system mount point in containers." - - - target: "$.components.schemas.ForgeConfig.properties.dragenEnabled" - update: - description: "Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support." - - - target: "$.components.schemas.ForgeConfig.properties.dragenAmiId" - update: - description: "AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances." - - - target: "$.components.schemas.ForgeConfig.properties.ebsBootSize" - update: - description: "Boot disk size for instances, in GB." - - - target: "$.components.schemas.ForgeConfig.properties.ecsConfig" - update: - description: "Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)." - - - target: "$.components.schemas.ForgeConfig.properties.fargateHeadEnabled" - update: - description: "Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems." - - - target: "$.components.schemas.ForgeConfig.properties.arm64Enabled" - update: - description: "Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system." - - - target: "$.components.schemas.ForgeConfig.properties.dragenInstanceType" - update: - description: "Instance type for DRAGEN workflows." - - # ===== AZURE BATCH FORGE CONFIG ===== - - - target: "$.components.schemas.AzBatchForgeConfig.properties.vmType" - update: - description: "Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`." - - - target: "$.components.schemas.AzBatchForgeConfig.properties.vmCount" - update: - description: "Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused." - - - target: "$.components.schemas.AzBatchForgeConfig.properties.autoScale" - update: - description: "Enable auto-scaling for the Batch pool." - - - target: "$.components.schemas.AzBatchForgeConfig.properties.disposeOnDeletion" - update: - description: "Delete Batch compute pool when the compute environment is deleted." - - - target: "$.components.schemas.AzBatchForgeConfig.properties.containerRegIds" - update: - description: "Container registry resource IDs." \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/data-links-operations-overlay-1.85.yaml b/platform-api-docs/scripts/overlays_archive/data-links-operations-overlay-1.85.yaml deleted file mode 100644 index 3c022e955..000000000 --- a/platform-api-docs/scripts/overlays_archive/data-links-operations-overlay-1.85.yaml +++ /dev/null @@ -1,97 +0,0 @@ -# ===== DATA-LINKS OPERATIONS - SUMMARIES & DESCRIPTIONS ===== - -# GET /data-links/cache/refresh - Refresh data-link cache -- target: "$.paths./data-links/cache/refresh.get" - update: - summary: "Refresh data-link cache" - description: "Refreshes the data-link cache for the given `workspaceId` or `credentialsId`. Forces immediate re-discovery of available cloud storage resources." - -# GET /data-links/ - List data-links -- target: "$.paths./data-links/.get" - update: - summary: "List data-links" - description: "Retrieves all available data-links in a user context. Append `?workspaceId={your-workspace-id}` to retrieve data-links in a workspace context. Results can be filtered by credentials, provider, region, search query, and visibility." - -# GET /data-links/{dataLinkId}/browse{/path} - Explore data-link path -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get" - update: - summary: "Explore data-link path" - description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`. Returns a paginated list of files and folders at the specified location." - -# GET /data-links/{dataLinkId}/browse-tree - Explore data-link tree -- target: "$.paths./data-links/{dataLinkId}/browse-tree.get" - update: - summary: "Explore data-link tree" - description: "Retrieves a list of all files in the data-link associated with the given `dataLinkId`, including files in sub-paths. Useful for retrieving complete directory structures." - -# GET /data-links/{dataLinkId} - Describe data-link -- target: "$.paths./data-links/{dataLinkId}.get" - update: - summary: "Describe data-link" - description: "Retrieves the details of the data-link associated with the given `dataLinkId`, including provider information, credentials, and access status." - -# POST /data-links/hide - Hide data-links -- target: "$.paths./data-links/hide.post" - update: - summary: "Hide data-links" - description: "Hides the given data-links from the data-links list view. Hidden data-links remain accessible but are filtered from default list views." - -# POST /data-links/show - Show data-links -- target: "$.paths./data-links/show.post" - update: - summary: "Show data-links" - description: "Shows previously hidden data-links in the data-links list view." - -# POST /data-links/ - Create data-link -- target: "$.paths./data-links/.post" - update: - summary: "Create data-link" - description: "Creates a new data-link in a user context. Append `?workspaceId=` to create the data-link in a workspace context. Data-links can be public (no credentials required) or private (credentials-based access)." - -# PUT /data-links/{dataLinkId} - Update data-link -- target: "$.paths./data-links/{dataLinkId}.put" - update: - summary: "Update data-link" - description: "Updates the data-link associated with the given `dataLinkId`. Allows modification of name, description, and associated credentials." - -# DELETE /data-links/{dataLinkId} - Delete data-link -- target: "$.paths./data-links/{dataLinkId}.delete" - update: - summary: "Delete data-link" - description: "Deletes the data-link associated with the given `dataLinkId`. The underlying cloud storage resource is not affected." - -# GET /data-links/{dataLinkId}/download/{+filePath} - Download data-link file -- target: "$.paths./data-links/{dataLinkId}/download/{+filePath}.get" - update: - summary: "Download data-link file" - description: "Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`. Returns the file content directly as a streamed response." - -# GET /data-links/{dataLinkId}/generate-download-url - Generate download URL -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get" - update: - summary: "Generate download URL" - description: "Returns a pre-signed URL to download files from the data-link associated with the given `dataLinkId`. The URL can be used for direct downloads or preview purposes." - -# GET /data-links/{dataLinkId}/script/download - Generate download script -- target: "$.paths./data-links/{dataLinkId}/script/download.get" - update: - summary: "Generate download script" - description: "Creates a script to download files from the data-link associated with the given `dataLinkId`. Append `?dirs` or `?files` to specify a list of files or paths to download within the data-link." - -# POST /data-links/{dataLinkId}/upload{/dirPath} - Generate upload URL -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post" - update: - summary: "Generate upload URL" - description: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint." - -# POST /data-links/{dataLinkId}/upload/finish{/dirPath} - Finish upload -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post" - update: - summary: "Finish upload" - description: "Finalizes upload of a data-link file, specifying a file path (`dirPath`). This endpoint is required for AWS S3 data-links to complete a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." - -# DELETE /data-links/{dataLinkId}/content - Delete data-link content -- target: "$.paths./data-links/{dataLinkId}/content.delete" - update: - summary: "Delete data-link content" - description: "Deletes the content of the data-link associated with the given `dataLinkId`. The data-link itself is preserved, but files and directories within it are removed." \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/data-links-params-overlay-1.85.yaml b/platform-api-docs/scripts/overlays_archive/data-links-params-overlay-1.85.yaml deleted file mode 100644 index 9313dfc95..000000000 --- a/platform-api-docs/scripts/overlays_archive/data-links-params-overlay-1.85.yaml +++ /dev/null @@ -1,265 +0,0 @@ -# ===== DATA-LINKS PARAMETERS - PATH, QUERY, AND REQUEST BODY ===== - -# ---- PATH PARAMETERS ---- - -# dataLinkId - used across multiple endpoints -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/browse-tree.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}.put.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}.delete.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/download/{+filePath}.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/script/download.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/content.delete.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -# path parameter -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='path')]" - update: - description: "Content path within the data-link. Use forward slashes to navigate directory structures (e.g., `folder/subfolder`)." - -# filePath parameter -- target: "$.paths./data-links/{dataLinkId}/download/{+filePath}.get.parameters[?(@.name=='filePath')]" - update: - description: "File path to download within the data-link (e.g., `folder/subfolder/object`)." - -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get.parameters[?(@.name=='filePath')]" - update: - description: "File path to download within the data-link (e.g., `folder/subfolder/object`)." - -# dirPath parameter -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post.parameters[?(@.name=='dirPath')]" - update: - description: "Path to the destination directory within the data-link where the file will be uploaded (e.g., `folder/subfolder`)." - -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post.parameters[?(@.name=='dirPath')]" - update: - description: "Path to the destination directory within the data-link where the file was uploaded (e.g., `folder/subfolder`)." - -# ---- QUERY PARAMETERS - workspaceId ---- - -- target: "$.paths./data-links/cache/refresh.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, refreshes cache in a user context." - -- target: "$.paths./data-links/.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, lists data-links in a user context." - -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/browse-tree.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/hide.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/show.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, creates data-link in a user context." - -- target: "$.paths./data-links/{dataLinkId}.put.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}.delete.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/download/{+filePath}.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/script/download.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/content.delete.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -# ---- QUERY PARAMETERS - credentialsId ---- - -- target: "$.paths./data-links/cache/refresh.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Filters cache refresh to data-links accessible with the specified credentials." - -- target: "$.paths./data-links/.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Filters results to data-links accessible with the specified credentials." - -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for accessing private data-links." - -- target: "$.paths./data-links/{dataLinkId}/browse-tree.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for accessing private data-links." - -- target: "$.paths./data-links/{dataLinkId}.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for accessing private data-links." - -- target: "$.paths./data-links/{dataLinkId}/download/{+filePath}.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for downloading from private data-links." - -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for generating download URLs for private data-links." - -- target: "$.paths./data-links/{dataLinkId}/script/download.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for generating download scripts for private data-links." - -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for uploading to private data-links." - -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for finalizing uploads to private data-links." - -- target: "$.paths./data-links/{dataLinkId}/content.delete.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for deleting content from private data-links." - -# ---- SEARCH AND FILTER PARAMETERS ---- - -- target: "$.paths./data-links/.get.parameters[?(@.name=='search')]" - update: - description: "Free text search criteria. Supports data-link `name`, `region`, and `provider`." - -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='search')]" - update: - description: "Prefix search of data-link content. Filters files and folders by `name` prefix (e.g., `search=my-file` matches `my-file.txt`, `my-file-2.csv`)." - -# ---- PAGINATION PARAMETERS ---- - -- target: "$.paths./data-links/.get.parameters[?(@.name=='max')]" - update: - description: "Maximum number of results to return. Default: `25`, maximum: `100`." - -- target: "$.paths./data-links/.get.parameters[?(@.name=='offset')]" - update: - description: "Number of results to skip for pagination. Default: `0`." - -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='pageSize')]" - update: - description: "Number of items to return per page. If omitted, a default maximum value is returned. Maximum: `100`." - -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='nextPageToken')]" - update: - description: "Token used to fetch the next page of items. Obtained from the previous response." - -# ---- VISIBILITY PARAMETERS ---- - -- target: "$.paths./data-links/.get.parameters[?(@.name=='visibility')]" - update: - description: "Visibility filter. Supports `visible` (show only visible data-links), `hidden` (show only hidden data-links), or `all` (show all data-links)." - -# ---- DOWNLOAD/UPLOAD PARAMETERS ---- - -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get.parameters[?(@.name=='preview')]" - update: - description: "If `true`, generates a URL for preview purposes. If `false`, generates a URL for direct download. Default: `false`." - -- target: "$.paths./data-links/{dataLinkId}/script/download.get.parameters[?(@.name=='dirs')]" - update: - description: "List of directory paths to include in the download script." - -- target: "$.paths./data-links/{dataLinkId}/script/download.get.parameters[?(@.name=='files')]" - update: - description: "List of file paths to include in the download script." - -- target: "$.paths./data-links/{dataLinkId}/browse-tree.get.parameters[?(@.name=='paths')]" - update: - description: "List of paths to explore. Returns all files within the specified paths, including sub-paths." - -# ---- REQUEST BODY DESCRIPTIONS ---- - -- target: "$.paths./data-links/hide.post.requestBody" - update: - description: "Data-link IDs to hide." - -- target: "$.paths./data-links/show.post.requestBody" - update: - description: "Data-link IDs to show." - -- target: "$.paths./data-links/.post.requestBody" - update: - description: "Data-link creation request." - -- target: "$.paths./data-links/{dataLinkId}.put.requestBody" - update: - description: "Data-link update request." - -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post.requestBody" - update: - description: "Multi-part upload request containing file metadata (name, size, content type)." - -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post.requestBody" - update: - description: "Finish multi-part upload request for AWS S3 data-links, containing upload ID, file name, part tags, and error status." - -- target: "$.paths./data-links/{dataLinkId}/content.delete.requestBody" - update: - description: "Data-link content deletion request specifying files and directories to delete." \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/data-links-schema-overlay-1.85.yaml b/platform-api-docs/scripts/overlays_archive/data-links-schema-overlay-1.85.yaml deleted file mode 100644 index 15a866d09..000000000 --- a/platform-api-docs/scripts/overlays_archive/data-links-schema-overlay-1.85.yaml +++ /dev/null @@ -1,267 +0,0 @@ -# ===== DATA-LINKS SCHEMAS - REQUEST/RESPONSE OBJECTS ===== - -# ---- REQUEST SCHEMAS ---- - -# DataLinkCreateRequest -- target: "$.components.schemas.DataLinkCreateRequest.properties.name" - update: - description: "Unique name for the data-link. Must consist of alphanumeric, dash, or underscore characters." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.description" - update: - description: "Description of the data-link. Maximum length: 1000 characters." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.type" - update: - description: "Type of the data-link. Currently supports `bucket`." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.provider" - update: - description: "Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.resourceRef" - update: - description: "Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.publicAccessible" - update: - description: "Whether the data-link is publicly accessible. If `true`, no credentials are required. If `false`, `credentialsId` must be provided." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.credentialsId" - update: - description: "Credentials string identifier. Required when `publicAccessible` is `false`." - -# DataLinkUpdateRequest -- target: "$.components.schemas.DataLinkUpdateRequest.properties.name" - update: - description: "New name for the data-link. Must be unique within the workspace or user context." - -- target: "$.components.schemas.DataLinkUpdateRequest.properties.description" - update: - description: "Updated description for the data-link. Maximum length: 1000 characters." - -- target: "$.components.schemas.DataLinkUpdateRequest.properties.credentialsId" - update: - description: "Updated credentials ID for accessing the data-link." - -# DataLinksVisibilityRequest -- target: "$.components.schemas.DataLinksVisibilityRequest.properties.dataLinkIds" - update: - description: "Array of data-link IDs to hide or show." - -# DataLinkDeleteItemRequest -- target: "$.components.schemas.DataLinkDeleteItemRequest.properties.files" - update: - description: "Array of file paths to be deleted from the data-link." - -- target: "$.components.schemas.DataLinkDeleteItemRequest.properties.dirs" - update: - description: "Array of directory paths to be deleted from the data-link." - -# DataLinkMultiPartUploadRequest -- target: "$.components.schemas.DataLinkMultiPartUploadRequest.properties.fileName" - update: - description: "Name of the file to upload." - -- target: "$.components.schemas.DataLinkMultiPartUploadRequest.properties.contentLength" - update: - description: "Size of the file to upload in bytes." - -- target: "$.components.schemas.DataLinkMultiPartUploadRequest.properties.contentType" - update: - description: "MIME type of the file to upload (e.g., `application/octet-stream`, `text/plain`)." - -# DataLinkFinishMultiPartUploadRequest -- target: "$.components.schemas.DataLinkFinishMultiPartUploadRequest.properties.uploadId" - update: - description: "Upload ID assigned when initiating multi-part upload for AWS S3. Obtained from the `/upload` endpoint response." - -- target: "$.components.schemas.DataLinkFinishMultiPartUploadRequest.properties.fileName" - update: - description: "Name of the uploaded file." - -- target: "$.components.schemas.DataLinkFinishMultiPartUploadRequest.properties.tags" - update: - description: "Array of ETags assigned for each part by AWS S3 during the upload process. Each ETag is returned in the response headers when uploading a part to the pre-signed URLs from the `/upload` endpoint." - -- target: "$.components.schemas.DataLinkFinishMultiPartUploadRequest.properties.withError" - update: - description: "Flag indicating whether the upload encountered an error. If `true`, the upload will be aborted. If `false`, the upload will be completed." - -# ---- RESPONSE SCHEMAS ---- - -# DataLinkResponse -- target: "$.components.schemas.DataLinkResponse.properties.dataLink" - update: - description: "Data-link object containing metadata." - -# DataLinksListResponse -- target: "$.components.schemas.DataLinksListResponse.properties.dataLinks" - update: - description: "Array of data-link objects." - -- target: "$.components.schemas.DataLinksListResponse.properties.totalSize" - update: - description: "Total number of data-links matching the query." - -- target: "$.components.schemas.DataLinksListResponse.properties.isFetching" - update: - description: "Flag indicating whether more data-links are currently being fetched from cloud providers. Not rendered in JSON response; used to determine HTTP status code." - -# DataLinkContentResponse -- target: "$.components.schemas.DataLinkContentResponse.properties.originalPath" - update: - description: "Base path for all returned objects within the data-link." - -- target: "$.components.schemas.DataLinkContentResponse.properties.objects" - update: - description: "Array of data-link items (files and folders) at the specified path." - -- target: "$.components.schemas.DataLinkContentResponse.properties.nextPageToken" - update: - description: "Token that can be used to request the next page of items. Null if no more items are available." - -# DataLinkContentTreeListResponse -- target: "$.components.schemas.DataLinkContentTreeListResponse.properties.items" - update: - description: "Array of simple data-link items containing file paths and sizes." - -# DataLinkDownloadUrlResponse -- target: "$.components.schemas.DataLinkDownloadUrlResponse.properties.url" - update: - description: "Pre-signed URL to download the requested file." - -# DataLinkDownloadScriptResponse -- target: "$.components.schemas.DataLinkDownloadScriptResponse.properties.script" - update: - description: "Shell script content to download files from the data-link." - -# DataLinkMultiPartUploadResponse -- target: "$.components.schemas.DataLinkMultiPartUploadResponse.properties.uploadId" - update: - description: "Upload ID generated by AWS S3. Required for the `/upload/finish` request." - -- target: "$.components.schemas.DataLinkMultiPartUploadResponse.properties.uploadUrls" - update: - description: "Array of pre-signed URLs to execute multi-part upload. One URL per part." - -# DataLinkDeleteItemResponse -- target: "$.components.schemas.DataLinkDeleteItemResponse.properties.deletionFailures" - update: - description: "Array of items that failed to be deleted, including error messages." - -# ---- DTO SCHEMAS ---- - -# DataLinkDto -- target: "$.components.schemas.DataLinkDto.properties.id" - update: - description: "Data-link string identifier. Generated based on provider, type, region, and resource path." - -- target: "$.components.schemas.DataLinkDto.properties.name" - update: - description: "Name of the data-link (e.g., bucket name)." - -- target: "$.components.schemas.DataLinkDto.properties.description" - update: - description: "Description of the data-link. Null for data-links auto-discovered from workspace credentials." - -- target: "$.components.schemas.DataLinkDto.properties.resourceRef" - update: - description: "Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)." - -- target: "$.components.schemas.DataLinkDto.properties.type" - update: - description: "Data-link type. Currently supports `bucket`." - -- target: "$.components.schemas.DataLinkDto.properties.provider" - update: - description: "Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`." - -- target: "$.components.schemas.DataLinkDto.properties.region" - update: - description: "Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers." - -- target: "$.components.schemas.DataLinkDto.properties.credentials" - update: - description: "Array of credentials that can access this data-link. Empty for public data-links." - -- target: "$.components.schemas.DataLinkDto.properties.publicAccessible" - update: - description: "Whether the data-link is publicly accessible without credentials." - -- target: "$.components.schemas.DataLinkDto.properties.hidden" - update: - description: "Visibility status flag. If `true`, data-link is hidden from default list views." - -- target: "$.components.schemas.DataLinkDto.properties.status" - update: - description: "Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted." - -- target: "$.components.schemas.DataLinkDto.properties.message" - update: - description: "Error message for invalid data-links. Null for valid data-links." - -# DataLinkItem -- target: "$.components.schemas.DataLinkItem.properties.type" - update: - description: "Type of the item. Either `FILE` or `FOLDER`." - -- target: "$.components.schemas.DataLinkItem.properties.name" - update: - description: "Name of the file or folder." - -- target: "$.components.schemas.DataLinkItem.properties.size" - update: - description: "Size of the file in bytes. For folders, always `0`." - -- target: "$.components.schemas.DataLinkItem.properties.mimeType" - update: - description: "MIME type of the file, calculated by analyzing the file extension. Null for folders." - -# DataLinkSimpleItem -- target: "$.components.schemas.DataLinkSimpleItem.properties.path" - update: - description: "Path to the item from the data-link root (resource path)." - -- target: "$.components.schemas.DataLinkSimpleItem.properties.size" - update: - description: "Size of the file in bytes. For folders, always `0`." - -# DataLinkItemDeletionFailure -- target: "$.components.schemas.DataLinkItemDeletionFailure.properties.dataLinkItem" - update: - description: "Data-link item that failed to be deleted." - -- target: "$.components.schemas.DataLinkItemDeletionFailure.properties.errorMessage" - update: - description: "Error message describing why the deletion failed." - -# DataLinkCredentials -- target: "$.components.schemas.DataLinkCredentials.properties.id" - update: - description: "Credentials string identifier." - -- target: "$.components.schemas.DataLinkCredentials.properties.name" - update: - description: "Name of the credentials." - -- target: "$.components.schemas.DataLinkCredentials.properties.provider" - update: - description: "Credentials cloud provider." - -# ---- ENUM SCHEMAS ---- - -# DataLinkType -- target: "$.components.schemas.DataLinkType" - update: - description: "Data-link type. Currently only `bucket` is supported." - -# DataLinkProvider -- target: "$.components.schemas.DataLinkProvider" - update: - description: "Cloud provider for data-links. Supports AWS S3, Google Cloud Storage, Azure Blob Storage, Azure with Entra ID, Seqera Compute storage, and generic S3-compatible storage." - -# DataLinkItemType -- target: "$.components.schemas.DataLinkItemType" - update: - description: "Type of data-link content item. Either `FILE` or `FOLDER`." \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/dataset-operations-overlay-1.85.yaml b/platform-api-docs/scripts/overlays_archive/dataset-operations-overlay-1.85.yaml deleted file mode 100644 index 8047f1c97..000000000 --- a/platform-api-docs/scripts/overlays_archive/dataset-operations-overlay-1.85.yaml +++ /dev/null @@ -1,171 +0,0 @@ -# ===== DATASETS OPERATIONS - SUMMARIES & DESCRIPTIONS ===== - -# GET /datasets - List datasets -- target: "$.paths./datasets.get" - update: - summary: "List datasets" - description: "Lists all available datasets in a user context. Append `?workspaceId` to list datasets in a workspace context. Results can be filtered by search query, sorted, and paginated." - -# POST /datasets - Create dataset -- target: "$.paths./datasets.post" - update: - summary: "Create dataset" - description: "Creates a new dataset in the user context. Include the dataset name and description in your request body. Append `?workspaceId` to create the dataset in a workspace context." - -# DELETE /datasets - Delete multiple datasets -- target: "$.paths./datasets.delete" - update: - summary: "Delete datasets" - description: "Deletes multiple datasets identified by the given `datasetIds`. Returns arrays of successfully deleted and failed dataset IDs." - -# POST /datasets/hide - Hide datasets -- target: "$.paths./datasets/hide.post" - update: - summary: "Hide datasets" - description: "Hides the given datasets from the datasets list view. Hidden datasets remain accessible but are filtered from default list views unless `?visibility=hidden` or `?visibility=all` is specified." - -# POST /datasets/show - Show datasets -- target: "$.paths./datasets/show.post" - update: - summary: "Show datasets" - description: "Shows previously hidden datasets in the datasets list view." - -# POST /datasets/labels/add - Add labels to datasets -- target: "$.paths./datasets/labels/add.post" - update: - summary: "Add labels to datasets" - description: "Adds the given list of labels to the given datasets. Existing labels are preserved. Only simple labels are supported; resource labels cannot be attached to datasets." - -# POST /datasets/labels/apply - Replace dataset labels -- target: "$.paths./datasets/labels/apply.post" - update: - summary: "Replace dataset labels" - description: "Applies the given list of labels to the given datasets. Existing labels are replaced - include labels to be preserved in `labelIds`. Only simple labels are supported; resource labels cannot be attached to datasets." - -# POST /datasets/labels/remove - Remove labels from datasets -- target: "$.paths./datasets/labels/remove.post" - update: - summary: "Remove labels from datasets" - description: "Removes the given list of labels from the given datasets." - -# GET /datasets/versions - List latest dataset versions -- target: "$.paths./datasets/versions.get" - update: - summary: "List latest dataset versions" - description: "Lists the latest version of each dataset in the user context. Append `?workspaceId` to list latest versions in a workspace context. Filter by MIME type and search query." - -# GET /datasets/{datasetId}/metadata - Describe dataset -- target: "$.paths./datasets/{datasetId}/metadata.get" - update: - summary: "Describe dataset" - description: "Retrieves the metadata of the dataset identified by the given `datasetId`. Append `?attributes=labels` to include label information in response." - -# PUT /datasets/{datasetId} - Update dataset -- target: "$.paths./datasets/{datasetId}.put" - update: - summary: "Update dataset" - description: "Updates the name and description of the dataset identified by the given `datasetId`." - -# POST /datasets/{datasetId}/upload - Upload new dataset version -- target: "$.paths./datasets/{datasetId}/upload.post" - update: - summary: "Upload new dataset version" - description: "Uploads CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. Each upload increments the version number." - -# GET /datasets/{datasetId}/versions - List all dataset versions -- target: "$.paths./datasets/{datasetId}/versions.get" - update: - summary: "List all dataset versions" - description: "Lists all versions of the dataset identified by the given `datasetId`. Filter by MIME type to retrieve specific file format versions." - -# GET /datasets/{datasetId}/v/{version}/n/{fileName} - Download dataset content -- target: "$.paths./datasets/{datasetId}/v/{version}/n/{fileName}.get" - update: - summary: "Download dataset content" - description: "Downloads the content of the dataset version identified by the given `datasetId` and `version`. The `fileName` must match the original uploaded filename." - -# DELETE /datasets/{datasetId} - Delete dataset -- target: "$.paths./datasets/{datasetId}.delete" - update: - summary: "Delete dataset" - description: "Deletes the dataset identified by the given `datasetId`, including all associated versions." - -# POST /datasets/{datasetId}/versions/{version}/disable - Disable dataset version -- target: "$.paths./datasets/{datasetId}/versions/{version}/disable.post" - update: - summary: "Disable dataset version" - description: "Disables the specified version of a dataset. Disabled versions cannot be used in workflow runs and cannot be re-enabled." - -# GET /launch/{launchId}/datasets - Describe launch datasets -- target: "$.paths./launch/{launchId}/datasets.get" - update: - summary: "Describe launch datasets" - description: "Retrieves the details of the datasets used in the launch identified by the given `launchId`." - -# ===== DEPRECATED DATASET OPERATIONS - ADDENDUM ===== -# Updates for workspace-scoped dataset endpoints that are now deprecated -# in favor of user/workspace-scoped endpoints with optional workspaceId query param - -# ---- LIST DATASETS (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets.get.summary" - update: "(Deprecated) List available datasets" - -- target: "$.paths./workspaces/{workspaceId}/datasets.get.description" - update: "**This endpoint is deprecated. See [List datasets](https://docs.seqera.io/platform-api/list-datasets-v-2) for the current endpoint.**\n\nLists all available datasets in the workspace context identified by the given `workspaceId`." - -# ---- CREATE DATASET (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets.post.summary" - update: "(Deprecated) Create dataset" - -- target: "$.paths./workspaces/{workspaceId}/datasets.post.description" - update: "**This endpoint is deprecated. See [Create dataset](https://docs.seqera.io/platform-api/create-dataset-v-2) for the current endpoint.**\n\nCreates a new dataset in the given workspace context. Include the dataset file and details in your request body." - -# ---- LIST WORKSPACE DATASET VERSIONS (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/versions.get.summary" - update: "(Deprecated) List latest dataset versions" - -- target: "$.paths./workspaces/{workspaceId}/datasets/versions.get.description" - update: "**This endpoint is deprecated. See [List latest dataset versions](https://docs.seqera.io/platform-api/list-latest-dataset-versions-v-2) for the current endpoint.**\n\nLists the latest version of each dataset associated with the given `workspaceId`." - -# ---- UPDATE DATASET (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}.put.summary" - update: "(Deprecated) Update dataset" - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}.put.description" - update: "**This endpoint is deprecated. See [Update dataset](https://docs.seqera.io/platform-api/update-dataset-v-2) for the current endpoint.**\n\nUpdates the details of the dataset identified by the given `datasetId`." - -# ---- DELETE DATASET (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}.delete.summary" - update: "(Deprecated) Delete dataset" - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}.delete.description" - update: "**This endpoint is deprecated. See [Delete dataset](https://docs.seqera.io/platform-api/delete-dataset-v-2) for the current endpoint.**\n\nDeletes the dataset identified by the given `datasetId`." - -# ---- DESCRIBE DATASET (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/metadata.get.summary" - update: "(Deprecated) Describe dataset" - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/metadata.get.description" - update: "**This endpoint is deprecated. See [Describe dataset](https://docs.seqera.io/platform-api/describe-dataset-v-2) for the current endpoint.**\n\nRetrieves the metadata of the dataset identified by the given `datasetId`." - -# ---- UPLOAD DATASET (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/upload.post.summary" - update: "(Deprecated) Upload new dataset version" - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/upload.post.description" - update: "**This endpoint is deprecated. See [Upload new dataset version](https://docs.seqera.io/platform-api/upload-dataset-v-2) for the current endpoint.**\n\nUploads the CSV or TSV content to create a new version of the dataset identified by the given `datasetId`." - -# ---- LIST DATASET VERSIONS (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/versions.get.summary" - update: "(Deprecated) List all dataset versions" - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/versions.get.description" - update: "**This endpoint is deprecated. See [List all dataset versions](https://docs.seqera.io/platform-api/list-dataset-versions-v-2) for the current endpoint.**\n\nLists all versions of the given `datasetId`." \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/dataset-schema-overlay-1.85.yaml b/platform-api-docs/scripts/overlays_archive/dataset-schema-overlay-1.85.yaml deleted file mode 100644 index 4680dc2d2..000000000 --- a/platform-api-docs/scripts/overlays_archive/dataset-schema-overlay-1.85.yaml +++ /dev/null @@ -1,219 +0,0 @@ -# ===== DATASETS SCHEMAS - REQUEST/RESPONSE OBJECTS ===== - -# ---- REQUEST SCHEMAS ---- - -# CreateDatasetRequest -- target: "$.components.schemas.CreateDatasetRequest" - update: - required: ["name"] - -- target: "$.components.schemas.CreateDatasetRequest.properties.name" - update: - description: "Unique name for the dataset. Must consist of alphanumeric, dash, or underscore characters." - -- target: "$.components.schemas.CreateDatasetRequest.properties.description" - update: - description: "Description of the dataset. Maximum length: 5000 characters." - -# UpdateDatasetRequest -- target: "$.components.schemas.UpdateDatasetRequest.properties.name" - update: - description: "New name for the dataset. Must be unique within the workspace or user context." - -- target: "$.components.schemas.UpdateDatasetRequest.properties.description" - update: - description: "Updated description of the dataset. Maximum length: 5000 characters." - -# DeleteDatasetsRequest -- target: "$.components.schemas.DeleteDatasetsRequest.properties.datasetIds" - update: - description: "Array of dataset IDs to delete." - -# ChangeDatasetVisibilityRequest -- target: "$.components.schemas.ChangeDatasetVisibilityRequest.properties.datasetIds" - update: - description: "Array of dataset IDs to hide or show." - -# AssociateDatasetsLabelsRequest -- target: "$.components.schemas.AssociateDatasetsLabelsRequest.properties.datasetIds" - update: - description: "Array of dataset IDs to which labels will be added, applied, or removed." - -- target: "$.components.schemas.AssociateDatasetsLabelsRequest.properties.labelIds" - update: - description: "Array of label IDs to add, apply, or remove." - -# ---- RESPONSE SCHEMAS ---- - -# CreateDatasetResponse -- target: "$.components.schemas.CreateDatasetResponse.properties.dataset" - update: - description: "Created dataset object containing metadata." - -# DescribeDatasetResponse -- target: "$.components.schemas.DescribeDatasetResponse.properties.dataset" - update: - description: "Dataset object containing metadata and optional attributes." - -# ListDatasetsResponse -- target: "$.components.schemas.ListDatasetsResponse.properties.datasets" - update: - description: "Array of dataset objects." - -- target: "$.components.schemas.ListDatasetsResponse.properties.totalSize" - update: - description: "Total number of datasets matching the query." - -# DeleteDatasetsResponse -- target: "$.components.schemas.DeleteDatasetsResponse.properties.success" - update: - description: "Array of dataset IDs that were successfully deleted." - -- target: "$.components.schemas.DeleteDatasetsResponse.properties.failed" - update: - description: "Array of dataset IDs that failed to delete." - -# ListDatasetVersionsResponse -- target: "$.components.schemas.ListDatasetVersionsResponse.properties.versions" - update: - description: "Array of dataset version objects." - -- target: "$.components.schemas.ListDatasetVersionsResponse.properties.totalSize" - update: - description: "Total number of dataset versions matching the query." - -# UploadDatasetVersionResponse -- target: "$.components.schemas.UploadDatasetVersionResponse.properties.version" - update: - description: "Created dataset version object containing metadata and download URL." - -# ---- DTO SCHEMAS ---- - -# DatasetDto -- target: "$.components.schemas.DatasetDto.properties.id" - update: - description: "Dataset string identifier." - -- target: "$.components.schemas.DatasetDto.properties.user" - update: - description: "User who created the dataset." - -- target: "$.components.schemas.DatasetDto.properties.workspaceId" - update: - description: "Workspace numeric identifier. Null if dataset is in user context." - -- target: "$.components.schemas.DatasetDto.properties.organizationId" - update: - description: "Organization numeric identifier." - -- target: "$.components.schemas.DatasetDto.properties.name" - update: - description: "Dataset name." - -- target: "$.components.schemas.DatasetDto.properties.lastUpdatedBy" - update: - description: "User who last updated the dataset." - -- target: "$.components.schemas.DatasetDto.properties.description" - update: - description: "Dataset description." - -- target: "$.components.schemas.DatasetDto.properties.mediaType" - update: - description: "MIME type of the dataset content (e.g., `text/csv`, `text/tab-separated-values`)." - -- target: "$.components.schemas.DatasetDto.properties.dateCreated" - update: - description: "Creation timestamp." - -- target: "$.components.schemas.DatasetDto.properties.lastUpdated" - update: - description: "Last update timestamp." - -- target: "$.components.schemas.DatasetDto.properties.deleted" - update: - description: "Deletion status flag." - -- target: "$.components.schemas.DatasetDto.properties.hidden" - update: - description: "Visibility status flag. If `true`, dataset is hidden from default list views." - -- target: "$.components.schemas.DatasetDto.properties.labels" - update: - description: "Array of labels attached to the dataset. Only returned when `?attributes=labels` is specified." - -- target: "$.components.schemas.DatasetDto.properties.version" - update: - description: "Version number (deprecated, no replacement)." - -- target: "$.components.schemas.DatasetDto.properties.runsInfo" - update: - description: "Usage statistics for the dataset, including run count and last usage timestamp." - -# DatasetVersionDto -- target: "$.components.schemas.DatasetVersionDto.properties.datasetId" - update: - description: "Dataset string identifier." - -- target: "$.components.schemas.DatasetVersionDto.properties.datasetName" - update: - description: "Dataset name." - -- target: "$.components.schemas.DatasetVersionDto.properties.datasetDescription" - update: - description: "Dataset description." - -- target: "$.components.schemas.DatasetVersionDto.properties.hasHeader" - update: - description: "Indicates whether the dataset file contains a header row." - -- target: "$.components.schemas.DatasetVersionDto.properties.version" - update: - description: "Version number." - -- target: "$.components.schemas.DatasetVersionDto.properties.createdBy" - update: - description: "User who created this version." - -- target: "$.components.schemas.DatasetVersionDto.properties.dateCreated" - update: - description: "Version creation timestamp." - -- target: "$.components.schemas.DatasetVersionDto.properties.lastUpdated" - update: - description: "Version last update timestamp." - -- target: "$.components.schemas.DatasetVersionDto.properties.fileName" - update: - description: "Original filename of the uploaded dataset file." - -- target: "$.components.schemas.DatasetVersionDto.properties.mediaType" - update: - description: "MIME type of the dataset content (e.g., `text/csv`, `text/tab-separated-values`)." - -- target: "$.components.schemas.DatasetVersionDto.properties.workspaceId" - update: - description: "Workspace numeric identifier. Null if dataset is in user context." - -- target: "$.components.schemas.DatasetVersionDto.properties.url" - update: - description: "Download URL for the dataset version content." - -- target: "$.components.schemas.DatasetVersionDto.properties.disabled" - update: - description: "Indicates whether this version is disabled. Disabled versions cannot be used in workflow runs." - -# DatasetRunsInfo -- target: "$.components.schemas.DatasetRunsInfo.properties.runsCount" - update: - description: "Number of workflow runs that have used this dataset." - -- target: "$.components.schemas.DatasetRunsInfo.properties.lastUsed" - update: - description: "Timestamp of the most recent workflow run that used this dataset." - -# DatasetQueryAttribute enum -- target: "$.components.schemas.DatasetQueryAttribute" - update: - description: "Query attribute options for including additional dataset information in API responses." - enum: ["labels"] \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/hpc-grid-configs-overlay-1.85.yaml b/platform-api-docs/scripts/overlays_archive/hpc-grid-configs-overlay-1.85.yaml deleted file mode 100644 index c367c1e2f..000000000 --- a/platform-api-docs/scripts/overlays_archive/hpc-grid-configs-overlay-1.85.yaml +++ /dev/null @@ -1,349 +0,0 @@ -# ===== HPC COMPUTE CONFIGS - GRID SCHEDULER PROPERTY DESCRIPTIONS ===== - -# These properties were previously inherited from AbstractGridConfig and now need -# explicit descriptions on each scheduler type (LSF, Slurm, Altair PBS, Moab, Univa) - -# ---- LSF COMPUTE CONFIG ---- - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.workDir" - update: - type: string - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.launchDir" - update: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.userName" - update: - type: string - description: "Username for SSH connection to HPC head node." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.hostName" - update: - type: string - description: "Hostname or IP address of HPC head node." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.port" - update: - type: integer - format: int32 - description: "SSH port. Default: `22`." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.headQueue" - update: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.computeQueue" - update: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.maxQueueSize" - update: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.headJobOptions" - update: - type: string - description: "Additional submit options for the Nextflow head job." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.propagateHeadJobOptions" - update: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ---- SLURM COMPUTE CONFIG ---- - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.workDir" - update: - type: string - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.launchDir" - update: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.userName" - update: - type: string - description: "Username for SSH connection to HPC head node." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.hostName" - update: - type: string - description: "Hostname or IP address of HPC head node." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.port" - update: - type: integer - format: int32 - description: "SSH port. Default: `22`." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.headQueue" - update: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.computeQueue" - update: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.maxQueueSize" - update: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.headJobOptions" - update: - type: string - description: "Additional submit options for the Nextflow head job." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.propagateHeadJobOptions" - update: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ---- ALTAIR PBS COMPUTE CONFIG ---- - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.workDir" - update: - type: string - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.launchDir" - update: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.userName" - update: - type: string - description: "Username for SSH connection to HPC head node." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.hostName" - update: - type: string - description: "Hostname or IP address of HPC head node." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.port" - update: - type: integer - format: int32 - description: "SSH port. Default: `22`." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.headQueue" - update: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.computeQueue" - update: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.maxQueueSize" - update: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.headJobOptions" - update: - type: string - description: "Additional submit options for the Nextflow head job." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.propagateHeadJobOptions" - update: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ---- MOAB COMPUTE CONFIG ---- - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.workDir" - update: - type: string - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.launchDir" - update: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.userName" - update: - type: string - description: "Username for SSH connection to HPC head node." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.hostName" - update: - type: string - description: "Hostname or IP address of HPC head node." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.port" - update: - type: integer - format: int32 - description: "SSH port. Default: `22`." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.headQueue" - update: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.computeQueue" - update: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.maxQueueSize" - update: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.headJobOptions" - update: - type: string - description: "Additional submit options for the Nextflow head job." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.propagateHeadJobOptions" - update: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ---- UNIVA COMPUTE CONFIG ---- - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.workDir" - update: - type: string - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.launchDir" - update: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.userName" - update: - type: string - description: "Username for SSH connection to HPC head node." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.hostName" - update: - type: string - description: "Hostname or IP address of HPC head node." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.port" - update: - type: integer - format: int32 - description: "SSH port. Default: `22`." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.headQueue" - update: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.computeQueue" - update: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.maxQueueSize" - update: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.headJobOptions" - update: - type: string - description: "Additional submit options for the Nextflow head job." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.propagateHeadJobOptions" - update: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/managed-id-summaries-descriptions-overlay.yaml b/platform-api-docs/scripts/overlays_archive/managed-id-summaries-descriptions-overlay.yaml deleted file mode 100644 index d3bf7acbb..000000000 --- a/platform-api-docs/scripts/overlays_archive/managed-id-summaries-descriptions-overlay.yaml +++ /dev/null @@ -1,346 +0,0 @@ -overlay: 1.0.0 -info: - title: Managed Identities and credentials operations API Overlay - version: 1.0.0 -actions: - # ---- Operation summary and description fields ---- - - target: "$.paths./identities.get" - update: - summary: "List managed identities" - description: "Lists all available managed identities in an organization context. To list the managed identities for an organization other than the requester's default, append an `?orgId`. Only organizations accessible to the requester's access token can be queried." - - - target: "$.paths./identities.post" - update: - summary: "Create managed identity" - description: "Creates a new managed identity in an organization context. Managed identities enable centralized credential management for HPC environments." - - - target: "$.paths./identities/{managedIdentityId}.get" - update: - summary: "Describe managed identity" - description: "Retrieves the details of the managed identity associated with the given `managedIdentityId`." - - - target: "$.paths./identities/{managedIdentityId}.put" - update: - summary: "Update managed identity" - description: "Updates the details of the managed identity associated with the given `managedIdentityId`." - - - target: "$.paths./identities/{managedIdentityId}.delete" - update: - summary: "Delete managed identity" - description: "Deletes the managed identity associated with the given `managedIdentityId`. To optionally check whether the deletion will be blocked by running jobs that depend on associated managed credentials, append `?checked=true`." - - - target: "$.paths./identities/{managedIdentityId}/credentials.get" - update: - summary: "List managed credentials" - description: "Lists all managed credentials associated with the given `managedIdentityId`. Filter by user with `?userId`." - - - target: "$.paths./identities/{managedIdentityId}/credentials.post" - update: - summary: "Create managed credentials" - description: "Creates new managed credentials for the given `managedIdentityId`. To associate the credentials with a user other than the requester, append the `?userId`." - - - target: "$.paths./identities/{managedIdentityId}/credentials/{managedCredentialsId}.put" - update: - summary: "Update managed credentials" - description: "Updates the managed credentials identified by the given `managedCredentialsId` within the given `managedIdentityId`." - - - target: "$.paths./identities/{managedIdentityId}/credentials/{managedCredentialsId}.delete" - update: - summary: "Delete managed credentials" - description: "Deletes the managed credentials identified by the given `managedCredentialsId` from the associated `managedIdentityId`. To optionally check whether the deletion will be blocked by running jobs that depend on the managed credentials, append `?checked=true`." - -# ---- Path parameters ---- - - target: "$.paths./identities/{managedIdentityId}.get.parameters[?(@.name=='managedIdentityId')]" - update: - description: "Managed identity numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}.put.parameters[?(@.name=='managedIdentityId')]" - update: - description: "Managed identity numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}.delete.parameters[?(@.name=='managedIdentityId')]" - update: - description: "Managed identity numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}/credentials.get.parameters[?(@.name=='managedIdentityId')]" - update: - description: "Managed identity numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}/credentials.post.parameters[?(@.name=='managedIdentityId')]" - update: - description: "Managed identity numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}/credentials/{managedCredentialsId}.put.parameters[?(@.name=='managedIdentityId')]" - update: - description: "Managed identity numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}/credentials/{managedCredentialsId}.put.parameters[?(@.name=='managedCredentialsId')]" - update: - description: "Managed credentials numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}/credentials/{managedCredentialsId}.delete.parameters[?(@.name=='managedIdentityId')]" - update: - description: "Managed identity numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}/credentials/{managedCredentialsId}.delete.parameters[?(@.name=='managedCredentialsId')]" - update: - description: "Managed credentials numeric identifier." - - # ---- Query parameters ---- - - target: "$.paths./identities.get.parameters[?(@.name=='orgId')]" - update: - description: "Organization numeric identifier. Append to list managed identities within an organization other than the requester's default." - - - target: "$.paths./identities.get.parameters[?(@.name=='search')]" - update: - description: "Filter search parameter. Supports free text search on name and keywords: `platform:`." - - - target: "$.paths./identities.get.parameters[?(@.name=='max')]" - update: - description: "Maximum number of results to return. Default: `20`." - - - target: "$.paths./identities.get.parameters[?(@.name=='offset')]" - update: - description: "Number of results to skip for pagination. Default: `0`." - - - target: "$.paths./identities.post.parameters[?(@.name=='orgId')]" - update: - description: "Organization numeric identifier. Append to create managed identity within an organization other than the requester's default." - - - target: "$.paths./identities/{managedIdentityId}.get.parameters[?(@.name=='orgId')]" - update: - description: "Organization numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}.put.parameters[?(@.name=='orgId')]" - update: - description: "Organization numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}.delete.parameters[?(@.name=='orgId')]" - update: - description: "Organization numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}.delete.parameters[?(@.name=='checked')]" - update: - description: "If `true`, deletion is blocked if running jobs depend on associated managed credentials. Default: `false`." - - - target: "$.paths./identities/{managedIdentityId}/credentials.get.parameters[?(@.name=='orgId')]" - update: - description: "Organization numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}/credentials.get.parameters[?(@.name=='userId')]" - update: - description: "User numeric identifier. Filter managed credentials by specific user." - - - target: "$.paths./identities/{managedIdentityId}/credentials.get.parameters[?(@.name=='search')]" - update: - description: "Filter search parameter. Supports free text search on `userName`, `firstName + lastName`, and keywords: `is:missing`, `is:added`." - - - target: "$.paths./identities/{managedIdentityId}/credentials.get.parameters[?(@.name=='max')]" - update: - description: "Maximum number of results to return. Default: `20`." - - - target: "$.paths./identities/{managedIdentityId}/credentials.get.parameters[?(@.name=='offset')]" - update: - description: "Number of results to skip for pagination. Default: `0`." - - - target: "$.paths./identities/{managedIdentityId}/credentials.post.parameters[?(@.name=='orgId')]" - update: - description: "Organization numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}/credentials.post.parameters[?(@.name=='userId')]" - update: - description: "User numeric identifier. Append to associate managed credentials with a user other than the requester." - - - target: "$.paths./identities/{managedIdentityId}/credentials/{managedCredentialsId}.put.parameters[?(@.name=='orgId')]" - update: - description: "Organization numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}/credentials/{managedCredentialsId}.delete.parameters[?(@.name=='orgId')]" - update: - description: "Organization numeric identifier." - - - target: "$.paths./identities/{managedIdentityId}/credentials/{managedCredentialsId}.delete.parameters[?(@.name=='checked')]" - update: - description: "If `true`, deletion is blocked if running jobs depend on the given managed credentials. Default: `false`." - - # ---- Request body descriptions ---- - - target: "$.paths./identities.post.requestBody" - update: - description: "Managed identity create request." - - - target: "$.paths./identities/{managedIdentityId}.put.requestBody" - update: - description: "Managed identity update request." - - - target: "$.paths./identities/{managedIdentityId}/credentials.post.requestBody" - update: - description: "Managed credentials create request, including provider type and authentication details." - - - target: "$.paths./identities/{managedIdentityId}/credentials/{managedCredentialsId}.put.requestBody" - update: - description: "Managed credentials update request." - - # ---- Schema property descriptions for CreateManagedIdentityRequest ---- - - target: "$.components.schemas.CreateManagedIdentityRequest.properties.name" - update: - description: "Unique name for the managed identity. Must consist of alphanumeric, dash, or underscore characters." - - - target: "$.components.schemas.CreateManagedIdentityRequest.properties.platform" - update: - description: "HPC platform type for this managed identity." - - - target: "$.components.schemas.CreateManagedIdentityRequest.properties.config" - update: - description: "Platform-specific configuration. Structure depends on the selected platform." - - # ---- Schema property descriptions for CreateManagedCredentialsRequest ---- - - target: "$.components.schemas.CreateManagedCredentialsRequest.properties.provider" - update: - description: "Authentication provider type. Currently supports `ssh`." - - - target: "$.components.schemas.CreateManagedCredentialsRequest.properties.credentials" - update: - description: "Authentication credentials configuration object." - - - target: "$.components.schemas.CreateManagedCredentialsRequest.properties.metadata" - update: - description: "Additional metadata for the managed credentials." - - # ---- Schema property descriptions for UpdateManagedIdentityRequest ---- - - target: "$.components.schemas.UpdateManagedIdentityRequest.properties.managedIdentity" - update: - description: "Updated managed identity configuration object." - - # ---- Schema property descriptions for UpdateManagedCredentialsRequest ---- - - target: "$.components.schemas.UpdateManagedCredentialsRequest.properties.provider" - update: - description: "Authentication provider type. Currently supports `ssh`." - - - target: "$.components.schemas.UpdateManagedCredentialsRequest.properties.credentials" - update: - description: "Updated authentication credentials configuration." - - - target: "$.components.schemas.UpdateManagedCredentialsRequest.properties.metadata" - update: - description: "Additional metadata for the managed credentials." - - # ---- Response schema descriptions ---- - - target: "$.components.schemas.ListManagedIdentitiesResponse.properties.managedIdentities" - update: - description: "Array of managed identities." - - - target: "$.components.schemas.ListManagedIdentitiesResponse.properties.totalSize" - update: - description: "Total number of managed identities matching the query." - - - target: "$.components.schemas.CreateManagedIdentityResponse.properties.id" - update: - description: "Managed identity numeric identifier." - - - target: "$.components.schemas.CreateManagedIdentityResponse.properties.name" - update: - description: "Name of the created managed identity." - - - target: "$.components.schemas.CreateManagedIdentityResponse.properties.platform" - update: - description: "HPC platform type." - - - target: "$.components.schemas.CreateManagedIdentityResponse.properties.config" - update: - description: "Platform-specific configuration." - - - target: "$.components.schemas.ListManagedCredentialsResponse.properties.managedCredentials" - update: - description: "Array of managed credentials objects." - - - target: "$.components.schemas.ListManagedCredentialsResponse.properties.totalSize" - update: - description: "Total number of managed credentials matching the query." - - - target: "$.components.schemas.CreateManagedCredentialsResponse.properties.managedCredentials" - update: - description: "Created managed credentials object." - - - target: "$.components.schemas.DeleteManagedCredentialsConflictResponse.properties.managedCredentialsId" - update: - description: "Identifier of credentials that could not be deleted." - - - target: "$.components.schemas.DeleteManagedCredentialsConflictResponse.properties.conflicts" - update: - description: "Array of conflicts preventing deletion." - - - target: "$.components.schemas.DeleteManagedCredentialsConflictResponse.Conflict.properties.type" - update: - description: "Type of resource causing the conflict." - - - target: "$.components.schemas.DeleteManagedCredentialsConflictResponse.Conflict.properties.id" - update: - description: "Identifier of the conflicting resource." - - - target: "$.components.schemas.DeleteManagedCredentialsConflictResponse.Conflict.properties.name" - update: - description: "Name of the conflicting resource." - - - target: "$.components.schemas.DeleteManagedCredentialsConflictResponse.Conflict.properties.url" - update: - description: "URL of the conflicting resource." - - # ---- ManagedIdentityDbDto schema ---- - - target: "$.components.schemas.ManagedIdentityDbDto_AbstractGridConfig_.properties.id" - update: - description: "Managed identity numeric identifier." - - - target: "$.components.schemas.ManagedIdentityDbDto_AbstractGridConfig_.properties.name" - update: - description: "Name of the managed identity." - - - target: "$.components.schemas.ManagedIdentityDbDto_AbstractGridConfig_.properties.platform" - update: - description: "HPC platform type." - - - target: "$.components.schemas.ManagedIdentityDbDto_AbstractGridConfig_.properties.config" - update: - description: "HPC platform-specific configuration for the managed identity." - - # ---- ManagedCredentialsDbDto schema ---- - - target: "$.components.schemas.ManagedCredentialsDbDto.properties.id" - update: - description: "Managed credentials numeric identifier." - - # ---- ListManagedCredentialsRespDto schema ---- - - target: "$.components.schemas.ListManagedCredentialsRespDto.properties.managedCredentialsId" - update: - description: "Managed credentials numeric identifier." - - - target: "$.components.schemas.ListManagedCredentialsRespDto.properties.userId" - update: - description: "User numeric identifier associated with these credentials." - - - target: "$.components.schemas.ListManagedCredentialsRespDto.properties.userName" - update: - description: "Username of the associated user." - - - target: "$.components.schemas.ListManagedCredentialsRespDto.properties.firstName" - update: - description: "First name of the associated user." - - - target: "$.components.schemas.ListManagedCredentialsRespDto.properties.lastName" - update: - description: "Last name of the associated user." - - - target: "$.components.schemas.ListManagedCredentialsRespDto.properties.avatarUrl" - update: - description: "URL of the user's avatar image." - - - target: "$.components.schemas.ListManagedCredentialsRespDto.properties.provider" - update: - description: "Authentication provider type." - - - target: "$.components.schemas.ListManagedCredentialsRespDto.properties.metadata" - update: - description: "Additional metadata for the managed credentials." - - # ---- ManagedCredentialsMetadata schema ---- - - target: "$.components.schemas.ManagedCredentialsMetadata.properties.discriminator" - update: - description: "Type discriminator for metadata structure (read-only)." \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/new-compute-keys-schemas-overlay-1.85.yaml b/platform-api-docs/scripts/overlays_archive/new-compute-keys-schemas-overlay-1.85.yaml deleted file mode 100644 index c3a4449ca..000000000 --- a/platform-api-docs/scripts/overlays_archive/new-compute-keys-schemas-overlay-1.85.yaml +++ /dev/null @@ -1,217 +0,0 @@ -# ===== NEW SCHEMAS - 1.85 ===== -# Descriptions for completely new schemas added in 1.85 - -# ---- LOCAL COMPUTE CONFIG ---- - -- target: "$.components.schemas.LocalComputeConfig.properties.discriminator" - update: - type: string - description: "Platform type discriminator (read-only, set based on platform selection)." - -- target: "$.components.schemas.LocalComputeConfig.properties.workDir" - update: - type: string - description: "Nextflow work directory on the local file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.LocalComputeConfig.properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.LocalComputeConfig.properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.LocalComputeConfig.properties.environment" - update: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - description: "Environment variables to set for Nextflow execution." - -- target: "$.components.schemas.LocalComputeConfig.properties.waveEnabled" - update: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - -- target: "$.components.schemas.LocalComputeConfig.properties.fusion2Enabled" - update: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - -- target: "$.components.schemas.LocalComputeConfig.properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ---- LOCAL SECURITY KEYS ---- - -- target: "$.components.schemas.LocalSecurityKeys.properties.discriminator" - update: - type: string - description: "Credentials provider type identifier." - -- target: "$.components.schemas.LocalSecurityKeys.properties.password" - update: - type: string - writeOnly: true - description: "Password for local platform access." - -# ---- AZURE CLOUD KEYS ---- - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.discriminator" - update: - type: string - description: "Credentials provider type identifier." - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.subscriptionId" - update: - type: string - description: "Azure subscription ID." - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.storageName" - update: - type: string - description: "Azure storage account name." - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.tenantId" - update: - type: string - description: "Azure tenant ID." - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.clientId" - update: - type: string - description: "Azure service principal client ID." - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.clientSecret" - update: - type: string - writeOnly: true - description: "Azure service principal client secret." - -# ---- AZURE CLOUD PLATFORM META INFO ---- - -- target: "$.components.schemas.AzCloudPlatformMetaInfo.properties.discriminator" - update: - type: string - description: "Platform type identifier." - -- target: "$.components.schemas.AzCloudPlatformMetaInfo.properties.warnings" - update: - type: array - items: - type: string - description: "Azure Cloud configuration warnings." - -- target: "$.components.schemas.AzCloudPlatformMetaInfo.properties.containers" - update: - type: array - items: - type: string - description: "Azure Blob Storage containers accessible to workspace credentials." - -- target: "$.components.schemas.AzCloudPlatformMetaInfo.properties.instanceTypes" - update: - type: array - items: - type: string - description: "Available Azure VM instance types." - -# ---- STUDIO REMOTE CONFIGURATION ---- - -- target: "$.components.schemas.StudioRemoteConfiguration.properties.repository" - update: - type: string - description: "Git repository URL for Studios remote configuration." - -- target: "$.components.schemas.StudioRemoteConfiguration.properties.revision" - update: - type: string - nullable: true - description: "Git branch, tag, or commit ID. If omitted, uses the default branch." - -- target: "$.components.schemas.StudioRemoteConfiguration.properties.commitId" - update: - type: string - nullable: true - description: "Git commit ID for the remote configuration. Maximum length: 40 characters." - -# ---- COMPUTE ENV RESOURCES ---- - -- target: "$.components.schemas.ComputeEnvResources.properties.cpus" - update: - type: integer - format: int32 - nullable: true - description: "Number of CPUs allocated to the compute environment. Null if information is unavailable." - -- target: "$.components.schemas.ComputeEnvResources.properties.memory" - update: - type: integer - format: int32 - nullable: true - description: "Memory allocated to the compute environment in GB. Null if information is unavailable." - -- target: "$.components.schemas.ComputeEnvResources.properties.gpus" - update: - type: integer - format: int32 - nullable: true - description: "Number of GPUs allocated to the compute environment. Null if information is unavailable." - -- target: "$.components.schemas.ComputeEnvResources.properties.diskSize" - update: - type: integer - format: int32 - nullable: true - description: "Disk size allocated to the compute environment in GB. Null if information is unavailable." - -- target: "$.components.schemas.ComputeEnvResources.properties.estimatedPrice" - update: - type: number - format: float - nullable: true - description: "Estimated hourly cost of the compute environment in USD. Null if information is unavailable." - -- target: "$.components.schemas.ComputeEnvResources.properties.instanceType" - update: - type: string - nullable: true - description: "Instance type used by the compute environment. Null if information is unavailable." - -# ---- DATA STUDIO CREATE REQUEST ---- - -# Update required fields to only computeEnvId and name -- target: "$.components.schemas.DataStudioCreateRequest.required[*]" - remove: true - -- target: "$.components.schemas.DataStudioCreateRequest.required" - update: - - computeEnvId - - name - -# Remove minLength constraint from dataStudioToolUrl -- target: "$.components.schemas.DataStudioCreateRequest.properties.dataStudioToolUrl.minLength" - remove: true - -# Add remoteConfig property -- target: "$.components.schemas.DataStudioCreateRequest.properties.remoteConfig" - update: - nullable: true - allOf: - - $ref: "#/components/schemas/StudioRemoteConfiguration" - -# ---- DATA STUDIO DTO ---- - -# Add remoteConfig property -- target: "$.components.schemas.DataStudioDto.properties.remoteConfig" - update: - $ref: "#/components/schemas/StudioRemoteConfiguration" - -# ---- DATA STUDIO WORKSPACE SETTINGS RESPONSE ---- - -# Remove required array -- target: "$.components.schemas.DataStudioWorkspaceSettingsResponse.required" - remove: true \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/pipelines-param-descriptions-overlay.yaml b/platform-api-docs/scripts/overlays_archive/pipelines-param-descriptions-overlay.yaml deleted file mode 100644 index 9367be16d..000000000 --- a/platform-api-docs/scripts/overlays_archive/pipelines-param-descriptions-overlay.yaml +++ /dev/null @@ -1,267 +0,0 @@ -overlay: "1.0.0" -info: - title: "Pipeline Parameters Descriptions" - version: "1.0.0" - description: "Comprehensive descriptions for all pipeline parameters - path, query, and request body" - -actions: - # ===== PATH AND QUERY PARAMETERS ===== - - # GET /pipelines - List pipelines - - target: "$.paths./pipelines.get.parameters[?(@.name=='attributes')].description" - update: "Additional attribute values to include in the response (`labels`, `optimized`, `computeEnv`). Returns empty values if omitted." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier. If omitted, lists pipelines in a user context." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='max')].description" - update: "Maximum number of results to return (pagination). Default: `50`, Maximum: `100`." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='offset')].description" - update: "Number of results to skip for pagination. Default: `0`." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='search')].description" - update: "Search string to filter pipelines by name or description." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='visibility')].description" - update: "Filter pipelines by visibility. Valid values: `private`, `shared`, `all`." - - # POST /pipelines - Create pipeline - - target: "$.paths./pipelines.post.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier. If omitted, creates pipeline in a user context." - - # GET /pipelines/info - Describe remote pipeline repository - - target: "$.paths./pipelines/info.get.parameters[?(@.name=='name')].description" - update: "Pipeline repository name (e.g., `nextflow-io/hello`) or full URL." - - - target: "$.paths./pipelines/info.get.parameters[?(@.name=='revision')].description" - update: "Git revision, branch, or tag to describe. Default: repository default branch." - - - target: "$.paths./pipelines/info.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier. If omitted, describes pipeline in a user context." - - - target: "$.paths./pipelines/info.get.parameters[?(@.name=='mainScript')].description" - update: "Alternative main script filename. Default: `main.nf`." - - # GET /pipelines/repositories - List pipeline repositories - - target: "$.paths./pipelines/repositories.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier. If omitted, lists repositories in a user context." - - # GET /pipelines/validate - Validate pipeline name - - target: "$.paths./pipelines/validate.get.parameters[?(@.name=='name')].description" - update: "Pipeline name to validate for uniqueness and format." - - - target: "$.paths./pipelines/validate.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier. If omitted, validates pipeline name in a user context." - - - target: "$.paths./pipelines/validate.get.parameters[?(@.name=='orgId')].description" - update: "Organization numeric identifier. Used for organization-level validation." - - # GET /pipelines/{pipelineId} - Describe pipeline - - target: "$.paths./pipelines/{pipelineId}.get.parameters[?(@.name=='pipelineId')].description" - update: "Pipeline numeric identifier." - - - target: "$.paths./pipelines/{pipelineId}.get.parameters[?(@.name=='attributes')].description" - update: "Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns empty values if omitted." - - - target: "$.paths./pipelines/{pipelineId}.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - - target: "$.paths./pipelines/{pipelineId}.get.parameters[?(@.name=='sourceWorkspaceId')].description" - update: "Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace." - - # PUT /pipelines/{pipelineId} - Update pipeline - - target: "$.paths./pipelines/{pipelineId}.put.parameters[?(@.name=='pipelineId')].description" - update: "Pipeline numeric identifier." - - - target: "$.paths./pipelines/{pipelineId}.put.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - # DELETE /pipelines/{pipelineId} - Delete pipeline - - target: "$.paths./pipelines/{pipelineId}.delete.parameters[?(@.name=='pipelineId')].description" - update: "Pipeline numeric identifier." - - - target: "$.paths./pipelines/{pipelineId}.delete.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - # GET /pipelines/{pipelineId}/launch - Describe pipeline launch - - target: "$.paths./pipelines/{pipelineId}/launch.get.parameters[?(@.name=='pipelineId')].description" - update: "Pipeline numeric identifier." - - - target: "$.paths./pipelines/{pipelineId}/launch.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - - target: "$.paths./pipelines/{pipelineId}/launch.get.parameters[?(@.name=='sourceWorkspaceId')].description" - update: "Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace." - - # GET /pipelines/{pipelineId}/schema - Describe pipeline schema - - target: "$.paths./pipelines/{pipelineId}/schema.get.parameters[?(@.name=='pipelineId')].description" - update: "Pipeline numeric identifier." - - - target: "$.paths./pipelines/{pipelineId}/schema.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - - target: "$.paths./pipelines/{pipelineId}/schema.get.parameters[?(@.name=='sourceWorkspaceId')].description" - update: "Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace." - - - target: "$.paths./pipelines/{pipelineId}/schema.get.parameters[?(@.name=='attributes')].description" - update: "Attribute values to include in the response. `schema` returns the pipeline schema, `params` returns the pipeline config. Returns all if omitted." - - # ===== REQUEST BODY PARAMETERS ===== - - # CreatePipelineRequest - Top level fields - - target: "$.components.schemas.CreatePipelineRequest.properties.name" - update: - description: "Pipeline name. Must be unique within the workspace." - - - target: "$.components.schemas.CreatePipelineRequest.properties.description" - update: - description: "Pipeline description." - - - target: "$.components.schemas.CreatePipelineRequest.properties.icon" - update: - description: "Pipeline icon URL." - - - target: "$.components.schemas.CreatePipelineRequest.properties.labelIds" - update: - description: "Array of label IDs to apply to the pipeline." - - # CreatePipelineRequest - Launch object - - target: "$.components.schemas.CreatePipelineRequest.properties.launch" - update: - description: "Launch configuration for the pipeline." - - # UpdatePipelineRequest - Top level fields - - target: "$.components.schemas.UpdatePipelineRequest.properties.name" - update: - description: "Pipeline name. Must be unique within the workspace." - - - target: "$.components.schemas.UpdatePipelineRequest.properties.description" - update: - description: "Pipeline description." - - - target: "$.components.schemas.UpdatePipelineRequest.properties.icon" - update: - description: "Pipeline icon URL." - - - target: "$.components.schemas.UpdatePipelineRequest.properties.labelIds" - update: - description: "Array of label IDs to assign to the pipeline. If null, empty, or omitted, all existing labels are removed. Label IDs to be preserved must be included in your request." - - # UpdatePipelineRequest - Launch object - - target: "$.components.schemas.UpdatePipelineRequest.properties.launch" - update: - description: "Launch configuration for the pipeline." - - # WorkflowLaunchRequest fields (used by both Create and Update) - - target: "$.components.schemas.WorkflowLaunchRequest.properties.id" - update: - description: "Launch configuration identifier." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.computeEnvId" - update: - description: "Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.runName" - update: - description: "Custom run name for the workflow execution." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.pipeline" - update: - description: "Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`)." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.workDir" - update: - description: "Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.revision" - update: - description: "Git revision, branch, or tag to use." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.sessionId" - update: - description: "Nextflow session identifier for resuming failed runs." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.configProfiles" - update: - description: "Array of Nextflow configuration profile names to apply." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.userSecrets" - update: - description: "Array of user secrets to make available to the pipeline." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.workspaceSecrets" - update: - description: "Array of workspace secrets to make available to the pipeline." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.configText" - update: - description: "Nextflow configuration as text (overrides config files)." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.towerConfig" - update: - description: "Platform-specific configuration options." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.paramsText" - update: - description: "Pipeline parameters in JSON or YAML format." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.preRunScript" - update: - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.postRunScript" - update: - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.mainScript" - update: - description: "Alternative main script filename. Default: `main.nf`." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.entryName" - update: - description: "Workflow entry point name when using Nextflow DSL2." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.schemaName" - update: - description: "Name of the pipeline schema to use." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.resume" - update: - description: "Enable resume to restart workflow execution from the last successful process. See [Resume a workflow run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run)." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.pullLatest" - update: - description: "Pull the latest version of the pipeline from the repository." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.stubRun" - update: - description: "Execute a stub run for testing (processes return dummy results)." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.optimizationId" - update: - description: "Optimization configuration identifier. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.optimizationTargets" - update: - description: "Comma-separated list of optimization targets. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.labelIds" - update: - description: "Array of label IDs to assign to each pipeline run." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.headJobCpus" - update: - description: "Number of CPUs allocated for the Nextflow head job." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.headJobMemoryMb" - update: - description: "Memory allocation for the Nextflow head job in megabytes." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.launchContainer" - update: - description: "Container image to use for the Nextflow launcher." - - - target: "$.components.schemas.WorkflowLaunchRequest.properties.dateCreated" - update: - description: "Timestamp when the launch configuration was created." \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/pipelines-workflows-workspaces-overlay-1.85.yaml b/platform-api-docs/scripts/overlays_archive/pipelines-workflows-workspaces-overlay-1.85.yaml deleted file mode 100644 index d03e21e6d..000000000 --- a/platform-api-docs/scripts/overlays_archive/pipelines-workflows-workspaces-overlay-1.85.yaml +++ /dev/null @@ -1,68 +0,0 @@ -overlay: 1.0.0 -info: - title: Remaining endpoints overlay (pipelines, workflows, workspaces) - version: 0.0.0 -actions: - # ===== PIPELINES - OPERATIONS ===== - - # ---- UPDATE PIPELINE ---- - - - target: "$.paths./pipelines/{pipelineId}.put.summary" - update: "Update pipeline" - - - target: "$.paths./pipelines/{pipelineId}.put.description" - update: "Updates the details of the pipeline identified by the given `pipelineId`.\n\n**Note**: If `labelIds` is `null`, empty, or omitted, existing pipeline labels are removed. Include `labelIds: [,]` to override existing labels. Labels to be preserved must be included. To append a list of labels to multiple pipelines, use `/pipelines/labels/add`." - - # ===== PIPELINES - PARAMETERS ===== - - # ---- LIST PIPELINES ---- - - - target: "$.paths./pipelines.get.parameters[?(@.name=='attributes')].description" - update: "Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns an empty value (`labels: null`, etc.) if omitted." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='max')].description" - update: "Maximum number of pipelines to return per request." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='offset')].description" - update: "Number of results to skip for pagination. Default: `0`." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='sortBy')].description" - update: "Field to sort pipelines by. Accepts `NAME`, `CREATED`, or `MODIFIED`. Default: `NAME`." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='sortDir')].description" - update: "Sort direction for results. Accepts `ASCENDING` or `DESCENDING`. Default: `ASCENDING`." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='search')].description" - update: "Free-text search filter to match against pipeline names and descriptions." - - - target: "$.paths./pipelines.get.parameters[?(@.name=='visibility')].description" - update: "Filter pipelines by visibility. Accepts `private`, `shared`, or `all`." - - # ===== WORKFLOWS - OPERATIONS ===== - - # ---- GET WORKFLOW LOG ---- - - - target: "$.paths./workflow/{workflowId}/log.get.operationId" - update: "GetWorkflowLog" - - - target: "$.paths./workflow/{workflowId}/log.get.summary" - update: "Get workflow log" - - - target: "$.paths./workflow/{workflowId}/log.get.description" - update: "Retrieves the execution log output of the workflow identified by the given `workflowId`." - - # ===== WORKSPACES - OPERATIONS ===== - - # ---- VALIDATE WORKSPACE NAME ---- - - - target: "$.paths./orgs/{orgId}/workspaces/validate.get.operationId" - update: "ValidateWorkspaceName" - - - target: "$.paths./orgs/{orgId}/workspaces/validate.get.summary" - update: "Validate workspace name" - - - target: "$.paths./orgs/{orgId}/workspaces/validate.get.description" - update: "Confirms the validity of the given workspace name within the organization identified by the given `orgId`. Append `?name=`." \ No newline at end of file diff --git a/platform-api-docs/scripts/overlays_archive/request-examples-overlay.yaml b/platform-api-docs/scripts/overlays_archive/request-examples-overlay.yaml deleted file mode 100644 index fa0096c45..000000000 --- a/platform-api-docs/scripts/overlays_archive/request-examples-overlay.yaml +++ /dev/null @@ -1,156 +0,0 @@ -overlay: "1.0.0" -info: - title: "Compute Environment Examples Enhancement" - version: "1.0.0" - description: "Adds comprehensive examples for creating compute environments across different cloud providers" - -actions: - # Add multiple provider examples to compute environment creation endpoint - - target: "$.paths['/compute-envs'].post.requestBody.content['application/json']" - update: - examples: - AwsBatchForge: - description: "A minimal AWS Batch Forge compute environment with Wave and Fusion enabled." - value: - computeEnv: - name: "aws-batch-ce" - platform: "aws-batch" - credentialsId: "your-aws-credentials-id" - description: "Minimal AWS Batch Forge compute environment with Wave, Fusion, and fast instance storage enabled" - config: - region: "eu-west-2" - forge: - type: "SPOT" - minCpus: "0" - maxCpus: "100" - workDir: "s3://your-bucket/work" - waveEnabled: "true" - fusion2Enabled: "true" - nvnmeStorageEnabled: "true" - - AwsCloud: - description: "Minimal AWS Cloud compute environment with default instance type and AMI" - value: - computeEnv: - name: "aws-cloud-ce" - description: "Minimal AWS Cloud compute environment with default instance type and AMI" - platform: "aws-cloud" - credentialsId: "your-aws-credentials-id" - config: - region: "eu-west-2" - workDir: "s3://your-bucket/work" - - GoogleBatch: - description: "Minimal Google Cloud Batch compute environment with Wave and Fusion enabled" - value: - computeEnv: - name: "google-batch-ce" - description: "Minimal Google Cloud Batch compute environment with Wave and Fusion enabled" - platform: "google-batch" - credentialsId: "your-google-credentials-id" - config: - location: "europe-west2" - workDir: "gs://your-bucket/work" - spot: true - waveEnabled: true - fusion2Enabled: true - - GoogleCloud: - description: "Minimal Google Cloud compute environment with default instance type and image ID" - value: - computeEnv: - name: "google-cloud-ce" - description: "Minimal Google Cloud compute environment with default instance type and image ID" - platform: "google-cloud" - credentialsId: "your-google-credentials-id" - config: - region: "europe-west2" - workDir: "gs://your-bucket/work" - - AzureBatchForge: - description: "Minimal Azure Batch Forge compute environment with Wave and Fusion enabled" - value: - computeEnv: - name: "azure-batch-ce" - description: "Minimal Azure Batch Forge compute environment with Wave and Fusion enabled" - platform: "azure-batch" - credentialsId: "your-azure-credentials-id" - config: - region: "eastus" - workDir: "az://your-storage-account/work" - forge: - vmCount: 50 - autoScale: true - waveEnabled: true - fusion2Enabled: true - - AwsEks: - description: "Minimal AWS EKS compute environment with Fusion storage" - value: - computeEnv: - name: "aws-eks-ce" - description: "Minimal AWS EKS compute environment with Fusion storage" - platform: "eks-platform" - credentialsId: "your-aws-credentials-id" - config: - region: "eu-west-2" - workDir: "s3://your-bucket/work" - clusterName: "your-cluster-name" - namespace: "your-namespace" - headServiceAccount: "your-service-account" - waveEnabled: "true" - fusion2Enabled: "true" - - GoogleGke: - description: "Minimal Google Kubernetes Engine compute environment with Fusion storage" - value: - computeEnv: - name: "gke-ce" - description: "Minimal Google Kubernetes Engine compute environment with Fusion storage" - platform: "gke-platform" - credentialsId: "your-google-credentials-id" - config: - region: "europe-west2" - workDir: "gs://your-bucket/work" - clusterName: "your-cluster-name" - namespace: "your-namespace" - headServiceAccount: "your-service-account" - waveEnabled: "true" - fusion2Enabled: "true" - - Kubernetes: - description: "Minimal Kubernetes compute environment with persistent volume storage" - value: - computeEnv: - name: "k8s-ce" - description: "Minimal Kubernetes compute environment with persistent volume storage" - platform: "k8s-platform" - credentialsId: "your-k8s-credentials-id" - config: - workDir: "/workspace" - server: "https://your-k8s-api-server:6443" - sslCert: "-----BEGIN CERTIFICATE-----\nYOUR_CERTIFICATE\n-----END CERTIFICATE-----" - namespace: "your-namespace" - headServiceAccount: "your-service-account" - storageClaimName: "your-storage-claim" - storageMountPath: "/workspace" - - # Add request example to POST /pipelines (CreatePipeline) - - target: "$.paths./pipelines.post.requestBody.content.application/json" - update: - examples: - BasicPipelineCreation: - summary: "Create a pipeline with nf-core/rnaseq" - description: "Minimal pipeline creation request using nf-core/rnaseq with the `test_full` configuration profile." - value: - name: "rnaseq-pipeline" - description: "Minimal nf-core/rnaseq pipeline configuration with the `test_full` profile." - launch: - pipeline: "https://github.com/nf-core/rnaseq" - computeEnvId: "your-compute-env-id" - revision: "master" - configProfiles: - - "test_full" - labelIds: - - "label_id_1" - - "label_id_2" diff --git a/platform-api-docs/scripts/specs/api-1.85-full-overlay.yaml b/platform-api-docs/scripts/specs/api-1.85-full-overlay.yaml deleted file mode 100644 index 6ff46626f..000000000 --- a/platform-api-docs/scripts/specs/api-1.85-full-overlay.yaml +++ /dev/null @@ -1,1678 +0,0 @@ -overlay: 1.0.0 -info: - title: Seqera Platform API v1.85 overlay - version: 1.0.0 - description: Combines all specs folder overlays into a single overlay to apply to our decorated spec. - -actions: -- target: "$" - update: - servers: - - url: https://api.cloud.seqera.io - description: Seqera Platform Cloud API - -# ===== HPC COMPUTE CONFIGS - GRID SCHEDULER PROPERTY DESCRIPTIONS ===== - -# These properties were previously inherited from AbstractGridConfig and now need -# explicit descriptions on each scheduler type (LSF, Slurm, Altair PBS, Moab, Univa) - -# ---- LSF COMPUTE CONFIG ---- - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.workDir" - update: - type: string - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.launchDir" - update: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.userName" - update: - type: string - description: "Username for SSH connection to HPC head node." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.hostName" - update: - type: string - description: "Hostname or IP address of HPC head node." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.port" - update: - type: integer - format: int32 - description: "SSH port. Default: `22`." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.headQueue" - update: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.computeQueue" - update: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.maxQueueSize" - update: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.headJobOptions" - update: - type: string - description: "Additional submit options for the Nextflow head job." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.propagateHeadJobOptions" - update: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.LsfComputeConfig.allOf[1].properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ---- SLURM COMPUTE CONFIG ---- - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.workDir" - update: - type: string - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.launchDir" - update: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.userName" - update: - type: string - description: "Username for SSH connection to HPC head node." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.hostName" - update: - type: string - description: "Hostname or IP address of HPC head node." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.port" - update: - type: integer - format: int32 - description: "SSH port. Default: `22`." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.headQueue" - update: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.computeQueue" - update: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.maxQueueSize" - update: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.headJobOptions" - update: - type: string - description: "Additional submit options for the Nextflow head job." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.propagateHeadJobOptions" - update: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.SlurmComputeConfig.allOf[1].properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ---- ALTAIR PBS COMPUTE CONFIG ---- - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.workDir" - update: - type: string - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.launchDir" - update: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.userName" - update: - type: string - description: "Username for SSH connection to HPC head node." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.hostName" - update: - type: string - description: "Hostname or IP address of HPC head node." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.port" - update: - type: integer - format: int32 - description: "SSH port. Default: `22`." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.headQueue" - update: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.computeQueue" - update: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.maxQueueSize" - update: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.headJobOptions" - update: - type: string - description: "Additional submit options for the Nextflow head job." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.propagateHeadJobOptions" - update: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.AltairPbsComputeConfig.allOf[1].properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ---- MOAB COMPUTE CONFIG ---- - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.workDir" - update: - type: string - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.launchDir" - update: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.userName" - update: - type: string - description: "Username for SSH connection to HPC head node." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.hostName" - update: - type: string - description: "Hostname or IP address of HPC head node." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.port" - update: - type: integer - format: int32 - description: "SSH port. Default: `22`." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.headQueue" - update: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.computeQueue" - update: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.maxQueueSize" - update: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.headJobOptions" - update: - type: string - description: "Additional submit options for the Nextflow head job." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.propagateHeadJobOptions" - update: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.MoabComputeConfig.allOf[1].properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ---- UNIVA COMPUTE CONFIG ---- - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.workDir" - update: - type: string - description: "Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.launchDir" - update: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.userName" - update: - type: string - description: "Username for SSH connection to HPC head node." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.hostName" - update: - type: string - description: "Hostname or IP address of HPC head node." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.port" - update: - type: integer - format: int32 - description: "SSH port. Default: `22`." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.headQueue" - update: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.computeQueue" - update: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.maxQueueSize" - update: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.headJobOptions" - update: - type: string - description: "Additional submit options for the Nextflow head job." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.propagateHeadJobOptions" - update: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.UnivaComputeConfig.allOf[1].properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ===== NEW SCHEMAS - 1.85 ===== -# Descriptions for completely new schemas added in 1.85 - -# ---- LOCAL COMPUTE CONFIG ---- - -- target: "$.components.schemas.LocalComputeConfig.properties.discriminator" - update: - type: string - description: "Platform type discriminator (read-only, set based on platform selection)." - -- target: "$.components.schemas.LocalComputeConfig.properties.workDir" - update: - type: string - description: "Nextflow work directory on the local file system. Must be an absolute path and credentials must have read-write access." - -- target: "$.components.schemas.LocalComputeConfig.properties.preRunScript" - update: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.LocalComputeConfig.properties.postRunScript" - update: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - -- target: "$.components.schemas.LocalComputeConfig.properties.environment" - update: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - description: "Environment variables to set for Nextflow execution." - -- target: "$.components.schemas.LocalComputeConfig.properties.waveEnabled" - update: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - -- target: "$.components.schemas.LocalComputeConfig.properties.fusion2Enabled" - update: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - -- target: "$.components.schemas.LocalComputeConfig.properties.nextflowConfig" - update: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - -# ---- LOCAL SECURITY KEYS ---- - -- target: "$.components.schemas.LocalSecurityKeys.properties.discriminator" - update: - type: string - description: "Credentials provider type identifier." - -- target: "$.components.schemas.LocalSecurityKeys.properties.password" - update: - type: string - writeOnly: true - description: "Password for local platform access." - -# ---- AZURE CLOUD KEYS ---- - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.discriminator" - update: - type: string - description: "Credentials provider type identifier." - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.subscriptionId" - update: - type: string - description: "Azure subscription ID." - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.storageName" - update: - type: string - description: "Azure storage account name." - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.tenantId" - update: - type: string - description: "Azure tenant ID." - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.clientId" - update: - type: string - description: "Azure service principal client ID." - -- target: "$.components.schemas.AzureCloudKeys.allOf[1].properties.clientSecret" - update: - type: string - writeOnly: true - description: "Azure service principal client secret." - -# ---- AZURE CLOUD PLATFORM META INFO ---- - -- target: "$.components.schemas.AzCloudPlatformMetaInfo.properties.discriminator" - update: - type: string - description: "Platform type identifier." - -- target: "$.components.schemas.AzCloudPlatformMetaInfo.properties.warnings" - update: - type: array - items: - type: string - description: "Azure Cloud configuration warnings." - -- target: "$.components.schemas.AzCloudPlatformMetaInfo.properties.containers" - update: - type: array - items: - type: string - description: "Azure Blob Storage containers accessible to workspace credentials." - -- target: "$.components.schemas.AzCloudPlatformMetaInfo.properties.instanceTypes" - update: - type: array - items: - type: string - description: "Available Azure VM instance types." - -# ---- STUDIO REMOTE CONFIGURATION ---- - -- target: "$.components.schemas.StudioRemoteConfiguration.properties.repository" - update: - type: string - description: "Git repository URL for Studios remote configuration." - -- target: "$.components.schemas.StudioRemoteConfiguration.properties.revision" - update: - type: string - nullable: true - description: "Git branch, tag, or commit ID. If omitted, uses the default branch." - -- target: "$.components.schemas.StudioRemoteConfiguration.properties.commitId" - update: - type: string - nullable: true - description: "Git commit ID for the remote configuration. Maximum length: 40 characters." - -# ---- COMPUTE ENV RESOURCES ---- - -- target: "$.components.schemas.ComputeEnvResources.properties.cpus" - update: - type: integer - format: int32 - nullable: true - description: "Number of CPUs allocated to the compute environment. Null if information is unavailable." - -- target: "$.components.schemas.ComputeEnvResources.properties.memory" - update: - type: integer - format: int32 - nullable: true - description: "Memory allocated to the compute environment in GB. Null if information is unavailable." - -- target: "$.components.schemas.ComputeEnvResources.properties.gpus" - update: - type: integer - format: int32 - nullable: true - description: "Number of GPUs allocated to the compute environment. Null if information is unavailable." - -- target: "$.components.schemas.ComputeEnvResources.properties.diskSize" - update: - type: integer - format: int32 - nullable: true - description: "Disk size allocated to the compute environment in GB. Null if information is unavailable." - -- target: "$.components.schemas.ComputeEnvResources.properties.estimatedPrice" - update: - type: number - format: float - nullable: true - description: "Estimated hourly cost of the compute environment in USD. Null if information is unavailable." - -- target: "$.components.schemas.ComputeEnvResources.properties.instanceType" - update: - type: string - nullable: true - description: "Instance type used by the compute environment. Null if information is unavailable." - -# ---- DATA STUDIO CREATE REQUEST ---- - -# Update required fields to only computeEnvId and name -- target: "$.components.schemas.DataStudioCreateRequest.required[*]" - remove: true - -- target: "$.components.schemas.DataStudioCreateRequest.required" - update: - - computeEnvId - - name - -# Remove minLength constraint from dataStudioToolUrl -- target: "$.components.schemas.DataStudioCreateRequest.properties.dataStudioToolUrl.minLength" - remove: true - -# Add remoteConfig property -- target: "$.components.schemas.DataStudioCreateRequest.properties.remoteConfig" - update: - nullable: true - allOf: - - $ref: "#/components/schemas/StudioRemoteConfiguration" - -# ---- DATA STUDIO DTO ---- - -# Add remoteConfig property -- target: "$.components.schemas.DataStudioDto.properties.remoteConfig" - update: - $ref: "#/components/schemas/StudioRemoteConfiguration" - -# ---- DATA STUDIO WORKSPACE SETTINGS RESPONSE ---- - -# Remove required array -- target: "$.components.schemas.DataStudioWorkspaceSettingsResponse.required" - remove: true - -# ===== PIPELINES - OPERATIONS ===== - -# ---- UPDATE PIPELINE ---- - -- target: "$.paths./pipelines/{pipelineId}.put.summary" - update: "Update pipeline" - -- target: "$.paths./pipelines/{pipelineId}.put.description" - update: "Updates the details of the pipeline identified by the given `pipelineId`.\n\n**Note**: If `labelIds` is `null`, empty, or omitted, existing pipeline labels are removed. Include `labelIds: [,]` to override existing labels. Labels to be preserved must be included. To append a list of labels to multiple pipelines, use `/pipelines/labels/add`." - -# ===== PIPELINES - PARAMETERS ===== - -# ---- LIST PIPELINES ---- - -- target: "$.paths./pipelines.get.parameters[?(@.name=='attributes')].description" - update: "Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns an empty value (`labels: null`, etc.) if omitted." - -- target: "$.paths./pipelines.get.parameters[?(@.name=='workspaceId')].description" - update: "Workspace numeric identifier." - -- target: "$.paths./pipelines.get.parameters[?(@.name=='max')].description" - update: "Maximum number of pipelines to return per request." - -- target: "$.paths./pipelines.get.parameters[?(@.name=='offset')].description" - update: "Number of results to skip for pagination. Default: `0`." - -- target: "$.paths./pipelines.get.parameters[?(@.name=='sortBy')].description" - update: "Field to sort pipelines by. Accepts `NAME`, `CREATED`, or `MODIFIED`. Default: `NAME`." - -- target: "$.paths./pipelines.get.parameters[?(@.name=='sortDir')].description" - update: "Sort direction for results. Accepts `ASCENDING` or `DESCENDING`. Default: `ASCENDING`." - -- target: "$.paths./pipelines.get.parameters[?(@.name=='search')].description" - update: "Free-text search filter to match against pipeline names and descriptions." - -- target: "$.paths./pipelines.get.parameters[?(@.name=='visibility')].description" - update: "Filter pipelines by visibility. Accepts `private`, `shared`, or `all`." - -# ===== WORKFLOWS - OPERATIONS ===== - -# ---- GET WORKFLOW LOG ---- - -- target: "$.paths./workflow/{workflowId}/log.get.operationId" - update: "GetWorkflowLog" - -- target: "$.paths./workflow/{workflowId}/log.get.summary" - update: "Get workflow log" - -- target: "$.paths./workflow/{workflowId}/log.get.description" - update: "Retrieves the execution log output of the workflow identified by the given `workflowId`." - -# ===== WORKSPACES - OPERATIONS ===== - -# ---- VALIDATE WORKSPACE NAME ---- - -- target: "$.paths./orgs/{orgId}/workspaces/validate.get.operationId" - update: "ValidateWorkspaceName" - -- target: "$.paths./orgs/{orgId}/workspaces/validate.get.summary" - update: "Validate workspace name" - -- target: "$.paths./orgs/{orgId}/workspaces/validate.get.description" - update: "Confirms the validity of the given workspace name within the organization identified by the given `orgId`. Append `?name=`." - -# ===== DATA-LINKS OPERATIONS - SUMMARIES & DESCRIPTIONS ===== - -# GET /data-links/cache/refresh - Refresh data-link cache -- target: "$.paths./data-links/cache/refresh.get" - update: - summary: "Refresh data-link cache" - description: "Refreshes the data-link cache for the given `workspaceId` or `credentialsId`. Forces immediate re-discovery of available cloud storage resources." - -# GET /data-links/ - List data-links -- target: "$.paths./data-links/.get" - update: - summary: "List data-links" - description: "Retrieves all available data-links in a user context. Append `?workspaceId={your-workspace-id}` to retrieve data-links in a workspace context. Results can be filtered by credentials, provider, region, search query, and visibility." - -# GET /data-links/{dataLinkId}/browse{/path} - Explore data-link path -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get" - update: - summary: "Explore data-link path" - description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`. Returns a paginated list of files and folders at the specified location." - -# GET /data-links/{dataLinkId}/browse-tree - Explore data-link tree -- target: "$.paths./data-links/{dataLinkId}/browse-tree.get" - update: - summary: "Explore data-link tree" - description: "Retrieves a list of all files in the data-link associated with the given `dataLinkId`, including files in sub-paths. Useful for retrieving complete directory structures." - -# GET /data-links/{dataLinkId} - Describe data-link -- target: "$.paths./data-links/{dataLinkId}.get" - update: - summary: "Describe data-link" - description: "Retrieves the details of the data-link associated with the given `dataLinkId`, including provider information, credentials, and access status." - -# POST /data-links/hide - Hide data-links -- target: "$.paths./data-links/hide.post" - update: - summary: "Hide data-links" - description: "Hides the given data-links from the data-links list view. Hidden data-links remain accessible but are filtered from default list views." - -# POST /data-links/show - Show data-links -- target: "$.paths./data-links/show.post" - update: - summary: "Show data-links" - description: "Shows previously hidden data-links in the data-links list view." - -# POST /data-links/ - Create data-link -- target: "$.paths./data-links/.post" - update: - summary: "Create data-link" - description: "Creates a new data-link in a user context. Append `?workspaceId=` to create the data-link in a workspace context. Data-links can be public (no credentials required) or private (credentials-based access)." - -# PUT /data-links/{dataLinkId} - Update data-link -- target: "$.paths./data-links/{dataLinkId}.put" - update: - summary: "Update data-link" - description: "Updates the data-link associated with the given `dataLinkId`. Allows modification of name, description, and associated credentials." - -# DELETE /data-links/{dataLinkId} - Delete data-link -- target: "$.paths./data-links/{dataLinkId}.delete" - update: - summary: "Delete data-link" - description: "Deletes the data-link associated with the given `dataLinkId`. The underlying cloud storage resource is not affected." - -# GET /data-links/{dataLinkId}/download/{+filePath} - Download data-link file -- target: "$.paths./data-links/{dataLinkId}/download/{+filePath}.get" - update: - summary: "Download data-link file" - description: "Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`. Returns the file content directly as a streamed response." - -# GET /data-links/{dataLinkId}/generate-download-url - Generate download URL -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get" - update: - summary: "Generate download URL" - description: "Returns a pre-signed URL to download files from the data-link associated with the given `dataLinkId`. The URL can be used for direct downloads or preview purposes." - -# GET /data-links/{dataLinkId}/script/download - Generate download script -- target: "$.paths./data-links/{dataLinkId}/script/download.get" - update: - summary: "Generate download script" - description: "Creates a script to download files from the data-link associated with the given `dataLinkId`. Append `?dirs` or `?files` to specify a list of files or paths to download within the data-link." - -# POST /data-links/{dataLinkId}/upload{/dirPath} - Generate upload URL -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post" - update: - summary: "Generate upload URL" - description: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint." - -# POST /data-links/{dataLinkId}/upload/finish{/dirPath} - Finish upload -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post" - update: - summary: "Finish upload" - description: "Finalizes upload of a data-link file, specifying a file path (`dirPath`). This endpoint is required for AWS S3 data-links to complete a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." - -# DELETE /data-links/{dataLinkId}/content - Delete data-link content -- target: "$.paths./data-links/{dataLinkId}/content.delete" - update: - summary: "Delete data-link content" - description: "Deletes the content of the data-link associated with the given `dataLinkId`. The data-link itself is preserved, but files and directories within it are removed." - -# ===== DATA-LINKS PARAMETERS - PATH, QUERY, AND REQUEST BODY ===== - -# ---- PATH PARAMETERS ---- - -# dataLinkId - used across multiple endpoints -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/browse-tree.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}.put.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}.delete.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/download/{+filePath}.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/script/download.get.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -- target: "$.paths./data-links/{dataLinkId}/content.delete.parameters[?(@.name=='dataLinkId')]" - update: - description: "Data-link string identifier." - -# path parameter -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='path')]" - update: - description: "Content path within the data-link. Use forward slashes to navigate directory structures (e.g., `folder/subfolder`)." - -# filePath parameter -- target: "$.paths./data-links/{dataLinkId}/download/{+filePath}.get.parameters[?(@.name=='filePath')]" - update: - description: "File path to download within the data-link (e.g., `folder/subfolder/object`)." - -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get.parameters[?(@.name=='filePath')]" - update: - description: "File path to download within the data-link (e.g., `folder/subfolder/object`)." - -# dirPath parameter -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post.parameters[?(@.name=='dirPath')]" - update: - description: "Path to the destination directory within the data-link where the file will be uploaded (e.g., `folder/subfolder`)." - -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post.parameters[?(@.name=='dirPath')]" - update: - description: "Path to the destination directory within the data-link where the file was uploaded (e.g., `folder/subfolder`)." - -# ---- QUERY PARAMETERS - workspaceId ---- - -- target: "$.paths./data-links/cache/refresh.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, refreshes cache in a user context." - -- target: "$.paths./data-links/.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, lists data-links in a user context." - -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/browse-tree.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/hide.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/show.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, creates data-link in a user context." - -- target: "$.paths./data-links/{dataLinkId}.put.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}.delete.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/download/{+filePath}.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/script/download.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -- target: "$.paths./data-links/{dataLinkId}/content.delete.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. Optional." - -# ---- QUERY PARAMETERS - credentialsId ---- - -- target: "$.paths./data-links/cache/refresh.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Filters cache refresh to data-links accessible with the specified credentials." - -- target: "$.paths./data-links/.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Filters results to data-links accessible with the specified credentials." - -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for accessing private data-links." - -- target: "$.paths./data-links/{dataLinkId}/browse-tree.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for accessing private data-links." - -- target: "$.paths./data-links/{dataLinkId}.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for accessing private data-links." - -- target: "$.paths./data-links/{dataLinkId}/download/{+filePath}.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for downloading from private data-links." - -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for generating download URLs for private data-links." - -- target: "$.paths./data-links/{dataLinkId}/script/download.get.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for generating download scripts for private data-links." - -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for uploading to private data-links." - -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for finalizing uploads to private data-links." - -- target: "$.paths./data-links/{dataLinkId}/content.delete.parameters[?(@.name=='credentialsId')]" - update: - description: "Credentials string identifier. Required for deleting content from private data-links." - -# ---- SEARCH AND FILTER PARAMETERS ---- - -- target: "$.paths./data-links/.get.parameters[?(@.name=='search')]" - update: - description: "Free text search criteria. Supports data-link `name`, `region`, and `provider`." - -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='search')]" - update: - description: "Prefix search of data-link content. Filters files and folders by `name` prefix (e.g., `search=my-file` matches `my-file.txt`, `my-file-2.csv`)." - -# ---- PAGINATION PARAMETERS ---- - -- target: "$.paths./data-links/.get.parameters[?(@.name=='max')]" - update: - description: "Maximum number of results to return. Default: `25`, maximum: `100`." - -- target: "$.paths./data-links/.get.parameters[?(@.name=='offset')]" - update: - description: "Number of results to skip for pagination. Default: `0`." - -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='pageSize')]" - update: - description: "Number of items to return per page. If omitted, a default maximum value is returned. Maximum: `100`." - -- target: "$.paths./data-links/{dataLinkId}/browse{/path}.get.parameters[?(@.name=='nextPageToken')]" - update: - description: "Token used to fetch the next page of items. Obtained from the previous response." - -# ---- VISIBILITY PARAMETERS ---- - -- target: "$.paths./data-links/.get.parameters[?(@.name=='visibility')]" - update: - description: "Visibility filter. Supports `visible` (show only visible data-links), `hidden` (show only hidden data-links), or `all` (show all data-links)." - -# ---- DOWNLOAD/UPLOAD PARAMETERS ---- - -- target: "$.paths./data-links/{dataLinkId}/generate-download-url.get.parameters[?(@.name=='preview')]" - update: - description: "If `true`, generates a URL for preview purposes. If `false`, generates a URL for direct download. Default: `false`." - -- target: "$.paths./data-links/{dataLinkId}/script/download.get.parameters[?(@.name=='dirs')]" - update: - description: "List of directory paths to include in the download script." - -- target: "$.paths./data-links/{dataLinkId}/script/download.get.parameters[?(@.name=='files')]" - update: - description: "List of file paths to include in the download script." - -- target: "$.paths./data-links/{dataLinkId}/browse-tree.get.parameters[?(@.name=='paths')]" - update: - description: "List of paths to explore. Returns all files within the specified paths, including sub-paths." - -# ---- REQUEST BODY DESCRIPTIONS ---- - -- target: "$.paths./data-links/hide.post.requestBody" - update: - description: "Data-link IDs to hide." - -- target: "$.paths./data-links/show.post.requestBody" - update: - description: "Data-link IDs to show." - -- target: "$.paths./data-links/.post.requestBody" - update: - description: "Data-link creation request." - -- target: "$.paths./data-links/{dataLinkId}.put.requestBody" - update: - description: "Data-link update request." - -- target: "$.paths./data-links/{dataLinkId}/upload{/dirPath}.post.requestBody" - update: - description: "Multi-part upload request containing file metadata (name, size, content type)." - -- target: "$.paths./data-links/{dataLinkId}/upload/finish{/dirPath}.post.requestBody" - update: - description: "Finish multi-part upload request for AWS S3 data-links, containing upload ID, file name, part tags, and error status." - -- target: "$.paths./data-links/{dataLinkId}/content.delete.requestBody" - update: - description: "Data-link content deletion request specifying files and directories to delete." - -# ===== DATA-LINKS SCHEMAS - REQUEST/RESPONSE OBJECTS ===== - -# ---- REQUEST SCHEMAS ---- - -# DataLinkCreateRequest -- target: "$.components.schemas.DataLinkCreateRequest.properties.name" - update: - description: "Unique name for the data-link. Must consist of alphanumeric, dash, or underscore characters." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.description" - update: - description: "Description of the data-link. Maximum length: 1000 characters." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.type" - update: - description: "Type of the data-link. Currently supports `bucket`." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.provider" - update: - description: "Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.resourceRef" - update: - description: "Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.publicAccessible" - update: - description: "Whether the data-link is publicly accessible. If `true`, no credentials are required. If `false`, `credentialsId` must be provided." - -- target: "$.components.schemas.DataLinkCreateRequest.properties.credentialsId" - update: - description: "Credentials string identifier. Required when `publicAccessible` is `false`." - -# DataLinkUpdateRequest -- target: "$.components.schemas.DataLinkUpdateRequest.properties.name" - update: - description: "New name for the data-link. Must be unique within the workspace or user context." - -- target: "$.components.schemas.DataLinkUpdateRequest.properties.description" - update: - description: "Updated description for the data-link. Maximum length: 1000 characters." - -- target: "$.components.schemas.DataLinkUpdateRequest.properties.credentialsId" - update: - description: "Updated credentials ID for accessing the data-link." - -# DataLinksVisibilityRequest -- target: "$.components.schemas.DataLinksVisibilityRequest.properties.dataLinkIds" - update: - description: "Array of data-link IDs to hide or show." - -# DataLinkDeleteItemRequest -- target: "$.components.schemas.DataLinkDeleteItemRequest.properties.files" - update: - description: "Array of file paths to be deleted from the data-link." - -- target: "$.components.schemas.DataLinkDeleteItemRequest.properties.dirs" - update: - description: "Array of directory paths to be deleted from the data-link." - -# DataLinkMultiPartUploadRequest -- target: "$.components.schemas.DataLinkMultiPartUploadRequest.properties.fileName" - update: - description: "Name of the file to upload." - -- target: "$.components.schemas.DataLinkMultiPartUploadRequest.properties.contentLength" - update: - description: "Size of the file to upload in bytes." - -- target: "$.components.schemas.DataLinkMultiPartUploadRequest.properties.contentType" - update: - description: "MIME type of the file to upload (e.g., `application/octet-stream`, `text/plain`)." - -# DataLinkFinishMultiPartUploadRequest -- target: "$.components.schemas.DataLinkFinishMultiPartUploadRequest.properties.uploadId" - update: - description: "Upload ID assigned when initiating multi-part upload for AWS S3. Obtained from the `/upload` endpoint response." - -- target: "$.components.schemas.DataLinkFinishMultiPartUploadRequest.properties.fileName" - update: - description: "Name of the uploaded file." - -- target: "$.components.schemas.DataLinkFinishMultiPartUploadRequest.properties.tags" - update: - description: "Array of ETags assigned for each part by AWS S3 during the upload process. Each ETag is returned in the response headers when uploading a part to the pre-signed URLs from the `/upload` endpoint." - -- target: "$.components.schemas.DataLinkFinishMultiPartUploadRequest.properties.withError" - update: - description: "Flag indicating whether the upload encountered an error. If `true`, the upload will be aborted. If `false`, the upload will be completed." - -# ---- RESPONSE SCHEMAS ---- - -# DataLinkResponse -- target: "$.components.schemas.DataLinkResponse.properties.dataLink" - update: - description: "Data-link object containing metadata." - -# DataLinksListResponse -- target: "$.components.schemas.DataLinksListResponse.properties.dataLinks" - update: - description: "Array of data-link objects." - -- target: "$.components.schemas.DataLinksListResponse.properties.totalSize" - update: - description: "Total number of data-links matching the query." - -- target: "$.components.schemas.DataLinksListResponse.properties.isFetching" - update: - description: "Flag indicating whether more data-links are currently being fetched from cloud providers. Not rendered in JSON response; used to determine HTTP status code." - -# DataLinkContentResponse -- target: "$.components.schemas.DataLinkContentResponse.properties.originalPath" - update: - description: "Base path for all returned objects within the data-link." - -- target: "$.components.schemas.DataLinkContentResponse.properties.objects" - update: - description: "Array of data-link items (files and folders) at the specified path." - -- target: "$.components.schemas.DataLinkContentResponse.properties.nextPageToken" - update: - description: "Token that can be used to request the next page of items. Null if no more items are available." - -# DataLinkContentTreeListResponse -- target: "$.components.schemas.DataLinkContentTreeListResponse.properties.items" - update: - description: "Array of simple data-link items containing file paths and sizes." - -# DataLinkDownloadUrlResponse -- target: "$.components.schemas.DataLinkDownloadUrlResponse.properties.url" - update: - description: "Pre-signed URL to download the requested file." - -# DataLinkDownloadScriptResponse -- target: "$.components.schemas.DataLinkDownloadScriptResponse.properties.script" - update: - description: "Shell script content to download files from the data-link." - -# DataLinkMultiPartUploadResponse -- target: "$.components.schemas.DataLinkMultiPartUploadResponse.properties.uploadId" - update: - description: "Upload ID generated by AWS S3. Required for the `/upload/finish` request." - -- target: "$.components.schemas.DataLinkMultiPartUploadResponse.properties.uploadUrls" - update: - description: "Array of pre-signed URLs to execute multi-part upload. One URL per part." - -# DataLinkDeleteItemResponse -- target: "$.components.schemas.DataLinkDeleteItemResponse.properties.deletionFailures" - update: - description: "Array of items that failed to be deleted, including error messages." - -# ---- DTO SCHEMAS ---- - -# DataLinkDto -- target: "$.components.schemas.DataLinkDto.properties.id" - update: - description: "Data-link string identifier. Generated based on provider, type, region, and resource path." - -- target: "$.components.schemas.DataLinkDto.properties.name" - update: - description: "Name of the data-link (e.g., bucket name)." - -- target: "$.components.schemas.DataLinkDto.properties.description" - update: - description: "Description of the data-link. Null for data-links auto-discovered from workspace credentials." - -- target: "$.components.schemas.DataLinkDto.properties.resourceRef" - update: - description: "Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)." - -- target: "$.components.schemas.DataLinkDto.properties.type" - update: - description: "Data-link type. Currently supports `bucket`." - -- target: "$.components.schemas.DataLinkDto.properties.provider" - update: - description: "Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`." - -- target: "$.components.schemas.DataLinkDto.properties.region" - update: - description: "Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers." - -- target: "$.components.schemas.DataLinkDto.properties.credentials" - update: - description: "Array of credentials that can access this data-link. Empty for public data-links." - -- target: "$.components.schemas.DataLinkDto.properties.publicAccessible" - update: - description: "Whether the data-link is publicly accessible without credentials." - -- target: "$.components.schemas.DataLinkDto.properties.hidden" - update: - description: "Visibility status flag. If `true`, data-link is hidden from default list views." - -- target: "$.components.schemas.DataLinkDto.properties.status" - update: - description: "Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted." - -- target: "$.components.schemas.DataLinkDto.properties.message" - update: - description: "Error message for invalid data-links. Null for valid data-links." - -# DataLinkItem -- target: "$.components.schemas.DataLinkItem.properties.type" - update: - description: "Type of the item. Either `FILE` or `FOLDER`." - -- target: "$.components.schemas.DataLinkItem.properties.name" - update: - description: "Name of the file or folder." - -- target: "$.components.schemas.DataLinkItem.properties.size" - update: - description: "Size of the file in bytes. For folders, always `0`." - -- target: "$.components.schemas.DataLinkItem.properties.mimeType" - update: - description: "MIME type of the file, calculated by analyzing the file extension. Null for folders." - -# DataLinkSimpleItem -- target: "$.components.schemas.DataLinkSimpleItem.properties.path" - update: - description: "Path to the item from the data-link root (resource path)." - -- target: "$.components.schemas.DataLinkSimpleItem.properties.size" - update: - description: "Size of the file in bytes. For folders, always `0`." - -# DataLinkItemDeletionFailure -- target: "$.components.schemas.DataLinkItemDeletionFailure.properties.dataLinkItem" - update: - description: "Data-link item that failed to be deleted." - -- target: "$.components.schemas.DataLinkItemDeletionFailure.properties.errorMessage" - update: - description: "Error message describing why the deletion failed." - -# DataLinkCredentials -- target: "$.components.schemas.DataLinkCredentials.properties.id" - update: - description: "Credentials string identifier." - -- target: "$.components.schemas.DataLinkCredentials.properties.name" - update: - description: "Name of the credentials." - -- target: "$.components.schemas.DataLinkCredentials.properties.provider" - update: - description: "Credentials cloud provider." - -# ---- ENUM SCHEMAS ---- - -# DataLinkType -- target: "$.components.schemas.DataLinkType" - update: - description: "Data-link type. Currently only `bucket` is supported." - -# DataLinkProvider -- target: "$.components.schemas.DataLinkProvider" - update: - description: "Cloud provider for data-links. Supports AWS S3, Google Cloud Storage, Azure Blob Storage, Azure with Entra ID, Seqera Compute storage, and generic S3-compatible storage." - -# DataLinkItemType -- target: "$.components.schemas.DataLinkItemType" - update: - description: "Type of data-link content item. Either `FILE` or `FOLDER`." - -# ===== DATASETS OPERATIONS - SUMMARIES & DESCRIPTIONS ===== - -# GET /datasets - List datasets -- target: "$.paths./datasets.get" - update: - summary: "List datasets" - description: "Lists all available datasets in a user context. Append `?workspaceId` to list datasets in a workspace context. Results can be filtered by search query, sorted, and paginated." - -# POST /datasets - Create dataset -- target: "$.paths./datasets.post" - update: - summary: "Create dataset" - description: "Creates a new dataset in the user context. Include the dataset name and description in your request body. Append `?workspaceId` to create the dataset in a workspace context." - -# DELETE /datasets - Delete multiple datasets -- target: "$.paths./datasets.delete" - update: - summary: "Delete datasets" - description: "Deletes multiple datasets identified by the given `datasetIds`. Returns arrays of successfully deleted and failed dataset IDs." - -# POST /datasets/hide - Hide datasets -- target: "$.paths./datasets/hide.post" - update: - summary: "Hide datasets" - description: "Hides the given datasets from the datasets list view. Hidden datasets remain accessible but are filtered from default list views unless `?visibility=hidden` or `?visibility=all` is specified." - -# POST /datasets/show - Show datasets -- target: "$.paths./datasets/show.post" - update: - summary: "Show datasets" - description: "Shows previously hidden datasets in the datasets list view." - -# POST /datasets/labels/add - Add labels to datasets -- target: "$.paths./datasets/labels/add.post" - update: - summary: "Add labels to datasets" - description: "Adds the given list of labels to the given datasets. Existing labels are preserved. Only simple labels are supported; resource labels cannot be attached to datasets." - -# POST /datasets/labels/apply - Replace dataset labels -- target: "$.paths./datasets/labels/apply.post" - update: - summary: "Replace dataset labels" - description: "Applies the given list of labels to the given datasets. Existing labels are replaced - include labels to be preserved in `labelIds`. Only simple labels are supported; resource labels cannot be attached to datasets." - -# POST /datasets/labels/remove - Remove labels from datasets -- target: "$.paths./datasets/labels/remove.post" - update: - summary: "Remove labels from datasets" - description: "Removes the given list of labels from the given datasets." - -# GET /datasets/versions - List latest dataset versions -- target: "$.paths./datasets/versions.get" - update: - summary: "List latest dataset versions" - description: "Lists the latest version of each dataset in the user context. Append `?workspaceId` to list latest versions in a workspace context. Filter by MIME type and search query." - -# GET /datasets/{datasetId}/metadata - Describe dataset -- target: "$.paths./datasets/{datasetId}/metadata.get" - update: - summary: "Describe dataset" - description: "Retrieves the metadata of the dataset identified by the given `datasetId`. Append `?attributes=labels` to include label information in response." - -# PUT /datasets/{datasetId} - Update dataset -- target: "$.paths./datasets/{datasetId}.put" - update: - summary: "Update dataset" - description: "Updates the name and description of the dataset identified by the given `datasetId`." - -# POST /datasets/{datasetId}/upload - Upload new dataset version -- target: "$.paths./datasets/{datasetId}/upload.post" - update: - summary: "Upload new dataset version" - description: "Uploads CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. Each upload increments the version number." - -# GET /datasets/{datasetId}/versions - List all dataset versions -- target: "$.paths./datasets/{datasetId}/versions.get" - update: - summary: "List all dataset versions" - description: "Lists all versions of the dataset identified by the given `datasetId`. Filter by MIME type to retrieve specific file format versions." - -# GET /datasets/{datasetId}/v/{version}/n/{fileName} - Download dataset content -- target: "$.paths./datasets/{datasetId}/v/{version}/n/{fileName}.get" - update: - summary: "Download dataset content" - description: "Downloads the content of the dataset version identified by the given `datasetId` and `version`. The `fileName` must match the original uploaded filename." - -# DELETE /datasets/{datasetId} - Delete dataset -- target: "$.paths./datasets/{datasetId}.delete" - update: - summary: "Delete dataset" - description: "Deletes the dataset identified by the given `datasetId`, including all associated versions." - -# POST /datasets/{datasetId}/versions/{version}/disable - Disable dataset version -- target: "$.paths./datasets/{datasetId}/versions/{version}/disable.post" - update: - summary: "Disable dataset version" - description: "Disables the specified version of a dataset. Disabled versions cannot be used in workflow runs and cannot be re-enabled." - -# GET /launch/{launchId}/datasets - Describe launch datasets -- target: "$.paths./launch/{launchId}/datasets.get" - update: - summary: "Describe launch datasets" - description: "Retrieves the details of the datasets used in the launch identified by the given `launchId`." - -# ===== DEPRECATED DATASET OPERATIONS - ADDENDUM ===== -# Updates for workspace-scoped dataset endpoints that are now deprecated -# in favor of user/workspace-scoped endpoints with optional workspaceId query param - -# ---- LIST DATASETS (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets.get.summary" - update: "(Deprecated) List available datasets" - -- target: "$.paths./workspaces/{workspaceId}/datasets.get.description" - update: "**This endpoint is deprecated. See [List datasets](https://docs.seqera.io/platform-api/list-datasets-v-2) for the current endpoint.**\n\nLists all available datasets in the workspace context identified by the given `workspaceId`." - -# ---- CREATE DATASET (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets.post.summary" - update: "(Deprecated) Create dataset" - -- target: "$.paths./workspaces/{workspaceId}/datasets.post.description" - update: "**This endpoint is deprecated. See [Create dataset](https://docs.seqera.io/platform-api/create-dataset-v-2) for the current endpoint.**\n\nCreates a new dataset in the given workspace context. Include the dataset file and details in your request body." - -# ---- LIST WORKSPACE DATASET VERSIONS (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/versions.get.summary" - update: "(Deprecated) List latest dataset versions" - -- target: "$.paths./workspaces/{workspaceId}/datasets/versions.get.description" - update: "**This endpoint is deprecated. See [List latest dataset versions](https://docs.seqera.io/platform-api/list-latest-dataset-versions-v-2) for the current endpoint.**\n\nLists the latest version of each dataset associated with the given `workspaceId`." - -# ---- UPDATE DATASET (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}.put.summary" - update: "(Deprecated) Update dataset" - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}.put.description" - update: "**This endpoint is deprecated. See [Update dataset](https://docs.seqera.io/platform-api/update-dataset-v-2) for the current endpoint.**\n\nUpdates the details of the dataset identified by the given `datasetId`." - -# ---- DELETE DATASET (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}.delete.summary" - update: "(Deprecated) Delete dataset" - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}.delete.description" - update: "**This endpoint is deprecated. See [Delete dataset](https://docs.seqera.io/platform-api/delete-dataset-v-2) for the current endpoint.**\n\nDeletes the dataset identified by the given `datasetId`." - -# ---- DESCRIBE DATASET (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/metadata.get.summary" - update: "(Deprecated) Describe dataset" - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/metadata.get.description" - update: "**This endpoint is deprecated. See [Describe dataset](https://docs.seqera.io/platform-api/describe-dataset-v-2) for the current endpoint.**\n\nRetrieves the metadata of the dataset identified by the given `datasetId`." - -# ---- UPLOAD DATASET (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/upload.post.summary" - update: "(Deprecated) Upload new dataset version" - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/upload.post.description" - update: "**This endpoint is deprecated. See [Upload new dataset version](https://docs.seqera.io/platform-api/upload-dataset-v-2) for the current endpoint.**\n\nUploads the CSV or TSV content to create a new version of the dataset identified by the given `datasetId`." - -# ---- LIST DATASET VERSIONS (DEPRECATED) ---- - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/versions.get.summary" - update: "(Deprecated) List all dataset versions" - -- target: "$.paths./workspaces/{workspaceId}/datasets/{datasetId}/versions.get.description" - update: "**This endpoint is deprecated. See [List all dataset versions](https://docs.seqera.io/platform-api/list-dataset-versions-v-2) for the current endpoint.**\n\nLists all versions of the given `datasetId`." - -# ===== DATASETS PARAMETERS - PATH, QUERY, AND REQUEST BODY ===== - -# ---- PATH PARAMETERS ---- - -# datasetId - used across multiple endpoints -- target: "$.paths./datasets/{datasetId}/metadata.get.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}.put.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}/upload.post.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}/versions.get.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}/v/{version}/n/{fileName}.get.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}.delete.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}/versions/{version}/disable.post.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -# version parameter -- target: "$.paths./datasets/{datasetId}/v/{version}/n/{fileName}.get.parameters[?(@.name=='version')]" - update: - description: "Dataset version number." - -- target: "$.paths./datasets/{datasetId}/versions/{version}/disable.post.parameters[?(@.name=='version')]" - update: - description: "Dataset version number to disable." - -# fileName parameter -- target: "$.paths./datasets/{datasetId}/v/{version}/n/{fileName}.get.parameters[?(@.name=='fileName')]" - update: - description: "File name for the downloaded dataset content. Must match the original uploaded filename." - -# launchId parameter -- target: "$.paths./launch/{launchId}/datasets.get.parameters[?(@.name=='launchId')]" - update: - description: "Launch string identifier." - -# ---- QUERY PARAMETERS - workspaceId ---- - -# Confirmed user/workspace context operations -- target: "$.paths./datasets.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, lists datasets in a user context." - -- target: "$.paths./datasets.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, creates dataset in a user context." - -- target: "$.paths./datasets/versions.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, lists dataset versions in a user context." - -# All other workspaceId parameters (behavior not explicitly confirmed) -- target: "$.paths./datasets.delete.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/hide.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/show.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/labels/add.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/labels/apply.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/labels/remove.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}/metadata.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}.put.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}/upload.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}/versions.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}/v/{version}/n/{fileName}.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}.delete.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}/versions/{version}/disable.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./launch/{launchId}/datasets.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -# ---- PAGINATION PARAMETERS ---- - -# GET /datasets - pagination -- target: "$.paths./datasets.get.parameters[?(@.name=='max')]" - update: - description: "Maximum number of results to return. Default: `20`." - -- target: "$.paths./datasets.get.parameters[?(@.name=='offset')]" - update: - description: "Number of results to skip for pagination. Default: `0`." - -# GET /datasets/versions - pagination -- target: "$.paths./datasets/versions.get.parameters[?(@.name=='max')]" - update: - description: "Maximum number of results to return. Default: `20`." - -- target: "$.paths./datasets/versions.get.parameters[?(@.name=='offset')]" - update: - description: "Number of results to skip for pagination. Default: `0`." - -# ---- SEARCH PARAMETERS ---- - -- target: "$.paths./datasets.get.parameters[?(@.name=='search')]" - update: - description: "Filter search parameter. Supports free text search on dataset name and description." - -- target: "$.paths./datasets/versions.get.parameters[?(@.name=='search')]" - update: - description: "Filter search parameter. Supports free text search on dataset name and description." - -# ---- SORTING PARAMETERS ---- - -- target: "$.paths./datasets.get.parameters[?(@.name=='sortBy')]" - update: - description: "Sort field. Supports `name` (alphabetical by name) or `modified` (by last update timestamp). Default: `name`." - -- target: "$.paths./datasets.get.parameters[?(@.name=='sortDir')]" - update: - description: "Sort direction. Supports `asc` (ascending) or `desc` (descending). Default: `asc`." - -# ---- VISIBILITY PARAMETERS ---- - -- target: "$.paths./datasets.get.parameters[?(@.name=='visibility')]" - update: - description: "Visibility filter. Supports `visible` (show only visible datasets), `hidden` (show only hidden datasets), or `all` (show all datasets). Default: `visible`." - -# ---- ATTRIBUTES PARAMETERS ---- - -- target: "$.paths./datasets.get.parameters[?(@.name=='attributes')]" - update: - description: "Additional attribute values to include in the response. Supports `labels`. Returns `labels: null` if omitted." - -- target: "$.paths./datasets/{datasetId}/metadata.get.parameters[?(@.name=='attributes')]" - update: - description: "Additional attribute values to include in the response. Supports `labels`. Returns `labels: null` if omitted." - -# ---- MIME TYPE PARAMETERS ---- - -- target: "$.paths./datasets/versions.get.parameters[?(@.name=='mimeType')]" - update: - description: "Dataset MIME type filter (e.g., `text/csv`, `text/tab-separated-values`)." - -- target: "$.paths./datasets/{datasetId}/versions.get.parameters[?(@.name=='mimeType')]" - update: - description: "Optional MIME type filter (e.g., `text/csv`, `text/tab-separated-values`)." - -# ---- UPLOAD PARAMETERS ---- - -- target: "$.paths./datasets/{datasetId}/upload.post.parameters[?(@.name=='header')]" - update: - description: "Indicates whether the uploaded file contains a header row. Default: `true`." - -# ---- REQUEST BODY DESCRIPTIONS ---- - -- target: "$.paths./datasets.post.requestBody" - update: - description: "Dataset create request." - -- target: "$.paths./datasets.delete.requestBody" - update: - description: "Dataset IDs to delete." - -- target: "$.paths./datasets/hide.post.requestBody" - update: - description: "Dataset IDs to hide." - -- target: "$.paths./datasets/show.post.requestBody" - update: - description: "Dataset IDs to show." - -- target: "$.paths./datasets/labels/add.post.requestBody" - update: - description: "Dataset IDs and label IDs to add." - -- target: "$.paths./datasets/labels/apply.post.requestBody" - update: - description: "Dataset IDs and label IDs to apply (replacing existing labels)." - -- target: "$.paths./datasets/labels/remove.post.requestBody" - update: - description: "Dataset IDs and label IDs to remove." - -- target: "$.paths./datasets/{datasetId}.put.requestBody" - update: - description: "Dataset update request." diff --git a/platform-api-docs/scripts/specs/dataset-params-overlay-1.85.yaml b/platform-api-docs/scripts/specs/dataset-params-overlay-1.85.yaml deleted file mode 100644 index cd595303e..000000000 --- a/platform-api-docs/scripts/specs/dataset-params-overlay-1.85.yaml +++ /dev/null @@ -1,229 +0,0 @@ -# ===== DATASETS PARAMETERS - PATH, QUERY, AND REQUEST BODY ===== - -# ---- PATH PARAMETERS ---- - -# datasetId - used across multiple endpoints -- target: "$.paths./datasets/{datasetId}/metadata.get.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}.put.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}/upload.post.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}/versions.get.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}/v/{version}/n/{fileName}.get.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}.delete.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -- target: "$.paths./datasets/{datasetId}/versions/{version}/disable.post.parameters[?(@.name=='datasetId')]" - update: - description: "Dataset string identifier." - -# version parameter -- target: "$.paths./datasets/{datasetId}/v/{version}/n/{fileName}.get.parameters[?(@.name=='version')]" - update: - description: "Dataset version number." - -- target: "$.paths./datasets/{datasetId}/versions/{version}/disable.post.parameters[?(@.name=='version')]" - update: - description: "Dataset version number to disable." - -# fileName parameter -- target: "$.paths./datasets/{datasetId}/v/{version}/n/{fileName}.get.parameters[?(@.name=='fileName')]" - update: - description: "File name for the downloaded dataset content. Must match the original uploaded filename." - -# launchId parameter -- target: "$.paths./launch/{launchId}/datasets.get.parameters[?(@.name=='launchId')]" - update: - description: "Launch string identifier." - -# ---- QUERY PARAMETERS - workspaceId ---- - -# Confirmed user/workspace context operations -- target: "$.paths./datasets.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, lists datasets in a user context." - -- target: "$.paths./datasets.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, creates dataset in a user context." - -- target: "$.paths./datasets/versions.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier. If omitted, lists dataset versions in a user context." - -# All other workspaceId parameters (behavior not explicitly confirmed) -- target: "$.paths./datasets.delete.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/hide.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/show.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/labels/add.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/labels/apply.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/labels/remove.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}/metadata.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}.put.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}/upload.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}/versions.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}/v/{version}/n/{fileName}.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}.delete.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./datasets/{datasetId}/versions/{version}/disable.post.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -- target: "$.paths./launch/{launchId}/datasets.get.parameters[?(@.name=='workspaceId')]" - update: - description: "Workspace numeric identifier." - -# ---- PAGINATION PARAMETERS ---- - -# GET /datasets - pagination -- target: "$.paths./datasets.get.parameters[?(@.name=='max')]" - update: - description: "Maximum number of results to return. Default: `20`." - -- target: "$.paths./datasets.get.parameters[?(@.name=='offset')]" - update: - description: "Number of results to skip for pagination. Default: `0`." - -# GET /datasets/versions - pagination -- target: "$.paths./datasets/versions.get.parameters[?(@.name=='max')]" - update: - description: "Maximum number of results to return. Default: `20`." - -- target: "$.paths./datasets/versions.get.parameters[?(@.name=='offset')]" - update: - description: "Number of results to skip for pagination. Default: `0`." - -# ---- SEARCH PARAMETERS ---- - -- target: "$.paths./datasets.get.parameters[?(@.name=='search')]" - update: - description: "Filter search parameter. Supports free text search on dataset name and description." - -- target: "$.paths./datasets/versions.get.parameters[?(@.name=='search')]" - update: - description: "Filter search parameter. Supports free text search on dataset name and description." - -# ---- SORTING PARAMETERS ---- - -- target: "$.paths./datasets.get.parameters[?(@.name=='sortBy')]" - update: - description: "Sort field. Supports `name` (alphabetical by name) or `modified` (by last update timestamp). Default: `name`." - -- target: "$.paths./datasets.get.parameters[?(@.name=='sortDir')]" - update: - description: "Sort direction. Supports `asc` (ascending) or `desc` (descending). Default: `asc`." - -# ---- VISIBILITY PARAMETERS ---- - -- target: "$.paths./datasets.get.parameters[?(@.name=='visibility')]" - update: - description: "Visibility filter. Supports `visible` (show only visible datasets), `hidden` (show only hidden datasets), or `all` (show all datasets). Default: `visible`." - -# ---- ATTRIBUTES PARAMETERS ---- - -- target: "$.paths./datasets.get.parameters[?(@.name=='attributes')]" - update: - description: "Additional attribute values to include in the response. Supports `labels`. Returns `labels: null` if omitted." - -- target: "$.paths./datasets/{datasetId}/metadata.get.parameters[?(@.name=='attributes')]" - update: - description: "Additional attribute values to include in the response. Supports `labels`. Returns `labels: null` if omitted." - -# ---- MIME TYPE PARAMETERS ---- - -- target: "$.paths./datasets/versions.get.parameters[?(@.name=='mimeType')]" - update: - description: "Dataset MIME type filter (e.g., `text/csv`, `text/tab-separated-values`)." - -- target: "$.paths./datasets/{datasetId}/versions.get.parameters[?(@.name=='mimeType')]" - update: - description: "Optional MIME type filter (e.g., `text/csv`, `text/tab-separated-values`)." - -# ---- UPLOAD PARAMETERS ---- - -- target: "$.paths./datasets/{datasetId}/upload.post.parameters[?(@.name=='header')]" - update: - description: "Indicates whether the uploaded file contains a header row. Default: `true`." - -# ---- REQUEST BODY DESCRIPTIONS ---- - -- target: "$.paths./datasets.post.requestBody" - update: - description: "Dataset create request." - -- target: "$.paths./datasets.delete.requestBody" - update: - description: "Dataset IDs to delete." - -- target: "$.paths./datasets/hide.post.requestBody" - update: - description: "Dataset IDs to hide." - -- target: "$.paths./datasets/show.post.requestBody" - update: - description: "Dataset IDs to show." - -- target: "$.paths./datasets/labels/add.post.requestBody" - update: - description: "Dataset IDs and label IDs to add." - -- target: "$.paths./datasets/labels/apply.post.requestBody" - update: - description: "Dataset IDs and label IDs to apply (replacing existing labels)." - -- target: "$.paths./datasets/labels/remove.post.requestBody" - update: - description: "Dataset IDs and label IDs to remove." - -- target: "$.paths./datasets/{datasetId}.put.requestBody" - update: - description: "Dataset update request." \ No newline at end of file diff --git a/platform-api-docs/scripts/specs/seqera-api-1.85-decorated.yml b/platform-api-docs/scripts/specs/seqera-api-1.85-decorated.yml deleted file mode 100644 index e3fbf73e8..000000000 --- a/platform-api-docs/scripts/specs/seqera-api-1.85-decorated.yml +++ /dev/null @@ -1,14381 +0,0 @@ -openapi: 3.0.1 -info: - title: Seqera API - description: Seqera Platform services API - contact: - url: https://seqera.io - email: info@seqera.io - version: 1.66.0 -servers: - - url: https://api.cloud.seqera.io - description: Seqera Platform Cloud API -tags: - - name: actions - description: Pipeline actions - - name: avatars - description: Avatars - - name: compute-envs - description: Compute environments - - name: credentials - description: Credentials - - name: data-links - description: Cloud storage directory paths in Data Explorer - - name: datasets - description: Pipeline input datasets (samplesheets) in CSV or TSV format - - name: ga4gh - description: GA4GH workflow execution service runs - - name: labels - description: Labels and resource labels - - name: launch - description: Workflow launch events - - name: orgs - description: Organizations - - name: pipelines - description: Pipelines - - name: pipeline-secrets - description: Pipeline secrets in a user or workspace context - - name: platforms - description: Computing platforms - - name: service-info - description: Seqera Platform API service information - - name: studios - description: Studios and Studio sessions - - name: teams - description: Teams in an organization context - - name: tokens - description: API access tokens - - name: trace - description: Workflow execution traces - - name: users - description: Users - - name: workflows - description: Workflow executions - - name: workspaces - description: Workspaces in an organization context -paths: - /actions: - get: - tags: - - actions - summary: List actions - description: "Lists all available actions in a user context, enriched by `attributes`. Append `?workspaceId` to list actions in a workspace context." - operationId: ListActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ActionQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListActionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - actions - summary: Create action - description: Creates a new pipeline action. Append `?workspaceId` to associate the action with the given workspace. - operationId: CreateAction - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateActionRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/add: - post: - tags: - - labels - summary: Add labels to actions - description: Adds the given list of labels to the given pipeline actions. Existing labels are preserved. - operationId: AddLabelsToActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/apply: - post: - tags: - - labels - summary: Replace action labels - description: Applies the given list of labels to the given pipeline actions. Existing labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/remove: - post: - tags: - - labels - summary: Remove labels from actions - description: Removes the given list of labels from the given pipeline actions. - operationId: RemoveLabelsFromActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/types: - get: - tags: - - actions - summary: List action event types - description: Lists the supported event types that trigger a pipeline action. Append `?workspaceId` to list event types in a workspace context. - operationId: ListActionTypes - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListEventTypesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/validate: - get: - tags: - - actions - summary: Validate action name - description: Confirms the validity of the given action name. Append `?name=`. - operationId: ValidateActionName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Action name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /actions/{actionId}: - get: - tags: - - actions - summary: Describe action - description: Retrieves the details of the action identified by the given `actionId`. - operationId: DescribeAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ActionQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - actions - summary: Update action - description: Updates the details of the action identified by the given `actionId`. The `source` of an existing action cannot be changed. - operationId: UpdateAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateActionRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - actions - summary: Delete action - description: Deletes the pipeline action identified by the given `actionId`. - operationId: DeleteAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/{actionId}/launch: - post: - tags: - - actions - summary: Trigger Tower Launch action - description: Triggers the execution of the Tower Launch action identified by the given `actionId`. - operationId: LaunchAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action launch request - content: - application/json: - schema: - $ref: "#/components/schemas/LaunchActionRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/LaunchActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/{actionId}/pause: - post: - tags: - - actions - summary: Pause or resume action - description: Pauses or resumes the pipeline action identified by the given `actionId`. - operationId: PauseAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /avatars: - post: - tags: - - avatars - summary: Create the avatar image - operationId: CreateAvatar - requestBody: - description: Image file request - content: - multipart/form-data: - schema: - type: object - properties: - image: - type: string - format: binary - encoding: - image: - contentType: application/octet-stream - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAvatarResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /avatars/{avatarId}: - get: - tags: - - avatars - summary: Download the avatar image - operationId: DownloadAvatar - parameters: - - name: avatarId - in: path - description: Avatar string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found element - security: - - BearerAuth: [] - /compute-envs: - get: - tags: - - compute-envs - summary: List compute environments - description: "Lists all available compute environments in a user context. Append `?workspaceId` to list compute environments in a workspace context, and `?status` to filter by compute environment status." - operationId: ListComputeEnvs - parameters: - - name: status - in: query - description: Filter by compute environment status. - schema: - type: string - enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID", "CREATING", "AVAILABLE", "ERRORED", "INVALID"] - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, lists compute environments in a user context. - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListComputeEnvsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - compute-envs - summary: Create compute environment - description: Creates a new compute environment. Append `?workspaceId` to create the environment in a workspace context. - operationId: CreateComputeEnv - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, creates compute environment in a user context. - schema: - type: integer - format: int64 - requestBody: - description: Compute environment create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateComputeEnvRequest" - examples: - AwsBatchForge: - description: "A minimal AWS Batch Forge compute environment with Wave and Fusion enabled." - value: - computeEnv: - name: "aws-batch-ce" - platform: "aws-batch" - credentialsId: "your-aws-credentials-id" - description: "Minimal AWS Batch Forge compute environment with Wave, Fusion, and fast instance storage enabled" - config: - region: "eu-west-2" - forge: - type: "SPOT" - minCpus: "0" - maxCpus: "100" - workDir: "s3://your-bucket/work" - waveEnabled: "true" - fusion2Enabled: "true" - nvnmeStorageEnabled: "true" - AwsCloud: - description: "Minimal AWS Cloud compute environment with default instance type and AMI" - value: - computeEnv: - name: "aws-cloud-ce" - description: "Minimal AWS Cloud compute environment with default instance type and AMI" - platform: "aws-cloud" - credentialsId: "your-aws-credentials-id" - config: - region: "eu-west-2" - workDir: "s3://your-bucket/work" - GoogleBatch: - description: "Minimal Google Cloud Batch compute environment with Wave and Fusion enabled" - value: - computeEnv: - name: "google-batch-ce" - description: "Minimal Google Cloud Batch compute environment with Wave and Fusion enabled" - platform: "google-batch" - credentialsId: "your-google-credentials-id" - config: - location: "europe-west2" - workDir: "gs://your-bucket/work" - spot: true - waveEnabled: true - fusion2Enabled: true - GoogleCloud: - description: "Minimal Google Cloud compute environment with default instance type and image ID" - value: - computeEnv: - name: "google-cloud-ce" - description: "Minimal Google Cloud compute environment with default instance type and image ID" - platform: "google-cloud" - credentialsId: "your-google-credentials-id" - config: - region: "europe-west2" - workDir: "gs://your-bucket/work" - AzureBatchForge: - description: "Minimal Azure Batch Forge compute environment with Wave and Fusion enabled" - value: - computeEnv: - name: "azure-batch-ce" - description: "Minimal Azure Batch Forge compute environment with Wave and Fusion enabled" - platform: "azure-batch" - credentialsId: "your-azure-credentials-id" - config: - region: "eastus" - workDir: "az://your-storage-account/work" - forge: - vmCount: 50 - autoScale: true - waveEnabled: true - fusion2Enabled: true - AwsEks: - description: "Minimal AWS EKS compute environment with Fusion storage" - value: - computeEnv: - name: "aws-eks-ce" - description: "Minimal AWS EKS compute environment with Fusion storage" - platform: "eks-platform" - credentialsId: "your-aws-credentials-id" - config: - region: "eu-west-2" - workDir: "s3://your-bucket/work" - clusterName: "your-cluster-name" - namespace: "your-namespace" - headServiceAccount: "your-service-account" - waveEnabled: "true" - fusion2Enabled: "true" - GoogleGke: - description: "Minimal Google Kubernetes Engine compute environment with Fusion storage" - value: - computeEnv: - name: "gke-ce" - description: "Minimal Google Kubernetes Engine compute environment with Fusion storage" - platform: "gke-platform" - credentialsId: "your-google-credentials-id" - config: - region: "europe-west2" - workDir: "gs://your-bucket/work" - clusterName: "your-cluster-name" - namespace: "your-namespace" - headServiceAccount: "your-service-account" - waveEnabled: "true" - fusion2Enabled: "true" - Kubernetes: - description: "Minimal Kubernetes compute environment with persistent volume storage" - value: - computeEnv: - name: "k8s-ce" - description: "Minimal Kubernetes compute environment with persistent volume storage" - platform: "k8s-platform" - credentialsId: "your-k8s-credentials-id" - config: - workDir: "/workspace" - server: "https://your-k8s-api-server:6443" - sslCert: "-----BEGIN CERTIFICATE-----\nYOUR_CERTIFICATE\n-----END CERTIFICATE-----" - namespace: "your-namespace" - headServiceAccount: "your-service-account" - storageClaimName: "your-storage-claim" - storageMountPath: "/workspace" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateComputeEnvResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /compute-envs/validate: - get: - tags: - - compute-envs - summary: Validate compute environment name - description: Confirms the validity of the given compute environment name in a user context. Append `?name=`. - operationId: ValidateComputeEnvName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, validates compute environment name in a user context. - schema: - type: integer - format: int64 - - name: name - in: query - description: Compute environment name to validate for uniqueness and format. - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /compute-envs/{computeEnvId}: - get: - tags: - - compute-envs - summary: Describe compute environment - description: Retrieves the details of the compute environment identified by the given `computeEnvId`. - operationId: DescribeComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment alphanumeric identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response. Returns `labels: null` if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ComputeEnvQueryAttribute" - type: string - enum: ["labels", "labels"] - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeComputeEnvResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - compute-envs - summary: Update compute environment - description: Updates the details of the compute environment identified by the given `computeEnvId`. - operationId: UpdateComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment alphanumeric identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - requestBody: - description: Compute environment update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateComputeEnvRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - compute-envs - summary: Delete compute environment - description: Deletes the compute environment identified by the given `computeEnvId`. - operationId: DeleteComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment alphanumeric identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Conflicting deletion - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /compute-envs/{computeEnvId}/primary: - post: - tags: - - compute-envs - summary: Define primary compute environment - description: Selects the compute environment identified by the given `computeEnvId` as the primary compute environment in the given workspace context. - operationId: UpdateComputeEnvPrimary - parameters: - - name: computeEnvId - in: path - description: Compute environment alphanumeric identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /credentials: - get: - tags: - - credentials - summary: List credentials - description: "Lists all available credentials in a user context. Append `?workspaceId` to list credentials in a workspace context, and `?platformId` to filter credentials by computing platform." - operationId: ListCredentials - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: platformId - in: query - description: Platform string identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - credentials - summary: Create credentials - description: Creates new credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. - operationId: CreateCredentials - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Credentials create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCredentialsRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /credentials/validate: - get: - tags: - - credentials - summary: Validate credential name - description: Validates the given credentials name. Append `?name=`. - operationId: ValidateCredentialsName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Credentials name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /credentials/{credentialsId}: - get: - tags: - - credentials - summary: Describe credentials - description: Retrieves the details of the credentials identified by the given `credentialsId`. - operationId: DescribeCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - credentials - summary: Update credentials - description: Updates the details of the credentials identified by the given `credentialsId`. - operationId: UpdateCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Credentials update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateCredentialsRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - credentials - summary: Delete credentials - description: Deletes the credentials identified by the given `credentialsId`. - operationId: DeleteCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: checked - in: query - description: If set credentials deletion will be blocked by running jobs that depend on them - schema: - type: boolean - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this credentials - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteCredentialsConflictResponse" - security: - - BearerAuth: [] - /data-links: - get: - tags: - - data-links - summary: List data-links - description: | - Retrieves all available data-links in a user context. Append `?workspaceId={your-workspace-id}` to retrieve data-links in a workspace context. - operationId: ListDataLinks - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials identifier - schema: - type: string - - name: search - in: query - description: "Free text search criteria — data-link name and keywords: `region`, `provider`." - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: visibility - in: query - description: Filter results by visibility - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinksListResponse" - "202": - description: Accepted - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinksListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, or the API is disabled in the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - data-links - summary: Create data-link - description: Creates a new data-link in a user context. Append `?workspaceId=` to create the data-link in a workspace context. - operationId: CreateCustomDataLink - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Data-link creation request - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkCreateRequest" - required: true - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled in the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/cache/refresh: - get: - tags: - - data-links - summary: Refresh data-link cache - description: Refreshes the data-link cache for the given `workspaceId` or `credentialsId`. Forces immediate re-discovery of available cloud storage resources. - operationId: RefreshDataLinkCache - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, refreshes cache in a user context. - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier. Filters cache refresh to data-links accessible with the specified credentials. - schema: - type: string - responses: - "200": - description: OK - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}: - get: - tags: - - data-links - summary: Describe data-link - description: Retrieves the details of the data-link associated with the given `dataLinkId`, including provider information, credentials, and access status. - operationId: DescribeDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. Optional. - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier. Required for accessing private data-links. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - data-links - summary: Update data-link - description: Updates the data-link associated with the given `dataLinkId`. Allows modification of name, description, and associated credentials. - operationId: UpdateCustomDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. Optional. - schema: - type: integer - format: int64 - requestBody: - description: Data-link update request. - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkUpdateRequest" - required: true - responses: - "200": - description: Success — Data-link updated - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - data-links - summary: Delete data-link - description: Deletes the data-link associated with the given `dataLinkId`. The underlying cloud storage resource is not affected. - operationId: DeleteCustomDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. Optional. - schema: - type: integer - format: int64 - responses: - "200": - description: Success — Data-link deleted - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "204": - description: DeleteCustomDataLink 204 response - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse: - get: - tags: - - data-links - summary: Explore data-link path - description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." - operationId: ExploreDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: path - in: path - description: Content path - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: search - in: query - description: Prefix search of data-link content - schema: - type: string - - name: nextPageToken - in: query - description: Token used to fetch the next page of items - schema: - type: string - - name: pageSize - in: query - description: "Number of items to return per page. If omitted, a default maximum value is returned." - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse-tree: - get: - tags: - - data-links - summary: Explore data-link tree - description: Retrieves a list of all files in the data-link associated with the given `dataLinkId`, including files in sub-paths. Useful for retrieving complete directory structures. - operationId: ExploreDataLinkTree - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. Optional. - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier. Required for accessing private data-links. - schema: - type: string - - name: paths - in: query - description: List of paths to explore. Returns all files within the specified paths, including sub-paths. - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentTreeListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse/{path}: - get: - tags: - - data-links - summary: Explore data-link path - description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." - operationId: ExploreDataLink_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: path - in: path - description: Content path - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: search - in: query - description: Prefix search of data-link content - schema: - type: string - - name: nextPageToken - in: query - description: Token used to fetch the next page of items - schema: - type: string - - name: pageSize - in: query - description: "Number of items to return per page. If ommitted, a default maximum value is returned." - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/content: - delete: - tags: - - data-links - summary: Delete data-link content - description: Deletes the content of the data-link associated with the given `dataLinkId`. The data-link itself is preserved, but files and directories within it are removed. - operationId: DeleteDataLinkItem - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. Optional. - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier. Required for deleting content from private data-links. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDeleteItemRequest" - required: true - description: "Data-link content deletion request specifying files and directories to delete." - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDeleteItemResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/download: - get: - tags: - - data-links - summary: Download data-link file at path - description: Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`. - operationId: DownloadDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: filePath - in: path - description: File path to download - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/generate-download-url: - get: - tags: - - data-links - summary: Generate download URL - description: Returns a pre-signed URL to download files from the data-link associated with the given `dataLinkId`. The URL can be used for direct downloads or preview purposes. - operationId: GenerateDownloadUrlDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier. - required: true - schema: - type: string - - name: filePath - in: query - description: File path to download within the data-link (e.g., `folder/subfolder/object`). - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier. Required for generating download URLs for private data-links. - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. Optional. - schema: - type: integer - format: int64 - - name: preview - in: query - description: "If `true`, generates a URL for preview purposes. If `false`, generates a URL for direct download. Default: `false`." - schema: - type: boolean - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDownloadUrlResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/script/download: - get: - tags: - - data-links - summary: Generate download script - description: Creates a script to download files from the data-link associated with the given `dataLinkId`. Append `?dirs` or `?files` to specify a list of files or paths to download within the data-link. - operationId: GenerateDownloadScript - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. Optional. - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier. Required for generating download scripts for private data-links. - schema: - type: string - - name: dirs - in: query - description: List of directory paths to include in the download script. - schema: - type: array - items: - type: object - - name: files - in: query - description: List of file paths to include in the download script. - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDownloadScriptResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload: - post: - tags: - - data-links - summary: Generate data-link file upload URL (to given path) - description: |- - Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). - For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - operationId: GenerateDataLinkUploadUrl - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: Origin - in: header - schema: - type: string - nullable: true - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/finish: - post: - tags: - - data-links - summary: Finish data-link file upload to given path - description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." - operationId: FinishDataLinkUpload - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkFinishMultiPartUploadRequest" - required: true - responses: - "202": - description: No content - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "200": - description: FinishDataLinkUpload 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/finish/{dirPath}: - post: - tags: - - data-links - summary: Finish data-link file upload to given path - description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." - operationId: FinishDataLinkUpload_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkFinishMultiPartUploadRequest" - required: true - responses: - "202": - description: No content - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "200": - description: FinishDataLinkUpload_1 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/{dirPath}: - post: - tags: - - data-links - summary: Generate data-link file upload URL (to given path) - description: |- - Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). - For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - operationId: GenerateDataLinkUploadUrl_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: Origin - in: header - schema: - type: string - nullable: true - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets: - get: - tags: - - datasets - summary: List datasets - description: Lists all available datasets in a user context. Append `?workspaceId` to list datasets in a workspace context. Results can be filtered by search query, sorted, and paginated. - operationId: ListDatasetsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, lists datasets in a user context. - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - datasets - summary: Create dataset - description: Creates a new dataset in the user context. Include the dataset name and description in your request body. Append `?workspaceId` to create the dataset in a workspace context. - operationId: CreateDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, creates dataset in a user context. - schema: - type: integer - format: int64 - requestBody: - description: Dataset create request. - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /datasets/versions: - get: - tags: - - datasets - summary: List latest dataset versions - description: Lists the latest version of each dataset in the user context. Append `?workspaceId` to list latest versions in a workspace context. Filter by MIME type and search query. - operationId: ListLatestDatasetVersionsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, lists dataset versions in a user context. - schema: - type: integer - format: int64 - - name: mimeType - in: query - description: Dataset MIME type filter (e.g., `text/csv`, `text/tab-separated-values`). - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}: - put: - tags: - - datasets - summary: Update dataset - description: Updates the name and description of the dataset identified by the given `datasetId`. - operationId: UpdateDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier. - required: true - schema: - type: string - requestBody: - description: Dataset update request. - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateDatasetRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - datasets - summary: Delete dataset - description: Deletes the dataset identified by the given `datasetId`, including all associated versions. - operationId: DeleteDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier. - required: true - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/metadata: - get: - tags: - - datasets - summary: Describe dataset - description: Retrieves the metadata of the dataset identified by the given `datasetId`. Append `?attributes=labels` to include label information in response. - operationId: DescribeDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier. - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/upload: - post: - tags: - - datasets - summary: Upload new dataset version - description: Uploads CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. Each upload increments the version number. - operationId: UploadDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier. - required: true - schema: - type: string - - name: header - in: query - description: 'Indicates whether the uploaded file contains a header row. Default: `true`.' - schema: - type: boolean - requestBody: - description: Dataset file request - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/MultiRequestFileSchema" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UploadDatasetVersionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/v/{version}/n/{fileName}: - get: - tags: - - datasets - summary: Download dataset content - description: Downloads the content of the dataset version identified by the given `datasetId` and `version`. The `fileName` must match the original uploaded filename. - operationId: DownloadDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier. - required: true - schema: - type: string - - name: version - in: path - description: Dataset version number. - required: true - schema: - type: string - - name: fileName - in: path - description: File name for the downloaded dataset content. Must match the original uploaded filename. - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /datasets/{datasetId}/versions: - get: - tags: - - datasets - summary: List all dataset versions - description: Lists all versions of the dataset identified by the given `datasetId`. Filter by MIME type to retrieve specific file format versions. - operationId: ListDatasetVersionsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier. - required: true - schema: - type: string - - name: mimeType - in: query - description: Optional MIME type filter (e.g., `text/csv`, `text/tab-separated-values`). - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /ga4gh/wes/v1/runs: - get: - tags: - - ga4gh - summary: "GA4GH: List runs" - description: Uses the GA4GH workflow execution service API to list all run records. - operationId: Ga4ghRunList - parameters: - - name: page_size - in: query - description: Page size - schema: - type: integer - format: int32 - - name: page_token - in: query - description: Page token - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunListResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - post: - tags: - - ga4gh - summary: "GA4GH: Launch run" - description: "Uses the GA4GH workflow execution service API to launch a new run. Runs are launched in the user workspace context by default. To launch in an organization workspace context, include the `workspaceId` in `workflow_engine_parameters`. Runs are launched with the workspace primary compute environment by default. To launch with a different compute environment, include the `computeEnvId` in `workflow_engine_parameters`." - operationId: Ga4ghRunCreate - requestBody: - description: Run request - content: - application/json: - schema: - $ref: "#/components/schemas/RunRequest" - multipart/form-data: - schema: - $ref: "#/components/schemas/RunRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunId" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}: - get: - tags: - - ga4gh - summary: "GA4GH: Describe run" - description: Uses the GA4GH workflow execution service API to retrieve the details of the run assoiated with the given `run_id`. - operationId: Ga4ghRunDescribe - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunLog" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}/cancel: - post: - tags: - - ga4gh - summary: "GA4GH: Cancel run" - description: Uses the GA4GH workflow execution service API to cancel the run associated with the given `run_id`. - operationId: Ga4ghRunCancel - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunId" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}/status: - get: - tags: - - ga4gh - summary: "GA4GH: Retrieve run status" - description: Uses the GA4GH workflow execution service API to retrieve the status of the run associated with the given `run_id`. - operationId: Ga4ghRunStatus - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunStatus" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/service-info: - get: - tags: - - ga4gh - summary: GA4GH workflow execution service API info - operationId: Ga4ghServiceInfo - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ServiceInfo" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /identities: - get: - tags: - - identities - summary: List managed identities - description: Lists all available managed identities in an organization context. To list the managed identities for an organization other than the requester's default, append an `?orgId`. Only organizations accessible to the requester's access token can be queried. - operationId: ListManagedIdentities - parameters: - - name: orgId - in: query - description: Organization numeric identifier. Append to list managed identities within an organization other than the requester's default. - schema: - type: integer - format: int64 - - name: search - in: query - description: "Filter search parameter. Supports free text search on name and keywords: `platform:`." - schema: - type: string - nullable: true - - name: max - in: query - description: 'Maximum number of results to return. Default: `20`.' - schema: - type: integer - format: int32 - nullable: true - - name: offset - in: query - description: 'Number of results to skip for pagination. Default: `0`.' - schema: - type: integer - format: int32 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListManagedIdentitiesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - identities - summary: Create managed identity - description: Creates a new managed identity in an organization context. Managed identities enable centralized credential management for HPC environments. - operationId: CreateManagedIdentity - parameters: - - name: orgId - in: query - description: Organization numeric identifier. Append to create managed identity within an organization other than the requester's default. - schema: - type: integer - format: int64 - requestBody: - description: Managed identity create request. - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /identities/{managedIdentityId}: - get: - tags: - - identities - summary: Describe managed identity - description: Retrieves the details of the managed identity associated with the given `managedIdentityId`. - operationId: DescribeManagedIdentity - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - identities - summary: Update managed identity - description: Updates the details of the managed identity associated with the given `managedIdentityId`. - operationId: UpdateManagedIdentity - parameters: - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - requestBody: - description: Managed identity update request. - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateManagedIdentityRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - identities - summary: Delete managed identity - description: Deletes the managed identity associated with the given `managedIdentityId`. To optionally check whether the deletion will be blocked by running jobs that depend on associated managed credentials, append `?checked=true`. - operationId: DeleteManagedIdentity - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - - name: checked - in: query - description: 'If `true`, deletion is blocked if running jobs depend on associated managed credentials. Default: `false`.' - schema: - type: boolean - nullable: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this Managed Identity - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse" - security: - - BearerAuth: [] - /identities/{managedIdentityId}/credentials: - get: - tags: - - identities - summary: List managed credentials - description: Lists all managed credentials associated with the given `managedIdentityId`. Filter by user with `?userId`. - operationId: ListManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - - name: userId - in: query - description: User numeric identifier. Filter managed credentials by specific user. - schema: - type: integer - format: int64 - nullable: true - - name: search - in: query - description: "Filter search parameter. Supports free text search on `userName`, `firstName + lastName`, and keywords: `is:missing`, `is:added`." - schema: - type: string - - name: max - in: query - description: 'Maximum number of results to return. Default: `20`.' - schema: - type: integer - format: int32 - - name: offset - in: query - description: 'Number of results to skip for pagination. Default: `0`.' - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListManagedCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - identities - summary: Create managed credentials - description: Creates new managed credentials for the given `managedIdentityId`. To associate the credentials with a user other than the requester, append the `?userId`. - operationId: CreateManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - - name: userId - in: query - description: User numeric identifier. Append to associate managed credentials with a user other than the requester. - schema: - type: integer - format: int64 - nullable: true - requestBody: - description: Managed credentials create request, including provider type and authentication details. - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedCredentialsRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /identities/{managedIdentityId}/credentials/{managedCredentialsId}: - put: - tags: - - identities - summary: Update managed credentials - description: Updates the managed credentials identified by the given `managedCredentialsId` within the given `managedIdentityId`. - operationId: UpdateManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: managedCredentialsId - in: path - description: Managed credentials numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - requestBody: - description: Managed credentials update request. - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateManagedCredentialsRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - identities - summary: Delete managed credentials - description: Deletes the managed credentials identified by the given `managedCredentialsId` from the associated `managedIdentityId`. To optionally check whether the deletion will be blocked by running jobs that depend on the managed credentials, append `?checked=true`. - operationId: DeleteManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: managedCredentialsId - in: path - description: Managed credentials numeric identifier. - required: true - schema: - type: integer - format: int64 - nullable: true - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - - name: checked - in: query - description: 'If `true`, deletion is blocked if running jobs depend on the given managed credentials. Default: `false`.' - schema: - type: boolean - nullable: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this Managed Credentials - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse" - security: - - BearerAuth: [] - /labels: - get: - tags: - - labels - summary: List labels - description: Lists all available labels in a user context. Append `?workspaceId` to list labels in a workspace context. - operationId: ListLabels - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - - name: type - in: query - description: Label type - schema: - $ref: "#/components/schemas/LabelType" - - name: isDefault - in: query - description: Label default flag - schema: - type: boolean - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListLabelsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - labels - summary: Create label - description: "Creates a new label or returns an existing label based on name/value. By default the operation works in a user context, append `?workspaceId` to create/retrieve a label in a workspace context. Resource labels include `resource: true` and a `value`." - operationId: CreateLabel - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: "Provide a label `name`. Set `resource: true` for resource labels. Only resource labels have a `value` — if `resource: true`, include a `value`. Else, omit `value` from your request body." - content: - application/json: - schema: - $ref: "#/components/schemas/CreateLabelRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateLabelResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /labels/dynamic/allowed: - get: - tags: - - labels - operationId: GetAllowedDynamicLabels - responses: - "200": - description: Ok - content: - application/json: - schema: - $ref: "#/components/schemas/AllowedDynamicLabelsResponse" - "400": - description: Bad Request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /labels/{labelId}: - put: - tags: - - labels - summary: Update label - description: Updates the label identified by the given `labelId`. - operationId: UpdateLabel - parameters: - - name: labelId - in: path - description: Label numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Label update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateLabelRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateLabelResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - labels - summary: Delete label - description: Deletes the label identified by the given `labelId`. - operationId: DeleteLabel - parameters: - - name: labelId - in: path - description: Label numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /launch/{launchId}: - get: - tags: - - launch - summary: Describe Launch record - description: Retrieves the details of the launch identified by the given `launchId`. - operationId: DescribeLaunch - parameters: - - name: launchId - in: path - description: Launch string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /launch/{launchId}/datasets: - get: - tags: - - datasets - summary: Describe launch datasets - description: Retrieves the details of the datasets used in the launch identified by the given `launchId`. - operationId: ListLaunchDatasetVersions - parameters: - - name: launchId - in: path - description: Launch string identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs: - get: - tags: - - orgs - summary: List organizations - description: Lists all available organizations in a user context. - operationId: ListOrganizations - parameters: - - name: role - in: query - description: Organization user role identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListOrganizationsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - orgs - summary: Create organization - description: Creates a new organization. - operationId: CreateOrganization - requestBody: - description: Organization create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateOrganizationRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateOrganizationResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/validate: - get: - tags: - - orgs - summary: Validate organization name - description: Confirms the validity of the given organization name. Append `?name=`. - operationId: ValidateOrganizationName - parameters: - - name: name - in: query - description: Organization name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}: - get: - tags: - - orgs - summary: Describe organization - description: Retrieves the details of the organization identified by the given `orgId`. - operationId: DescribeOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeOrganizationResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - orgs - summary: Update organization - description: Updates the details of the organization identified by the given `orgId`. - operationId: UpdateOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Organization update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateOrganizationRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - orgs - summary: Delete organization - description: Deletes the organization identified by the given `orgId`. - operationId: DeleteOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/collaborators: - get: - tags: - - orgs - summary: List organization collaborators - description: Lists the collaborators of the organization identified by the given `orgId`. - operationId: ListOrganizationCollaborators - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members: - get: - tags: - - orgs - summary: List organization members - description: Lists the members of the organization identified by the given `orgId`. - operationId: ListOrganizationMembers - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/add: - put: - tags: - - orgs - summary: Add organization member - description: Adds a new member to the organization identified by the given `orgId`. - operationId: CreateOrganizationMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Member addition request - content: - application/json: - schema: - $ref: "#/components/schemas/AddMemberRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddMemberResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/members/leave: - delete: - tags: - - orgs - summary: Leave organization - description: Removes the requesting user from the organization identified by the given `orgId`. - operationId: LeaveOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/{memberId}: - delete: - tags: - - orgs - summary: Delete member - description: Deletes the member identified by the given `memberId`. - operationId: DeleteOrganizationMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Organization member numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/{memberId}/role: - put: - tags: - - orgs - summary: Update member role - description: Updates the role of the member identified by the given `memberId`. - operationId: UpdateOrganizationMemberRole - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Organization member numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Member role update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateMemberRoleRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/quotas: - get: - tags: - - orgs - summary: Describe organization quotas - description: Retrieves the details of the organization quotas identified by the given `orgId`. - operationId: DescribeOrganizationQuotas - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: include - in: query - description: Optional list of quota names to include - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeOrganizationQuotasResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams: - get: - tags: - - teams - summary: List organization teams - description: Lists all teams in the organization identified by the given `orgId`. - operationId: ListOrganizationTeams - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - teams - summary: Create team - description: Creates a new team in the organization identified by the given `orgId`. - operationId: CreateOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/teams/validate: - get: - tags: - - teams - summary: Validate team name - description: Confirms the validity of the given team name. Append `?name=`. - operationId: ValidateTeamName - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: name - in: query - description: Team name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}: - get: - tags: - - teams - summary: Describe team - description: Retrieves the details of the team identified by the given `teamId`. - operationId: DescribeOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - teams - summary: Update team - description: Updates the details of the team identified by the given `teamId`. - operationId: UpdateOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateTeamRequest" - required: true - responses: - "200": - description: OK - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "204": - description: UpdateOrganizationTeam 204 response - security: - - BearerAuth: [] - delete: - tags: - - teams - summary: Delete team - description: Deletes the team identified by the given `teamId`. - operationId: DeleteOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/members: - get: - tags: - - teams - summary: List team members - description: Lists the team members associated with the given `teamId`. - operationId: ListOrganizationTeamMembers - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - schema: - type: string - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - teams - summary: Create team member - description: Adds a new member to the team identified by the given `teamId`. - operationId: CreateOrganizationTeamMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamMemberRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddTeamMemberResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/members/{memberId}/delete: - delete: - tags: - - teams - summary: Delete team member - description: Deletes the team member identified by the given `memberId`. - operationId: DeleteOrganizationTeamMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Member numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/workspaces: - get: - tags: - - teams - summary: List team workspaces - description: Lists all the workspaces of which the given `teamId` is a participant. - operationId: ListWorkspacesByTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Search criteria - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesResponse" - "404": - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "400": - description: Bad Request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces: - get: - tags: - - workspaces - summary: List organization workspaces - description: Lists the organization workspaces in `orgId` to which the requesting user belongs. - operationId: ListWorkspaces - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - workspaces - summary: Create workspace - description: Creates a new organization workspace. - operationId: CreateWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkspaceRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/validate: - get: - tags: - - workspaces - summary: Validate workspace name - description: Confirms the validity of the given workspace name within the organization identified by the given `orgId`. Append `?name=`. - operationId: ValidateWorkspaceName - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: name - in: query - description: Workspace name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}: - get: - tags: - - workspaces - summary: Describe workspace - description: Retrieves the details of the workspace identified by the given `workspaceId`. - operationId: DescribeWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - workspaces - summary: Update workspace - description: Updates the details of the workspace identified by the given `workspaceId`. - operationId: UpdateWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicate name - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workspaces - summary: Delete workspace - description: Deletes the workspace identified by the given `workspaceId`. - operationId: DeleteWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants: - get: - tags: - - workspaces - summary: List workspace participants - description: Lists the participants of the workspace identified by the given `workspaceId`. - operationId: ListWorkspaceParticipants - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListParticipantsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workspaces - summary: Leave workspace - description: Removes the requesting user from the given workspace. - operationId: LeaveWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/add: - put: - tags: - - workspaces - summary: Create workspace participant - description: Adds a new participant to the workspace identified by the given `workspaceId`. - operationId: CreateWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Participant addition request - content: - application/json: - schema: - $ref: "#/components/schemas/AddParticipantRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddParticipantResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/{participantId}: - delete: - tags: - - workspaces - summary: Delete workspace participant - description: Deletes the given participant from the given workspace. - operationId: DeleteWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: participantId - in: path - description: Participant numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/{participantId}/role: - put: - tags: - - workspaces - summary: Update participant role - description: Updates the role of the given participant in the given workspace. - operationId: UpdateWorkspaceParticipantRole - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: participantId - in: path - description: Participant numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Participant role update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateParticipantRoleRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/settings/studios: - get: - tags: - - workspaces - summary: List workspace Studios settings - description: Retrieves the Studios settings of the workspace identified by the given `workspaceId`. - operationId: FindDataStudiosWorkspaceSettings - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioWorkspaceSettingsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - put: - tags: - - workspaces - summary: Update workspace Studios settings - description: Updates the Studios settings of the workspace identified by the given `workspaceId`. - operationId: UpdateDataStudiosWorkspaceSettings - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "200": - description: UpdateDataStudiosWorkspaceSettings 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /pipeline-secrets: - get: - tags: - - pipeline-secrets - summary: List pipeline secrets - description: Lists all available pipeline secrets in a user context. Append `?workspaceId` to list secrets in a workspace context. - operationId: ListPipelineSecrets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelineSecretsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - pipeline-secrets - summary: Create pipeline secret - description: Creates a new pipeline secret in the user context. Append `?workspaceId` to create the secret in a workspace context. - operationId: CreatePipelineSecret - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Pipeline secret create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineSecretRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineSecretResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipeline-secrets/validate: - get: - tags: - - pipeline-secrets - summary: Validate secret name - description: Confirms the validity of the given pipeline secret name in a user context. Append `?name=`. Append `?workspaceId` to validate the name in a workspace context. - operationId: ValidatePipelineSecretName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Secret name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipeline-secrets/{secretId}: - get: - tags: - - pipeline-secrets - summary: Describe pipeline secret - description: Retrieves the details of the pipeline secret identified by the given `secretId`. - operationId: DescribePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineSecretResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - pipeline-secrets - summary: Update secret - description: Updates the pipeline secret identified by the given `secretId`. - operationId: UpdatePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Secret update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineSecretRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - pipeline-secrets - summary: Delete secret - description: Deletes the pipeline secret identified by the given `secretId`. - operationId: DeletePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines: - get: - tags: - - pipelines - summary: List pipelines - description: "Lists all available pipelines in a user context, enriched by `attributes`. Append `workspaceId` to list pipelines in a workspace context." - operationId: ListPipelines - parameters: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns an empty value (`labels: null`, etc.) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: max - in: query - description: 'Maximum number of pipelines to return per request.' - schema: - type: integer - format: int32 - - name: offset - in: query - description: 'Number of results to skip for pagination. Default: `0`.' - schema: - type: integer - format: int32 - - name: search - in: query - description: Free-text search filter to match against pipeline names and descriptions. - schema: - type: string - - name: visibility - in: query - description: 'Filter pipelines by visibility. Accepts `private`, `shared`, or `all`.' - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelinesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - pipelines - summary: Create pipeline - description: Creates a new pipeline in a user context. Append `?workspaceId` to create the pipeline in a workspace context. - operationId: CreatePipeline - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, creates pipeline in a user context. - schema: - type: integer - format: int64 - requestBody: - description: Pipeline creation request - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineRequest" - examples: - BasicPipelineCreation: - summary: "Create a pipeline with nf-core/rnaseq" - description: "Minimal pipeline creation request using nf-core/rnaseq with the `test_full` configuration profile." - value: - name: "rnaseq-pipeline" - description: "Minimal nf-core/rnaseq pipeline configuration with the `test_full` profile." - launch: - pipeline: "https://github.com/nf-core/rnaseq" - computeEnvId: "your-compute-env-id" - revision: "master" - configProfiles: - - "test_full" - labelIds: - - "label_id_1" - - "label_id_2" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipelines/info: - get: - tags: - - pipelines - summary: Describe remote pipeline repository - description: Retrieves the details of a remote Nextflow pipeline Git repository. Append the repository name or full URL with `?name`. - operationId: DescribePipelineRepository - parameters: - - name: name - in: query - description: Pipeline repository name (e.g., `nextflow-io/hello`) or full URL. - schema: - type: string - - name: revision - in: query - description: 'Git revision, branch, or tag to describe. Default: repository default branch.' - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, describes pipeline in a user context. - schema: - type: integer - format: int64 - - name: mainScript - in: query - description: 'Alternative main script filename. Default: `main.nf`.' - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/add: - post: - tags: - - labels - summary: Add labels to pipelines - description: Adds the given list of labels to the given pipelines. Existing labels are preserved. - operationId: AddLabelsToPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/apply: - post: - tags: - - labels - summary: Replace pipeline labels - description: Applies the given list of labels to the given pipelines. Existing labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/remove: - post: - tags: - - labels - summary: Remove labels from pipelines - description: Removes the given list of labels from the given pipelines. - operationId: RemoveLabelsFromPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/repositories: - get: - tags: - - pipelines - summary: List user pipeline repositories - description: "Lists known Nextflow pipeline Git repositories, extracted from existing runs. Append `?workspaceId` to list repositories in a workspace context." - operationId: ListPipelineRepositories - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, lists repositories in a user context. - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelineInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/validate: - get: - tags: - - pipelines - summary: Validate pipeline name - description: Confirms the validity of the given pipeline `name` in a user context. Append `?name=`. Append `?workspaceId` to validate the name in a workspace context. - operationId: ValidatePipelineName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, validates pipeline name in a user context. - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. Used for organization-level validation. - schema: - type: integer - format: int64 - - name: name - in: query - description: Pipeline name to validate for uniqueness and format. - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipelines/{pipelineId}: - get: - tags: - - pipelines - summary: Describe pipeline - description: "Retrieves the details of the pipeline identified by the given `pipelineId`, enriched by `attributes`." - operationId: DescribePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns empty values if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace. - required: false - schema: - type: integer - format: int64 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - pipelines - summary: Update pipeline - description: "Updates the details of the pipeline identified by the given `pipelineId`.\n\n**Note**: If `labelIds` is `null`, empty, or omitted, existing pipeline labels are removed. Include `labelIds: [,]` to override existing labels. Labels to be preserved must be included. To append a list of labels to multiple pipelines, use `/pipelines/labels/add`." - operationId: UpdatePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - requestBody: - description: Pipeline update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - pipelines - summary: Delete pipeline - description: Deletes the pipeline identified by the given `pipelineId`. - operationId: DeletePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/{pipelineId}/launch: - get: - tags: - - pipelines - summary: Describe pipeline launch - description: Retrieves the launch details of the pipeline identified by the given `pipelineId`. - operationId: DescribePipelineLaunch - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace. - required: false - schema: - type: integer - format: int64 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/{pipelineId}/schema: - get: - tags: - - pipelines - summary: Describe pipeline schema - description: "Retrieves the pipeline schema of the pipeline identified by the given `pipelineId`, enriched by `attributes`.\n `200 - OK` responses include the pipeline schema.\n `204 - OK` responses indicate a successful request, with no saved schema found for the given pipeline ID.\n " - operationId: DescribePipelineSchema - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace. - required: false - schema: - type: integer - format: int64 - nullable: true - - name: attributes - in: query - description: "Attribute values to include in the response. `schema` returns the pipeline schema, `params` returns the pipeline config. Returns all if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineSchemaAttributes" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/PipelineSchemaResponse" - "204": - description: Request OK - No schema found for given pipeline ID - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms: - get: - tags: - - platforms - summary: List platforms - description: Lists all available computing platforms in a user context. Append `?workspaceId` to list platforms in a workspace context. - operationId: ListPlatforms - parameters: - - name: orgId - in: query - description: Organization numeric identifier - required: false - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - required: false - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPlatformsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms/{platformId}: - get: - tags: - - platforms - summary: Describe platform - description: Retrieves the details of the computing platform identified by the given `platformId`. - operationId: DescribePlatform - parameters: - - name: platformId - in: path - description: Platform string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: regionId - in: query - required: true - schema: - type: string - - name: credentialsId - in: query - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePlatformResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms/{platformId}/regions: - get: - tags: - - platforms - summary: List platform regions - description: Lists the available regions for the computing platform identified by the given `platformId`. - operationId: ListPlatformRegions - parameters: - - name: platformId - in: path - description: Platform string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListRegionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /service-info: - get: - tags: - - service-info - summary: General Seqera service features and version. - operationId: Info - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ServiceInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - /studios: - get: - tags: - - studios - summary: List Studios - description: Lists all available Studios in a user context. Append `?workspaceId` to list Studios in a workspace context. - operationId: ListDataStudios - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: search - in: query - description: "Optional search criteria, allowing free text search on name and templateUrl and keywords: `userId`, `computeEnvId` and `status`." - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: attributes - in: query - description: "Optional attribute values to be included in the response (`labels`). Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/DataStudioQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the workspace is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - post: - tags: - - studios - summary: Create Studio - description: "Creates a new Studio environment, starting it by default. Default behavior can be changed using the query parameter `autoStart=false`." - operationId: CreateDataStudio - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: autoStart - in: query - description: Optionally disable the Studio's automatic launch when it is created. - schema: - type: boolean - requestBody: - description: Create Studio request - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateRequest" - required: true - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateResponse" - "404": - description: "NotFound, when the workspace or compute environment is not found or when the API is disabled." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Conflict - duplicated name - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - "200": - description: CreateDataStudio 200 response - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateResponse" - security: - - BearerAuth: [] - /studios/data-links: - get: - tags: - - studios - summary: List mounted data-links - description: "Lists the IDs of all available data-links mounted in existing Studios. Append `orgId` or `?workspaceId` to list mounted data-links in an organization or workspace context, respectively." - operationId: ListMountedDataLinkIds - parameters: - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: status - in: query - description: Optional Studio status - schema: - type: string - - name: exclude - in: query - description: Optional Studio session ID to exclude in the request. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioMountedLinksResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/templates: - get: - tags: - - studios - summary: List available Studio templates - description: "Returns the list of available, configured Studio templates." - operationId: ListDataStudioTemplates - parameters: - - name: workspaceId - in: query - description: Workspace identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - responses: - "200": - description: Ok - paginated list of available Studio templates. - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioTemplatesListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/validate: - get: - tags: - - studios - summary: Validate Studio name - description: Confirms the availability of the given name for a Studio in the user context. Append `?workspaceId=` to validate the name in a workspace context. - operationId: ValidateDataStudioName - parameters: - - name: workspaceId - in: query - description: Workspace identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Studio name to validate - schema: - type: string - responses: - "204": - description: "Ok - No content, if the name is valid and available." - "400": - description: "Bad request, if the name is not valid." - "409": - description: "Conflict, name duplicated in the given context." - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}: - get: - tags: - - studios - summary: Describe Studio - description: Retrieves the details of the Studio session identified by the given `sessionId`. - operationId: DescribeDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "202": - description: "Accepted, when the Studio is fetching mounted data links in the background." - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - delete: - tags: - - studios - summary: Delete Studio - description: Deletes the Studio associated with the given Studio session ID. - operationId: DeleteDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/checkpoints: - get: - tags: - - studios - summary: List Studio checkpoints - description: "Retrieves the list of checkpoints for the given Studio session ID, sorted by creation date in descending order." - operationId: ListDataStudioCheckpoints - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: search - in: query - description: "Optional search criteria, allowing free text search on name and keywords: `status`, `before` and `after` for saved date" - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioListCheckpointsResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/checkpoints/{checkpointId}: - get: - tags: - - studios - summary: Get Studio checkpoint - description: Retrieves the details of the given Studio checkpoint ID. - operationId: GetDataStudioCheckpoint - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: checkpointId - in: path - description: Numeric identifier of the checkpoint. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the studio or the checkpoint is not found or when the API is disabled for the workspace" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - put: - tags: - - studios - summary: Update Studio checkpoint name - description: Updates the name of the given Studio checkpoint ID. - operationId: UpdateDataStudioCheckpoint - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: checkpointId - in: path - description: Numeric identifier of the checkpoint. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointUpdateRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the studio or the checkpoint is not found or when the API is disabled for the workspace" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: "Conflict, when the checkpoint name conflicts with an existing checkpoint for the same Studio." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/lifespan: - post: - tags: - - studios - description: Extends the lifespan of the given Studio session ID. - operationId: ExtendDataStudioLifespan - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/start: - put: - tags: - - studios - summary: Starts a Studio - description: Starts the given Studio session ID. - operationId: StartDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: An optional overriding configuration for the studio to be started. - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStartRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStartResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/stop: - put: - tags: - - studios - summary: Stop Studio - description: Stops the given Studio session ID. - operationId: StopDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStopResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /tokens: - get: - tags: - - tokens - summary: List tokens - description: Retrieves the list of all available API access tokens. - operationId: TokenList - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListAccessTokensResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - tokens - summary: Create token - description: Creates an API access token with the details in the given request body. - operationId: CreateToken - requestBody: - description: Access token create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAccessTokenRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAccessTokenResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /tokens/delete-all: - delete: - tags: - - tokens - summary: Delete all user tokens - description: Deletes all API access tokens in the user context. - operationId: DeleteAllTokens - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /tokens/{tokenId}: - delete: - tags: - - tokens - summary: Delete token - description: Deletes the given API access token ID. - operationId: DeleteToken - parameters: - - name: tokenId - in: path - description: Token numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/create: - post: - tags: - - trace - summary: Create workflow execution trace - description: Creates a new workflow execution trace. - operationId: CreateTrace - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace create request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCreateRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCreateResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/begin: - put: - tags: - - trace - summary: Signal workflow execution start - description: Updates the workflow execution trace for the given `workflowId`. - operationId: UpdateTraceBegin - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace begin request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceBeginRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceBeginResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/complete: - put: - tags: - - trace - summary: Signal workflow execution completion - description: Updates the workflow execution trace for the given `workflowId`. - operationId: UpdateTraceComplete - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace complete request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCompleteRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCompleteResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/heartbeat: - put: - tags: - - trace - summary: Signal workflow execution heartbeat - description: Update the workflow execution trace heartbeat for the given `workflowId` to signal that execution is ongoing. - operationId: UpdateTraceHeartbeat - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace heartbeat request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceHeartbeatRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceHeartbeatResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/progress: - put: - tags: - - trace - summary: Store workflow task execution metadata - description: Store the execution metadata for one or more tasks in the given `workflowId`. - operationId: UpdateTraceProgress - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace progress request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceProgressRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceProgressResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /user-info: - get: - tags: - - users - summary: Describe current user - operationId: UserInfo - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeUserResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /user/{userId}/workspaces: - get: - tags: - - workspaces - summary: List user workspaces and organizations - description: Lists the workspaces and organizations to which the user identified by the given `userId` belongs. - operationId: ListWorkspacesUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesAndOrgResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /users/validate: - get: - tags: - - users - summary: Check that the user name is valid - operationId: ValidateUserName - parameters: - - name: name - in: query - description: User name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /users/{userId}: - get: - tags: - - users - summary: Describe a user entity - operationId: DescribeUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeUserResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - post: - tags: - - users - summary: Update an user entity - operationId: UpdateUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: User update request - content: - application/json: - schema: - $ref: "#/components/schemas/UserDbDto" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - users - summary: Delete a user entity - operationId: DeleteUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow: - get: - tags: - - workflows - summary: List workflows - description: "Lists all workflow records, enriched with `attributes`. Append `?workspaceId` to list workflow records in a workspace context." - operationId: ListWorkflows - parameters: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`, `optimized` status). Returns an empty value (`labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/WorkflowQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkflowsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/delete: - post: - tags: - - workflows - summary: Delete workflows - description: Deletes the workflow records identified by the given list of `workflowIds`. - operationId: DeleteWorkflowMany - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Force the deletion even if any workflows are active - schema: - type: boolean - requestBody: - description: Delete workflows request - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteWorkflowsRequest" - required: true - responses: - "200": - description: "OK - Return the IDs of workflows that could not be deleted, if any" - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteWorkflowsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/add: - post: - tags: - - labels - summary: Add labels to workflows - description: Adds the given list of labels to the given workflows. Existing labels are preserved. - operationId: AddLabelsToWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/apply: - post: - tags: - - labels - summary: Replace workflow labels - description: Applies the given list of labels to the given workflows. Existing labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/remove: - post: - tags: - - labels - summary: Remove labels from workflows - description: Removes the given list of labels from the given workflows. - operationId: RemoveLabelsFromWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/launch: - post: - tags: - - workflows - summary: Launch workflow - description: Submits a workflow execution. - operationId: CreateWorkflowLaunch - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier - required: false - schema: - type: integer - format: int64 - nullable: true - requestBody: - description: Workflow launch request - content: - application/json: - schema: - $ref: "#/components/schemas/SubmitWorkflowLaunchRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/SubmitWorkflowLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/random-name: - get: - tags: - - workflows - summary: Generates a random name - operationId: GenerateRandomWorkflowName - responses: - "200": - description: Generated name - content: - application/json: - schema: - $ref: "#/components/schemas/RandomWorkflowNameResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/validate: - get: - tags: - - workflows - summary: Validate run name - description: "Check that the given run name of a workflow has a valid format. When the session ID is given: check that no other workflow in the system exists with the combination of both elements." - operationId: ValidateWorkflowConstraints - parameters: - - name: runName - in: query - description: Workflow run name to validate - schema: - type: string - - name: sessionId - in: query - description: Workflow session ID to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request. Invalid run name format - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicated element. Existing run name and session ID combination - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}: - get: - tags: - - workflows - summary: Describe workflow - description: Retrieves the details of the workflow record associated with the given `workflowId`. - operationId: DescribeWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: Comma-separated list of attributes to retrieve. Returns an empty value for each attribute not specified. - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/WorkflowQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkflowResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workflows - summary: Delete the Workflow entity with the given ID - operationId: DeleteWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Force the deletion even if the workflow is active - schema: - type: boolean - responses: - "204": - description: OK - Not content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/cancel: - post: - tags: - - workflows - summary: Cancel workflow - description: Cancels the workflow execution identified by the given `workflowId`. - operationId: CancelWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Cancel on the Platform side even if it cannot be cancelled on the CE provider side - schema: - type: boolean - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/download: - get: - tags: - - workflows - summary: Download workflow files - description: Downloads the workflow files for the Nextflow main job associated with the given `workflowId`. - operationId: DownloadWorkflowLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: fileName - in: query - description: Filename to download - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/download/{taskId}: - get: - tags: - - workflows - summary: Download workflow task files - description: Downloads the workflow files of the task identified by the given `taskId`. - operationId: DownloadWorkflowTaskLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: fileName - in: query - description: Filename to download - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/launch: - get: - tags: - - workflows - summary: Describe workflow launch - description: Retrieves the details of the workflow launch associated with the given `workflowId`. - operationId: DescribeWorkflowLaunch - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkflowLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element. Existing run name and session ID combination - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /workflow/{workflowId}/log: - get: - tags: - - workflows - summary: Get workflow log - description: Retrieves the execution log output of the workflow identified by the given `workflowId`. - operationId: GetWorkflowLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: next - in: query - description: Workflow log cursor - schema: - type: string - - name: maxLength - in: query - description: Maximum length in bytes of the log to retrieve - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/WorkflowLogResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/log/{taskId}: - get: - tags: - - workflows - summary: Get workflow task logs - description: Retrieves the output logs for the workflow task identified by the given `taskId`. - operationId: GetWorkflowTaskLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: next - in: query - description: Workflow log cursor - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: maxLength - in: query - description: Maximum length in bytes of the log to retrieve - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/WorkflowLogResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/metrics: - get: - tags: - - workflows - summary: Get the execution metrics for the given Workflow ID - operationId: DescribeWorkflowMetrics - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetWorkflowMetricsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/progress: - get: - tags: - - workflows - summary: Retrieve the execution progress for the given Workflow ID - operationId: DescribeWorkflowProgress - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetProgressResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/star: - get: - tags: - - workflows - summary: Check workflow star status - description: Confirms whether the given `workflowId` is starred. - operationId: DescribeWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - post: - tags: - - workflows - summary: Star workflow - description: Adds the workflow identified by the given `workflowId` to your list of starred workflows. - operationId: CreateWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - delete: - tags: - - workflows - summary: Unstar workflow - description: Removes the workflow identified by the given `workflowId` from your list of starred workflows. - operationId: DeleteWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - /workflow/{workflowId}/task/{taskId}: - get: - tags: - - workflows - summary: Describe a task entity with the given ID - operationId: DescribeWorkflowTask - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeTaskResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/tasks: - get: - tags: - - workflows - summary: List the tasks for the given Workflow ID and filter parameters - operationId: ListWorkflowTasks - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: sortBy - in: query - description: Field to sort by - schema: - type: string - - name: sortDir - in: query - description: Sorting direction (asc|desc) - schema: - type: string - - name: search - in: query - description: Search tasks by name - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListTasksResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets: - get: - tags: - - datasets - summary: (Deprecated) List available datasets - description: |- - **This endpoint is deprecated. See [List datasets](https://docs.seqera.io/platform-api/list-datasets-v-2) for the current endpoint.** - - Lists all available datasets in the workspace context identified by the given `workspaceId`. - operationId: ListDatasets - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - post: - tags: - - datasets - summary: (Deprecated) Create dataset - description: |- - **This endpoint is deprecated. See [Create dataset](https://docs.seqera.io/platform-api/create-dataset-v-2) for the current endpoint.** - - Creates a new dataset in the given workspace context. Include the dataset file and details in your request body. - operationId: CreateDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Dataset create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/versions: - get: - tags: - - datasets - summary: (Deprecated) List latest dataset versions - description: |- - **This endpoint is deprecated. See [List latest dataset versions](https://docs.seqera.io/platform-api/list-latest-dataset-versions-v-2) for the current endpoint.** - - Lists the latest version of each dataset associated with the given `workspaceId`. - operationId: ListWorkspaceDatasetVersions - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: mimeType - in: query - schema: - type: string - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}: - put: - tags: - - datasets - summary: (Deprecated) Update dataset - description: |- - **This endpoint is deprecated. See [Update dataset](https://docs.seqera.io/platform-api/update-dataset-v-2) for the current endpoint.** - - Updates the details of the dataset identified by the given `datasetId`. - operationId: UpdateDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - requestBody: - description: Dataset update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateDatasetRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - deprecated: true - security: - - BearerAuth: [] - delete: - tags: - - datasets - summary: (Deprecated) Delete dataset - description: |- - **This endpoint is deprecated. See [Delete dataset](https://docs.seqera.io/platform-api/delete-dataset-v-2) for the current endpoint.** - - Deletes the dataset identified by the given `datasetId`. - operationId: DeleteDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/metadata: - get: - tags: - - datasets - summary: (Deprecated) Describe dataset - description: |- - **This endpoint is deprecated. See [Describe dataset](https://docs.seqera.io/platform-api/describe-dataset-v-2) for the current endpoint.** - - Retrieves the metadata of the dataset identified by the given `datasetId`. - operationId: DescribeDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/upload: - post: - tags: - - datasets - summary: (Deprecated) Upload new dataset version - description: |- - **This endpoint is deprecated. See [Upload new dataset version](https://docs.seqera.io/platform-api/upload-dataset-v-2) for the current endpoint.** - - Uploads the CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. - operationId: UploadDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: header - in: query - description: Uploaded file has header - schema: - type: boolean - requestBody: - description: Dataset file request - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/MultiRequestFileSchema" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UploadDatasetVersionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/v/{version}/n/{fileName}: - get: - tags: - - datasets - summary: Download dataset content - description: Downloads the content of the dataset identified by the given `datasetId` and `version`. - operationId: DownloadDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: version - in: path - description: Version number to download - required: true - schema: - type: string - - name: fileName - in: path - description: File name for the downloaded dataset content - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/versions: - get: - tags: - - datasets - summary: (Deprecated) List all dataset versions - description: |- - **This endpoint is deprecated. See [List all dataset versions](https://docs.seqera.io/platform-api/list-dataset-versions-v-2) for the current endpoint.** - - Lists all versions of the given `datasetId`. - operationId: ListDatasetVersions - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: mimeType - in: query - description: MIME type filter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] -components: - schemas: - AbstractGridConfig: - type: object - properties: - workDir: - type: string - description: Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access. - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - launchDir: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - userName: - type: string - description: "Username for SSH connection to HPC head node." - hostName: - type: string - description: "Hostname or IP address of HPC head node." - port: - type: integer - format: int32 - description: "SSH port. Default: `22`." - headQueue: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - computeQueue: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - maxQueueSize: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - headJobOptions: - type: string - description: "Additional submit options for the Nextflow head job." - propagateHeadJobOptions: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - AccessToken: - required: - - name - type: object - properties: - basicAuth: - type: string - deprecated: true - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 50 - minLength: 1 - type: string - lastUsed: - type: string - format: date-time - dateCreated: - type: string - format: date-time - Action.ConfigType: - type: object - properties: - discriminator: - type: string - readOnly: true - discriminator: - propertyName: discriminator - mapping: - github: "#/components/schemas/GithubActionConfig" - tower: "#/components/schemas/Action.TowerActionConfig" - oneOf: - - $ref: "#/components/schemas/Action.TowerActionConfig" - - $ref: "#/components/schemas/GithubActionConfig" - Action.EventType: - type: object - properties: - discriminator: - type: string - readOnly: true - timestamp: - type: string - format: date-time - discriminator: - propertyName: discriminator - mapping: - github: "#/components/schemas/GithubActionEvent" - tower: "#/components/schemas/Action.TowerActionEvent" - oneOf: - - $ref: "#/components/schemas/GithubActionEvent" - - $ref: "#/components/schemas/Action.TowerActionEvent" - Action.Source: - type: string - enum: - - github - - tower - x-enum-varnames: - - github - - tower - Action.Status: - type: string - enum: - - CREATING - - ACTIVE - - ERROR - - PAUSED - Action.TowerActionConfig: - type: object - properties: - discriminator: - type: string - readOnly: true - Action.TowerActionEvent: - type: object - properties: - discriminator: - type: string - readOnly: true - timestamp: - type: string - format: date-time - workflowId: - type: string - ActionQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - ActionResponseDto: - type: object - properties: - id: - type: string - launch: - $ref: "#/components/schemas/Launch" - name: - type: string - hookId: - type: string - hookUrl: - type: string - message: - type: string - source: - $ref: "#/components/schemas/Action.Source" - status: - $ref: "#/components/schemas/Action.Status" - config: - $ref: "#/components/schemas/Action.ConfigType" - event: - $ref: "#/components/schemas/Action.EventType" - lastSeen: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - ActiveConnection: - required: - - lastActive - type: object - allOf: - - $ref: "#/components/schemas/UserInfo" - - properties: - lastActive: - type: string - format: date-time - AddMemberRequest: - type: object - properties: - user: - type: string - AddMemberResponse: - type: object - properties: - member: - $ref: "#/components/schemas/MemberDbDto" - AddParticipantRequest: - type: object - properties: - memberId: - type: integer - format: int64 - teamId: - type: integer - format: int64 - userNameOrEmail: - type: string - AddParticipantResponse: - type: object - properties: - participant: - $ref: "#/components/schemas/ParticipantDbDto" - AddTeamMemberResponse: - type: object - properties: - member: - $ref: "#/components/schemas/MemberDbDto" - AgentSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - connectionId: - type: string - workDir: - type: string - shared: - type: boolean - AllowedDynamicLabelsResponse: - type: object - properties: - values: - type: array - items: - type: string - AltairPbsComputeConfig: - title: Altair PBS configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - Analytics: - type: object - properties: - hubspotId: - type: string - posthogApiKey: - type: string - posthogApiHost: - type: string - AssociateActionLabelsRequest: - type: object - properties: - actionIds: - type: array - items: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - AssociatePipelineLabelsRequest: - type: object - properties: - pipelineIds: - type: array - items: - type: integer - format: int64 - labelIds: - type: array - items: - type: integer - format: int64 - AssociateWorkflowLabelsRequest: - type: object - properties: - workflowIds: - type: array - items: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - Avatar: - type: object - properties: - id: - maxLength: 22 - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - AwsBatchConfig: - title: AWS Batch configuration - type: object - properties: - storageType: - type: string - deprecated: true - lustreId: - type: string - deprecated: true - volumes: - type: array - items: - type: string - description: "EBS volumes to mount (format: `/host/path:/container/path`)." - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - region: - type: string - description: "AWS region where resources will be created (e.g., `us-east-1`)." - computeQueue: - type: string - description: "AWS Batch compute queue for running jobs." - dragenQueue: - type: string - description: "AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)." - dragenInstanceType: - type: string - description: "EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)." - computeJobRole: - type: string - description: "Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs." - executionRole: - type: string - description: "IAM role ARN for ECS task execution." - headQueue: - type: string - description: "AWS Batch queue for the Nextflow head job." - headJobRole: - type: string - description: "Role ARN to grant fine-grained IAM permissions to the Nextflow head job." - cliPath: - type: string - description: "Path to the AWS CLI installation in the container." - workDir: - type: string - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - headJobCpus: - type: integer - format: int32 - description: "Number of CPUs allocated to the Nextflow head job." - headJobMemoryMb: - type: integer - format: int32 - description: "Memory allocation for the Nextflow head job, in megabytes." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - nvnmeStorageEnabled: - type: boolean - description: "Enable NVMe instance storage. Requires Fusion file system." - logGroup: - type: string - description: "CloudWatch Logs group for container logs." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - fusionSnapshots: - type: boolean - description: "Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system." - forge: - $ref: "#/components/schemas/ForgeConfig" - description: "Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#batch-forge-compute-environment) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines." - forgedResources: - type: array - items: - type: object - additionalProperties: true - description: "Resources created by Batch Forge (read-only)." - required: ["region", "workDir", "region", "workDir"] - AwsBatchPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - jobQueues: - type: array - items: - $ref: "#/components/schemas/JobQueue" - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - fileSystems: - type: array - items: - $ref: "#/components/schemas/FsxFileSystem" - efsFileSystems: - type: array - items: - $ref: "#/components/schemas/EfsFileSystem" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceFamilies: - type: array - items: - type: string - allocStrategy: - type: array - items: - type: string - AwsCloudConfig: - title: AWS Cloud configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - allowBuckets: - type: array - items: - type: string - description: "Comma-separated list of S3 buckets accessible to the compute environment." - region: - type: string - description: "AWS region for EC2 instances (e.g., `us-east-1`)." - instanceType: - type: string - description: "EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used." - imageId: - type: string - description: "The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance." - workDir: - type: string - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - logGroup: - type: string - description: "CloudWatch Logs group for container logs." - arm64Enabled: - type: boolean - description: "Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs." - gpuEnabled: - type: boolean - description: "Enable GPU instances to run compute jobs." - ec2KeyPair: - type: string - description: "EC2 key pair name for SSH access to instances." - ebsBootSize: - type: integer - format: int32 - description: "EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default." - instanceProfileArn: - type: string - description: "The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run." - subnetId: - type: string - description: "Subnet ID for instance placement (single subnet)." - securityGroups: - type: array - items: - type: string - description: "Security group IDs that control network access." - forgedResources: - type: array - items: - type: object - additionalProperties: true - description: "Resources created by Cloud Forge (read-only)." - required: ["region", "workDir", "region", "workDir"] - AwsCloudPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceTypes: - type: array - items: - $ref: "#/components/schemas/InstanceType" - AwsSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - accessKey: - type: string - secretKey: - type: string - writeOnly: true - assumeRoleArn: - type: string - AzBatchConfig: - title: Azure batch configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - region: - type: string - description: "Azure region (e.g., `eastus`)." - headPool: - type: string - description: "Batch pool for the Nextflow head job." - autoPoolMode: - type: boolean - deprecated: true - forge: - $ref: "#/components/schemas/AzBatchForgeConfig" - description: "Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation." - tokenDuration: - type: string - description: "Duration of the SAS token created by Nextflow. Default: `12h`." - deleteJobsOnCompletion: - $ref: "#/components/schemas/JobCleanupPolicy" - description: "Automatically delete Batch jobs after completion." - enum: ["on_success", "always", "never", "on_success", "always", "never"] - deletePoolsOnCompletion: - type: boolean - description: "Automatically delete Batch pools after completion. Default: `false`." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - managedIdentityClientId: - type: string - nullable: true - description: "The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage." - required: ["region", "workDir", "region", "workDir"] - AzBatchForgeConfig: - type: object - properties: - vmType: - type: string - description: "Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`." - vmCount: - type: integer - format: int32 - description: "Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused." - autoScale: - type: boolean - description: "Enable auto-scaling for the Batch pool." - disposeOnDeletion: - type: boolean - description: "Delete Batch compute pool when the compute environment is deleted." - containerRegIds: - type: array - items: - type: string - description: "Container registry resource IDs." - AzBatchPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - pools: - type: array - items: - type: string - containers: - type: array - items: - type: string - vmTypes: - type: array - items: - type: string - AzCloudConfig: - title: Azure Cloud configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - nextflowConfig: - type: string - instanceType: - type: string - description: "Azure VM size (e.g., `Standard_D2s_v3`)." - region: - type: string - resourceGroup: - type: string - description: "Azure resource group for VMs." - networkId: - type: string - description: "Virtual network resource ID." - subscriptionId: - type: string - description: "Azure subscription ID." - managedIdentityId: - type: string - description: "User-assigned managed identity resource ID." - managedIdentityClientId: - type: string - description: "Managed identity client ID for authentication." - logWorkspaceId: - type: string - description: "Log Analytics workspace ID for monitoring." - logTableName: - type: string - description: "Custom table name in Log Analytics." - dataCollectionEndpoint: - type: string - description: "Data collection endpoint for logs." - dataCollectionRuleId: - type: string - description: "Data collection rule ID for log routing." - forgedResources: - type: array - items: - $ref: "#/components/schemas/Map.Entry_String.String_" - description: "Resources created by Cloud Forge (read-only)." - required: ["location", "workDir", "location", "workDir"] - AzureEntraKeys: - type: object - allOf: - - $ref: "#/components/schemas/AzureSecurityKeys" - - properties: - discriminator: - type: string - readOnly: true - tenantId: - type: string - clientId: - type: string - clientSecret: - type: string - writeOnly: true - AzureReposSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - AzureSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - batchName: - type: string - storageName: - type: string - batchKey: - type: string - writeOnly: true - storageKey: - type: string - writeOnly: true - BitBucketSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - token: - type: string - writeOnly: true - username: - type: string - password: - type: string - writeOnly: true - Bucket: - type: object - properties: - path: - type: string - CloudPriceModel: - type: string - enum: - - standard - - spot - x-enum-varnames: - - standard - - spot - CodeCommitSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - ComputeConfig: - type: object - properties: - workDir: - type: string - description: Work directory path for storing intermediate workflow files. - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - description: "Environment variables to set in the compute environment." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - discriminator: - type: string - description: Platform type discriminator (read-only, set based on platform selection). - readOnly: true - discriminator: - propertyName: discriminator - mapping: - moab-platform: "#/components/schemas/MoabComputeConfig" - aws-batch: "#/components/schemas/AwsBatchConfig" - google-cloud: "#/components/schemas/GoogleCloudConfig" - azure-cloud: "#/components/schemas/AzCloudConfig" - gke-platform: "#/components/schemas/GkeComputeConfig" - google-batch: "#/components/schemas/GoogleBatchConfig" - aws-cloud: "#/components/schemas/AwsCloudConfig" - slurm-platform: "#/components/schemas/SlurmComputeConfig" - k8s-platform: "#/components/schemas/K8sComputeConfig" - altair-platform: "#/components/schemas/AltairPbsComputeConfig" - lsf-platform: "#/components/schemas/LsfComputeConfig" - azure-batch: "#/components/schemas/AzBatchConfig" - seqeracompute-platform: "#/components/schemas/SeqeraComputeConfig" - eks-platform: "#/components/schemas/EksComputeConfig" - google-lifesciences: "#/components/schemas/GoogleLifeSciencesConfig" - uge-platform: "#/components/schemas/UnivaComputeConfig" - oneOf: - - $ref: "#/components/schemas/AwsBatchConfig" - - $ref: "#/components/schemas/AwsCloudConfig" - - $ref: "#/components/schemas/SeqeraComputeConfig" - - $ref: "#/components/schemas/GoogleLifeSciencesConfig" - - $ref: "#/components/schemas/GoogleBatchConfig" - - $ref: "#/components/schemas/AzBatchConfig" - - $ref: "#/components/schemas/LsfComputeConfig" - - $ref: "#/components/schemas/SlurmComputeConfig" - - $ref: "#/components/schemas/K8sComputeConfig" - - $ref: "#/components/schemas/EksComputeConfig" - - $ref: "#/components/schemas/GkeComputeConfig" - - $ref: "#/components/schemas/UnivaComputeConfig" - - $ref: "#/components/schemas/AltairPbsComputeConfig" - - $ref: "#/components/schemas/MoabComputeConfig" - ComputeEnv.Status: - type: string - readOnly: true - enum: - - CREATING - - AVAILABLE - - ERRORED - - INVALID - ComputeEnvDbDto: - type: object - properties: - id: - type: string - name: - type: string - platform: - type: string - region: - type: string - ComputeEnvQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - ComputeEnvResponseDto: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - platform: - type: string - enum: - - aws-batch - - aws-cloud - - seqeracompute-platform - - google-lifesciences - - google-batch - - azure-batch - - k8s-platform - - eks-platform - - gke-platform - - uge-platform - - slurm-platform - - lsf-platform - - altair-platform - config: - $ref: "#/components/schemas/ComputeConfig" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - lastUsed: - type: string - format: date-time - deleted: - type: boolean - status: - $ref: "#/components/schemas/ComputeEnv.Status" - message: - type: string - primary: - type: boolean - credentialsId: - type: string - managedIdentityId: - type: string - orgId: - type: integer - format: int64 - workspaceId: - type: integer - format: int64 - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - ComputeEnv_ComputeConfig_: - required: - - config - - name - - platform - - "name" - - "platform" - - "config" - - "name" - - "platform" - - "config" - type: object - properties: - credentialsId: - type: string - description: "Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See [Create credentials](https://docs.seqera.io/platform-api/create-credentials)." - orgId: - type: integer - format: int64 - readOnly: true - description: "Organization numeric identifier (read-only, set by system)." - workspaceId: - type: integer - format: int64 - readOnly: true - description: "Workspace numeric identifier (read-only, set by system)." - id: - maxLength: 22 - type: string - readOnly: true - description: "Compute environment alphanumeric identifier (read-only, generated by system)." - name: - maxLength: 100 - type: string - description: "Unique name for the compute environment. Must consist of 1-100 alphanumeric, dash, or underscore characters." - description: - maxLength: 2000 - type: string - description: "Description of the compute environment. Maximum length: 2000 characters." - platform: - maxLength: 25 - type: string - enum: - - aws-batch - - aws-cloud - - google-lifesciences - - google-batch - - google-cloud - - azure-batch - - azure-cloud - - k8s-platform - - eks-platform - - gke-platform - - uge-platform - - slurm-platform - - lsf-platform - - altair-platform - - moab-platform - - local-platform - - seqeracompute-platform - - "aws-batch" - - "aws-cloud" - - "google-batch" - - "google-cloud" - - "azure-batch" - - "k8s-platform" - - "eks-platform" - - "gke-platform" - - "slurm-platform" - - "lsf-platform" - - "uge-platform" - - "moab-platform" - - "altair-platform" - - "local-platform" - - "seqeracompute-platform" - - "aws-batch" - - "aws-cloud" - - "google-batch" - - "google-cloud" - - "azure-batch" - - "azure-cloud" - - "k8s-platform" - - "eks-platform" - - "gke-platform" - - "slurm-platform" - - "lsf-platform" - - "uge-platform" - - "moab-platform" - - "altair-platform" - - "local-platform" - - "seqeracompute-platform" - description: "Compute platform provider." - config: - $ref: "#/components/schemas/ComputeConfig" - description: "Platform-specific configuration. Structure depends on the selected platform." - dateCreated: - type: string - format: date-time - readOnly: true - description: "Creation timestamp (read-only, set by system)." - lastUpdated: - type: string - format: date-time - readOnly: true - description: "Last update timestamp (read-only, updated by system)." - lastUsed: - type: string - format: date-time - readOnly: true - description: "Last usage timestamp (read-only, updated by system)." - deleted: - type: boolean - readOnly: true - description: "Deletion status flag (read-only, updated by system)." - status: - type: string - readOnly: true - allOf: - - $ref: "#/components/schemas/ComputeEnv.Status" - description: "Current status of the compute environment (read-only)." - enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID", "CREATING", "AVAILABLE", "ERRORED", "INVALID"] - message: - maxLength: 4096 - type: string - primary: - type: boolean - readOnly: true - ComputePlatform: - type: object - properties: - id: - type: string - name: - type: string - credentialsProviders: - type: array - items: - type: string - ComputePlatformDto: - type: object - properties: - id: - type: string - name: - type: string - ComputeRegion: - type: object - properties: - id: - type: string - name: - type: string - ConfigEnvVariable: - type: object - properties: - name: - type: string - description: "Environment variable name." - value: - type: string - description: "Environment variable value." - head: - type: boolean - description: "Apply this variable to the Nextflow head job." - compute: - type: boolean - description: "Apply this variable to the Nextflow compute jobs." - required: ["name", "value", "name", "value"] - ContainerData: - required: - - targetImage - type: object - properties: - requestId: - type: string - sourceImage: - type: string - targetImage: - type: string - buildId: - type: string - scanId: - type: string - mirrorId: - type: string - cached: - type: boolean - freeze: - type: boolean - requestTime: - type: string - format: date-time - ContainerRegistryKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - userName: - type: string - password: - type: string - writeOnly: true - registry: - type: string - CreateAccessTokenRequest: - type: object - properties: - name: - type: string - CreateAccessTokenResponse: - type: object - properties: - accessKey: - type: string - token: - $ref: "#/components/schemas/AccessToken" - CreateActionRequest: - type: object - properties: - name: - type: string - source: - $ref: "#/components/schemas/Action.Source" - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - CreateActionResponse: - type: object - properties: - actionId: - type: string - CreateAvatarResponse: - type: object - properties: - avatar: - $ref: "#/components/schemas/Avatar" - url: - type: string - CreateComputeEnvRequest: - type: object - properties: - computeEnv: - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - description: "Compute environment configuration object." - labelIds: - type: array - items: - type: integer - format: int64 - description: "Array of label IDs to assign to the compute environment." - required: ["computeEnv", "computeEnv"] - CreateComputeEnvResponse: - type: object - properties: - computeEnvId: - type: string - CreateCredentialsRequest: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - CreateCredentialsResponse: - type: object - properties: - credentialsId: - type: string - CreateDatasetRequest: - type: object - properties: - name: - type: string - description: - type: string - CreateDatasetResponse: - type: object - properties: - dataset: - $ref: "#/components/schemas/DatasetDto" - CreateLabelRequest: - type: object - properties: - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - CreateLabelResponse: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - CreateManagedCredentialsRequest: - type: object - properties: - provider: - type: string - enum: - - ssh - description: "Authentication provider type. Currently supports `ssh`." - credentials: - $ref: "#/components/schemas/Credentials" - description: "Authentication credentials configuration object." - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - description: "Additional metadata for the managed credentials." - CreateManagedCredentialsResponse: - type: object - properties: - managedCredentials: - $ref: "#/components/schemas/ManagedCredentialsDbDto" - description: "Created managed credentials object." - CreateManagedIdentityRequest: - type: object - properties: - name: - type: string - description: "Unique name for the managed identity. Must consist of alphanumeric, dash, or underscore characters." - platform: - type: string - enum: - - altair-platform - - lsf-platform - - moab-platform - - slurm-platform - - uge-platform - description: "HPC platform type for this managed identity." - config: - $ref: "#/components/schemas/AbstractGridConfig" - description: "Platform-specific configuration. Structure depends on the selected platform." - CreateManagedIdentityResponse: - type: object - properties: - id: - type: integer - format: int64 - description: "Managed identity numeric identifier." - name: - type: string - description: "Name of the created managed identity." - platform: - type: string - description: "HPC platform type." - config: - $ref: "#/components/schemas/ComputeConfig" - description: "Platform-specific configuration." - CreateOrganizationRequest: - type: object - properties: - organization: - $ref: "#/components/schemas/Organization" - logoId: - type: string - CreateOrganizationResponse: - type: object - properties: - organization: - $ref: "#/components/schemas/OrganizationDbDto" - CreatePipelineRequest: - type: object - properties: - name: - type: string - description: "Pipeline name. Must be unique within the workspace." - description: - type: string - description: "Pipeline description." - icon: - type: string - description: "Pipeline icon URL." - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - description: "Launch configuration for the pipeline." - labelIds: - type: array - items: - type: integer - format: int64 - description: "Array of label IDs to apply to the pipeline." - CreatePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - CreatePipelineSecretRequest: - type: object - properties: - name: - type: string - value: - type: string - CreatePipelineSecretResponse: - type: object - properties: - secretId: - type: integer - format: int64 - CreateTeamMemberRequest: - type: object - properties: - userNameOrEmail: - type: string - CreateTeamRequest: - type: object - properties: - team: - $ref: "#/components/schemas/Team" - avatarId: - type: string - CreateTeamResponse: - type: object - properties: - team: - $ref: "#/components/schemas/TeamDbDto" - CreateWorkflowStarResponse: - type: object - properties: - workflowId: - type: string - CreateWorkspaceRequest: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - CreateWorkspaceResponse: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - Credentials: - required: - - name - - provider - type: object - properties: - id: - maxLength: 22 - type: string - name: - maxLength: 100 - type: string - description: - type: string - provider: - maxLength: 16 - type: string - enum: - - aws - - azure - - azure_entra - - google - - github - - gitlab - - bitbucket - - ssh - - k8s - - container-reg - - tw-agent - - codecommit - - gitea - - azurerepos - - seqeracompute - - azure-cloud - - s3 - baseUrl: - maxLength: 200 - pattern: "" - type: string - category: - maxLength: 20 - type: string - deleted: - type: boolean - readOnly: true - lastUsed: - type: string - format: date-time - readOnly: true - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - keys: - $ref: "#/components/schemas/SecurityKeys" - DataLink.Status: - type: string - readOnly: true - enum: - - VALID - - INVALID - DataLinkContentResponse: - type: object - properties: - originalPath: - type: string - description: "Base path for all returned objects within the data-link." - objects: - type: array - items: - $ref: "#/components/schemas/DataLinkItem" - description: "Array of data-link items (files and folders) at the specified path." - nextPageToken: - type: string - description: "Token that can be used to request the next page of items. Null if no more items are available." - DataLinkContentTreeListResponse: - required: - - items - type: object - properties: - items: - type: array - items: - $ref: "#/components/schemas/DataLinkSimpleItem" - description: "Array of simple data-link items containing file paths and sizes." - DataLinkCreateRequest: - type: object - properties: - name: - type: string - description: "Unique name for the data-link. Must consist of alphanumeric, dash, or underscore characters." - description: - type: string - description: "Description of the data-link. Maximum length: 1000 characters." - type: - $ref: "#/components/schemas/DataLinkType" - description: "Type of the data-link. Currently supports `bucket`." - provider: - $ref: "#/components/schemas/DataLinkProvider" - description: "Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`." - resourceRef: - type: string - description: "Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)." - publicAccessible: - type: boolean - description: "Whether the data-link is publicly accessible. If `true`, no credentials are required. If `false`, `credentialsId` must be provided." - credentialsId: - type: string - description: "Credentials string identifier. Required when `publicAccessible` is `false`." - DataLinkCredentials: - required: - - id - - name - - provider - type: object - properties: - id: - type: string - description: "Credentials string identifier." - name: - type: string - description: "Name of the credentials." - provider: - $ref: "#/components/schemas/DataLinkProvider" - description: "Credentials cloud provider." - DataLinkDeleteItemRequest: - type: object - properties: - files: - type: array - items: - type: string - description: "Array of file paths to be deleted from the data-link." - dirs: - type: array - items: - type: string - description: "Array of directory paths to be deleted from the data-link." - DataLinkDeleteItemResponse: - type: object - properties: - deletionFailures: - type: array - items: - $ref: "#/components/schemas/DataLinkItemDeletionFailure" - description: "Array of items that failed to be deleted, including error messages." - DataLinkDownloadScriptResponse: - type: object - properties: - script: - type: string - description: "Shell script content to download files from the data-link." - DataLinkDownloadUrlResponse: - type: object - properties: - url: - type: string - description: "Pre-signed URL to download the requested file." - DataLinkDto: - type: object - properties: - id: - type: string - description: "Data-link string identifier. Generated based on provider, type, region, and resource path." - name: - type: string - description: "Name of the data-link (e.g., bucket name)." - description: - type: string - description: "Description of the data-link. Null for data-links auto-discovered from workspace credentials." - resourceRef: - type: string - description: "Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)." - type: - $ref: "#/components/schemas/DataLinkType" - description: "Data-link type. Currently supports `bucket`." - provider: - $ref: "#/components/schemas/DataLinkProvider" - description: "Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`." - region: - type: string - description: "Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers." - credentials: - type: array - items: - $ref: "#/components/schemas/DataLinkCredentials" - description: "Array of credentials that can access this data-link. Empty for public data-links." - publicAccessible: - type: boolean - description: "Whether the data-link is publicly accessible without credentials." - hidden: - type: boolean - description: "Visibility status flag. If `true`, data-link is hidden from default list views." - status: - type: string - readOnly: true - allOf: - - $ref: "#/components/schemas/DataLink.Status" - description: "Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted." - message: - type: string - description: "Error message for invalid data-links. Null for valid data-links." - DataLinkFinishMultiPartUploadRequest: - type: object - properties: - uploadId: - type: string - description: "Upload ID assigned when initiating multi-part upload for AWS S3. Obtained from the `/upload` endpoint response." - fileName: - type: string - description: "Name of the uploaded file." - tags: - type: array - items: - $ref: "#/components/schemas/UploadEtag" - description: "Array of ETags assigned for each part by AWS S3 during the upload process. Each ETag is returned in the response headers when uploading a part to the pre-signed URLs from the `/upload` endpoint." - withError: - type: boolean - description: "Flag indicating whether the upload encountered an error. If `true`, the upload will be aborted. If `false`, the upload will be completed." - DataLinkItem: - type: object - properties: - type: - $ref: "#/components/schemas/DataLinkItemType" - description: "Type of the item. Either `FILE` or `FOLDER`." - name: - type: string - description: "Name of the file or folder." - size: - type: integer - format: int64 - description: "Size of the file in bytes. For folders, always `0`." - mimeType: - type: string - description: "MIME type of the file, calculated by analyzing the file extension. Null for folders." - DataLinkItemDeletionFailure: - required: - - dataLinkItem - - errorMessage - type: object - properties: - dataLinkItem: - $ref: "#/components/schemas/DataLinkItem" - description: "Data-link item that failed to be deleted." - errorMessage: - type: string - description: "Error message describing why the deletion failed." - DataLinkItemType: - type: string - enum: - - FOLDER - - FILE - description: "Type of data-link content item. Either `FILE` or `FOLDER`." - DataLinkMultiPartUploadRequest: - type: object - properties: - fileName: - type: string - description: "Name of the file to upload." - contentLength: - type: integer - format: int64 - description: "Size of the file to upload in bytes." - contentType: - type: string - description: "MIME type of the file to upload (e.g., `application/octet-stream`, `text/plain`)." - DataLinkMultiPartUploadResponse: - type: object - properties: - uploadId: - type: string - description: "Upload ID generated by AWS S3. Required for the `/upload/finish` request." - uploadUrls: - type: array - items: - type: string - description: "Array of pre-signed URLs to execute multi-part upload. One URL per part." - DataLinkProvider: - type: string - enum: - - aws - - google - - azure - - azure_entra - - azure-cloud - - seqeracompute - - s3 - description: "Cloud provider for data-links. Supports AWS S3, Google Cloud Storage, Azure Blob Storage, Azure with Entra ID, Seqera Compute storage, and generic S3-compatible storage." - DataLinkResponse: - type: object - properties: - dataLink: - $ref: "#/components/schemas/DataLinkDto" - description: "Data-link object containing metadata." - DataLinkSimpleItem: - required: - - path - - size - type: object - properties: - path: - type: string - description: "Path to the item from the data-link root (resource path)." - size: - type: integer - format: int64 - description: "Size of the file in bytes. For folders, always `0`." - DataLinkType: - type: string - enum: - - bucket - x-enum-varnames: - - bucket - description: "Data-link type. Currently only `bucket` is supported." - DataLinkUpdateRequest: - type: object - properties: - name: - type: string - description: "New name for the data-link. Must be unique within the workspace or user context." - description: - type: string - description: "Updated description for the data-link. Maximum length: 1000 characters." - credentialsId: - type: string - description: "Updated credentials ID for accessing the data-link." - DataLinksListResponse: - type: object - properties: - dataLinks: - type: array - items: - $ref: "#/components/schemas/DataLinkDto" - description: "Array of data-link objects." - totalSize: - type: integer - format: int64 - description: "Total number of data-links matching the query." - DataStudioCheckpointDto: - required: - - author - - dateCreated - - dateSaved - - id - - name - - path - - status - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - dateCreated: - type: string - format: date-time - dateSaved: - type: string - format: date-time - author: - $ref: "#/components/schemas/UserInfo" - path: - type: string - status: - $ref: "#/components/schemas/StudioCheckpointStatus" - DataStudioCheckpointUpdateRequest: - type: object - properties: - name: - type: string - DataStudioComputeEnvDto: - type: object - allOf: - - $ref: "#/components/schemas/ComputeEnvDbDto" - - properties: - credentialsId: - type: string - workDir: - type: string - DataStudioConfiguration: - type: object - properties: - gpu: - minimum: 0 - type: integer - format: int32 - cpu: - minimum: 0 - type: integer - format: int32 - memory: - minimum: 0 - type: integer - format: int32 - mountData: - type: array - items: - type: string - environment: - type: object - additionalProperties: - type: string - nullable: true - condaEnvironment: - maxLength: 2048 - type: string - lifespanHours: - minimum: 0 - type: integer - format: int32 - DataStudioCreateRequest: - required: - - computeEnvId - - name - type: object - properties: - name: - maxLength: 80 - minLength: 1 - type: string - description: - maxLength: 2048 - type: string - dataStudioToolUrl: - type: string - computeEnvId: - minLength: 1 - type: string - initialCheckpointId: - type: integer - format: int64 - configuration: - $ref: "#/components/schemas/DataStudioConfiguration" - isPrivate: - type: boolean - labelIds: - type: array - nullable: true - items: - type: integer - format: int64 - spot: - type: boolean - nullable: true - DataStudioCreateResponse: - type: object - properties: - studio: - $ref: "#/components/schemas/DataStudioDto" - DataStudioDto: - type: object - properties: - sessionId: - type: string - workspaceId: - type: integer - format: int64 - parentCheckpoint: - $ref: "#/components/schemas/DataStudioDto.ParentCheckpoint" - user: - $ref: "#/components/schemas/UserInfo" - name: - type: string - description: - type: string - studioUrl: - type: string - computeEnv: - $ref: "#/components/schemas/DataStudioComputeEnvDto" - template: - $ref: "#/components/schemas/DataStudioTemplate" - configuration: - $ref: "#/components/schemas/DataStudioConfiguration" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - lastStarted: - type: string - format: date-time - effectiveLifespanHours: - type: integer - format: int32 - activeConnections: - type: array - items: - $ref: "#/components/schemas/ActiveConnection" - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - waveBuildUrl: - type: string - baseImage: - type: string - customImage: - type: boolean - isPrivate: - type: boolean - mountedDataLinks: - type: array - items: - $ref: "#/components/schemas/DataLinkDto" - progress: - type: array - items: - $ref: "#/components/schemas/DataStudioProgressStep" - labels: - type: array - nullable: true - items: - $ref: "#/components/schemas/LabelDbDto" - DataStudioDto.ParentCheckpoint: - type: object - properties: - checkpointId: - type: integer - format: int64 - checkpointName: - type: string - sessionId: - type: string - studioName: - type: string - DataStudioListCheckpointsResponse: - required: - - checkpoints - - totalSize - type: object - properties: - checkpoints: - type: array - items: - $ref: "#/components/schemas/DataStudioCheckpointDto" - totalSize: - type: integer - format: int64 - DataStudioListResponse: - required: - - studios - - totalSize - type: object - properties: - studios: - type: array - items: - $ref: "#/components/schemas/DataStudioDto" - totalSize: - type: integer - format: int64 - DataStudioMountedLinksResponse: - type: object - properties: - dataLinkIds: - type: array - items: - type: string - DataStudioProgressStep: - type: object - properties: - status: - $ref: "#/components/schemas/DataStudioProgressStep.Status" - message: - type: string - warnings: - type: array - items: - type: string - DataStudioProgressStep.Status: - type: string - enum: - - pending - - in-progress - - succeeded - - errored - DataStudioQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - DataStudioStartRequest: - type: object - properties: - configuration: - nullable: true - allOf: - - $ref: "#/components/schemas/DataStudioConfiguration" - description: - type: string - nullable: true - labelIds: - type: array - nullable: true - items: - type: integer - format: int64 - spot: - type: boolean - nullable: true - DataStudioStartResponse: - required: - - jobSubmitted - - sessionId - - statusInfo - type: object - properties: - jobSubmitted: - type: boolean - sessionId: - type: string - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - DataStudioStatus: - type: string - enum: - - starting - - running - - stopping - - stopped - - errored - - building - - buildFailed - x-enum-varnames: - - starting - - running - - stopping - - stopped - - errored - - building - - buildFailed - DataStudioStatusInfo: - type: object - properties: - status: - $ref: "#/components/schemas/DataStudioStatus" - message: - type: string - lastUpdate: - type: string - format: date-time - stopReason: - $ref: "#/components/schemas/DataStudioStopReason" - DataStudioStopReason: - type: string - enum: - - CREDITS_RUN_OUT - - LIFESPAN_EXPIRED - - SPOT_RECLAMATION - DataStudioStopResponse: - required: - - jobSubmitted - - sessionId - - statusInfo - type: object - properties: - jobSubmitted: - type: boolean - sessionId: - type: string - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - DataStudioTemplate: - type: object - properties: - repository: - type: string - icon: - type: string - status: - $ref: "#/components/schemas/DataStudioVersionStatus" - tool: - type: string - DataStudioTemplatesListResponse: - required: - - templates - - totalSize - type: object - properties: - templates: - type: array - items: - $ref: "#/components/schemas/DataStudioTemplate" - totalSize: - type: integer - format: int64 - DataStudioVersionStatus: - type: string - enum: - - recommended - - deprecated - - experimental - - unsupported - x-enum-varnames: - - recommended - - deprecated - - experimental - - unsupported - DataStudioWorkspaceSettingsResponse: - type: object - properties: - orgId: - type: integer - format: int64 - wspId: - type: integer - format: int64 - lifespanHours: - type: integer - format: int32 - DatasetDto: - type: object - properties: - id: - type: string - user: - $ref: "#/components/schemas/UserInfo" - workspaceId: - type: integer - format: int64 - organizationId: - type: integer - format: int64 - name: - type: string - lastUpdatedBy: - $ref: "#/components/schemas/UserInfo" - description: - type: string - mediaType: - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - deleted: - type: boolean - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - version: - type: integer - format: int64 - DatasetVersionDto: - type: object - properties: - datasetId: - type: string - datasetName: - type: string - datasetDescription: - type: string - hasHeader: - type: boolean - version: - type: integer - format: int64 - createdBy: - $ref: "#/components/schemas/UserInfo" - lastUpdated: - type: string - format: date-time - fileName: - type: string - mediaType: - type: string - workspaceId: - type: integer - format: int64 - url: - type: string - DeleteCredentialsConflictResponse: - type: object - properties: - credentialsId: - type: string - conflicts: - type: array - items: - $ref: "#/components/schemas/DeleteCredentialsConflictResponse.Conflict" - DeleteCredentialsConflictResponse.Conflict: - type: object - properties: - type: - type: string - id: - type: string - name: - type: string - url: - type: string - DeleteManagedCredentialsConflictResponse: - type: object - properties: - managedCredentialsId: - type: string - description: "Identifier of credentials that could not be deleted." - conflicts: - type: array - items: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse.Conflict" - description: "Array of conflicts preventing deletion." - DeleteManagedCredentialsConflictResponse.Conflict: - type: object - properties: - type: - type: string - id: - type: string - name: - type: string - url: - type: string - DeleteWorkflowsRequest: - type: object - properties: - workflowIds: - type: array - items: - type: string - DeleteWorkflowsResponse: - type: object - properties: - failedWorkflowIds: - type: array - items: - type: string - DescribeActionResponse: - type: object - properties: - action: - $ref: "#/components/schemas/ActionResponseDto" - DescribeComputeEnvResponse: - type: object - properties: - computeEnv: - $ref: "#/components/schemas/ComputeEnvResponseDto" - DescribeCredentialsResponse: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - DescribeDatasetResponse: - type: object - properties: - dataset: - $ref: "#/components/schemas/DatasetDto" - DescribeLaunchResponse: - type: object - properties: - launch: - $ref: "#/components/schemas/Launch" - DescribeOrganizationQuotasResponse: - type: object - properties: - quotas: - $ref: "#/components/schemas/OrganizationQuotas" - DescribeOrganizationResponse: - type: object - properties: - organization: - $ref: "#/components/schemas/OrganizationDbDto" - DescribePipelineInfoResponse: - type: object - properties: - pipelineInfo: - $ref: "#/components/schemas/PipelineInfo" - DescribePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - DescribePipelineSecretResponse: - type: object - properties: - pipelineSecret: - $ref: "#/components/schemas/PipelineSecret" - DescribePlatformResponse: - type: object - properties: - metainfo: - $ref: "#/components/schemas/PlatformMetainfo" - DescribeTaskResponse: - type: object - properties: - task: - $ref: "#/components/schemas/Task" - DescribeTeamResponse: - type: object - properties: - team: - $ref: "#/components/schemas/TeamDbDto" - DescribeUserResponse: - type: object - properties: - user: - $ref: "#/components/schemas/UserDbDto" - needConsent: - type: boolean - defaultWorkspaceId: - type: integer - format: int64 - DescribeWorkflowLaunchResponse: - type: object - properties: - launch: - $ref: "#/components/schemas/WorkflowLaunchResponse" - DescribeWorkflowResponse: - type: object - properties: - workflow: - $ref: "#/components/schemas/Workflow" - progress: - $ref: "#/components/schemas/ProgressData" - platform: - $ref: "#/components/schemas/ComputePlatformDto" - jobInfo: - $ref: "#/components/schemas/JobInfoDto" - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - optimized: - type: boolean - messages: - type: array - items: - type: string - DescribeWorkspaceResponse: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - EfsFileSystem: - type: object - properties: - id: - type: string - EksComputeConfig: - title: Amazon EKS cluster configuration - type: object - allOf: - - $ref: "#/components/schemas/K8sComputeConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - nextflowConfig: - type: string - region: - type: string - description: AWS region - clusterName: - type: string - description: The AWS EKS cluster name - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - required: ["region", "clusterName", "workDir", "region", "clusterName", "workDir"] - EksPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - clusters: - type: array - items: - type: string - EmptyBodyRequest: - type: object - ErrorResponse: - required: - - message - type: object - properties: - message: - type: string - EventType: - type: object - properties: - source: - type: string - display: - type: string - description: - type: string - enabled: - type: boolean - ForgeConfig: - type: object - properties: - type: - type: string - enum: - - SPOT - - EC2 - - "SPOT" - - "EC2" - - "SPOT" - - "EC2" - description: "Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)." - minCpus: - type: integer - format: int32 - description: "Minimum CPUs provisioned in the compute environment." - maxCpus: - type: integer - format: int32 - description: "Maximum CPUs provisioned in the compute environment." - gpuEnabled: - type: boolean - description: "Enable GPU instances." - ebsAutoScale: - type: boolean - description: "If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system." - instanceTypes: - type: array - items: - type: string - description: "Comma-separated list of allowed EC2 instance types." - allocStrategy: - type: string - enum: - - BEST_FIT - - BEST_FIT_PROGRESSIVE - - SPOT_CAPACITY_OPTIMIZED - - SPOT_PRICE_CAPACITY_OPTIMIZED - - "BEST_FIT" - - "BEST_FIT_PROGRESSIVE" - - "SPOT_CAPACITY_OPTIMIZED" - - "SPOT_PRICE_CAPACITY_OPTIMIZED" - - "BEST_FIT" - - "BEST_FIT_PROGRESSIVE" - - "SPOT_CAPACITY_OPTIMIZED" - - "SPOT_PRICE_CAPACITY_OPTIMIZED" - description: "Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances." - imageId: - type: string - description: "Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used." - vpcId: - type: string - description: "VPC ID for networking." - subnets: - type: array - items: - type: string - description: "List of VPC subnets to isolate EC2 resources from each other, or the internet." - securityGroups: - type: array - items: - type: string - description: "List of security group IDs to define a set of firewall rules that control EC2 compute node traffic." - fsxMount: - type: string - description: "FSx for Lustre mount point." - fsxName: - type: string - description: "FSx for Lustre file system name." - fsxSize: - type: integer - format: int32 - description: "FSx for Lustre file system size in GB." - disposeOnDeletion: - type: boolean - description: "If true, delete AWS resources when compute environment is deleted." - ec2KeyPair: - type: string - description: "EC2 key pair for SSH access." - allowBuckets: - type: array - items: - type: string - description: "List of additional S3 buckets accessible to compute environment." - ebsBlockSize: - type: integer - format: int32 - description: "EBS volume size in GB." - fusionEnabled: - type: boolean - description: "(Deprecated) Enable Fusion file system (v1)." - bidPercentage: - type: integer - format: int32 - description: "Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`." - efsCreate: - type: boolean - description: "If true, creates new EFS file system." - efsId: - type: string - description: "Existing EFS file system ID." - efsMount: - type: string - description: "EFS file system mount point in containers." - dragenEnabled: - type: boolean - description: "Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support." - dragenAmiId: - type: string - description: "AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances." - ebsBootSize: - type: integer - format: int32 - description: "Boot disk size for instances, in GB." - ecsConfig: - type: string - description: "Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)." - fargateHeadEnabled: - type: boolean - description: "Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems." - arm64Enabled: - type: boolean - description: "Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system." - dragenInstanceType: - type: string - description: "Instance type for DRAGEN workflows." - FsxFileSystem: - type: object - properties: - id: - type: string - dns: - type: string - mount: - type: string - GetProgressResponse: - type: object - properties: - progress: - $ref: "#/components/schemas/ProgressData" - GetWorkflowMetricsResponse: - type: object - properties: - metrics: - type: array - items: - $ref: "#/components/schemas/WorkflowMetrics" - GitHubSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - GitLabSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - token: - type: string - writeOnly: true - username: - type: string - password: - type: string - writeOnly: true - GiteaSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - GithubActionConfig: - type: object - properties: - discriminator: - type: string - readOnly: true - events: - type: array - items: - type: string - GithubActionEvent: - type: object - properties: - discriminator: - type: string - readOnly: true - ref: - type: string - commitId: - type: string - commitMessage: - type: string - pusherName: - type: string - pusherEmail: - type: string - timestamp: - type: string - format: date-time - GkeComputeConfig: - title: Google GKE cluster configuration - type: object - allOf: - - $ref: "#/components/schemas/K8sComputeConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - nextflowConfig: - type: string - region: - type: string - description: The GKE cluster region - or - zone - clusterName: - type: string - description: The GKE cluster name - fusion2Enabled: - type: boolean - waveEnabled: - type: boolean - required: ["region", "clusterName", "workDir", "region", "clusterName", "workDir"] - GkePlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - clusters: - type: array - items: - type: string - GoogleBatchConfig: - title: Google Batch service configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - location: - type: string - description: "Google Cloud location (region) for Batch jobs (e.g., `us-central1`)." - workDir: - type: string - spot: - type: boolean - description: "Use Spot instances." - bootDiskSizeGb: - type: integer - format: int32 - description: "Boot disk size in GB for compute instances." - cpuPlatform: - type: string - description: "Google Cloud Batch CPU platform." - machineType: - type: string - description: "Machine type for compute instances (e.g., `n1-standard-4`)." - projectId: - type: string - description: "Google Cloud project ID." - sshDaemon: - type: boolean - description: "Enable SSH daemon for debugging." - sshImage: - type: string - description: "Container image for SSH daemon." - debugMode: - type: integer - format: int32 - description: "Debug level (0-3) for troubleshooting." - copyImage: - type: string - description: "Container image for copying files." - usePrivateAddress: - type: boolean - description: "Use private IP addresses only (no external IPs)." - labels: - type: object - additionalProperties: - type: string - description: "Comma-separated list of labels to apply to Batch resources." - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - headJobCpus: - type: integer - format: int32 - description: "Number of CPUs allocated for the Nextflow head job." - headJobMemoryMb: - type: integer - format: int32 - description: "Memory allocation for the Nextflow head job in megabytes." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - nfsTarget: - type: string - description: "NFS server target for shared storage." - nfsMount: - type: string - description: "NFS mount path in containers." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - serviceAccount: - type: string - description: "Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)." - network: - type: string - description: "VPC network name." - subnetwork: - type: string - description: "Subnetwork name within the VPC." - headJobInstanceTemplate: - type: string - description: "Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job." - computeJobsInstanceTemplate: - type: string - description: "Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs." - required: ["location", "workDir", "location", "workDir"] - GoogleBucket: - type: object - properties: - path: - type: string - GoogleCloudConfig: - title: Google Cloud configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - workDir: - type: string - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - projectId: - type: string - description: "Google Cloud project ID." - region: - type: string - description: "Google Cloud region (e.g., `us-central1`)." - zone: - type: string - description: "Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list." - serviceAccountEmail: - type: string - description: "Service account email for IAM access to instances." - instanceType: - type: string - description: "Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used." - imageId: - type: string - description: "ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release." - arm64Enabled: - type: boolean - description: "Enable ARM64 instances." - gpuEnabled: - type: boolean - description: "Enable GPU instances." - bootDiskSizeGb: - type: integer - format: int32 - description: "Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used." - forgedResources: - type: array - items: - type: object - additionalProperties: true - description: "Resources created by Cloud Forge (read-only)." - required: ["region", "workDir", "region", "workDir"] - GoogleCloudPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - zones: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/GoogleBucket" - instanceTypes: - type: array - items: - $ref: "#/components/schemas/GoogleInstanceType" - images: - type: array - items: - $ref: "#/components/schemas/GoogleImage" - GoogleImage: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - arch: - type: string - GoogleInstanceType: - type: object - properties: - id: - type: string - arch: - type: string - GoogleLifeSciencesConfig: - title: Google life sciences configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - region: - type: string - zones: - type: array - items: - type: string - location: - type: string - workDir: - type: string - preemptible: - type: boolean - bootDiskSizeGb: - type: integer - format: int32 - projectId: - type: string - sshDaemon: - type: boolean - sshImage: - type: string - debugMode: - type: integer - format: int32 - copyImage: - type: string - usePrivateAddress: - type: boolean - labels: - type: object - additionalProperties: - type: string - preRunScript: - type: string - postRunScript: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - nextflowConfig: - type: string - nfsTarget: - type: string - nfsMount: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - GooglePlatformMetainfo: - type: object - properties: - locations: - type: array - items: - type: string - discriminator: - type: string - warnings: - type: array - items: - type: string - zones: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/GooglePlatformMetainfo.Bucket" - filestores: - type: array - items: - $ref: "#/components/schemas/GooglePlatformMetainfo.Filestore" - GooglePlatformMetainfo.Bucket: - type: object - properties: - path: - type: string - GooglePlatformMetainfo.Filestore: - type: object - properties: - target: - type: string - name: - type: string - location: - type: string - GoogleSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - data: - type: string - writeOnly: true - GridPlatformMetainfo: - type: object - properties: - discriminator: - type: string - Image: - required: - - arch - - description - - id - - name - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - arch: - type: string - InstanceType: - required: - - arch - type: object - properties: - id: - type: string - arch: - type: string - Iterator_String_: - type: object - JobCleanupPolicy: - type: string - enum: - - on_success - - always - - never - x-enum-varnames: - - on_success - - always - - never - JobInfoDto: - type: object - properties: - id: - type: integer - format: int64 - operationId: - type: string - message: - type: string - status: - type: string - exitCode: - type: integer - format: int32 - JobQueue: - required: - - name - - state - type: object - properties: - name: - type: string - state: - type: string - K8sComputeConfig: - title: Kubernetes compute configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - server: - type: string - description: "Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)." - sslCert: - type: string - description: "SSL certificate to authenticate the connection with the Kubernetes cluster." - namespace: - type: string - description: "Kubernetes namespace for workflow execution. Default: `default`." - computeServiceAccount: - type: string - description: "Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`." - headServiceAccount: - type: string - description: "Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)." - storageClaimName: - type: string - description: "PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode." - storageMountPath: - type: string - description: "Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`." - podCleanup: - $ref: "#/components/schemas/PodCleanupPolicy" - description: "Pod cleanup policy after job completion." - enum: ["on_success", "always", "never", "on_success", "always", "never"] - headPodSpec: - type: string - description: "Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`." - servicePodSpec: - type: string - description: "Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - headJobCpus: - type: integer - format: int32 - description: "Number of CPUs allocated for the Nextflow head job." - headJobMemoryMb: - type: integer - format: int32 - description: "Memory allocation for the Nextflow head job in megabytes." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - required: ["server", "sslCert", "workDir", "server", "sslCert", "workDir"] - K8sPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - K8sSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - certificate: - type: string - privateKey: - type: string - writeOnly: true - token: - type: string - writeOnly: true - LabelDbDto: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - isDynamic: - type: boolean - isInterpolated: - type: boolean - dateCreated: - type: string - format: date-time - LabelType: - type: string - enum: - - simple - - resource - - all - x-enum-varnames: - - simple - - resource - - all - Launch: - required: - - dateCreated - - pipeline - type: object - properties: - id: - maxLength: 22 - type: string - computeEnv: - nullable: true - allOf: - - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - pipeline: - maxLength: 200 - type: string - workDir: - type: string - revision: - maxLength: 100 - type: string - configText: - type: string - towerConfig: - type: string - paramsText: - type: string - preRunScript: - type: string - postRunScript: - type: string - mainScript: - maxLength: 200 - type: string - entryName: - maxLength: 80 - type: string - schemaName: - maxLength: 100 - pattern: "[\\p{Graph}&&[^/]]\\p{Graph}+" - type: string - resume: - type: boolean - resumeLaunchId: - maxLength: 22 - type: string - pullLatest: - type: boolean - stubRun: - type: boolean - sessionId: - maxLength: 36 - type: string - runName: - maxLength: 80 - type: string - configProfiles: - type: array - items: - type: string - userSecrets: - type: array - items: - type: string - workspaceSecrets: - type: array - items: - type: string - optimizationId: - maxLength: 32 - type: string - optimizationTargets: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - launchContainer: - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - LaunchActionRequest: - type: object - properties: - params: - type: object - additionalProperties: true - LaunchActionResponse: - type: object - properties: - workflowId: - type: string - ListAccessTokensResponse: - type: object - properties: - tokens: - type: array - items: - $ref: "#/components/schemas/AccessToken" - ListActionsResponse: - type: object - properties: - actions: - type: array - items: - $ref: "#/components/schemas/ListActionsResponse.ActionInfo" - ListActionsResponse.ActionInfo: - type: object - properties: - id: - type: string - name: - type: string - pipeline: - type: string - source: - $ref: "#/components/schemas/Action.Source" - status: - $ref: "#/components/schemas/Action.Status" - lastSeen: - type: string - format: date-time - dateCreated: - type: string - format: date-time - event: - $ref: "#/components/schemas/Action.EventType" - endpoint: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - usageCmd: - type: string - ListComputeEnvsResponse: - type: object - properties: - computeEnvs: - type: array - items: - $ref: "#/components/schemas/ListComputeEnvsResponse.Entry" - ListComputeEnvsResponse.Entry: - type: object - properties: - id: - type: string - name: - type: string - platform: - type: string - status: - $ref: "#/components/schemas/ComputeEnv.Status" - message: - type: string - lastUsed: - type: string - format: date-time - primary: - type: boolean - workspaceName: - type: string - visibility: - type: string - workDir: - type: string - credentialsId: - type: string - region: - type: string - ListCredentialsResponse: - type: object - properties: - credentials: - type: array - items: - $ref: "#/components/schemas/Credentials" - ListDatasetVersionsResponse: - type: object - properties: - versions: - type: array - items: - $ref: "#/components/schemas/DatasetVersionDto" - ListDatasetsResponse: - type: object - properties: - datasets: - type: array - items: - $ref: "#/components/schemas/DatasetDto" - ListEventTypesResponse: - type: object - properties: - eventTypes: - type: array - items: - $ref: "#/components/schemas/EventType" - ListLabelsResponse: - type: object - properties: - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - totalSize: - type: integer - format: int64 - ListManagedCredentialsRespDto: - type: object - properties: - managedCredentialsId: - type: integer - format: int64 - description: "Managed credentials numeric identifier." - userId: - type: integer - format: int64 - description: "User numeric identifier associated with these credentials." - userName: - type: string - description: "Username of the associated user." - firstName: - type: string - description: "First name of the associated user." - lastName: - type: string - description: "Last name of the associated user." - avatarUrl: - type: string - description: "URL of the user's avatar image." - provider: - type: string - enum: - - ssh - description: "Authentication provider type." - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - description: "Additional metadata for the managed credentials." - ListManagedCredentialsResponse: - type: object - properties: - managedCredentials: - type: array - items: - $ref: "#/components/schemas/ListManagedCredentialsRespDto" - description: "Array of managed credentials objects." - totalSize: - type: integer - format: int64 - description: "Total number of managed credentials matching the query." - ListManagedIdentitiesResponse: - type: object - properties: - managedIdentities: - type: array - items: - $ref: "#/components/schemas/ManagedIdentityDbDto_AbstractGridConfig_" - description: "Array of managed identities." - totalSize: - type: integer - format: int64 - description: "Total number of managed identities matching the query." - ListMembersResponse: - type: object - properties: - members: - type: array - items: - $ref: "#/components/schemas/MemberDbDto" - totalSize: - type: integer - format: int64 - ListOrganizationsResponse: - type: object - properties: - organizations: - type: array - items: - $ref: "#/components/schemas/OrganizationDbDto" - totalSize: - type: integer - format: int32 - ListParticipantsResponse: - type: object - properties: - participants: - type: array - items: - $ref: "#/components/schemas/ParticipantDbDto" - totalSize: - type: integer - format: int64 - ListPipelineInfoResponse: - type: object - properties: - pipelines: - type: array - items: - type: string - ListPipelineSecretsResponse: - type: object - properties: - pipelineSecrets: - type: array - items: - $ref: "#/components/schemas/PipelineSecret" - totalSize: - type: integer - format: int64 - ListPipelinesResponse: - type: object - properties: - pipelines: - type: array - items: - $ref: "#/components/schemas/PipelineDbDto" - totalSize: - type: integer - format: int64 - ListPlatformsResponse: - type: object - properties: - platforms: - type: array - items: - $ref: "#/components/schemas/ComputePlatform" - ListRegionsResponse: - type: object - properties: - regions: - type: array - items: - $ref: "#/components/schemas/ComputeRegion" - ListTasksResponse: - type: object - properties: - tasks: - type: array - items: - $ref: "#/components/schemas/DescribeTaskResponse" - total: - type: integer - format: int64 - ListTeamResponse: - type: object - properties: - teams: - type: array - items: - $ref: "#/components/schemas/TeamDbDto" - totalSize: - type: integer - format: int64 - ListWorkflowsResponse: - type: object - properties: - workflows: - type: array - items: - $ref: "#/components/schemas/ListWorkflowsResponse.ListWorkflowsElement" - totalSize: - type: integer - format: int64 - ListWorkflowsResponse.ListWorkflowsElement: - type: object - properties: - workflow: - $ref: "#/components/schemas/WorkflowDbDto" - progress: - $ref: "#/components/schemas/ProgressData" - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - starred: - type: boolean - optimized: - type: boolean - ListWorkspacesAndOrgResponse: - type: object - properties: - orgsAndWorkspaces: - type: array - items: - $ref: "#/components/schemas/OrgAndWorkspaceDto" - ListWorkspacesResponse: - type: object - properties: - workspaces: - type: array - items: - $ref: "#/components/schemas/WorkspaceDbDto" - LocalPlatformMetainfo: - type: object - properties: - discriminator: - type: string - Log: - type: object - properties: - name: - type: string - cmd: - type: array - items: - type: string - start_time: - type: string - end_time: - type: string - stdout: - type: string - stderr: - type: string - exit_code: - type: integer - format: int32 - LogPage: - type: object - properties: - truncated: - type: boolean - entries: - $ref: "#/components/schemas/Iterator_String_" - rewindToken: - type: string - forwardToken: - type: string - pending: - type: boolean - message: - type: string - downloads: - type: array - items: - $ref: "#/components/schemas/LogPage.Download" - LogPage.Download: - type: object - properties: - saveName: - type: string - fileName: - type: string - displayText: - type: string - LsfComputeConfig: - title: IBM LSF configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - unitForLimits: - type: string - perJobMemLimit: - type: boolean - perTaskReserve: - type: boolean - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - ManagedCredentialsDbDto: - type: object - properties: - id: - type: integer - format: int64 - description: "Managed credentials numeric identifier." - ManagedCredentialsMetadata: - type: object - properties: - discriminator: - type: string - readOnly: true - description: "Type discriminator for metadata structure (read-only)." - ManagedIdentityDbDto_AbstractGridConfig_: - type: object - properties: - id: - type: integer - format: int64 - description: "Managed identity numeric identifier." - name: - type: string - description: "Name of the managed identity." - platform: - type: string - enum: - - altair-platform - - lsf-platform - - moab-platform - - slurm-platform - - uge-platform - description: "HPC platform type." - config: - $ref: "#/components/schemas/AbstractGridConfig" - description: "HPC platform-specific configuration for the managed identity." - Map.Entry_String.String_: - type: object - properties: - key: - type: string - value: - type: string - MemberDbDto: - type: object - properties: - memberId: - type: integer - format: int64 - userId: - type: integer - format: int64 - userName: - type: string - email: - type: string - firstName: - type: string - lastName: - type: string - avatar: - type: string - role: - $ref: "#/components/schemas/OrgRole" - MoabComputeConfig: - title: Moab configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - MultiRequestFileSchema: - type: object - properties: - file: - type: string - format: binary - NavbarConfig: - type: object - properties: - menus: - type: array - items: - $ref: "#/components/schemas/NavbarConfig.NavbarMenu" - NavbarConfig.NavbarMenu: - type: object - properties: - label: - type: string - url: - type: string - OrgAndWorkspaceDto: - type: object - properties: - orgId: - type: integer - format: int64 - orgName: - type: string - orgLogoUrl: - type: string - orgType: - $ref: "#/components/schemas/OrgType" - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - workspaceFullName: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - roles: - type: array - items: - type: string - OrgRole: - type: string - enum: - - owner - - member - - collaborator - x-enum-varnames: - - owner - - member - - collaborator - OrgType: - type: string - enum: - - academic - - evaluating - - pro - - basic - - internal - x-enum-varnames: - - academic - - evaluating - - pro - - basic - - internal - Organization: - required: - - fullName - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - readOnly: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - fullName: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - location: - maxLength: 100 - type: string - website: - pattern: "" - type: string - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - OrganizationDbDto: - type: object - properties: - paying: - type: boolean - deprecated: true - orgId: - type: integer - format: int64 - name: - type: string - fullName: - type: string - description: - type: string - location: - type: string - website: - type: string - logoId: - type: string - logoUrl: - type: string - memberId: - type: integer - format: int64 - memberRole: - $ref: "#/components/schemas/OrgRole" - type: - $ref: "#/components/schemas/OrgType" - OrganizationQuotas: - type: object - properties: - maxWorkspaces: - type: integer - format: int64 - maxMembers: - type: integer - format: int64 - maxTeams: - type: integer - format: int64 - maxPipelinesPerWorkspace: - type: integer - format: int64 - maxParticipantsPerWorkspace: - type: integer - format: int64 - maxDatasetsPerWorkspace: - type: integer - format: int64 - maxVersionsPerDataset: - type: integer - format: int64 - maxRuns: - type: integer - format: int64 - maxRunHistory: - type: integer - format: int64 - maxLabelsPerWorkspace: - type: integer - format: int64 - maxDataStudiosRunning: - type: integer - format: int64 - maxSeqeraComputeComputeEnvs: - type: integer - format: int64 - maxFusionThroughputBytes: - type: integer - format: int64 - ParticipantDbDto: - type: object - properties: - participantId: - type: integer - format: int64 - memberId: - type: integer - format: int64 - userName: - type: string - firstName: - type: string - lastName: - type: string - email: - type: string - orgRole: - $ref: "#/components/schemas/OrgRole" - teamId: - type: integer - format: int64 - teamName: - type: string - wspRole: - $ref: "#/components/schemas/WspRole" - type: - $ref: "#/components/schemas/ParticipantType" - teamAvatarUrl: - type: string - userAvatarUrl: - type: string - ParticipantType: - type: string - enum: - - MEMBER - - TEAM - - COLLABORATOR - PipelineDbDto: - type: object - properties: - pipelineId: - type: integer - format: int64 - name: - type: string - description: - type: string - icon: - type: string - repository: - type: string - userId: - type: integer - format: int64 - userName: - type: string - userFirstName: - type: string - userLastName: - type: string - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - visibility: - type: string - deleted: - type: boolean - lastUpdated: - type: string - format: date-time - optimizationId: - type: string - optimizationTargets: - type: string - optimizationStatus: - $ref: "#/components/schemas/PipelineOptimizationStatus" - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - computeEnv: - $ref: "#/components/schemas/ComputeEnvDbDto" - PipelineInfo: - type: object - properties: - projectName: - type: string - simpleName: - type: string - repositoryUrl: - type: string - cloneUrl: - type: string - provider: - type: string - configFiles: - type: array - items: - type: string - workDirs: - type: array - items: - type: string - revisions: - type: array - items: - type: string - profiles: - type: array - items: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - warnings: - type: array - items: - type: string - PipelineOptimizationStatus: - type: string - enum: - - OPTIMIZED - - OPTIMIZABLE - - UNAVAILABLE - PipelineQueryAttribute: - type: string - enum: - - optimized - - labels - - computeEnv - x-enum-varnames: - - optimized - - labels - - computeEnv - PipelineSchemaAttributes: - type: string - enum: - - schema - - params - x-enum-varnames: - - schema - - params - PipelineSchemaResponse: - required: - - schema - type: object - properties: - schema: - type: string - params: - type: string - PipelineSecret: - required: - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 100 - pattern: "^[a-zA-Z_](?:[0-9A-Za-z]+|(_)(?!\\1)){1,49}$" - type: string - lastUsed: - type: string - format: date-time - readOnly: true - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - PlatformMetainfo: - type: object - discriminator: - propertyName: discriminator - mapping: - gke-platform: "#/components/schemas/GkePlatformMetaInfo" - aws-cloud: "#/components/schemas/AwsCloudPlatformMetainfo" - seqeracompute: "#/components/schemas/SeqeraComputePlatformMetainfo" - k8s-platform: "#/components/schemas/K8sPlatformMetaInfo" - grid: "#/components/schemas/GridPlatformMetainfo" - aws-batch: "#/components/schemas/AwsBatchPlatformMetainfo" - google-cloud: "#/components/schemas/GoogleCloudPlatformMetaInfo" - local-platform: "#/components/schemas/LocalPlatformMetainfo" - azure-batch: "#/components/schemas/AzBatchPlatformMetainfo" - eks-platform: "#/components/schemas/EksPlatformMetaInfo" - oneOf: - - $ref: "#/components/schemas/AwsBatchPlatformMetainfo" - - $ref: "#/components/schemas/AwsCloudPlatformMetainfo" - - $ref: "#/components/schemas/GooglePlatformMetainfo" - - $ref: "#/components/schemas/GoogleCloudPlatformMetaInfo" - - $ref: "#/components/schemas/AzBatchPlatformMetainfo" - - $ref: "#/components/schemas/EksPlatformMetaInfo" - - $ref: "#/components/schemas/GkePlatformMetaInfo" - - $ref: "#/components/schemas/K8sPlatformMetaInfo" - - $ref: "#/components/schemas/GridPlatformMetainfo" - - $ref: "#/components/schemas/SeqeraComputePlatformDescriber" - - $ref: "#/components/schemas/LocalPlatformMetainfo" - PodCleanupPolicy: - type: string - enum: - - on_success - - always - - never - x-enum-varnames: - - on_success - - always - - never - ProcessLoad: - required: - - aborted - - cached - - cpuLoad - - cpuTime - - cpus - - failed - - ignored - - invCtxSwitch - - loadCpus - - loadMemory - - loadTasks - - memoryReq - - memoryRss - - peakCpus - - peakMemory - - peakTasks - - pending - - process - - readBytes - - retries - - running - - submitted - - succeeded - - volCtxSwitch - - writeBytes - type: object - properties: - pending: - type: integer - format: int64 - submitted: - type: integer - format: int64 - running: - type: integer - format: int64 - succeeded: - type: integer - format: int64 - failed: - type: integer - format: int64 - cached: - type: integer - format: int64 - aborted: - type: integer - format: int64 - retries: - type: integer - format: int64 - ignored: - type: integer - format: int64 - memoryEfficiency: - type: number - format: float - cpuEfficiency: - type: number - format: float - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - version: - type: integer - format: int64 - process: - type: string - cpus: - type: integer - format: int64 - deprecated: true - cpuTime: - type: integer - format: int64 - deprecated: true - cpuLoad: - type: integer - format: int64 - deprecated: true - memoryRss: - type: integer - format: int64 - deprecated: true - memoryReq: - type: integer - format: int64 - deprecated: true - readBytes: - type: integer - format: int64 - deprecated: true - writeBytes: - type: integer - format: int64 - deprecated: true - volCtxSwitch: - type: integer - format: int64 - deprecated: true - invCtxSwitch: - type: integer - format: int64 - deprecated: true - loadTasks: - type: integer - format: int64 - deprecated: true - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakCpus: - type: integer - format: int64 - peakTasks: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - ProgressData: - type: object - properties: - workflowProgress: - $ref: "#/components/schemas/WorkflowLoad" - processesProgress: - type: array - items: - $ref: "#/components/schemas/ProcessLoad" - totalProcesses: - type: integer - format: int32 - RandomWorkflowNameResponse: - type: object - properties: - name: - type: string - ResourceData: - type: object - properties: - warnings: - type: array - items: - type: string - mean: - type: number - format: float - min: - type: number - format: float - q1: - type: number - format: float - q2: - type: number - format: float - q3: - type: number - format: float - max: - type: number - format: float - minLabel: - type: string - maxLabel: - type: string - q1Label: - type: string - q2Label: - type: string - q3Label: - type: string - RunId: - type: object - properties: - run_id: - type: string - RunListResponse: - type: object - properties: - runs: - type: array - items: - $ref: "#/components/schemas/RunStatus" - next_page_token: - type: string - RunLog: - type: object - properties: - run_id: - type: string - request: - $ref: "#/components/schemas/RunRequest" - state: - $ref: "#/components/schemas/State" - run_log: - $ref: "#/components/schemas/Log" - task_logs: - type: array - items: - $ref: "#/components/schemas/Log" - outputs: {} - RunRequest: - type: object - properties: - workflow_params: - type: string - workflow_type: - type: string - workflow_type_version: - type: string - tags: - type: object - additionalProperties: - type: string - workflow_engine_parameters: - type: object - additionalProperties: - type: string - workflow_url: - type: string - RunStatus: - type: object - properties: - run_id: - type: string - state: - $ref: "#/components/schemas/State" - S3SecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - accessKey: - type: string - secretKey: - type: string - writeOnly: true - pathStyleAccessEnabled: - type: boolean - SSHSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - privateKey: - type: string - writeOnly: true - passphrase: - type: string - writeOnly: true - SecurityGroup: - type: object - properties: - id: - type: string - name: - type: string - vpcId: - type: string - SecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - discriminator: - propertyName: discriminator - mapping: - s3: "#/components/schemas/S3SecurityKeys" - github: "#/components/schemas/GitHubSecurityKeys" - azurerepos: "#/components/schemas/AzureReposSecurityKeys" - azure_entra: "#/components/schemas/AzureEntraKeys" - container-reg: "#/components/schemas/ContainerRegistryKeys" - tw-agent: "#/components/schemas/AgentSecurityKeys" - k8s: "#/components/schemas/K8sSecurityKeys" - ssh: "#/components/schemas/SSHSecurityKeys" - google: "#/components/schemas/GoogleSecurityKeys" - bitbucket: "#/components/schemas/BitBucketSecurityKeys" - gitea: "#/components/schemas/GiteaSecurityKeys" - seqeracompute: "#/components/schemas/SeqeraComputeSecurityKeys" - codecommit: "#/components/schemas/CodeCommitSecurityKeys" - gitlab: "#/components/schemas/GitLabSecurityKeys" - aws: "#/components/schemas/AwsSecurityKeys" - azure: "#/components/schemas/AzureSecurityKeys" - oneOf: - - $ref: "#/components/schemas/AwsSecurityKeys" - - $ref: "#/components/schemas/GoogleSecurityKeys" - - $ref: "#/components/schemas/GitHubSecurityKeys" - - $ref: "#/components/schemas/GitLabSecurityKeys" - - $ref: "#/components/schemas/BitBucketSecurityKeys" - - $ref: "#/components/schemas/GiteaSecurityKeys" - - $ref: "#/components/schemas/SSHSecurityKeys" - - $ref: "#/components/schemas/K8sSecurityKeys" - - $ref: "#/components/schemas/AzureSecurityKeys" - - $ref: "#/components/schemas/AzureReposSecurityKeys" - - $ref: "#/components/schemas/ContainerRegistryKeys" - - $ref: "#/components/schemas/AgentSecurityKeys" - - $ref: "#/components/schemas/CodeCommitSecurityKeys" - - $ref: "#/components/schemas/AzureEntraKeys" - - $ref: "#/components/schemas/SeqeraComputeSecurityKeys" - - $ref: "#/components/schemas/S3SecurityKeys" - SeqeraComputeConfig: - title: Seqera Compute configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - region: - type: string - description: "Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)." - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - defaultDataRetentionPolicy: - type: boolean - description: "If true, intermediary files are deleted after 28 days to manage storage cost/usage." - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - required: ["region", "workDir", "region", "workDir"] - SeqeraComputePlatformDescriber: - type: object - SeqeraComputePlatformMetainfo: - type: object - properties: - warnings: - type: array - items: - type: string - jobQueues: - type: array - items: - $ref: "#/components/schemas/JobQueue" - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - fileSystems: - type: array - items: - $ref: "#/components/schemas/FsxFileSystem" - efsFileSystems: - type: array - items: - $ref: "#/components/schemas/EfsFileSystem" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceFamilies: - type: array - items: - type: string - allocStrategy: - type: array - items: - type: string - instanceTypes: - type: array - items: - $ref: "#/components/schemas/InstanceType" - discriminator: - type: string - SeqeraComputeSecurityKeys: - type: object - allOf: - - $ref: "#/components/schemas/AwsSecurityKeys" - - properties: - discriminator: - type: string - readOnly: true - ServiceInfo: - type: object - properties: - version: - type: string - apiVersion: - type: string - commitId: - type: string - authTypes: - type: array - items: - type: string - loginPath: - type: string - navbar: - $ref: "#/components/schemas/NavbarConfig" - heartbeatInterval: - type: integer - format: int32 - userWorkspaceEnabled: - type: boolean - allowInstanceCredentials: - type: boolean - landingUrl: - type: string - termsOfUseUrl: - type: string - contentUrl: - type: string - analytics: - $ref: "#/components/schemas/Analytics" - allowLocalRepos: - type: boolean - deprecated: true - contentMaxFileSize: - type: integer - format: int64 - waveEnabled: - type: boolean - groundswellEnabled: - type: boolean - groundswellAllowedWorkspaces: - type: array - items: - type: integer - format: int64 - scmsServerUrl: - type: string - forgePrefix: - type: string - seqeraCloud: - type: boolean - evalWorkspaceIds: - type: array - items: - type: integer - format: int64 - contactEmail: - type: string - allowNextflowCliLogs: - type: boolean - logoutUrl: - type: string - nullable: true - ServiceInfoResponse: - type: object - properties: - serviceInfo: - $ref: "#/components/schemas/ServiceInfo" - SlurmComputeConfig: - title: Slurm configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - State: - type: string - enum: - - UNKNOWN - - QUEUED - - INITIALIZING - - RUNNING - - PAUSED - - COMPLETE - - EXECUTOR_ERROR - - SYSTEM_ERROR - - CANCELED - - CANCELING - StudioCheckpointStatus: - type: string - enum: - - empty - - interim - - finalized - - invalid - x-enum-varnames: - - empty - - interim - - finalized - - invalid - SubmitWorkflowLaunchRequest: - type: object - properties: - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - SubmitWorkflowLaunchResponse: - type: object - properties: - workflowId: - type: string - Subnet: - type: object - properties: - id: - type: string - zone: - type: string - vpcId: - type: string - Task: - required: - - status - - taskId - type: object - properties: - hash: - type: string - name: - type: string - process: - type: string - tag: - type: string - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - module: - type: array - items: - type: string - container: - type: string - attempt: - type: integer - format: int32 - script: - type: string - scratch: - type: string - workdir: - type: string - queue: - type: string - cpus: - type: integer - format: int32 - memory: - type: integer - format: int64 - disk: - type: integer - format: int64 - time: - type: integer - format: int64 - env: - type: string - executor: - type: string - machineType: - type: string - cloudZone: - type: string - priceModel: - $ref: "#/components/schemas/CloudPriceModel" - cost: - type: number - errorAction: - type: string - exitStatus: - type: integer - format: int32 - duration: - type: integer - format: int64 - realtime: - type: integer - format: int64 - nativeId: - type: string - pcpu: - type: number - format: double - pmem: - type: number - format: double - rss: - type: integer - format: int64 - vmem: - type: integer - format: int64 - peakRss: - type: integer - format: int64 - peakVmem: - type: integer - format: int64 - rchar: - type: integer - format: int64 - wchar: - type: integer - format: int64 - syscr: - type: integer - format: int64 - syscw: - type: integer - format: int64 - readBytes: - type: integer - format: int64 - writeBytes: - type: integer - format: int64 - volCtxt: - type: integer - format: int64 - invCtxt: - type: integer - format: int64 - exit: - type: integer - format: int32 - id: - type: integer - format: int64 - nullable: true - taskId: - type: integer - format: int64 - status: - $ref: "#/components/schemas/TaskStatus" - dateCreated: - type: string - format: date-time - nullable: true - lastUpdated: - type: string - format: date-time - nullable: true - TaskStatus: - type: string - enum: - - NEW - - SUBMITTED - - RUNNING - - CACHED - - COMPLETED - - FAILED - - ABORTED - Team: - required: - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - readOnly: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - description: - maxLength: 250 - type: string - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - TeamDbDto: - type: object - properties: - teamId: - type: integer - format: int64 - name: - type: string - description: - type: string - avatarUrl: - type: string - membersCount: - type: integer - format: int64 - TraceBeginRequest: - type: object - properties: - launchId: - type: string - deprecated: true - workflow: - $ref: "#/components/schemas/Workflow" - processNames: - type: array - items: - type: string - towerLaunch: - type: boolean - TraceBeginResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - watchUrl: - type: string - TraceCompleteRequest: - type: object - properties: - workflow: - $ref: "#/components/schemas/Workflow" - metrics: - type: array - items: - $ref: "#/components/schemas/WorkflowMetrics" - progress: - $ref: "#/components/schemas/TraceProgressData" - TraceCompleteResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - TraceCreateRequest: - type: object - properties: - launchId: - type: string - deprecated: true - sessionId: - type: string - runName: - type: string - projectName: - type: string - repository: - type: string - workflowId: - type: string - TraceCreateResponse: - type: object - properties: - message: - type: string - workflowId: - type: string - TraceHeartbeatRequest: - type: object - properties: - progress: - $ref: "#/components/schemas/TraceProgressData" - TraceHeartbeatResponse: - type: object - properties: - message: - type: string - TraceProcessingStatus: - type: string - enum: - - OK - - KO - TraceProgressData: - type: object - properties: - pending: - type: integer - format: int32 - submitted: - type: integer - format: int32 - running: - type: integer - format: int32 - succeeded: - type: integer - format: int32 - cached: - type: integer - format: int32 - failed: - type: integer - format: int32 - aborted: - type: integer - format: int32 - stored: - type: integer - format: int32 - ignored: - type: integer - format: int32 - retries: - type: integer - format: int32 - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakRunning: - type: integer - format: int32 - peakCpus: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - processes: - type: array - items: - $ref: "#/components/schemas/TraceProgressDetail" - TraceProgressDetail: - type: object - properties: - index: - type: integer - format: int32 - name: - type: string - pending: - type: integer - format: int32 - submitted: - type: integer - format: int32 - running: - type: integer - format: int32 - succeeded: - type: integer - format: int32 - cached: - type: integer - format: int32 - failed: - type: integer - format: int32 - aborted: - type: integer - format: int32 - stored: - type: integer - format: int32 - ignored: - type: integer - format: int32 - retries: - type: integer - format: int32 - terminated: - type: boolean - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakRunning: - type: integer - format: int32 - peakCpus: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - TraceProgressRequest: - type: object - properties: - tasks: - type: array - items: - $ref: "#/components/schemas/Task" - progress: - $ref: "#/components/schemas/TraceProgressData" - containers: - type: array - items: - $ref: "#/components/schemas/ContainerData" - TraceProgressResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - UnivaComputeConfig: - title: Univa Grid Engine configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - UpdateActionRequest: - type: object - properties: - name: - type: string - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - UpdateComputeEnvRequest: - type: object - properties: - name: - type: string - description: "New name for the compute environment. Must be unique within workspace." - credentialsId: - type: string - description: "Updated credentials identifier. Changing credentials may affect running workflows." - UpdateCredentialsRequest: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - UpdateDatasetRequest: - type: object - properties: - name: - type: string - description: - type: string - UpdateLabelRequest: - type: object - properties: - name: - type: string - value: - type: string - isDefault: - type: boolean - UpdateLabelResponse: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - isDefault: - type: boolean - UpdateManagedCredentialsRequest: - type: object - properties: - provider: - type: string - enum: - - ssh - description: "Authentication provider type. Currently supports `ssh`." - credentials: - $ref: "#/components/schemas/Credentials" - description: "Updated authentication credentials configuration." - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - description: "Additional metadata for the managed credentials." - UpdateManagedIdentityRequest: - type: object - properties: - managedIdentity: - $ref: "#/components/schemas/ManagedIdentityDbDto_AbstractGridConfig_" - description: "Updated managed identity configuration object." - UpdateMemberRoleRequest: - type: object - properties: - role: - $ref: "#/components/schemas/OrgRole" - UpdateOrganizationRequest: - type: object - properties: - fullName: - type: string - name: - type: string - description: - type: string - location: - type: string - website: - type: string - logoId: - type: string - paying: - type: boolean - nullable: true - deprecated: true - type: - nullable: true - allOf: - - $ref: "#/components/schemas/OrgType" - UpdateParticipantRoleRequest: - type: object - properties: - role: - $ref: "#/components/schemas/WspRole" - UpdatePipelineRequest: - type: object - properties: - name: - type: string - description: "Pipeline name. Must be unique within the workspace." - description: - type: string - description: "Pipeline description." - icon: - type: string - description: "Pipeline icon URL." - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - description: "Launch configuration for the pipeline." - labelIds: - type: array - items: - type: integer - format: int64 - description: "Array of label IDs to assign to the pipeline. If null, empty, or omitted, all existing labels are removed. Label IDs to be preserved must be included in your request." - UpdatePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - UpdatePipelineSecretRequest: - type: object - properties: - value: - type: string - UpdateTeamRequest: - type: object - properties: - name: - type: string - description: - type: string - avatarId: - type: string - UpdateWorkspaceRequest: - type: object - properties: - name: - type: string - fullName: - type: string - description: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - UploadDatasetVersionResponse: - type: object - properties: - version: - $ref: "#/components/schemas/DatasetVersionDto" - UploadEtag: - type: object - properties: - partNumber: - type: integer - format: int32 - eTag: - type: string - UserDbDto: - required: - - email - - userName - type: object - properties: - id: - type: integer - format: int64 - userName: - maxLength: 40 - type: string - email: - maxLength: 255 - type: string - format: email - firstName: - maxLength: 100 - type: string - lastName: - maxLength: 100 - type: string - organization: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - avatar: - type: string - avatarId: - type: string - notification: - type: boolean - termsOfUseConsent: - type: boolean - marketingConsent: - type: boolean - lastAccess: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - deleted: - type: boolean - UserInfo: - required: - - avatar - - email - - id - - userName - type: object - properties: - id: - type: integer - format: int64 - userName: - type: string - email: - type: string - avatar: - type: string - Visibility: - type: string - enum: - - PRIVATE - - SHARED - Vpc: - type: object - properties: - id: - type: string - isDefault: - type: boolean - WesErrorResponse: - type: object - properties: - msg: - type: string - status_code: - type: integer - format: int32 - WfFusionMeta: - type: object - properties: - enabled: - type: boolean - version: - maxLength: 20 - type: string - WfManifest: - type: object - properties: - nextflowVersion: - maxLength: 20 - type: string - defaultBranch: - maxLength: 20 - type: string - version: - maxLength: 20 - type: string - homePage: - maxLength: 200 - type: string - gitmodules: - maxLength: 150 - type: string - description: - maxLength: 1024 - type: string - name: - maxLength: 150 - type: string - mainScript: - maxLength: 100 - type: string - author: - maxLength: 150 - type: string - icon: - maxLength: 255 - type: string - WfNextflow: - type: object - properties: - version: - maxLength: 20 - type: string - build: - maxLength: 10 - type: string - timestamp: - type: string - format: date-time - WfStats: - type: object - properties: - computeTimeFmt: - maxLength: 50 - type: string - cachedCount: - type: integer - format: int32 - failedCount: - type: integer - format: int32 - ignoredCount: - type: integer - format: int32 - succeedCount: - type: integer - format: int32 - cachedCountFmt: - type: string - succeedCountFmt: - type: string - failedCountFmt: - type: string - ignoredCountFmt: - type: string - cachedPct: - type: number - format: float - failedPct: - type: number - format: float - succeedPct: - type: number - format: float - ignoredPct: - type: number - format: float - cachedDuration: - type: integer - format: int64 - failedDuration: - type: integer - format: int64 - succeedDuration: - type: integer - format: int64 - WfWaveMeta: - type: object - properties: - enabled: - type: boolean - Workflow: - required: - - commandLine - - projectName - - runName - - sessionId - - submit - - userName - - workDir - type: object - properties: - requiresAttention: - type: boolean - status: - $ref: "#/components/schemas/WorkflowStatus" - ownerId: - type: integer - format: int64 - readOnly: true - repository: - type: string - id: - maxLength: 16 - type: string - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - dateCreated: - type: string - format: date-time - nullable: true - readOnly: true - lastUpdated: - type: string - format: date-time - nullable: true - readOnly: true - runName: - maxLength: 80 - type: string - sessionId: - maxLength: 36 - type: string - profile: - maxLength: 100 - type: string - workDir: - type: string - commitId: - maxLength: 40 - type: string - userName: - maxLength: 40 - type: string - scriptId: - maxLength: 40 - type: string - revision: - maxLength: 100 - type: string - commandLine: - maxLength: 8096 - type: string - projectName: - maxLength: 200 - type: string - scriptName: - maxLength: 100 - type: string - launchId: - maxLength: 22 - type: string - configFiles: - type: array - items: - type: string - params: - type: object - additionalProperties: true - configText: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - nextflow: - $ref: "#/components/schemas/WfNextflow" - stats: - $ref: "#/components/schemas/WfStats" - fusion: - $ref: "#/components/schemas/WfFusionMeta" - wave: - $ref: "#/components/schemas/WfWaveMeta" - errorMessage: - type: string - errorReport: - type: string - deleted: - type: boolean - readOnly: true - projectDir: - type: string - homeDir: - type: string - container: - type: string - containerEngine: - type: string - scriptFile: - type: string - launchDir: - type: string - duration: - type: integer - format: int64 - exitStatus: - type: integer - format: int32 - resume: - type: boolean - success: - type: boolean - logFile: - maxLength: 255 - type: string - outFile: - maxLength: 255 - type: string - operationId: - maxLength: 110 - type: string - WorkflowDbDto: - type: object - properties: - messages: - type: array - items: - type: string - id: - type: string - ownerId: - type: integer - format: int64 - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - runName: - type: string - sessionId: - type: string - profile: - type: string - workDir: - type: string - commitId: - type: string - userName: - type: string - scriptId: - type: string - revision: - type: string - commandLine: - type: string - projectName: - type: string - scriptName: - type: string - launchId: - type: string - status: - $ref: "#/components/schemas/WorkflowStatus" - requiresAttention: - type: boolean - configFiles: - type: array - items: - type: string - params: - type: object - additionalProperties: true - configText: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - nextflow: - $ref: "#/components/schemas/WfNextflow" - stats: - $ref: "#/components/schemas/WfStats" - errorMessage: - type: string - errorReport: - type: string - deleted: - type: boolean - projectDir: - type: string - homeDir: - type: string - container: - type: string - repository: - type: string - containerEngine: - type: string - scriptFile: - type: string - launchDir: - type: string - duration: - type: integer - format: int64 - exitStatus: - type: integer - format: int32 - resume: - type: boolean - success: - type: boolean - WorkflowLaunchRequest: - type: object - properties: - id: - type: string - description: "Launch configuration identifier." - computeEnvId: - type: string - description: "Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted." - runName: - type: string - description: "Custom run name for the workflow execution." - pipeline: - type: string - description: "Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`)." - workDir: - type: string - description: "Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted." - revision: - type: string - description: "Git revision, branch, or tag to use." - sessionId: - type: string - description: "Nextflow session identifier for resuming failed runs." - configProfiles: - type: array - items: - type: string - description: "Array of Nextflow configuration profile names to apply." - userSecrets: - type: array - items: - type: string - description: "Array of user secrets to make available to the pipeline." - workspaceSecrets: - type: array - items: - type: string - description: "Array of workspace secrets to make available to the pipeline." - configText: - type: string - description: "Nextflow configuration as text (overrides config files)." - towerConfig: - type: string - description: "Platform-specific configuration options." - paramsText: - type: string - description: "Pipeline parameters in JSON or YAML format." - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - mainScript: - type: string - description: "Alternative main script filename. Default: `main.nf`." - entryName: - type: string - description: "Workflow entry point name when using Nextflow DSL2." - schemaName: - type: string - description: "Name of the pipeline schema to use." - resume: - type: boolean - description: "Enable resume to restart workflow execution from the last successful process. See [Resume a workflow run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run)." - pullLatest: - type: boolean - description: "Pull the latest version of the pipeline from the repository." - stubRun: - type: boolean - description: "Execute a stub run for testing (processes return dummy results)." - optimizationId: - type: string - description: "Optimization configuration identifier. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)." - optimizationTargets: - type: string - description: "Comma-separated list of optimization targets. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)." - labelIds: - type: array - items: - type: integer - format: int64 - description: "Array of label IDs to assign to each pipeline run." - headJobCpus: - type: integer - format: int32 - description: "Number of CPUs allocated for the Nextflow head job." - headJobMemoryMb: - type: integer - format: int32 - description: "Memory allocation for the Nextflow head job in megabytes." - launchContainer: - type: string - description: "Container image to use for the Nextflow launcher." - dateCreated: - type: string - format: date-time - description: "Timestamp when the launch configuration was created." - WorkflowLaunchResponse: - type: object - properties: - id: - type: string - computeEnv: - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - pipeline: - type: string - pipelineId: - type: integer - format: int64 - workDir: - type: string - revision: - type: string - sessionId: - type: string - configProfiles: - type: array - items: - type: string - userSecrets: - type: array - items: - type: string - workspaceSecrets: - type: array - items: - type: string - configText: - type: string - towerConfig: - type: string - paramsText: - type: string - preRunScript: - type: string - postRunScript: - type: string - mainScript: - type: string - entryName: - type: string - schemaName: - type: string - resume: - type: boolean - pullLatest: - type: boolean - stubRun: - type: boolean - resumeDir: - type: string - resumeCommitId: - type: string - headJobMemoryMb: - type: integer - format: int32 - headJobCpus: - type: integer - format: int32 - optimizationId: - type: string - optimizationTargets: - type: string - dateCreated: - type: string - format: date-time - WorkflowLoad: - required: - - aborted - - cached - - cpuLoad - - cpuTime - - cpus - - failed - - ignored - - invCtxSwitch - - loadCpus - - loadMemory - - loadTasks - - memoryReq - - memoryRss - - peakCpus - - peakMemory - - peakTasks - - pending - - readBytes - - retries - - running - - submitted - - succeeded - - volCtxSwitch - - writeBytes - type: object - properties: - pending: - type: integer - format: int64 - submitted: - type: integer - format: int64 - running: - type: integer - format: int64 - succeeded: - type: integer - format: int64 - failed: - type: integer - format: int64 - cached: - type: integer - format: int64 - aborted: - type: integer - format: int64 - retries: - type: integer - format: int64 - ignored: - type: integer - format: int64 - memoryEfficiency: - type: number - format: float - cpuEfficiency: - type: number - format: float - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - version: - type: integer - format: int64 - executors: - type: array - items: - type: string - cpus: - type: integer - format: int64 - cpuTime: - type: integer - format: int64 - cpuLoad: - type: integer - format: int64 - memoryRss: - type: integer - format: int64 - memoryReq: - type: integer - format: int64 - readBytes: - type: integer - format: int64 - writeBytes: - type: integer - format: int64 - volCtxSwitch: - type: integer - format: int64 - invCtxSwitch: - type: integer - format: int64 - loadTasks: - type: integer - format: int64 - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakCpus: - type: integer - format: int64 - peakTasks: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - cost: - type: number - netCpus: - type: integer - format: int64 - netCpuTime: - type: integer - format: int64 - netCpuLoad: - type: integer - format: int64 - netMemoryRss: - type: integer - format: int64 - netMemoryReq: - type: integer - format: int64 - netMemoryConsumption: - type: number - netReadBytes: - type: integer - format: int64 - netWriteBytes: - type: integer - format: int64 - netVolCtxSwitch: - type: integer - format: int64 - netInvCtxSwitch: - type: integer - format: int64 - netCost: - type: number - WorkflowLogResponse: - type: object - properties: - log: - $ref: "#/components/schemas/LogPage" - WorkflowMetrics: - required: - - process - type: object - properties: - id: - type: integer - format: int64 - nullable: true - process: - maxLength: 255 - type: string - cpu: - $ref: "#/components/schemas/ResourceData" - mem: - $ref: "#/components/schemas/ResourceData" - vmem: - $ref: "#/components/schemas/ResourceData" - time: - $ref: "#/components/schemas/ResourceData" - reads: - $ref: "#/components/schemas/ResourceData" - writes: - $ref: "#/components/schemas/ResourceData" - cpuUsage: - $ref: "#/components/schemas/ResourceData" - memUsage: - $ref: "#/components/schemas/ResourceData" - timeUsage: - $ref: "#/components/schemas/ResourceData" - WorkflowQueryAttribute: - type: string - enum: - - optimized - - labels - - messages - - minimal - x-enum-varnames: - - optimized - - labels - - messages - - minimal - WorkflowStatus: - type: string - enum: - - SUBMITTED - - RUNNING - - SUCCEEDED - - FAILED - - CANCELLED - - UNKNOWN - Workspace: - required: - - fullName - - name - - visibility - type: object - properties: - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - fullName: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - visibility: - $ref: "#/components/schemas/Visibility" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - WorkspaceDbDto: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - fullName: - type: string - description: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - WspRole: - type: string - enum: - - owner - - admin - - maintain - - launch - - connect - - view - x-enum-varnames: - - owner - - admin - - maintain - - launch - - connect - - view - securitySchemes: - BearerAuth: - type: http - scheme: bearer - bearerFormat: jwt diff --git a/platform-api-docs/scripts/specs/seqera-api-1.85.0.yml b/platform-api-docs/scripts/specs/seqera-api-1.85.0.yml deleted file mode 100644 index ad72e3e23..000000000 --- a/platform-api-docs/scripts/specs/seqera-api-1.85.0.yml +++ /dev/null @@ -1,14648 +0,0 @@ -openapi: 3.0.1 -info: - title: Seqera API - description: Seqera Platform services API - contact: - url: https://seqera.io - email: info@seqera.io - version: 1.85.0 -tags: -- name: actions - description: Pipeline actions -- name: avatars - description: Avatars -- name: compute-envs - description: Compute environments -- name: credentials - description: Credentials -- name: data-links - description: Cloud storage directory paths in Data Explorer -- name: datasets - description: Pipeline input datasets (samplesheets) in CSV or TSV format -- name: ga4gh - description: GA4GH workflow execution service runs -- name: labels - description: Labels and resource labels -- name: launch - description: Workflow launch events -- name: orgs - description: Organizations -- name: pipelines - description: Pipelines -- name: pipeline-secrets - description: Pipeline secrets in a user or workspace context -- name: platforms - description: Computing platforms -- name: service-info - description: Seqera Platform API service information -- name: studios - description: Studios and Studio sessions -- name: teams - description: Teams in an organization context -- name: tokens - description: API access tokens -- name: trace - description: Workflow execution traces -- name: users - description: Users -- name: workflows - description: Workflow executions -- name: workspaces - description: Workspaces in an organization context -paths: - /actions: - get: - tags: - - actions - summary: List actions - description: "Lists all available actions in a user context, enriched by `attributes`.\ - \ Append `?workspaceId` to list actions in a workspace context." - operationId: ListActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ActionQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListActionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - actions - summary: Create action - description: Creates a new pipeline action. Append `?workspaceId` to associate - the action with the given workspace. - operationId: CreateAction - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateActionRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/add: - post: - tags: - - labels - summary: Add labels to actions - description: Adds the given list of labels to the given pipeline actions. Existing - labels are preserved. - operationId: AddLabelsToActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/apply: - post: - tags: - - labels - summary: Replace action labels - description: Applies the given list of labels to the given pipeline actions. - Existing labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/remove: - post: - tags: - - labels - summary: Remove labels from actions - description: Removes the given list of labels from the given pipeline actions. - operationId: RemoveLabelsFromActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/types: - get: - tags: - - actions - summary: List action event types - description: Lists the supported event types that trigger a pipeline action. - Append `?workspaceId` to list event types in a workspace context. - operationId: ListActionTypes - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListEventTypesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/validate: - get: - tags: - - actions - summary: Validate action name - description: Confirms the validity of the given action name. Append `?name=`. - operationId: ValidateActionName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Action name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /actions/{actionId}: - get: - tags: - - actions - summary: Describe action - description: Retrieves the details of the action identified by the given `actionId`. - operationId: DescribeAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ActionQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - actions - summary: Update action - description: Updates the details of the action identified by the given `actionId`. - The `source` of an existing action cannot be changed. - operationId: UpdateAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateActionRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - actions - summary: Delete action - description: Deletes the pipeline action identified by the given `actionId`. - operationId: DeleteAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/{actionId}/launch: - post: - tags: - - actions - summary: Trigger Tower Launch action - description: Triggers the execution of the Tower Launch action identified by - the given `actionId`. - operationId: LaunchAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action launch request - content: - application/json: - schema: - $ref: "#/components/schemas/LaunchActionRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/LaunchActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/{actionId}/pause: - post: - tags: - - actions - summary: Pause or resume action - description: Pauses or resumes the pipeline action identified by the given `actionId`. - operationId: PauseAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /avatars: - post: - tags: - - avatars - summary: Create the avatar image - operationId: CreateAvatar - requestBody: - description: Image file request - content: - multipart/form-data: - schema: - type: object - properties: - image: - type: string - format: binary - encoding: - image: - contentType: application/octet-stream - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAvatarResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /avatars/{avatarId}: - get: - tags: - - avatars - summary: Download the avatar image - operationId: DownloadAvatar - parameters: - - name: avatarId - in: path - description: Avatar string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found element - security: - - BearerAuth: [] - /compute-envs: - get: - tags: - - compute-envs - summary: List compute environments - description: "Lists all available compute environments in a user context. Append\ - \ `?workspaceId` to list compute environments in a workspace context, and\ - \ `?status` to filter by compute environment status." - operationId: ListComputeEnvs - parameters: - - name: status - in: query - description: Compute environment status - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`,\ - \ `resources`). Returns an empty value (ex. `labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/ComputeEnvQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListComputeEnvsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - compute-envs - summary: Create compute environment - description: Creates a new compute environment. Append `?workspaceId` to create - the environment in a workspace context. - operationId: CreateComputeEnv - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Compute environment create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateComputeEnvRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateComputeEnvResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /compute-envs/validate: - get: - tags: - - compute-envs - summary: Validate compute environment name - description: Confirms the validity of the given compute environment name in - a user context. Append `?name=`. - operationId: ValidateComputeEnvName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Compute environment name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /compute-envs/{computeEnvId}: - get: - tags: - - compute-envs - summary: Describe compute environment - description: Retrieves the details of the compute environment identified by - the given `computeEnvId`. - operationId: DescribeComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ComputeEnvQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeComputeEnvResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - compute-envs - summary: Update compute environment - description: Updates the details of the compute environment identified by the - given `computeEnvId`. - operationId: UpdateComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Compute environment update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateComputeEnvRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - compute-envs - summary: Delete compute environment - description: Deletes the compute environment identified by the given `computeEnvId`. - operationId: DeleteComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Conflicting deletion - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /compute-envs/{computeEnvId}/primary: - post: - tags: - - compute-envs - summary: Define primary compute environment - description: Selects the compute environment identified by the given `computeEnvId` - as the primary compute environment in the given workspace context. - operationId: UpdateComputeEnvPrimary - parameters: - - name: computeEnvId - in: path - description: Compute environment string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /credentials: - get: - tags: - - credentials - summary: List credentials - description: "Lists all available credentials in a user context. Append `?workspaceId`\ - \ to list credentials in a workspace context, and `?platformId` to filter\ - \ credentials by computing platform." - operationId: ListCredentials - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: platformId - in: query - description: Platform string identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - credentials - summary: Create credentials - description: Creates new credentials in a user context. Append `?workspaceId` - to create the credentials in a workspace context. - operationId: CreateCredentials - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Credentials create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCredentialsRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /credentials/validate: - get: - tags: - - credentials - summary: Validate credential name - description: Validates the given credentials name. Append `?name=`. - operationId: ValidateCredentialsName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Credentials name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /credentials/{credentialsId}: - get: - tags: - - credentials - summary: Describe credentials - description: Retrieves the details of the credentials identified by the given - `credentialsId`. - operationId: DescribeCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - credentials - summary: Update credentials - description: Updates the details of the credentials identified by the given - `credentialsId`. - operationId: UpdateCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Credentials update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateCredentialsRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - credentials - summary: Delete credentials - description: Deletes the credentials identified by the given `credentialsId`. - operationId: DeleteCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: checked - in: query - description: If set credentials deletion will be blocked by running jobs that - depend on them - schema: - type: boolean - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this credentials - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteCredentialsConflictResponse" - security: - - BearerAuth: [] - /data-links: - get: - tags: - - data-links - summary: List data-links - description: | - Retrieves all available data-links in a user context. Append `?workspaceId={your-workspace-id}` to retrieve data-links in a workspace context. - operationId: ListDataLinks - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials identifier - schema: - type: string - - name: search - in: query - description: "Free text search criteria — data-link name and keywords: `region`,\ - \ `provider`." - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: visibility - in: query - description: Filter results by visibility - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinksListResponse" - "202": - description: Accepted - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinksListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, or the API\ - \ is disabled in the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - data-links - summary: Create data-link - description: Creates a new data-link in a user context. Append `?workspaceId=` - to create the data-link in a workspace context. - operationId: CreateCustomDataLink - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Data-link creation request - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkCreateRequest" - required: true - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ in the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/cache/refresh: - get: - tags: - - data-links - summary: Refresh data-link cache - description: Refreshes the data-link cache for the given `workspaceId` or `credentialsId` - operationId: RefreshDataLinkCache - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - responses: - "200": - description: OK - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}: - get: - tags: - - data-links - summary: Describe data-link - description: Retrieves the details of the data-link associated with the given - `dataLinkId`. - operationId: DescribeDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - data-links - summary: Update data-link - description: Update the data-link associated with the given `dataLinkId`. - operationId: UpdateCustomDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Data-link update request - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkUpdateRequest" - required: true - responses: - "200": - description: Success — Data-link updated - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - data-links - summary: Delete data-link - description: Deletes the data-link associated with the given `dataLinkId`. - operationId: DeleteCustomDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: Success — Data-link deleted - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "204": - description: DeleteCustomDataLink 204 response - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse: - get: - tags: - - data-links - summary: Explore data-link path - description: "Retrieves the content of the data-link associated with the given\ - \ `dataLinkId`, at the given `path`." - operationId: ExploreDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: path - in: path - description: Content path - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: search - in: query - description: Prefix search of data-link content - schema: - type: string - - name: nextPageToken - in: query - description: Token used to fetch the next page of items - schema: - type: string - - name: pageSize - in: query - description: "Number of items to return per page. If ommitted, a default maximum\ - \ value is returned." - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse-tree: - get: - tags: - - data-links - summary: Explore a data-link tree - description: Provides a list of all files in the provided paths (including files - in sub-paths). - operationId: ExploreDataLinkTree - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: paths - in: query - description: List of paths - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentTreeListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse/{path}: - get: - tags: - - data-links - summary: Explore data-link path - description: "Retrieves the content of the data-link associated with the given\ - \ `dataLinkId`, at the given `path`." - operationId: ExploreDataLink_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: path - in: path - description: Content path - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: search - in: query - description: Prefix search of data-link content - schema: - type: string - - name: nextPageToken - in: query - description: Token used to fetch the next page of items - schema: - type: string - - name: pageSize - in: query - description: "Number of items to return per page. If ommitted, a default maximum\ - \ value is returned." - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/content: - delete: - tags: - - data-links - summary: Delete data-link content - description: Deletes the content of the data-link associated with the given - `dataLinkId`. The data-link itself is preserved. - operationId: DeleteDataLinkItem - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDeleteItemRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDeleteItemResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/download: - get: - tags: - - data-links - summary: Download data-link file at path - description: Downloads the content at the given `filePath` in the data-link - associated with the given `dataLinkId`. - operationId: DownloadDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: filePath - in: path - description: File path to download - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/generate-download-url: - get: - tags: - - data-links - summary: Generate data-link file download URL - description: Returns a URL to download files from the data-link associated with - the given `dataLinkId`. - operationId: GenerateDownloadUrlDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: filePath - in: query - description: File path to download - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: preview - in: query - description: "Whether to generate the URL for preview purposes or direct download\ - \ (default: false)" - schema: - type: boolean - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDownloadUrlResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/script/download: - get: - tags: - - data-links - summary: Generate download script - description: Creates a script to download files from the data-link associated - with the given `dataLinkId`. Append `?dirs` or `?files` to specify a list - of files or paths to download within the data-link. - operationId: GenerateDownloadScript - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: dirs - in: query - description: List of paths to directories to download - schema: - type: array - items: - type: object - - name: files - in: query - description: List of paths to files to download - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDownloadScriptResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload: - post: - tags: - - data-links - summary: Generate data-link file upload URL (to given path) - description: |- - Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). - For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - operationId: GenerateDataLinkUploadUrl - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: Origin - in: header - schema: - type: string - nullable: true - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/finish: - post: - tags: - - data-links - summary: Finish data-link file upload to given path - description: "Finish upload of a data-link file, specifying a file path (`dirPath`).\ - \ This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize\ - \ a successful file upload, or abort an upload if an error was encountered\ - \ while uploading a file using an upload URL from the `/upload` endpoint." - operationId: FinishDataLinkUpload - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkFinishMultiPartUploadRequest" - required: true - responses: - "202": - description: No content - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "200": - description: FinishDataLinkUpload 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/finish/{dirPath}: - post: - tags: - - data-links - summary: Finish data-link file upload to given path - description: "Finish upload of a data-link file, specifying a file path (`dirPath`).\ - \ This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize\ - \ a successful file upload, or abort an upload if an error was encountered\ - \ while uploading a file using an upload URL from the `/upload` endpoint." - operationId: FinishDataLinkUpload_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkFinishMultiPartUploadRequest" - required: true - responses: - "202": - description: No content - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "200": - description: FinishDataLinkUpload_1 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/{dirPath}: - post: - tags: - - data-links - summary: Generate data-link file upload URL (to given path) - description: |- - Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). - For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - operationId: GenerateDataLinkUploadUrl_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: Origin - in: header - schema: - type: string - nullable: true - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets: - get: - tags: - - datasets - summary: List datasets - description: Lists all available datasets in a user context. Append `?workspaceId` - to list datasets in a workspace context. - operationId: ListDatasetsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Search query - schema: - type: string - - name: sortBy - in: query - description: "Sort field supports (`name`, `modified`), defaults to `name`" - schema: - type: string - - name: sortDir - in: query - description: "Sort direction supports (`asc`, `desc`), defaults to `asc`" - schema: - type: string - - name: visibility - in: query - description: "Visibility option supports (`visible`, `hidden`, `all`), defaults\ - \ to `visible`" - schema: - type: string - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/DatasetQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - datasets - summary: Create dataset - description: Creates a new dataset in the user context. Include the dataset - file and details in your request body. Append `?workspaceId` to create the - dataset in a workspace context. - operationId: CreateDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Dataset create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - datasets - summary: Delete dataset - description: Deletes the dataset identified by the given `datasetId`. - operationId: DeleteDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteDatasetsRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteDatasetsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "204": - description: DeleteDatasets 204 response - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteDatasetsResponse" - security: - - BearerAuth: [] - /datasets/hide: - post: - tags: - - datasets - summary: Hide dataset - description: Hide the given `datasetIds` - operationId: HideDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Dataset ids to be hidden. - content: - application/json: - schema: - $ref: "#/components/schemas/ChangeDatasetVisibilityRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/labels/add: - post: - tags: - - labels - summary: Add labels to datasets - description: Adds the given list of labels to the given datasets. Existing labels - are preserved. - operationId: AddLabelsToDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateDatasetsLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/labels/apply: - post: - tags: - - labels - summary: Replace datasets labels - description: Applies the given list of labels to the given datasets. Existing - labels are replaced - include labels to be preserved in `labelIds`. Only simple - labels can be attached to datasets - operationId: ApplyLabelsToDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateDatasetsLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - "400": - description: "Invalid request, if trying to associate resource labels" - security: - - BearerAuth: [] - /datasets/labels/remove: - post: - tags: - - labels - summary: Remove labels from datasets - description: Removes the given list of labels from the given datasets. - operationId: RemoveLabelsFromDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateDatasetsLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/show: - post: - tags: - - datasets - summary: Show dataset - description: Show the given `datasetIds` - operationId: ShowDatasets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Dataset ids to be shown. - content: - application/json: - schema: - $ref: "#/components/schemas/ChangeDatasetVisibilityRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/versions: - get: - tags: - - datasets - summary: List latest dataset versions - description: Lists the latest version of each dataset in the user context. Append - `?workspaceId` to list latest versions in a workspace context. - operationId: ListLatestDatasetVersionsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: mimeType - in: query - description: Dataset MIME type - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Search query - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}: - put: - tags: - - datasets - summary: Update dataset - description: Updates the details of the dataset identified by the given `datasetId`. - operationId: UpdateDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - requestBody: - description: Dataset update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateDatasetRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - datasets - summary: Delete dataset - description: Deletes the dataset identified by the given `datasetId`. - operationId: DeleteDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/metadata: - get: - tags: - - datasets - summary: Describe dataset - description: Retrieves the metadata of the dataset identified by the given `datasetId`. - operationId: DescribeDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/DatasetQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/upload: - post: - tags: - - datasets - summary: Upload new dataset version - description: Uploads the CSV or TSV content to create a new version of the dataset - identified by the given `datasetId`. - operationId: UploadDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: header - in: query - description: Uploaded file has header - schema: - type: boolean - requestBody: - description: Dataset file request - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/MultiRequestFileSchema" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UploadDatasetVersionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/v/{version}/n/{fileName}: - get: - tags: - - datasets - summary: Download dataset content - description: Downloads the content of the dataset identified by the given `datasetId` - and `version`. - operationId: DownloadDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: version - in: path - description: Version number to download - required: true - schema: - type: string - - name: fileName - in: path - description: File name for the downloaded dataset content - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /datasets/{datasetId}/versions: - get: - tags: - - datasets - summary: List all dataset versions - description: Lists all versions of the given `datasetId`. - operationId: ListDatasetVersionsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: mimeType - in: query - description: Optional MIME type filter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/versions/{version}/disable: - post: - tags: - - datasets - summary: Disable a dataset version - description: "Disable a dataset version, the dataset version cannot be used\ - \ for runs, and cannot be enabled again" - operationId: DisableDatasetVersion - parameters: - - name: datasetId - in: path - description: The dataset string id the version belongs to - required: true - schema: - type: string - - name: version - in: path - description: The version number to disable - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /ga4gh/wes/v1/runs: - get: - tags: - - ga4gh - summary: "GA4GH: List runs" - description: Uses the GA4GH workflow execution service API to list all run records. - operationId: Ga4ghRunList - parameters: - - name: page_size - in: query - description: Page size - schema: - type: integer - format: int32 - - name: page_token - in: query - description: Page token - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunListResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - post: - tags: - - ga4gh - summary: "GA4GH: Launch run" - description: "Uses the GA4GH workflow execution service API to launch a new\ - \ run. Runs are launched in the user workspace context by default. To launch\ - \ in an organization workspace context, include the `workspaceId` in `workflow_engine_parameters`.\ - \ Runs are launched with the workspace primary compute environment by default.\ - \ To launch with a different compute environment, include the `computeEnvId`\ - \ in `workflow_engine_parameters`." - operationId: Ga4ghRunCreate - requestBody: - description: Run request - content: - application/json: - schema: - $ref: "#/components/schemas/RunRequest" - multipart/form-data: - schema: - $ref: "#/components/schemas/RunRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunId" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}: - get: - tags: - - ga4gh - summary: "GA4GH: Describe run" - description: Uses the GA4GH workflow execution service API to retrieve the details - of the run assoiated with the given `run_id`. - operationId: Ga4ghRunDescribe - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunLog" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}/cancel: - post: - tags: - - ga4gh - summary: "GA4GH: Cancel run" - description: Uses the GA4GH workflow execution service API to cancel the run - associated with the given `run_id`. - operationId: Ga4ghRunCancel - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunId" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}/status: - get: - tags: - - ga4gh - summary: "GA4GH: Retrieve run status" - description: Uses the GA4GH workflow execution service API to retrieve the status - of the run associated with the given `run_id`. - operationId: Ga4ghRunStatus - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunStatus" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/service-info: - get: - tags: - - ga4gh - summary: GA4GH workflow execution service API info - operationId: Ga4ghServiceInfo - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ServiceInfo" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /identities: - get: - tags: - - identities - summary: List Managed Identities - description: List all Managed Identities in an organization. - operationId: ListManagedIdentities - parameters: - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: search - in: query - description: "Optional search criteria, allowing free text search on name\ - \ and keywords: `platform:`" - schema: - type: string - nullable: true - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - nullable: true - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListManagedIdentitiesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - identities - summary: Create Managed Identity - description: Create a new Managed Identity in an organization. - operationId: CreateManagedIdentity - parameters: - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Managed Identity create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /identities/{managedIdentityId}: - get: - tags: - - identities - summary: Describe a Managed Identity - description: Describe a Managed Identity in an organization. - operationId: DescribeManagedIdentity - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - identities - summary: Update a Managed Identity - description: Update a Managed Identity identified by the given ID. - operationId: UpdateManagedIdentity - parameters: - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Managed Identity update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateManagedIdentityRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - identities - summary: Delete a Managed Identity - description: Delete a Managed Identity identified by the given ID. - operationId: DeleteManagedIdentity - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: checked - in: query - description: If deletion of associated Managed Credentials will be blocked - by running jobs that depend on them - schema: - type: boolean - nullable: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this Managed Identity - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse" - security: - - BearerAuth: [] - /identities/{managedIdentityId}/credentials: - get: - tags: - - identities - summary: List Managed Credentials - description: List Managed Credentials belonging to a Managed Identity. - operationId: ListManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: userId - in: query - description: User numeric identifier to filter records by - schema: - type: integer - format: int64 - nullable: true - - name: search - in: query - description: "Optional filtering on Managed Credentials for the given Managed\ - \ Identity: Allows free text\ - \ search on `userName` or `firstName + lastName`. \ - \ Accepts keywords: `is:missing` or `is:added` to\ - \ filter on credentials status. \ - \ If not provided (or both provided), all are returned." - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListManagedCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - identities - summary: Creates Managed Credentials - description: Creates Managed Credentials for the given Managed Identity - operationId: CreateManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: userId - in: query - description: User numeric identifier - schema: - type: integer - format: int64 - nullable: true - requestBody: - description: Managed Credentials create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedCredentialsRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /identities/{managedIdentityId}/credentials/{managedCredentialsId}: - put: - tags: - - identities - summary: Updates Managed Credentials - description: Update Managed Credentials for the given Managed Identity - operationId: UpdateManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: managedCredentialsId - in: path - description: Managed Credentials numeric identifier - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Managed Credentials update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateManagedCredentialsRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - identities - summary: Delete a user's Managed Credentials record belonging to a Managed Identity - description: Delete Managed Credentials - operationId: DeleteManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: managedCredentialsId - in: path - description: Managed Credentials numeric identifier - required: true - schema: - type: integer - format: int64 - nullable: true - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: checked - in: query - description: If Managed Credentials deletion will be blocked by running jobs - that depend on them - schema: - type: boolean - nullable: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this Managed Credentials - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse" - security: - - BearerAuth: [] - /labels: - get: - tags: - - labels - summary: List labels - description: Lists all available labels in a user context. Append `?workspaceId` - to list labels in a workspace context. - operationId: ListLabels - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - - name: type - in: query - description: Label type - schema: - $ref: "#/components/schemas/LabelType" - - name: isDefault - in: query - description: Label default flag - schema: - type: boolean - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListLabelsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - labels - summary: Create label - description: "Creates a new label or returns an existing label based on name/value.\ - \ By default the operation works in a user context, append `?workspaceId`\ - \ to create/retrieve a label in a workspace context. Resource labels include\ - \ `resource: true` and a `value`." - operationId: CreateLabel - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: "Provide a label `name`. Set `resource: true` for resource labels.\ - \ Only resource labels have a `value` — if `resource: true`, include a `value`.\ - \ Else, omit `value` from your request body." - content: - application/json: - schema: - $ref: "#/components/schemas/CreateLabelRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateLabelResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /labels/dynamic/allowed: - get: - tags: - - labels - operationId: GetAllowedDynamicLabels - responses: - "200": - description: Ok - content: - application/json: - schema: - $ref: "#/components/schemas/AllowedDynamicLabelsResponse" - "400": - description: Bad Request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /labels/{labelId}: - put: - tags: - - labels - summary: Update label - description: Updates the label identified by the given `labelId`. - operationId: UpdateLabel - parameters: - - name: labelId - in: path - description: Label numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Label update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateLabelRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateLabelResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - labels - summary: Delete label - description: Deletes the label identified by the given `labelId`. - operationId: DeleteLabel - parameters: - - name: labelId - in: path - description: Label numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /launch/{launchId}: - get: - tags: - - launch - summary: Describe Launch record - description: Retrieves the details of the launch identified by the given `launchId`. - operationId: DescribeLaunch - parameters: - - name: launchId - in: path - description: Launch string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /launch/{launchId}/datasets: - get: - tags: - - datasets - summary: Describe launch datasets - description: Retrieves the details of the datasets used in the launch identified - by the given `launchId`. - operationId: ListLaunchDatasetVersions - parameters: - - name: launchId - in: path - description: Launch string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs: - get: - tags: - - orgs - summary: List organizations - description: Lists all available organizations in a user context. - operationId: ListOrganizations - parameters: - - name: role - in: query - description: Organization user role identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListOrganizationsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - orgs - summary: Create organization - description: Creates a new organization. - operationId: CreateOrganization - requestBody: - description: Organization create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateOrganizationRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateOrganizationResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/validate: - get: - tags: - - orgs - summary: Validate organization name - description: Confirms the validity of the given organization name. Append `?name=`. - operationId: ValidateOrganizationName - parameters: - - name: name - in: query - description: Organization name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}: - get: - tags: - - orgs - summary: Describe organization - description: Retrieves the details of the organization identified by the given - `orgId`. - operationId: DescribeOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeOrganizationResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - orgs - summary: Update organization - description: Updates the details of the organization identified by the given - `orgId`. - operationId: UpdateOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Organization update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateOrganizationRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - orgs - summary: Delete organization - description: Deletes the organization identified by the given `orgId`. - operationId: DeleteOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/collaborators: - get: - tags: - - orgs - summary: List organization collaborators - description: Lists the collaborators of the organization identified by the given - `orgId`. - operationId: ListOrganizationCollaborators - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members: - get: - tags: - - orgs - summary: List organization members - description: Lists the members of the organization identified by the given `orgId`. - operationId: ListOrganizationMembers - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/add: - put: - tags: - - orgs - summary: Add organization member - description: Adds a new member to the organization identified by the given `orgId`. - operationId: CreateOrganizationMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Member addition request - content: - application/json: - schema: - $ref: "#/components/schemas/AddMemberRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddMemberResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/members/leave: - delete: - tags: - - orgs - summary: Leave organization - description: Removes the requesting user from the organization identified by - the given `orgId`. - operationId: LeaveOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/{memberId}: - delete: - tags: - - orgs - summary: Delete member - description: Deletes the member identified by the given `memberId`. - operationId: DeleteOrganizationMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Organization member numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/{memberId}/role: - put: - tags: - - orgs - summary: Update member role - description: Updates the role of the member identified by the given `memberId`. - operationId: UpdateOrganizationMemberRole - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Organization member numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Member role update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateMemberRoleRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/quotas: - get: - tags: - - orgs - summary: Describe organization quotas - description: Retrieves the details of the organization quotas identified by - the given `orgId`. - operationId: DescribeOrganizationQuotas - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: include - in: query - description: Optional list of quota names to include - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeOrganizationQuotasResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams: - get: - tags: - - teams - summary: List organization teams - description: Lists all teams in the organization identified by the given `orgId`. - operationId: ListOrganizationTeams - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - teams - summary: Create team - description: Creates a new team in the organization identified by the given - `orgId`. - operationId: CreateOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/teams/validate: - get: - tags: - - teams - summary: Validate team name - description: Confirms the validity of the given team name. Append `?name=`. - operationId: ValidateTeamName - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: name - in: query - description: Team name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}: - get: - tags: - - teams - summary: Describe team - description: Retrieves the details of the team identified by the given `teamId`. - operationId: DescribeOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - teams - summary: Update team - description: Updates the details of the team identified by the given `teamId`. - operationId: UpdateOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateTeamRequest" - required: true - responses: - "200": - description: OK - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "204": - description: UpdateOrganizationTeam 204 response - security: - - BearerAuth: [] - delete: - tags: - - teams - summary: Delete team - description: Deletes the team identified by the given `teamId`. - operationId: DeleteOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/members: - get: - tags: - - teams - summary: List team members - description: Lists the team members associated with the given `teamId`. - operationId: ListOrganizationTeamMembers - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - schema: - type: string - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - teams - summary: Create team member - description: Adds a new member to the team identified by the given `teamId`. - operationId: CreateOrganizationTeamMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamMemberRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddTeamMemberResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/members/{memberId}/delete: - delete: - tags: - - teams - summary: Delete team member - description: Deletes the team member identified by the given `memberId`. - operationId: DeleteOrganizationTeamMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Member numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/workspaces: - get: - tags: - - teams - summary: List team workspaces - description: Lists all the workspaces of which the given `teamId` is a participant. - operationId: ListWorkspacesByTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Search criteria - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesResponse" - "404": - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "400": - description: Bad Request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces: - get: - tags: - - workspaces - summary: List organization workspaces - description: Lists the organization workspaces in `orgId` to which the requesting - user belongs. - operationId: ListWorkspaces - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - workspaces - summary: Create workspace - description: Creates a new organization workspace. - operationId: CreateWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkspaceRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/validate: - get: - tags: - - workspaces - summary: Validate workspace name - description: Confirms the validity of the given workspace name. Append `?name=`. - operationId: ValidateWorkspaceName - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: name - in: query - description: Workspace name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}: - get: - tags: - - workspaces - summary: Describe workspace - description: Retrieves the details of the workspace identified by the given - `workspaceId`. - operationId: DescribeWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - workspaces - summary: Update workspace - description: Updates the details of the workspace identified by the given `workspaceId`. - operationId: UpdateWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicate name - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workspaces - summary: Delete workspace - description: Deletes the workspace identified by the given `workspaceId`. - operationId: DeleteWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants: - get: - tags: - - workspaces - summary: List workspace participants - description: Lists the participants of the workspace identified by the given - `workspaceId`. - operationId: ListWorkspaceParticipants - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListParticipantsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workspaces - summary: Leave workspace - description: Removes the requesting user from the given workspace. - operationId: LeaveWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/add: - put: - tags: - - workspaces - summary: Create workspace participant - description: Adds a new participant to the workspace identified by the given - `workspaceId`. - operationId: CreateWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Participant addition request - content: - application/json: - schema: - $ref: "#/components/schemas/AddParticipantRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddParticipantResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/{participantId}: - delete: - tags: - - workspaces - summary: Delete workspace participant - description: Deletes the given participant from the given workspace. - operationId: DeleteWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: participantId - in: path - description: Participant numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/{participantId}/role: - put: - tags: - - workspaces - summary: Update participant role - description: Updates the role of the given participant in the given workspace. - operationId: UpdateWorkspaceParticipantRole - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: participantId - in: path - description: Participant numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Participant role update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateParticipantRoleRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/settings/studios: - get: - tags: - - workspaces - summary: List workspace Studios settings - description: Retrieves the Studios settings of the workspace identified by the - given `workspaceId`. - operationId: FindDataStudiosWorkspaceSettings - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioWorkspaceSettingsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - put: - tags: - - workspaces - summary: Update workspace Studios settings - description: Updates the Studios settings of the workspace identified by the - given `workspaceId`. - operationId: UpdateDataStudiosWorkspaceSettings - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipeline-secrets: - get: - tags: - - pipeline-secrets - summary: List pipeline secrets - description: Lists all available pipeline secrets in a user context. Append - `?workspaceId` to list secrets in a workspace context. - operationId: ListPipelineSecrets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelineSecretsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - pipeline-secrets - summary: Create pipeline secret - description: Creates a new pipeline secret in the user context. Append `?workspaceId` - to create the secret in a workspace context. - operationId: CreatePipelineSecret - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Pipeline secret create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineSecretRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineSecretResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipeline-secrets/validate: - get: - tags: - - pipeline-secrets - summary: Validate secret name - description: Confirms the validity of the given pipeline secret name in a user - context. Append `?name=`. Append `?workspaceId` to validate - the name in a workspace context. - operationId: ValidatePipelineSecretName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Secret name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipeline-secrets/{secretId}: - get: - tags: - - pipeline-secrets - summary: Describe pipeline secret - description: Retrieves the details of the pipeline secret identified by the - given `secretId`. - operationId: DescribePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineSecretResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - pipeline-secrets - summary: Update secret - description: Updates the pipeline secret identified by the given `secretId`. - operationId: UpdatePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Secret update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineSecretRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - pipeline-secrets - summary: Delete secret - description: Deletes the pipeline secret identified by the given `secretId`. - operationId: DeletePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines: - get: - tags: - - pipelines - summary: List pipelines - description: "Lists all available pipelines in a user context, enriched by `attributes`.\ - \ Append `workspaceId` to list pipelines in a workspace context." - operationId: ListPipelines - parameters: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`,\ - \ `optimized` status, `computeEnv`). Returns an empty value (`labels: null`,\ - \ etc.) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: sortBy - in: query - description: Sort field (`NAME` by default) - schema: - $ref: "#/components/schemas/PipelineListParams.SortBy" - - name: sortDir - in: query - description: Sort direction (`ASCENDING` by default) - schema: - $ref: "#/components/schemas/PipelineListParams.SortDir" - - name: search - in: query - description: Filter search parameter - schema: - type: string - - name: visibility - in: query - description: Filter visibility parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelinesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - pipelines - summary: Create pipeline - description: Creates a new pipeline in a user context. Append `?workspaceId` - to create the pipeline in a workspace context. - operationId: CreatePipeline - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Pipeline creation request - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipelines/info: - get: - tags: - - pipelines - summary: Describe remote pipeline repository - description: Retrieves the details of a remote Nextflow pipeline Git repository. - Append the repository name or full URL with `?name`. - operationId: DescribePipelineRepository - parameters: - - name: name - in: query - description: Pipeline repository name or URL - schema: - type: string - - name: revision - in: query - description: Pipeline revision - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: mainScript - in: query - description: Pipeline alternative main.nf - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/add: - post: - tags: - - labels - summary: Add labels to pipelines - description: Adds the given list of labels to the given pipelines. Existing - labels are preserved. - operationId: AddLabelsToPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/apply: - post: - tags: - - labels - summary: Replace pipeline labels - description: Applies the given list of labels to the given pipelines. Existing - labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/remove: - post: - tags: - - labels - summary: Remove labels from pipelines - description: Removes the given list of labels from the given pipelines. - operationId: RemoveLabelsFromPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/repositories: - get: - tags: - - pipelines - summary: List user pipeline repositories - description: "Lists known Nextflow pipeline Git repositories, extracted from\ - \ existing runs. Append `?workspaceId` to list repositories in a workspace\ - \ context." - operationId: ListPipelineRepositories - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelineInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/validate: - get: - tags: - - pipelines - summary: Validate pipeline name - description: Confirms the validity of the given pipeline `name` in a user context. - Append `?name=`. Append `?workspaceId` to validate the - name in a workspace context. - operationId: ValidatePipelineName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Pipeline name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipelines/{pipelineId}: - get: - tags: - - pipelines - summary: Describe pipeline - description: "Retrieves the details of the pipeline identified by the given\ - \ `pipelineId`, enriched by `attributes`." - operationId: DescribePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier - required: true - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`,\ - \ `optimized` status, `computeEnv`). Returns an empty value (`labels: null`,\ - \ etc.) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier - required: false - schema: - type: integer - format: int64 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - pipelines - summary: Update pipeline - description: "Updates the details of the pipeline identified by the given `pipelineId`.\ - \ \n **Note**: If `labelIds` is `null`, empty, or omitted, existing\ - \ pipeline labels are removed.\n Include `labelIds: [,]`\ - \ to override existing labels. Labels to be preserved must be included.\n\ - \ To append a list of labels to multiple pipelines, use `/pipelines/labels/add`." - operationId: UpdatePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Pipeline update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - pipelines - summary: Delete pipeline - description: Deletes the pipeline identified by the given `pipelineId`. - operationId: DeletePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/{pipelineId}/launch: - get: - tags: - - pipelines - summary: Describe pipeline launch - description: Retrieves the launch details of the pipeline identified by the - given `pipelineId`. - operationId: DescribePipelineLaunch - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier - required: false - schema: - type: integer - format: int64 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/{pipelineId}/schema: - get: - tags: - - pipelines - summary: Describe pipeline schema - description: "Retrieves the pipeline schema of the pipeline identified by the\ - \ given `pipelineId`, enriched by `attributes`.\n `200 - OK` responses\ - \ include the pipeline schema.\n `204 - OK` responses indicate\ - \ a successful request, with no saved schema found for the given pipeline\ - \ ID.\n " - operationId: DescribePipelineSchema - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier - required: false - schema: - type: integer - format: int64 - nullable: true - - name: attributes - in: query - description: "Additional attribute values to include in the response: `schema`\ - \ returns the pipeline schema, `params` returns the pipeline config. Returns\ - \ all if `attributes` is omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineSchemaAttributes" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/PipelineSchemaResponse" - "204": - description: Request OK - No schema found for given pipeline ID - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms: - get: - tags: - - platforms - summary: List platforms - description: Lists all available computing platforms in a user context. Append - `?workspaceId` to list platforms in a workspace context. - operationId: ListPlatforms - parameters: - - name: orgId - in: query - description: Organization numeric identifier - required: false - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - required: false - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPlatformsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms/{platformId}: - get: - tags: - - platforms - summary: Describe platform - description: Retrieves the details of the computing platform identified by the - given `platformId`. - operationId: DescribePlatform - parameters: - - name: platformId - in: path - description: Platform string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: regionId - in: query - required: true - schema: - type: string - - name: credentialsId - in: query - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePlatformResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms/{platformId}/regions: - get: - tags: - - platforms - summary: List platform regions - description: Lists the available regions for the computing platform identified - by the given `platformId`. - operationId: ListPlatformRegions - parameters: - - name: platformId - in: path - description: Platform string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListRegionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /service-info: - get: - tags: - - service-info - summary: General Seqera service features and version. - operationId: Info - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ServiceInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - /studios: - get: - tags: - - studios - summary: List Studios - description: Lists all available Studios in a user context. Append `?workspaceId` - to list Studios in a workspace context. - operationId: ListDataStudios - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: search - in: query - description: "Optional search criteria, allowing free text search on name\ - \ and templateUrl and keywords: `userId`, `computeEnvId` and `status`." - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: attributes - in: query - description: "Optional attribute values to be included in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/DataStudioQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the workspace is not found or when the API\ - \ is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - post: - tags: - - studios - summary: Create Studio - description: "Creates a new Studio environment, starting it by default. Default\ - \ behavior can be changed using the query parameter `autoStart=false`." - operationId: CreateDataStudio - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: autoStart - in: query - description: Optionally disable the Studio's automatic launch when it is created. - schema: - type: boolean - requestBody: - description: Create Studio request - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateRequest" - required: true - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateResponse" - "404": - description: "NotFound, when the workspace or compute environment is not\ - \ found or when the API is disabled." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Conflict - duplicated name - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - "200": - description: CreateDataStudio 200 response - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateResponse" - security: - - BearerAuth: [] - /studios/data-links: - get: - tags: - - studios - summary: List mounted data-links - description: "Lists the IDs of all available data-links mounted in existing\ - \ Studios. Append `orgId` or `?workspaceId` to list mounted data-links in\ - \ an organization or workspace context, respectively." - operationId: ListMountedDataLinkIds - parameters: - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: status - in: query - description: Optional Studio status - schema: - type: string - - name: exclude - in: query - description: Optional Studio session ID to exclude in the request. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioMountedLinksResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/templates: - get: - tags: - - studios - summary: List available Studio templates - description: "Returns the list of available, configured Studio templates." - operationId: ListDataStudioTemplates - parameters: - - name: workspaceId - in: query - description: Workspace identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - responses: - "200": - description: Ok - paginated list of available Studio templates. - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioTemplatesListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/validate: - get: - tags: - - studios - summary: Validate Studio name - description: Confirms the availability of the given name for a Studio in the - user context. Append `?workspaceId=` to validate the name in a workspace context. - operationId: ValidateDataStudioName - parameters: - - name: workspaceId - in: query - description: Workspace identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Studio name to validate - schema: - type: string - responses: - "204": - description: "Ok - No content, if the name is valid and available." - "400": - description: "Bad request, if the name is not valid." - "409": - description: "Conflict, name duplicated in the given context." - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}: - get: - tags: - - studios - summary: Describe Studio - description: Retrieves the details of the Studio session identified by the given - `sessionId`. - operationId: DescribeDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "202": - description: "Accepted, when the Studio is fetching mounted data links in\ - \ the background." - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - delete: - tags: - - studios - summary: Delete Studio - description: Deletes the Studio associated with the given Studio session ID. - operationId: DeleteDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/checkpoints: - get: - tags: - - studios - summary: List Studio checkpoints - description: "Retrieves the list of checkpoints for the given Studio session\ - \ ID, sorted by creation date in descending order." - operationId: ListDataStudioCheckpoints - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: search - in: query - description: "Optional search criteria, allowing free text search on name\ - \ and keywords: `status`, `before` and `after` for saved date" - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioListCheckpointsResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/checkpoints/{checkpointId}: - get: - tags: - - studios - summary: Get Studio checkpoint - description: Retrieves the details of the given Studio checkpoint ID. - operationId: GetDataStudioCheckpoint - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: checkpointId - in: path - description: Numeric identifier of the checkpoint. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the studio or the checkpoint is not found or\ - \ when the API is disabled for the workspace" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - put: - tags: - - studios - summary: Update Studio checkpoint name - description: Updates the name of the given Studio checkpoint ID. - operationId: UpdateDataStudioCheckpoint - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: checkpointId - in: path - description: Numeric identifier of the checkpoint. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointUpdateRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the studio or the checkpoint is not found or\ - \ when the API is disabled for the workspace" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: "Conflict, when the checkpoint name conflicts with an existing\ - \ checkpoint for the same Studio." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/lifespan: - post: - tags: - - studios - description: Extends the lifespan of the given Studio session ID. - operationId: ExtendDataStudioLifespan - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/start: - put: - tags: - - studios - summary: Starts a Studio - description: Starts the given Studio session ID. - operationId: StartDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: An optional overriding configuration for the studio to be started. - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStartRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStartResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/stop: - put: - tags: - - studios - summary: Stop Studio - description: Stops the given Studio session ID. - operationId: StopDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStopResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /tokens: - get: - tags: - - tokens - summary: List tokens - description: Retrieves the list of all available API access tokens. - operationId: TokenList - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListAccessTokensResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - tokens - summary: Create token - description: Creates an API access token with the details in the given request - body. - operationId: CreateToken - requestBody: - description: Access token create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAccessTokenRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAccessTokenResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /tokens/delete-all: - delete: - tags: - - tokens - summary: Delete all user tokens - description: Deletes all API access tokens in the user context. - operationId: DeleteAllTokens - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /tokens/{tokenId}: - delete: - tags: - - tokens - summary: Delete token - description: Deletes the given API access token ID. - operationId: DeleteToken - parameters: - - name: tokenId - in: path - description: Token numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/create: - post: - tags: - - trace - summary: Create workflow execution trace - description: Creates a new workflow execution trace. - operationId: CreateTrace - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace create request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCreateRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCreateResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/begin: - put: - tags: - - trace - summary: Signal workflow execution start - description: Updates the workflow execution trace for the given `workflowId`. - operationId: UpdateTraceBegin - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace begin request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceBeginRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceBeginResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/complete: - put: - tags: - - trace - summary: Signal workflow execution completion - description: Updates the workflow execution trace for the given `workflowId`. - operationId: UpdateTraceComplete - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace complete request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCompleteRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCompleteResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/heartbeat: - put: - tags: - - trace - summary: Signal workflow execution heartbeat - description: Update the workflow execution trace heartbeat for the given `workflowId` - to signal that execution is ongoing. - operationId: UpdateTraceHeartbeat - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace heartbeat request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceHeartbeatRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceHeartbeatResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/progress: - put: - tags: - - trace - summary: Store workflow task execution metadata - description: Store the execution metadata for one or more tasks in the given - `workflowId`. - operationId: UpdateTraceProgress - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace progress request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceProgressRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceProgressResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /user-info: - get: - tags: - - users - summary: Describe current user - operationId: UserInfo - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeUserResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /user/{userId}/workspaces: - get: - tags: - - workspaces - summary: List user workspaces and organizations - description: Lists the workspaces and organizations to which the user identified - by the given `userId` belongs. - operationId: ListWorkspacesUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesAndOrgResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /users/validate: - get: - tags: - - users - summary: Check that the user name is valid - operationId: ValidateUserName - parameters: - - name: name - in: query - description: User name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /users/{userId}: - get: - tags: - - users - summary: Describe a user entity - operationId: DescribeUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeUserResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - post: - tags: - - users - summary: Update an user entity - operationId: UpdateUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: User update request - content: - application/json: - schema: - $ref: "#/components/schemas/UserDbDto" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - users - summary: Delete a user entity - operationId: DeleteUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow: - get: - tags: - - workflows - summary: List workflows - description: "Lists all workflow records, enriched with `attributes`. Append\ - \ `?workspaceId` to list workflow records in a workspace context." - operationId: ListWorkflows - parameters: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`,\ - \ `optimized` status). Returns an empty value (`labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/WorkflowQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkflowsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/delete: - post: - tags: - - workflows - summary: Delete workflows - description: Deletes the workflow records identified by the given list of `workflowIds`. - operationId: DeleteWorkflowMany - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Force the deletion even if any workflows are active - schema: - type: boolean - requestBody: - description: Delete workflows request - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteWorkflowsRequest" - required: true - responses: - "200": - description: "OK - Return the IDs of workflows that could not be deleted,\ - \ if any" - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteWorkflowsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/add: - post: - tags: - - labels - summary: Add labels to workflows - description: Adds the given list of labels to the given workflows. Existing - labels are preserved. - operationId: AddLabelsToWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/apply: - post: - tags: - - labels - summary: Replace workflow labels - description: Applies the given list of labels to the given workflows. Existing - labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/remove: - post: - tags: - - labels - summary: Remove labels from workflows - description: Removes the given list of labels from the given workflows. - operationId: RemoveLabelsFromWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/launch: - post: - tags: - - workflows - summary: Launch workflow - description: Submits a workflow execution. - operationId: CreateWorkflowLaunch - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier - required: false - schema: - type: integer - format: int64 - nullable: true - requestBody: - description: Workflow launch request - content: - application/json: - schema: - $ref: "#/components/schemas/SubmitWorkflowLaunchRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/SubmitWorkflowLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/random-name: - get: - tags: - - workflows - summary: Generates a random name - operationId: GenerateRandomWorkflowName - responses: - "200": - description: Generated name - content: - application/json: - schema: - $ref: "#/components/schemas/RandomWorkflowNameResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/validate: - get: - tags: - - workflows - summary: Validate run name - description: "Check that the given run name of a workflow has a valid format.\ - \ When the session ID is given: check that no other workflow in the system\ - \ exists with the combination of both elements." - operationId: ValidateWorkflowConstraints - parameters: - - name: runName - in: query - description: Workflow run name to validate - schema: - type: string - - name: sessionId - in: query - description: Workflow session ID to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request. Invalid run name format - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicated element. Existing run name and session ID combination - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}: - get: - tags: - - workflows - summary: Describe workflow - description: Retrieves the details of the workflow record associated with the - given `workflowId`. - operationId: DescribeWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: Comma-separated list of attributes to retrieve. Returns an empty - value for each attribute not specified. - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/WorkflowQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkflowResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workflows - summary: Delete the Workflow entity with the given ID - operationId: DeleteWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Force the deletion even if the workflow is active - schema: - type: boolean - responses: - "204": - description: OK - Not content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/cancel: - post: - tags: - - workflows - summary: Cancel workflow - description: Cancels the workflow execution identified by the given `workflowId`. - operationId: CancelWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Cancel on the Platform side even if it cannot be cancelled on - the CE provider side - schema: - type: boolean - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/download: - get: - tags: - - workflows - summary: Download workflow files - description: Downloads the workflow files for the Nextflow main job associated - with the given `workflowId`. - operationId: DownloadWorkflowLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: fileName - in: query - description: Filename to download - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/download/{taskId}: - get: - tags: - - workflows - summary: Download workflow task files - description: Downloads the workflow files of the task identified by the given - `taskId`. - operationId: DownloadWorkflowTaskLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: fileName - in: query - description: Filename to download - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/launch: - get: - tags: - - workflows - summary: Describe workflow launch - description: Retrieves the details of the workflow launch associated with the - given `workflowId`. - operationId: DescribeWorkflowLaunch - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkflowLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element. Existing run name and session ID combination - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /workflow/{workflowId}/log: - get: - tags: - - workflows - summary: Get workflow logs - description: Retrieves the output logs for the Nextflow main job of the workflow - identified by the given `workflowId`. - operationId: GetWorkflowLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: next - in: query - description: Workflow log cursor - schema: - type: string - - name: maxLength - in: query - description: Maximum length in bytes of the log to retrieve - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/WorkflowLogResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/log/{taskId}: - get: - tags: - - workflows - summary: Get workflow task logs - description: Retrieves the output logs for the workflow task identified by the - given `taskId`. - operationId: GetWorkflowTaskLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: next - in: query - description: Workflow log cursor - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: maxLength - in: query - description: Maximum length in bytes of the log to retrieve - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/WorkflowLogResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/metrics: - get: - tags: - - workflows - summary: Get the execution metrics for the given Workflow ID - operationId: DescribeWorkflowMetrics - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetWorkflowMetricsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/progress: - get: - tags: - - workflows - summary: Retrieve the execution progress for the given Workflow ID - operationId: DescribeWorkflowProgress - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetProgressResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/star: - get: - tags: - - workflows - summary: Check workflow star status - description: Confirms whether the given `workflowId` is starred. - operationId: DescribeWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - post: - tags: - - workflows - summary: Star workflow - description: Adds the workflow identified by the given `workflowId` to your - list of starred workflows. - operationId: CreateWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - delete: - tags: - - workflows - summary: Unstar workflow - description: Removes the workflow identified by the given `workflowId` from - your list of starred workflows. - operationId: DeleteWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - /workflow/{workflowId}/task/{taskId}: - get: - tags: - - workflows - summary: Describe a task entity with the given ID - operationId: DescribeWorkflowTask - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeTaskResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/tasks: - get: - tags: - - workflows - summary: List the tasks for the given Workflow ID and filter parameters - operationId: ListWorkflowTasks - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: sortBy - in: query - description: Field to sort by - schema: - type: string - - name: sortDir - in: query - description: Sorting direction (asc|desc) - schema: - type: string - - name: search - in: query - description: Search tasks by name - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListTasksResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets: - get: - tags: - - datasets - summary: List available datasets - description: Lists all available datasets in the workspace context identified - by the given `workspaceId`. - operationId: ListDatasets - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - post: - tags: - - datasets - summary: Create dataset - description: Creates a new dataset in the given workspace context. Include the - dataset file and details in your request body. - operationId: CreateDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Dataset create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/versions: - get: - tags: - - datasets - summary: List latest dataset versions - description: Lists the latest version of each dataset associated with the given - `workspaceId`. - operationId: ListWorkspaceDatasetVersions - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: mimeType - in: query - schema: - type: string - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}: - put: - tags: - - datasets - summary: Update dataset - description: Updates the details of the dataset identified by the given `datasetId`. - operationId: UpdateDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - requestBody: - description: Dataset update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateDatasetRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - deprecated: true - security: - - BearerAuth: [] - delete: - tags: - - datasets - summary: Delete dataset - description: Deletes the dataset identified by the given `datasetId`. - operationId: DeleteDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/metadata: - get: - tags: - - datasets - summary: Describe dataset - description: Retrieves the metadata of the dataset identified by the given `datasetId`. - operationId: DescribeDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/DatasetQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/upload: - post: - tags: - - datasets - summary: Upload new dataset version - description: Uploads the CSV or TSV content to create a new version of the dataset - identified by the given `datasetId`. - operationId: UploadDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: header - in: query - description: Uploaded file has header - schema: - type: boolean - requestBody: - description: Dataset file request - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/MultiRequestFileSchema" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UploadDatasetVersionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/v/{version}/n/{fileName}: - get: - tags: - - datasets - summary: Download dataset content - description: Downloads the content of the dataset identified by the given `datasetId` - and `version`. - operationId: DownloadDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: version - in: path - description: Version number to download - required: true - schema: - type: string - - name: fileName - in: path - description: File name for the downloaded dataset content - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/versions: - get: - tags: - - datasets - summary: List all dataset versions - description: Lists all versions of the given `datasetId`. - operationId: ListDatasetVersions - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: mimeType - in: query - description: MIME type filter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] -components: - schemas: - AbstractGridConfig: - type: object - allOf: - - $ref: "#/components/schemas/ComputeConfig" - - properties: - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - AccessToken: - required: - - name - type: object - properties: - basicAuth: - type: string - deprecated: true - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 50 - minLength: 1 - type: string - lastUsed: - type: string - format: date-time - dateCreated: - type: string - format: date-time - Action.ConfigType: - type: object - properties: - discriminator: - type: string - readOnly: true - discriminator: - propertyName: discriminator - mapping: - github: "#/components/schemas/GithubActionConfig" - tower: "#/components/schemas/Action.TowerActionConfig" - oneOf: - - $ref: "#/components/schemas/Action.TowerActionConfig" - - $ref: "#/components/schemas/GithubActionConfig" - Action.EventType: - type: object - properties: - discriminator: - type: string - readOnly: true - timestamp: - type: string - format: date-time - discriminator: - propertyName: discriminator - mapping: - github: "#/components/schemas/GithubActionEvent" - tower: "#/components/schemas/Action.TowerActionEvent" - oneOf: - - $ref: "#/components/schemas/GithubActionEvent" - - $ref: "#/components/schemas/Action.TowerActionEvent" - Action.Source: - type: string - enum: - - github - - tower - x-enum-varnames: - - github - - tower - Action.Status: - type: string - enum: - - CREATING - - ACTIVE - - ERROR - - PAUSED - Action.TowerActionConfig: - type: object - properties: - discriminator: - type: string - Action.TowerActionEvent: - type: object - properties: - discriminator: - type: string - timestamp: - type: string - format: date-time - workflowId: - type: string - ActionQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - ActionResponseDto: - type: object - properties: - id: - type: string - launch: - $ref: "#/components/schemas/Launch" - name: - type: string - hookId: - type: string - hookUrl: - type: string - message: - type: string - source: - $ref: "#/components/schemas/Action.Source" - status: - $ref: "#/components/schemas/Action.Status" - config: - $ref: "#/components/schemas/Action.ConfigType" - event: - $ref: "#/components/schemas/Action.EventType" - lastSeen: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - ActiveConnection: - type: object - allOf: - - $ref: "#/components/schemas/UserInfo" - - properties: - lastActive: - type: string - format: date-time - AddMemberRequest: - type: object - properties: - user: - type: string - AddMemberResponse: - type: object - properties: - member: - $ref: "#/components/schemas/MemberDbDto" - AddParticipantRequest: - type: object - properties: - memberId: - type: integer - format: int64 - teamId: - type: integer - format: int64 - userNameOrEmail: - type: string - AddParticipantResponse: - type: object - properties: - participant: - $ref: "#/components/schemas/ParticipantDbDto" - AddTeamMemberResponse: - type: object - properties: - member: - $ref: "#/components/schemas/MemberDbDto" - AgentSecurityKeys: - type: object - properties: - discriminator: - type: string - connectionId: - type: string - workDir: - type: string - shared: - type: boolean - AllowedDynamicLabelsResponse: - type: object - properties: - values: - type: array - items: - type: string - AltairPbsComputeConfig: - title: Altair PBS configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - Analytics: - type: object - properties: - hubspotId: - type: string - posthogApiKey: - type: string - posthogApiHost: - type: string - AssociateActionLabelsRequest: - type: object - properties: - actionIds: - type: array - items: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - AssociateDatasetsLabelsRequest: - type: object - properties: - datasetIds: - type: array - items: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - AssociatePipelineLabelsRequest: - type: object - properties: - pipelineIds: - type: array - items: - type: integer - format: int64 - labelIds: - type: array - items: - type: integer - format: int64 - AssociateWorkflowLabelsRequest: - type: object - properties: - workflowIds: - type: array - items: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - Avatar: - type: object - properties: - id: - maxLength: 22 - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - AwsBatchConfig: - title: AWS Batch configuration - type: object - properties: - storageType: - type: string - deprecated: true - lustreId: - type: string - deprecated: true - volumes: - type: array - items: - type: string - discriminator: - type: string - region: - type: string - computeQueue: - type: string - dragenQueue: - type: string - dragenInstanceType: - type: string - computeJobRole: - type: string - executionRole: - type: string - headQueue: - type: string - headJobRole: - type: string - cliPath: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - nvnmeStorageEnabled: - type: boolean - logGroup: - type: string - nextflowConfig: - type: string - fusionSnapshots: - type: boolean - forge: - $ref: "#/components/schemas/ForgeConfig" - forgedResources: - type: array - items: - type: object - additionalProperties: true - AwsBatchPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - jobQueues: - type: array - items: - $ref: "#/components/schemas/JobQueue" - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - fileSystems: - type: array - items: - $ref: "#/components/schemas/FsxFileSystem" - efsFileSystems: - type: array - items: - $ref: "#/components/schemas/EfsFileSystem" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceFamilies: - type: array - items: - type: string - allocStrategy: - type: array - items: - type: string - AwsCloudConfig: - title: AWS Cloud configuration - type: object - properties: - discriminator: - type: string - allowBuckets: - type: array - items: - type: string - region: - type: string - instanceType: - type: string - imageId: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - logGroup: - type: string - arm64Enabled: - type: boolean - gpuEnabled: - type: boolean - ec2KeyPair: - type: string - ebsBootSize: - type: integer - format: int32 - instanceProfileArn: - type: string - subnetId: - type: string - securityGroups: - type: array - items: - type: string - forgedResources: - type: array - items: - type: object - additionalProperties: true - AwsCloudPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceTypes: - type: array - items: - $ref: "#/components/schemas/InstanceType" - AwsSecurityKeys: - type: object - properties: - discriminator: - type: string - accessKey: - type: string - secretKey: - type: string - writeOnly: true - assumeRoleArn: - type: string - AzBatchConfig: - title: Azure batch configuration - type: object - properties: - discriminator: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - region: - type: string - headPool: - type: string - autoPoolMode: - type: boolean - deprecated: true - forge: - $ref: "#/components/schemas/AzBatchForgeConfig" - tokenDuration: - type: string - deleteJobsOnCompletion: - $ref: "#/components/schemas/JobCleanupPolicy" - deletePoolsOnCompletion: - type: boolean - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - nextflowConfig: - type: string - managedIdentityClientId: - type: string - nullable: true - AzBatchForgeConfig: - type: object - properties: - vmType: - type: string - vmCount: - type: integer - format: int32 - autoScale: - type: boolean - disposeOnDeletion: - type: boolean - containerRegIds: - type: array - items: - type: string - AzBatchPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - pools: - type: array - items: - type: string - containers: - type: array - items: - type: string - vmTypes: - type: array - items: - type: string - AzCloudConfig: - title: Azure Cloud configuration - type: object - properties: - discriminator: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - nextflowConfig: - type: string - instanceType: - type: string - region: - type: string - resourceGroup: - type: string - networkId: - type: string - subscriptionId: - type: string - managedIdentityId: - type: string - managedIdentityClientId: - type: string - logWorkspaceId: - type: string - logTableName: - type: string - dataCollectionEndpoint: - type: string - dataCollectionRuleId: - type: string - forgedResources: - type: array - items: - $ref: "#/components/schemas/Map.Entry_String.String_" - AzCloudPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - containers: - type: array - items: - type: string - instanceTypes: - type: array - items: - type: string - AzureCloudKeys: - type: object - allOf: - - $ref: "#/components/schemas/AzureSecurityKeys" - - properties: - discriminator: - type: string - subscriptionId: - type: string - storageName: - type: string - tenantId: - type: string - clientId: - type: string - clientSecret: - type: string - writeOnly: true - AzureEntraKeys: - type: object - allOf: - - $ref: "#/components/schemas/AzureSecurityKeys" - - properties: - discriminator: - type: string - tenantId: - type: string - clientId: - type: string - clientSecret: - type: string - writeOnly: true - AzureReposSecurityKeys: - type: object - properties: - discriminator: - type: string - token: - type: string - username: - type: string - password: - type: string - writeOnly: true - AzureSecurityKeys: - type: object - properties: - discriminator: - type: string - batchName: - type: string - storageName: - type: string - batchKey: - type: string - writeOnly: true - storageKey: - type: string - writeOnly: true - BitBucketSecurityKeys: - type: object - properties: - discriminator: - type: string - username: - type: string - password: - type: string - writeOnly: true - token: - type: string - writeOnly: true - Bucket: - type: object - properties: - path: - type: string - ChangeDatasetVisibilityRequest: - type: object - properties: - datasetIds: - type: array - items: - type: string - CloudPriceModel: - type: string - enum: - - standard - - spot - x-enum-varnames: - - standard - - spot - CodeCommitSecurityKeys: - type: object - properties: - discriminator: - type: string - token: - type: string - username: - type: string - password: - type: string - writeOnly: true - ComputeConfig: - type: object - properties: - workDir: - type: string - description: Compute environment working directory - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to\ - \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have\ - \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - nextflowConfig: - type: string - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - discriminator: - propertyName: discriminator - mapping: - moab-platform: "#/components/schemas/MoabComputeConfig" - aws-batch: "#/components/schemas/AwsBatchConfig" - google-cloud: "#/components/schemas/GoogleCloudConfig" - local-platform: "#/components/schemas/LocalComputeConfig" - azure-cloud: "#/components/schemas/AzCloudConfig" - gke-platform: "#/components/schemas/GkeComputeConfig" - google-batch: "#/components/schemas/GoogleBatchConfig" - aws-cloud: "#/components/schemas/AwsCloudConfig" - slurm-platform: "#/components/schemas/SlurmComputeConfig" - k8s-platform: "#/components/schemas/K8sComputeConfig" - altair-platform: "#/components/schemas/AltairPbsComputeConfig" - lsf-platform: "#/components/schemas/LsfComputeConfig" - azure-batch: "#/components/schemas/AzBatchConfig" - seqeracompute-platform: "#/components/schemas/SeqeraComputeConfig" - eks-platform: "#/components/schemas/EksComputeConfig" - google-lifesciences: "#/components/schemas/GoogleLifeSciencesConfig" - uge-platform: "#/components/schemas/UnivaComputeConfig" - oneOf: - - $ref: "#/components/schemas/AwsBatchConfig" - - $ref: "#/components/schemas/AwsCloudConfig" - - $ref: "#/components/schemas/SeqeraComputeConfig" - - $ref: "#/components/schemas/GoogleLifeSciencesConfig" - - $ref: "#/components/schemas/GoogleBatchConfig" - - $ref: "#/components/schemas/GoogleCloudConfig" - - $ref: "#/components/schemas/AzBatchConfig" - - $ref: "#/components/schemas/AzCloudConfig" - - $ref: "#/components/schemas/LsfComputeConfig" - - $ref: "#/components/schemas/SlurmComputeConfig" - - $ref: "#/components/schemas/K8sComputeConfig" - - $ref: "#/components/schemas/EksComputeConfig" - - $ref: "#/components/schemas/GkeComputeConfig" - - $ref: "#/components/schemas/UnivaComputeConfig" - - $ref: "#/components/schemas/AltairPbsComputeConfig" - - $ref: "#/components/schemas/MoabComputeConfig" - - $ref: "#/components/schemas/LocalComputeConfig" - ComputeEnv.Status: - type: string - enum: - - CREATING - - AVAILABLE - - ERRORED - - INVALID - ComputeEnvDbDto: - type: object - properties: - id: - type: string - name: - type: string - platform: - type: string - region: - type: string - ComputeEnvQueryAttribute: - type: string - enum: - - labels - - resources - x-enum-varnames: - - labels - - resources - ComputeEnvResources: - type: object - properties: - cpus: - type: integer - format: int32 - nullable: true - memory: - type: integer - format: int32 - nullable: true - gpus: - type: integer - format: int32 - nullable: true - diskSize: - type: integer - format: int32 - nullable: true - estimatedPrice: - type: number - format: float - nullable: true - instanceType: - type: string - nullable: true - ComputeEnvResponseDto: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - platform: - type: string - enum: - - aws-batch - - aws-cloud - - seqeracompute-platform - - google-lifesciences - - google-batch - - azure-batch - - k8s-platform - - eks-platform - - gke-platform - - uge-platform - - slurm-platform - - lsf-platform - - altair-platform - config: - $ref: "#/components/schemas/ComputeConfig" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - lastUsed: - type: string - format: date-time - deleted: - type: boolean - status: - $ref: "#/components/schemas/ComputeEnv.Status" - message: - type: string - primary: - type: boolean - credentialsId: - type: string - managedIdentityId: - type: string - orgId: - type: integer - format: int64 - workspaceId: - type: integer - format: int64 - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - resources: - nullable: true - allOf: - - $ref: "#/components/schemas/ComputeEnvResources" - ComputeEnv_ComputeConfig_: - required: - - config - - name - - platform - type: object - properties: - credentialsId: - type: string - orgId: - type: integer - format: int64 - readOnly: true - workspaceId: - type: integer - format: int64 - readOnly: true - id: - maxLength: 22 - type: string - readOnly: true - name: - maxLength: 100 - type: string - description: - maxLength: 2000 - type: string - platform: - maxLength: 25 - type: string - enum: - - aws-batch - - aws-cloud - - google-lifesciences - - google-batch - - google-cloud - - azure-batch - - azure-cloud - - k8s-platform - - eks-platform - - gke-platform - - uge-platform - - slurm-platform - - lsf-platform - - altair-platform - - moab-platform - - local-platform - - seqeracompute-platform - config: - $ref: "#/components/schemas/ComputeConfig" - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - lastUsed: - type: string - format: date-time - readOnly: true - deleted: - type: boolean - readOnly: true - status: - type: string - readOnly: true - allOf: - - $ref: "#/components/schemas/ComputeEnv.Status" - message: - maxLength: 4096 - type: string - primary: - type: boolean - readOnly: true - ComputePlatform: - type: object - properties: - id: - type: string - name: - type: string - credentialsProviders: - type: array - items: - type: string - ComputePlatformDto: - type: object - properties: - id: - type: string - name: - type: string - ComputeRegion: - type: object - properties: - id: - type: string - name: - type: string - ConfigEnvVariable: - type: object - properties: - name: - type: string - value: - type: string - head: - type: boolean - compute: - type: boolean - ContainerData: - required: - - targetImage - type: object - properties: - requestId: - type: string - sourceImage: - type: string - targetImage: - type: string - buildId: - type: string - scanId: - type: string - mirrorId: - type: string - cached: - type: boolean - freeze: - type: boolean - requestTime: - type: string - format: date-time - ContainerRegistryKeys: - type: object - properties: - discriminator: - type: string - userName: - type: string - password: - type: string - writeOnly: true - registry: - type: string - CreateAccessTokenRequest: - type: object - properties: - name: - type: string - CreateAccessTokenResponse: - type: object - properties: - accessKey: - type: string - token: - $ref: "#/components/schemas/AccessToken" - CreateActionRequest: - type: object - properties: - name: - type: string - source: - $ref: "#/components/schemas/Action.Source" - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - CreateActionResponse: - type: object - properties: - actionId: - type: string - CreateAvatarResponse: - type: object - properties: - avatar: - $ref: "#/components/schemas/Avatar" - url: - type: string - CreateComputeEnvRequest: - type: object - properties: - computeEnv: - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - labelIds: - type: array - items: - type: integer - format: int64 - CreateComputeEnvResponse: - type: object - properties: - computeEnvId: - type: string - CreateCredentialsRequest: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - CreateCredentialsResponse: - type: object - properties: - credentialsId: - type: string - CreateDatasetRequest: - type: object - properties: - name: - type: string - description: - type: string - CreateDatasetResponse: - type: object - properties: - dataset: - $ref: "#/components/schemas/DatasetDto" - CreateLabelRequest: - type: object - properties: - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - CreateLabelResponse: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - CreateManagedCredentialsRequest: - type: object - properties: - provider: - type: string - enum: - - ssh - credentials: - $ref: "#/components/schemas/Credentials" - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - CreateManagedCredentialsResponse: - type: object - properties: - managedCredentials: - $ref: "#/components/schemas/ManagedCredentialsDbDto" - CreateManagedIdentityRequest: - type: object - properties: - name: - type: string - platform: - type: string - enum: - - altair-platform - - lsf-platform - - moab-platform - - slurm-platform - - uge-platform - config: - $ref: "#/components/schemas/AbstractGridConfig" - CreateManagedIdentityResponse: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - platform: - type: string - config: - $ref: "#/components/schemas/ComputeConfig" - CreateOrganizationRequest: - type: object - properties: - organization: - $ref: "#/components/schemas/Organization" - logoId: - type: string - CreateOrganizationResponse: - type: object - properties: - organization: - $ref: "#/components/schemas/OrganizationDbDto" - CreatePipelineRequest: - type: object - properties: - name: - type: string - description: - type: string - icon: - type: string - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - labelIds: - type: array - items: - type: integer - format: int64 - CreatePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - CreatePipelineSecretRequest: - type: object - properties: - name: - type: string - value: - type: string - CreatePipelineSecretResponse: - type: object - properties: - secretId: - type: integer - format: int64 - CreateTeamMemberRequest: - type: object - properties: - userNameOrEmail: - type: string - CreateTeamRequest: - type: object - properties: - team: - $ref: "#/components/schemas/Team" - avatarId: - type: string - CreateTeamResponse: - type: object - properties: - team: - $ref: "#/components/schemas/TeamDbDto" - CreateWorkflowStarResponse: - type: object - properties: - workflowId: - type: string - CreateWorkspaceRequest: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - CreateWorkspaceResponse: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - Credentials: - required: - - name - - provider - type: object - properties: - id: - maxLength: 22 - type: string - name: - maxLength: 100 - type: string - description: - type: string - provider: - maxLength: 16 - type: string - enum: - - aws - - azure - - azure_entra - - google - - github - - gitlab - - bitbucket - - ssh - - k8s - - container-reg - - tw-agent - - codecommit - - gitea - - azurerepos - - seqeracompute - - azure-cloud - - s3 - baseUrl: - maxLength: 200 - pattern: "" - type: string - category: - maxLength: 20 - type: string - deleted: - type: boolean - readOnly: true - lastUsed: - type: string - format: date-time - readOnly: true - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - keys: - $ref: "#/components/schemas/SecurityKeys" - DataLink.Status: - type: string - readOnly: true - enum: - - VALID - - INVALID - DataLinkContentResponse: - type: object - properties: - originalPath: - type: string - objects: - type: array - items: - $ref: "#/components/schemas/DataLinkItem" - nextPageToken: - type: string - DataLinkContentTreeListResponse: - required: - - items - type: object - properties: - items: - type: array - items: - $ref: "#/components/schemas/DataLinkSimpleItem" - DataLinkCreateRequest: - type: object - properties: - name: - type: string - description: - type: string - type: - $ref: "#/components/schemas/DataLinkType" - provider: - $ref: "#/components/schemas/DataLinkProvider" - resourceRef: - type: string - publicAccessible: - type: boolean - credentialsId: - type: string - DataLinkCredentials: - required: - - id - - name - - provider - type: object - properties: - id: - type: string - name: - type: string - provider: - $ref: "#/components/schemas/DataLinkProvider" - DataLinkDeleteItemRequest: - type: object - properties: - files: - type: array - items: - type: string - dirs: - type: array - items: - type: string - DataLinkDeleteItemResponse: - type: object - properties: - deletionFailures: - type: array - items: - $ref: "#/components/schemas/DataLinkItemDeletionFailure" - DataLinkDownloadScriptResponse: - type: object - properties: - script: - type: string - DataLinkDownloadUrlResponse: - type: object - properties: - url: - type: string - DataLinkDto: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - resourceRef: - type: string - type: - $ref: "#/components/schemas/DataLinkType" - provider: - $ref: "#/components/schemas/DataLinkProvider" - region: - type: string - credentials: - type: array - items: - $ref: "#/components/schemas/DataLinkCredentials" - publicAccessible: - type: boolean - hidden: - type: boolean - status: - type: string - readOnly: true - allOf: - - $ref: "#/components/schemas/DataLink.Status" - message: - type: string - DataLinkFinishMultiPartUploadRequest: - type: object - properties: - uploadId: - type: string - fileName: - type: string - tags: - type: array - items: - $ref: "#/components/schemas/UploadEtag" - withError: - type: boolean - DataLinkItem: - type: object - properties: - type: - $ref: "#/components/schemas/DataLinkItemType" - name: - type: string - size: - type: integer - format: int64 - mimeType: - type: string - DataLinkItemDeletionFailure: - required: - - dataLinkItem - - errorMessage - type: object - properties: - dataLinkItem: - $ref: "#/components/schemas/DataLinkItem" - errorMessage: - type: string - DataLinkItemType: - type: string - enum: - - FOLDER - - FILE - DataLinkMultiPartUploadRequest: - type: object - properties: - fileName: - type: string - contentLength: - type: integer - format: int64 - contentType: - type: string - DataLinkMultiPartUploadResponse: - type: object - properties: - uploadId: - type: string - uploadUrls: - type: array - items: - type: string - DataLinkProvider: - type: string - enum: - - aws - - google - - azure - - azure_entra - - azure-cloud - - seqeracompute - - s3 - DataLinkResponse: - type: object - properties: - dataLink: - $ref: "#/components/schemas/DataLinkDto" - DataLinkSimpleItem: - required: - - path - - size - type: object - properties: - path: - type: string - size: - type: integer - format: int64 - DataLinkType: - type: string - enum: - - bucket - x-enum-varnames: - - bucket - DataLinkUpdateRequest: - type: object - properties: - name: - type: string - description: - type: string - credentialsId: - type: string - DataLinksListResponse: - type: object - properties: - dataLinks: - type: array - items: - $ref: "#/components/schemas/DataLinkDto" - totalSize: - type: integer - format: int64 - DataStudioCheckpointDto: - required: - - author - - dateCreated - - dateSaved - - id - - name - - path - - status - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - dateCreated: - type: string - format: date-time - dateSaved: - type: string - format: date-time - author: - $ref: "#/components/schemas/UserInfo" - path: - type: string - status: - $ref: "#/components/schemas/StudioCheckpointStatus" - DataStudioCheckpointUpdateRequest: - type: object - properties: - name: - type: string - DataStudioComputeEnvDto: - type: object - allOf: - - $ref: "#/components/schemas/ComputeEnvDbDto" - - properties: - credentialsId: - type: string - workDir: - type: string - DataStudioConfiguration: - type: object - properties: - gpu: - minimum: 0 - type: integer - format: int32 - cpu: - minimum: 0 - type: integer - format: int32 - memory: - minimum: 0 - type: integer - format: int32 - mountData: - type: array - items: - type: string - environment: - type: object - additionalProperties: - type: string - nullable: true - condaEnvironment: - maxLength: 2048 - type: string - lifespanHours: - minimum: 0 - type: integer - format: int32 - DataStudioCreateRequest: - required: - - computeEnvId - - name - type: object - properties: - name: - maxLength: 80 - minLength: 1 - type: string - description: - maxLength: 2048 - type: string - dataStudioToolUrl: - type: string - computeEnvId: - minLength: 1 - type: string - initialCheckpointId: - type: integer - format: int64 - configuration: - $ref: "#/components/schemas/DataStudioConfiguration" - remoteConfig: - nullable: true - allOf: - - $ref: "#/components/schemas/StudioRemoteConfiguration" - isPrivate: - type: boolean - labelIds: - type: array - nullable: true - items: - type: integer - format: int64 - spot: - type: boolean - nullable: true - DataStudioCreateResponse: - type: object - properties: - studio: - $ref: "#/components/schemas/DataStudioDto" - DataStudioDto: - type: object - properties: - sessionId: - type: string - workspaceId: - type: integer - format: int64 - parentCheckpoint: - $ref: "#/components/schemas/DataStudioDto.ParentCheckpoint" - user: - $ref: "#/components/schemas/UserInfo" - name: - type: string - description: - type: string - studioUrl: - type: string - computeEnv: - $ref: "#/components/schemas/DataStudioComputeEnvDto" - template: - $ref: "#/components/schemas/DataStudioTemplate" - remoteConfig: - $ref: "#/components/schemas/StudioRemoteConfiguration" - configuration: - $ref: "#/components/schemas/DataStudioConfiguration" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - lastStarted: - type: string - format: date-time - effectiveLifespanHours: - type: integer - format: int32 - activeConnections: - type: array - items: - $ref: "#/components/schemas/ActiveConnection" - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - waveBuildUrl: - type: string - baseImage: - type: string - customImage: - type: boolean - isPrivate: - type: boolean - mountedDataLinks: - type: array - items: - $ref: "#/components/schemas/DataLinkDto" - progress: - type: array - items: - $ref: "#/components/schemas/DataStudioProgressStep" - labels: - type: array - nullable: true - items: - $ref: "#/components/schemas/LabelDbDto" - DataStudioDto.ParentCheckpoint: - type: object - properties: - checkpointId: - type: integer - format: int64 - checkpointName: - type: string - sessionId: - type: string - studioName: - type: string - DataStudioListCheckpointsResponse: - required: - - checkpoints - - totalSize - type: object - properties: - checkpoints: - type: array - items: - $ref: "#/components/schemas/DataStudioCheckpointDto" - totalSize: - type: integer - format: int64 - DataStudioListResponse: - required: - - studios - - totalSize - type: object - properties: - studios: - type: array - items: - $ref: "#/components/schemas/DataStudioDto" - totalSize: - type: integer - format: int64 - DataStudioMountedLinksResponse: - type: object - properties: - dataLinkIds: - type: array - items: - type: string - DataStudioProgressStep: - type: object - properties: - status: - $ref: "#/components/schemas/DataStudioProgressStep.Status" - message: - type: string - warnings: - type: array - items: - type: string - DataStudioProgressStep.Status: - type: string - enum: - - pending - - in-progress - - succeeded - - errored - DataStudioQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - DataStudioStartRequest: - type: object - properties: - configuration: - nullable: true - allOf: - - $ref: "#/components/schemas/DataStudioConfiguration" - description: - type: string - nullable: true - labelIds: - type: array - nullable: true - items: - type: integer - format: int64 - spot: - type: boolean - nullable: true - DataStudioStartResponse: - required: - - jobSubmitted - - sessionId - - statusInfo - type: object - properties: - jobSubmitted: - type: boolean - sessionId: - type: string - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - DataStudioStatus: - type: string - enum: - - starting - - running - - stopping - - stopped - - errored - - building - - buildFailed - x-enum-varnames: - - starting - - running - - stopping - - stopped - - errored - - building - - buildFailed - DataStudioStatusInfo: - type: object - properties: - status: - $ref: "#/components/schemas/DataStudioStatus" - message: - type: string - lastUpdate: - type: string - format: date-time - stopReason: - $ref: "#/components/schemas/DataStudioStopReason" - DataStudioStopReason: - type: string - enum: - - CREDITS_RUN_OUT - - LIFESPAN_EXPIRED - - SPOT_RECLAMATION - DataStudioStopResponse: - required: - - jobSubmitted - - sessionId - - statusInfo - type: object - properties: - jobSubmitted: - type: boolean - sessionId: - type: string - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - DataStudioTemplate: - type: object - properties: - repository: - type: string - icon: - type: string - status: - $ref: "#/components/schemas/DataStudioVersionStatus" - tool: - type: string - DataStudioTemplatesListResponse: - required: - - templates - - totalSize - type: object - properties: - templates: - type: array - items: - $ref: "#/components/schemas/DataStudioTemplate" - totalSize: - type: integer - format: int64 - DataStudioVersionStatus: - type: string - enum: - - recommended - - deprecated - - experimental - - unsupported - x-enum-varnames: - - recommended - - deprecated - - experimental - - unsupported - DataStudioWorkspaceSettingsResponse: - type: object - properties: - orgId: - type: integer - format: int64 - wspId: - type: integer - format: int64 - lifespanHours: - type: integer - format: int32 - DatasetDto: - type: object - properties: - id: - type: string - user: - $ref: "#/components/schemas/UserInfo" - workspaceId: - type: integer - format: int64 - organizationId: - type: integer - format: int64 - name: - type: string - lastUpdatedBy: - $ref: "#/components/schemas/UserInfo" - description: - type: string - mediaType: - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - deleted: - type: boolean - hidden: - type: boolean - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - version: - type: integer - format: int64 - runsInfo: - $ref: "#/components/schemas/DatasetRunsInfo" - DatasetQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - DatasetRunsInfo: - type: object - properties: - runsCount: - type: integer - format: int64 - lastUsed: - type: string - format: date-time - DatasetVersionDto: - type: object - properties: - datasetId: - type: string - datasetName: - type: string - datasetDescription: - type: string - hasHeader: - type: boolean - version: - type: integer - format: int64 - createdBy: - $ref: "#/components/schemas/UserInfo" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - fileName: - type: string - mediaType: - type: string - workspaceId: - type: integer - format: int64 - url: - type: string - disabled: - type: boolean - DeleteCredentialsConflictResponse: - type: object - properties: - credentialsId: - type: string - conflicts: - type: array - items: - $ref: "#/components/schemas/DeleteCredentialsConflictResponse.Conflict" - DeleteCredentialsConflictResponse.Conflict: - type: object - properties: - type: - type: string - id: - type: string - name: - type: string - url: - type: string - DeleteDatasetsRequest: - type: object - properties: - datasetIds: - type: array - items: - type: string - DeleteDatasetsResponse: - type: object - properties: - success: - type: array - items: - type: string - failed: - type: array - items: - type: string - DeleteManagedCredentialsConflictResponse: - type: object - properties: - managedCredentialsId: - type: string - conflicts: - type: array - items: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse.Conflict" - DeleteManagedCredentialsConflictResponse.Conflict: - type: object - properties: - type: - type: string - id: - type: string - name: - type: string - url: - type: string - DeleteWorkflowsRequest: - type: object - properties: - workflowIds: - type: array - items: - type: string - DeleteWorkflowsResponse: - type: object - properties: - failedWorkflowIds: - type: array - items: - type: string - DescribeActionResponse: - type: object - properties: - action: - $ref: "#/components/schemas/ActionResponseDto" - DescribeComputeEnvResponse: - type: object - properties: - computeEnv: - $ref: "#/components/schemas/ComputeEnvResponseDto" - DescribeCredentialsResponse: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - DescribeDatasetResponse: - type: object - properties: - dataset: - $ref: "#/components/schemas/DatasetDto" - DescribeLaunchResponse: - type: object - properties: - launch: - $ref: "#/components/schemas/Launch" - DescribeOrganizationQuotasResponse: - type: object - properties: - quotas: - $ref: "#/components/schemas/OrganizationQuotas" - DescribeOrganizationResponse: - type: object - properties: - organization: - $ref: "#/components/schemas/OrganizationDbDto" - DescribePipelineInfoResponse: - type: object - properties: - pipelineInfo: - $ref: "#/components/schemas/PipelineInfo" - DescribePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - DescribePipelineSecretResponse: - type: object - properties: - pipelineSecret: - $ref: "#/components/schemas/PipelineSecret" - DescribePlatformResponse: - type: object - properties: - metainfo: - $ref: "#/components/schemas/PlatformMetainfo" - DescribeTaskResponse: - type: object - properties: - task: - $ref: "#/components/schemas/Task" - DescribeTeamResponse: - type: object - properties: - team: - $ref: "#/components/schemas/TeamDbDto" - DescribeUserResponse: - type: object - properties: - user: - $ref: "#/components/schemas/UserDbDto" - needConsent: - type: boolean - defaultWorkspaceId: - type: integer - format: int64 - DescribeWorkflowLaunchResponse: - type: object - properties: - launch: - $ref: "#/components/schemas/WorkflowLaunchResponse" - DescribeWorkflowResponse: - type: object - properties: - workflow: - $ref: "#/components/schemas/Workflow" - progress: - $ref: "#/components/schemas/ProgressData" - platform: - $ref: "#/components/schemas/ComputePlatformDto" - jobInfo: - $ref: "#/components/schemas/JobInfoDto" - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - optimized: - type: boolean - messages: - type: array - items: - type: string - DescribeWorkspaceResponse: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - EfsFileSystem: - type: object - properties: - id: - type: string - EksComputeConfig: - title: Amazon EKS cluster configuration - type: object - allOf: - - $ref: "#/components/schemas/K8sComputeConfig" - - properties: - discriminator: - type: string - region: - type: string - description: AWS region - clusterName: - type: string - description: The AWS EKS cluster name - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - EksPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - clusters: - type: array - items: - type: string - EmptyBodyRequest: - type: object - ErrorResponse: - required: - - message - type: object - properties: - message: - type: string - EventType: - type: object - properties: - source: - type: string - display: - type: string - description: - type: string - enabled: - type: boolean - ForgeConfig: - type: object - properties: - type: - type: string - enum: - - SPOT - - EC2 - minCpus: - type: integer - format: int32 - maxCpus: - type: integer - format: int32 - gpuEnabled: - type: boolean - ebsAutoScale: - type: boolean - instanceTypes: - type: array - items: - type: string - allocStrategy: - type: string - enum: - - BEST_FIT - - BEST_FIT_PROGRESSIVE - - SPOT_CAPACITY_OPTIMIZED - - SPOT_PRICE_CAPACITY_OPTIMIZED - imageId: - type: string - vpcId: - type: string - subnets: - type: array - items: - type: string - securityGroups: - type: array - items: - type: string - fsxMount: - type: string - fsxName: - type: string - fsxSize: - type: integer - format: int32 - disposeOnDeletion: - type: boolean - ec2KeyPair: - type: string - allowBuckets: - type: array - items: - type: string - ebsBlockSize: - type: integer - format: int32 - fusionEnabled: - type: boolean - bidPercentage: - type: integer - format: int32 - efsCreate: - type: boolean - efsId: - type: string - efsMount: - type: string - dragenEnabled: - type: boolean - dragenAmiId: - type: string - ebsBootSize: - type: integer - format: int32 - ecsConfig: - type: string - fargateHeadEnabled: - type: boolean - arm64Enabled: - type: boolean - dragenInstanceType: - type: string - FsxFileSystem: - type: object - properties: - id: - type: string - dns: - type: string - mount: - type: string - GetProgressResponse: - type: object - properties: - progress: - $ref: "#/components/schemas/ProgressData" - GetWorkflowMetricsResponse: - type: object - properties: - metrics: - type: array - items: - $ref: "#/components/schemas/WorkflowMetrics" - GitHubSecurityKeys: - type: object - properties: - discriminator: - type: string - token: - type: string - username: - type: string - password: - type: string - writeOnly: true - GitLabSecurityKeys: - type: object - properties: - discriminator: - type: string - username: - type: string - password: - type: string - writeOnly: true - token: - type: string - writeOnly: true - GiteaSecurityKeys: - type: object - properties: - discriminator: - type: string - token: - type: string - username: - type: string - password: - type: string - writeOnly: true - GithubActionConfig: - type: object - properties: - discriminator: - type: string - events: - type: array - items: - type: string - GithubActionEvent: - type: object - properties: - discriminator: - type: string - ref: - type: string - commitId: - type: string - commitMessage: - type: string - pusherName: - type: string - pusherEmail: - type: string - timestamp: - type: string - format: date-time - GkeComputeConfig: - title: Google GKE cluster configuration - type: object - allOf: - - $ref: "#/components/schemas/K8sComputeConfig" - - properties: - discriminator: - type: string - region: - type: string - description: The GKE cluster region - or - zone - clusterName: - type: string - description: The GKE cluster name - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - fusion2Enabled: - type: boolean - waveEnabled: - type: boolean - GkePlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - clusters: - type: array - items: - type: string - GoogleBatchConfig: - title: Google Batch service configuration - type: object - properties: - discriminator: - type: string - location: - type: string - workDir: - type: string - spot: - type: boolean - bootDiskSizeGb: - type: integer - format: int32 - cpuPlatform: - type: string - machineType: - type: string - projectId: - type: string - sshDaemon: - type: boolean - sshImage: - type: string - debugMode: - type: integer - format: int32 - copyImage: - type: string - usePrivateAddress: - type: boolean - labels: - type: object - additionalProperties: - type: string - preRunScript: - type: string - postRunScript: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - nextflowConfig: - type: string - nfsTarget: - type: string - nfsMount: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - serviceAccount: - type: string - network: - type: string - subnetwork: - type: string - headJobInstanceTemplate: - type: string - computeJobsInstanceTemplate: - type: string - GoogleBucket: - type: object - properties: - path: - type: string - GoogleCloudConfig: - title: Google Cloud configuration - type: object - properties: - discriminator: - type: string - preRunScript: - type: string - postRunScript: - type: string - workDir: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - projectId: - type: string - region: - type: string - zone: - type: string - serviceAccountEmail: - type: string - instanceType: - type: string - imageId: - type: string - arm64Enabled: - type: boolean - gpuEnabled: - type: boolean - bootDiskSizeGb: - type: integer - format: int32 - forgedResources: - type: array - items: - type: object - additionalProperties: true - GoogleCloudPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - zones: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/GoogleBucket" - instanceTypes: - type: array - items: - $ref: "#/components/schemas/GoogleInstanceType" - images: - type: array - items: - $ref: "#/components/schemas/GoogleImage" - GoogleImage: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - arch: - type: string - GoogleInstanceType: - type: object - properties: - id: - type: string - arch: - type: string - GoogleLifeSciencesConfig: - title: Google life sciences configuration - type: object - properties: - discriminator: - type: string - region: - type: string - zones: - type: array - items: - type: string - location: - type: string - workDir: - type: string - preemptible: - type: boolean - bootDiskSizeGb: - type: integer - format: int32 - projectId: - type: string - sshDaemon: - type: boolean - sshImage: - type: string - debugMode: - type: integer - format: int32 - copyImage: - type: string - usePrivateAddress: - type: boolean - labels: - type: object - additionalProperties: - type: string - preRunScript: - type: string - postRunScript: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - nextflowConfig: - type: string - nfsTarget: - type: string - nfsMount: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - GooglePlatformMetainfo: - type: object - properties: - locations: - type: array - items: - type: string - discriminator: - type: string - warnings: - type: array - items: - type: string - zones: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/GooglePlatformMetainfo.Bucket" - filestores: - type: array - items: - $ref: "#/components/schemas/GooglePlatformMetainfo.Filestore" - GooglePlatformMetainfo.Bucket: - type: object - properties: - path: - type: string - GooglePlatformMetainfo.Filestore: - type: object - properties: - target: - type: string - name: - type: string - location: - type: string - GoogleSecurityKeys: - type: object - properties: - discriminator: - type: string - data: - type: string - writeOnly: true - GridPlatformMetainfo: - type: object - properties: - discriminator: - type: string - Image: - required: - - arch - - description - - id - - name - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - arch: - type: string - InstanceType: - required: - - arch - type: object - properties: - id: - type: string - arch: - type: string - Iterator_String_: - type: object - JobCleanupPolicy: - type: string - enum: - - on_success - - always - - never - x-enum-varnames: - - on_success - - always - - never - JobInfoDto: - type: object - properties: - id: - type: integer - format: int64 - operationId: - type: string - message: - type: string - status: - type: string - exitCode: - type: integer - format: int32 - JobQueue: - required: - - name - - state - type: object - properties: - name: - type: string - state: - type: string - K8sComputeConfig: - title: Kubernetes compute configuration - type: object - properties: - discriminator: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - server: - type: string - sslCert: - type: string - namespace: - type: string - computeServiceAccount: - type: string - headServiceAccount: - type: string - storageClaimName: - type: string - storageMountPath: - type: string - podCleanup: - $ref: "#/components/schemas/PodCleanupPolicy" - headPodSpec: - type: string - servicePodSpec: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - nextflowConfig: - type: string - K8sPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - K8sSecurityKeys: - type: object - properties: - discriminator: - type: string - certificate: - type: string - privateKey: - type: string - writeOnly: true - token: - type: string - writeOnly: true - LabelDbDto: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - isDynamic: - type: boolean - isInterpolated: - type: boolean - dateCreated: - type: string - format: date-time - LabelType: - type: string - enum: - - simple - - resource - - all - x-enum-varnames: - - simple - - resource - - all - Launch: - required: - - dateCreated - - pipeline - type: object - properties: - id: - maxLength: 22 - type: string - computeEnv: - nullable: true - allOf: - - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - pipeline: - maxLength: 200 - type: string - workDir: - type: string - revision: - maxLength: 100 - type: string - commitId: - maxLength: 40 - type: string - configText: - type: string - towerConfig: - type: string - paramsText: - type: string - preRunScript: - type: string - postRunScript: - type: string - mainScript: - maxLength: 200 - type: string - entryName: - maxLength: 80 - type: string - schemaName: - maxLength: 100 - pattern: "[\\p{Graph}&&[^/]]\\p{Graph}+" - type: string - resume: - type: boolean - resumeLaunchId: - maxLength: 22 - type: string - pullLatest: - type: boolean - stubRun: - type: boolean - sessionId: - maxLength: 36 - type: string - runName: - maxLength: 80 - type: string - configProfiles: - type: array - items: - type: string - userSecrets: - type: array - items: - type: string - workspaceSecrets: - type: array - items: - type: string - optimizationId: - maxLength: 32 - type: string - optimizationTargets: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - launchContainer: - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - LaunchActionRequest: - type: object - properties: - params: - type: object - additionalProperties: true - LaunchActionResponse: - type: object - properties: - workflowId: - type: string - ListAccessTokensResponse: - type: object - properties: - tokens: - type: array - items: - $ref: "#/components/schemas/AccessToken" - ListActionsResponse: - type: object - properties: - actions: - type: array - items: - $ref: "#/components/schemas/ListActionsResponse.ActionInfo" - ListActionsResponse.ActionInfo: - type: object - properties: - id: - type: string - name: - type: string - pipeline: - type: string - source: - $ref: "#/components/schemas/Action.Source" - status: - $ref: "#/components/schemas/Action.Status" - lastSeen: - type: string - format: date-time - dateCreated: - type: string - format: date-time - event: - $ref: "#/components/schemas/Action.EventType" - endpoint: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - usageCmd: - type: string - ListComputeEnvsResponse: - type: object - properties: - computeEnvs: - type: array - items: - $ref: "#/components/schemas/ListComputeEnvsResponse.Entry" - ListComputeEnvsResponse.Entry: - type: object - properties: - id: - type: string - name: - type: string - platform: - type: string - status: - $ref: "#/components/schemas/ComputeEnv.Status" - message: - type: string - lastUsed: - type: string - format: date-time - primary: - type: boolean - workspaceName: - type: string - visibility: - type: string - workDir: - type: string - credentialsId: - type: string - region: - type: string - labels: - type: array - nullable: true - items: - $ref: "#/components/schemas/LabelDbDto" - resources: - nullable: true - allOf: - - $ref: "#/components/schemas/ComputeEnvResources" - ListCredentialsResponse: - type: object - properties: - credentials: - type: array - items: - $ref: "#/components/schemas/Credentials" - ListDatasetVersionsResponse: - type: object - properties: - versions: - type: array - items: - $ref: "#/components/schemas/DatasetVersionDto" - totalSize: - type: integer - format: int64 - ListDatasetsResponse: - type: object - properties: - datasets: - type: array - items: - $ref: "#/components/schemas/DatasetDto" - totalSize: - type: integer - format: int64 - ListEventTypesResponse: - type: object - properties: - eventTypes: - type: array - items: - $ref: "#/components/schemas/EventType" - ListLabelsResponse: - type: object - properties: - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - totalSize: - type: integer - format: int64 - ListManagedCredentialsRespDto: - type: object - properties: - managedCredentialsId: - type: integer - format: int64 - userId: - type: integer - format: int64 - userName: - type: string - firstName: - type: string - lastName: - type: string - avatarUrl: - type: string - provider: - type: string - enum: - - ssh - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - ListManagedCredentialsResponse: - type: object - properties: - managedCredentials: - type: array - items: - $ref: "#/components/schemas/ListManagedCredentialsRespDto" - totalSize: - type: integer - format: int64 - ListManagedIdentitiesResponse: - type: object - properties: - managedIdentities: - type: array - items: - $ref: "#/components/schemas/ManagedIdentityDbDto_AbstractGridConfig_" - totalSize: - type: integer - format: int64 - ListMembersResponse: - type: object - properties: - members: - type: array - items: - $ref: "#/components/schemas/MemberDbDto" - totalSize: - type: integer - format: int64 - ListOrganizationsResponse: - type: object - properties: - organizations: - type: array - items: - $ref: "#/components/schemas/OrganizationDbDto" - totalSize: - type: integer - format: int32 - ListParticipantsResponse: - type: object - properties: - participants: - type: array - items: - $ref: "#/components/schemas/ParticipantDbDto" - totalSize: - type: integer - format: int64 - ListPipelineInfoResponse: - type: object - properties: - pipelines: - type: array - items: - type: string - ListPipelineSecretsResponse: - type: object - properties: - pipelineSecrets: - type: array - items: - $ref: "#/components/schemas/PipelineSecret" - totalSize: - type: integer - format: int64 - ListPipelinesResponse: - type: object - properties: - pipelines: - type: array - items: - $ref: "#/components/schemas/PipelineDbDto" - totalSize: - type: integer - format: int64 - ListPlatformsResponse: - type: object - properties: - platforms: - type: array - items: - $ref: "#/components/schemas/ComputePlatform" - ListRegionsResponse: - type: object - properties: - regions: - type: array - items: - $ref: "#/components/schemas/ComputeRegion" - ListTasksResponse: - type: object - properties: - tasks: - type: array - items: - $ref: "#/components/schemas/DescribeTaskResponse" - total: - type: integer - format: int64 - ListTeamResponse: - type: object - properties: - teams: - type: array - items: - $ref: "#/components/schemas/TeamDbDto" - totalSize: - type: integer - format: int64 - ListWorkflowsResponse: - type: object - properties: - workflows: - type: array - items: - $ref: "#/components/schemas/ListWorkflowsResponse.ListWorkflowsElement" - totalSize: - type: integer - format: int64 - ListWorkflowsResponse.ListWorkflowsElement: - type: object - properties: - workflow: - $ref: "#/components/schemas/WorkflowDbDto" - progress: - $ref: "#/components/schemas/ProgressData" - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - starred: - type: boolean - optimized: - type: boolean - ListWorkspacesAndOrgResponse: - type: object - properties: - orgsAndWorkspaces: - type: array - items: - $ref: "#/components/schemas/OrgAndWorkspaceDto" - ListWorkspacesResponse: - type: object - properties: - workspaces: - type: array - items: - $ref: "#/components/schemas/WorkspaceDbDto" - LocalComputeConfig: - title: Local execution configuration - type: object - properties: - discriminator: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - nextflowConfig: - type: string - LocalPlatformMetainfo: - type: object - properties: - discriminator: - type: string - LocalSecurityKeys: - title: Local security keys - type: object - properties: - discriminator: - type: string - password: - type: string - writeOnly: true - Log: - type: object - properties: - name: - type: string - cmd: - type: array - items: - type: string - start_time: - type: string - end_time: - type: string - stdout: - type: string - stderr: - type: string - exit_code: - type: integer - format: int32 - LogPage: - type: object - properties: - truncated: - type: boolean - entries: - $ref: "#/components/schemas/Iterator_String_" - rewindToken: - type: string - forwardToken: - type: string - pending: - type: boolean - message: - type: string - downloads: - type: array - items: - $ref: "#/components/schemas/LogPage.Download" - LogPage.Download: - type: object - properties: - saveName: - type: string - fileName: - type: string - displayText: - type: string - LsfComputeConfig: - title: IBM LSF configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - unitForLimits: - type: string - perJobMemLimit: - type: boolean - perTaskReserve: - type: boolean - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - ManagedCredentialsDbDto: - type: object - properties: - id: - type: integer - format: int64 - ManagedCredentialsMetadata: - type: object - properties: - discriminator: - type: string - readOnly: true - ManagedIdentityDbDto_AbstractGridConfig_: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - platform: - type: string - enum: - - altair-platform - - lsf-platform - - moab-platform - - slurm-platform - - uge-platform - config: - $ref: "#/components/schemas/AbstractGridConfig" - Map.Entry_String.String_: - type: object - properties: - key: - type: string - value: - type: string - MemberDbDto: - type: object - properties: - memberId: - type: integer - format: int64 - userId: - type: integer - format: int64 - userName: - type: string - email: - type: string - firstName: - type: string - lastName: - type: string - avatar: - type: string - role: - $ref: "#/components/schemas/OrgRole" - MoabComputeConfig: - title: Moab configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - MultiRequestFileSchema: - type: object - properties: - file: - type: string - format: binary - NavbarConfig: - type: object - properties: - menus: - type: array - items: - $ref: "#/components/schemas/NavbarConfig.NavbarMenu" - NavbarConfig.NavbarMenu: - type: object - properties: - label: - type: string - url: - type: string - OrgAndWorkspaceDto: - type: object - properties: - orgId: - type: integer - format: int64 - orgName: - type: string - orgLogoUrl: - type: string - orgType: - $ref: "#/components/schemas/OrgType" - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - workspaceFullName: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - roles: - type: array - items: - type: string - OrgRole: - type: string - enum: - - owner - - member - - collaborator - x-enum-varnames: - - owner - - member - - collaborator - OrgType: - type: string - enum: - - academic - - evaluating - - pro - - basic - - internal - x-enum-varnames: - - academic - - evaluating - - pro - - basic - - internal - Organization: - required: - - fullName - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - readOnly: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - fullName: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - location: - maxLength: 100 - type: string - website: - pattern: "" - type: string - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - OrganizationDbDto: - type: object - properties: - paying: - type: boolean - deprecated: true - orgId: - type: integer - format: int64 - name: - type: string - fullName: - type: string - description: - type: string - location: - type: string - website: - type: string - logoId: - type: string - logoUrl: - type: string - memberId: - type: integer - format: int64 - memberRole: - $ref: "#/components/schemas/OrgRole" - type: - $ref: "#/components/schemas/OrgType" - OrganizationQuotas: - type: object - properties: - maxWorkspaces: - type: integer - format: int64 - maxMembers: - type: integer - format: int64 - maxTeams: - type: integer - format: int64 - maxPipelinesPerWorkspace: - type: integer - format: int64 - maxParticipantsPerWorkspace: - type: integer - format: int64 - maxDatasetsPerWorkspace: - type: integer - format: int64 - maxVersionsPerDataset: - type: integer - format: int64 - maxRuns: - type: integer - format: int64 - maxRunHistory: - type: integer - format: int64 - maxLabelsPerWorkspace: - type: integer - format: int64 - maxDataStudiosRunning: - type: integer - format: int64 - maxSeqeraComputeComputeEnvs: - type: integer - format: int64 - maxFusionThroughputBytes: - type: integer - format: int64 - ParticipantDbDto: - type: object - properties: - participantId: - type: integer - format: int64 - memberId: - type: integer - format: int64 - userName: - type: string - firstName: - type: string - lastName: - type: string - email: - type: string - orgRole: - $ref: "#/components/schemas/OrgRole" - teamId: - type: integer - format: int64 - teamName: - type: string - wspRole: - $ref: "#/components/schemas/WspRole" - type: - $ref: "#/components/schemas/ParticipantType" - teamAvatarUrl: - type: string - userAvatarUrl: - type: string - ParticipantType: - type: string - enum: - - MEMBER - - TEAM - - COLLABORATOR - PipelineDbDto: - type: object - properties: - pipelineId: - type: integer - format: int64 - name: - type: string - description: - type: string - icon: - type: string - repository: - type: string - userId: - type: integer - format: int64 - userName: - type: string - userFirstName: - type: string - userLastName: - type: string - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - visibility: - type: string - deleted: - type: boolean - lastUpdated: - type: string - format: date-time - optimizationId: - type: string - optimizationTargets: - type: string - optimizationStatus: - $ref: "#/components/schemas/PipelineOptimizationStatus" - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - computeEnv: - $ref: "#/components/schemas/ComputeEnvDbDto" - PipelineInfo: - type: object - properties: - projectName: - type: string - simpleName: - type: string - repositoryUrl: - type: string - cloneUrl: - type: string - provider: - type: string - configFiles: - type: array - items: - type: string - revisionName: - type: string - nullable: true - commitId: - type: string - nullable: true - workDirs: - type: array - items: - type: string - revisions: - type: array - items: - type: string - profiles: - type: array - items: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - warnings: - type: array - items: - type: string - PipelineListParams.SortBy: - type: string - enum: - - CREATED - - MODIFIED - - NAME - PipelineListParams.SortDir: - type: string - enum: - - ASCENDING - - DESCENDING - PipelineOptimizationStatus: - type: string - enum: - - OPTIMIZED - - OPTIMIZABLE - - UNAVAILABLE - PipelineQueryAttribute: - type: string - enum: - - optimized - - labels - - computeEnv - x-enum-varnames: - - optimized - - labels - - computeEnv - PipelineSchemaAttributes: - type: string - enum: - - schema - - params - x-enum-varnames: - - schema - - params - PipelineSchemaResponse: - required: - - schema - type: object - properties: - schema: - type: string - params: - type: string - PipelineSecret: - required: - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 100 - pattern: "^[a-zA-Z_](?:[0-9A-Za-z]+|(_)(?!\\1)){1,49}$" - type: string - lastUsed: - type: string - format: date-time - readOnly: true - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - PlatformMetainfo: - type: object - discriminator: - propertyName: discriminator - mapping: - gke-platform: "#/components/schemas/GkePlatformMetaInfo" - aws-cloud: "#/components/schemas/AwsCloudPlatformMetainfo" - seqeracompute: "#/components/schemas/SeqeraComputePlatformMetainfo" - k8s-platform: "#/components/schemas/K8sPlatformMetaInfo" - grid: "#/components/schemas/GridPlatformMetainfo" - aws-batch: "#/components/schemas/AwsBatchPlatformMetainfo" - google-cloud: "#/components/schemas/GoogleCloudPlatformMetaInfo" - local-platform: "#/components/schemas/LocalPlatformMetainfo" - google: "#/components/schemas/GooglePlatformMetainfo" - azure-batch: "#/components/schemas/AzBatchPlatformMetainfo" - eks-platform: "#/components/schemas/EksPlatformMetaInfo" - azure-cloud: "#/components/schemas/AzCloudPlatformMetaInfo" - oneOf: - - $ref: "#/components/schemas/AwsBatchPlatformMetainfo" - - $ref: "#/components/schemas/AwsCloudPlatformMetainfo" - - $ref: "#/components/schemas/GooglePlatformMetainfo" - - $ref: "#/components/schemas/GoogleCloudPlatformMetaInfo" - - $ref: "#/components/schemas/AzBatchPlatformMetainfo" - - $ref: "#/components/schemas/AzCloudPlatformMetaInfo" - - $ref: "#/components/schemas/EksPlatformMetaInfo" - - $ref: "#/components/schemas/GkePlatformMetaInfo" - - $ref: "#/components/schemas/K8sPlatformMetaInfo" - - $ref: "#/components/schemas/GridPlatformMetainfo" - - $ref: "#/components/schemas/SeqeraComputePlatformMetainfo" - - $ref: "#/components/schemas/LocalPlatformMetainfo" - PodCleanupPolicy: - type: string - enum: - - on_success - - always - - never - x-enum-varnames: - - on_success - - always - - never - ProcessLoad: - required: - - aborted - - cached - - cpuLoad - - cpuTime - - cpus - - failed - - ignored - - invCtxSwitch - - loadCpus - - loadMemory - - loadTasks - - memoryReq - - memoryRss - - peakCpus - - peakMemory - - peakTasks - - pending - - process - - readBytes - - retries - - running - - submitted - - succeeded - - volCtxSwitch - - writeBytes - type: object - properties: - pending: - type: integer - format: int64 - submitted: - type: integer - format: int64 - running: - type: integer - format: int64 - succeeded: - type: integer - format: int64 - failed: - type: integer - format: int64 - cached: - type: integer - format: int64 - aborted: - type: integer - format: int64 - retries: - type: integer - format: int64 - ignored: - type: integer - format: int64 - memoryEfficiency: - type: number - format: float - cpuEfficiency: - type: number - format: float - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - version: - type: integer - format: int64 - process: - type: string - cpus: - type: integer - format: int64 - deprecated: true - cpuTime: - type: integer - format: int64 - deprecated: true - cpuLoad: - type: integer - format: int64 - deprecated: true - memoryRss: - type: integer - format: int64 - deprecated: true - memoryReq: - type: integer - format: int64 - deprecated: true - readBytes: - type: integer - format: int64 - deprecated: true - writeBytes: - type: integer - format: int64 - deprecated: true - volCtxSwitch: - type: integer - format: int64 - deprecated: true - invCtxSwitch: - type: integer - format: int64 - deprecated: true - loadTasks: - type: integer - format: int64 - deprecated: true - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakCpus: - type: integer - format: int64 - peakTasks: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - ProgressData: - type: object - properties: - workflowProgress: - $ref: "#/components/schemas/WorkflowLoad" - processesProgress: - type: array - items: - $ref: "#/components/schemas/ProcessLoad" - totalProcesses: - type: integer - format: int32 - RandomWorkflowNameResponse: - type: object - properties: - name: - type: string - ResourceData: - type: object - properties: - warnings: - type: array - items: - type: string - mean: - type: number - format: float - min: - type: number - format: float - q1: - type: number - format: float - q2: - type: number - format: float - q3: - type: number - format: float - max: - type: number - format: float - minLabel: - type: string - maxLabel: - type: string - q1Label: - type: string - q2Label: - type: string - q3Label: - type: string - RunId: - type: object - properties: - run_id: - type: string - RunListResponse: - type: object - properties: - runs: - type: array - items: - $ref: "#/components/schemas/RunStatus" - next_page_token: - type: string - RunLog: - type: object - properties: - run_id: - type: string - request: - $ref: "#/components/schemas/RunRequest" - state: - $ref: "#/components/schemas/State" - run_log: - $ref: "#/components/schemas/Log" - task_logs: - type: array - items: - $ref: "#/components/schemas/Log" - outputs: {} - RunRequest: - type: object - properties: - workflow_params: - type: string - workflow_type: - type: string - workflow_type_version: - type: string - tags: - type: object - additionalProperties: - type: string - workflow_engine_parameters: - type: object - additionalProperties: - type: string - workflow_url: - type: string - RunStatus: - type: object - properties: - run_id: - type: string - state: - $ref: "#/components/schemas/State" - S3SecurityKeys: - type: object - properties: - discriminator: - type: string - accessKey: - type: string - secretKey: - type: string - writeOnly: true - pathStyleAccessEnabled: - type: boolean - SSHSecurityKeys: - type: object - properties: - discriminator: - type: string - privateKey: - type: string - writeOnly: true - passphrase: - type: string - writeOnly: true - SecurityGroup: - type: object - properties: - id: - type: string - name: - type: string - vpcId: - type: string - SecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - discriminator: - propertyName: discriminator - mapping: - s3: "#/components/schemas/S3SecurityKeys" - github: "#/components/schemas/GitHubSecurityKeys" - azurerepos: "#/components/schemas/AzureReposSecurityKeys" - azure_entra: "#/components/schemas/AzureEntraKeys" - container-reg: "#/components/schemas/ContainerRegistryKeys" - tw-agent: "#/components/schemas/AgentSecurityKeys" - k8s: "#/components/schemas/K8sSecurityKeys" - ssh: "#/components/schemas/SSHSecurityKeys" - google: "#/components/schemas/GoogleSecurityKeys" - bitbucket: "#/components/schemas/BitBucketSecurityKeys" - azure-cloud: "#/components/schemas/AzureCloudKeys" - local: "#/components/schemas/LocalSecurityKeys" - gitea: "#/components/schemas/GiteaSecurityKeys" - seqeracompute: "#/components/schemas/SeqeraComputeSecurityKeys" - codecommit: "#/components/schemas/CodeCommitSecurityKeys" - gitlab: "#/components/schemas/GitLabSecurityKeys" - aws: "#/components/schemas/AwsSecurityKeys" - azure: "#/components/schemas/AzureSecurityKeys" - oneOf: - - $ref: "#/components/schemas/AwsSecurityKeys" - - $ref: "#/components/schemas/GoogleSecurityKeys" - - $ref: "#/components/schemas/GitHubSecurityKeys" - - $ref: "#/components/schemas/GitLabSecurityKeys" - - $ref: "#/components/schemas/BitBucketSecurityKeys" - - $ref: "#/components/schemas/GiteaSecurityKeys" - - $ref: "#/components/schemas/SSHSecurityKeys" - - $ref: "#/components/schemas/K8sSecurityKeys" - - $ref: "#/components/schemas/AzureSecurityKeys" - - $ref: "#/components/schemas/AzureCloudKeys" - - $ref: "#/components/schemas/AzureReposSecurityKeys" - - $ref: "#/components/schemas/ContainerRegistryKeys" - - $ref: "#/components/schemas/AgentSecurityKeys" - - $ref: "#/components/schemas/CodeCommitSecurityKeys" - - $ref: "#/components/schemas/AzureEntraKeys" - - $ref: "#/components/schemas/SeqeraComputeSecurityKeys" - - $ref: "#/components/schemas/S3SecurityKeys" - - $ref: "#/components/schemas/LocalSecurityKeys" - SeqeraComputeConfig: - title: Seqera Compute configuration - type: object - properties: - discriminator: - type: string - region: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - defaultDataRetentionPolicy: - type: boolean - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - SeqeraComputePlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - jobQueues: - type: array - items: - $ref: "#/components/schemas/JobQueue" - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - fileSystems: - type: array - items: - $ref: "#/components/schemas/FsxFileSystem" - efsFileSystems: - type: array - items: - $ref: "#/components/schemas/EfsFileSystem" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceFamilies: - type: array - items: - type: string - allocStrategy: - type: array - items: - type: string - instanceTypes: - type: array - items: - $ref: "#/components/schemas/InstanceType" - SeqeraComputeSecurityKeys: - type: object - allOf: - - $ref: "#/components/schemas/AwsSecurityKeys" - - properties: - discriminator: - type: string - ServiceInfo: - type: object - properties: - version: - type: string - apiVersion: - type: string - commitId: - type: string - authTypes: - type: array - items: - type: string - loginPath: - type: string - navbar: - deprecated: true - allOf: - - $ref: "#/components/schemas/NavbarConfig" - heartbeatInterval: - type: integer - format: int32 - userWorkspaceEnabled: - type: boolean - allowInstanceCredentials: - type: boolean - landingUrl: - type: string - termsOfUseUrl: - type: string - contentUrl: - type: string - analytics: - $ref: "#/components/schemas/Analytics" - allowLocalRepos: - type: boolean - deprecated: true - contentMaxFileSize: - type: integer - format: int64 - waveEnabled: - type: boolean - groundswellEnabled: - type: boolean - groundswellAllowedWorkspaces: - type: array - items: - type: integer - format: int64 - seqeraComputeEnabled: - type: boolean - forgePrefix: - type: string - seqeraCloud: - type: boolean - evalWorkspaceIds: - type: array - items: - type: integer - format: int64 - contactEmail: - type: string - allowNextflowCliLogs: - type: boolean - logoutUrl: - type: string - nullable: true - ServiceInfoResponse: - type: object - properties: - serviceInfo: - $ref: "#/components/schemas/ServiceInfo" - SlurmComputeConfig: - title: Slurm configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - State: - type: string - enum: - - UNKNOWN - - QUEUED - - INITIALIZING - - RUNNING - - PAUSED - - COMPLETE - - EXECUTOR_ERROR - - SYSTEM_ERROR - - CANCELED - - CANCELING - StudioCheckpointStatus: - type: string - enum: - - empty - - interim - - finalized - - invalid - x-enum-varnames: - - empty - - interim - - finalized - - invalid - StudioRemoteConfiguration: - required: - - repository - type: object - properties: - repository: - type: string - revision: - type: string - nullable: true - commitId: - type: string - nullable: true - SubmitWorkflowLaunchRequest: - type: object - properties: - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - SubmitWorkflowLaunchResponse: - type: object - properties: - workflowId: - type: string - Subnet: - type: object - properties: - id: - type: string - zone: - type: string - vpcId: - type: string - Task: - required: - - status - - taskId - type: object - properties: - hash: - type: string - name: - type: string - process: - type: string - tag: - type: string - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - module: - type: array - items: - type: string - container: - type: string - attempt: - type: integer - format: int32 - script: - type: string - scratch: - type: string - workdir: - type: string - queue: - type: string - cpus: - type: integer - format: int32 - memory: - type: integer - format: int64 - disk: - type: integer - format: int64 - time: - type: integer - format: int64 - env: - type: string - executor: - type: string - machineType: - type: string - cloudZone: - type: string - priceModel: - $ref: "#/components/schemas/CloudPriceModel" - cost: - type: number - errorAction: - type: string - exitStatus: - type: integer - format: int32 - duration: - type: integer - format: int64 - realtime: - type: integer - format: int64 - nativeId: - type: string - pcpu: - type: number - format: double - pmem: - type: number - format: double - rss: - type: integer - format: int64 - vmem: - type: integer - format: int64 - peakRss: - type: integer - format: int64 - peakVmem: - type: integer - format: int64 - rchar: - type: integer - format: int64 - wchar: - type: integer - format: int64 - syscr: - type: integer - format: int64 - syscw: - type: integer - format: int64 - readBytes: - type: integer - format: int64 - writeBytes: - type: integer - format: int64 - volCtxt: - type: integer - format: int64 - invCtxt: - type: integer - format: int64 - exit: - type: integer - format: int32 - id: - type: integer - format: int64 - nullable: true - taskId: - type: integer - format: int64 - status: - $ref: "#/components/schemas/TaskStatus" - dateCreated: - type: string - format: date-time - nullable: true - lastUpdated: - type: string - format: date-time - nullable: true - TaskStatus: - type: string - enum: - - NEW - - SUBMITTED - - RUNNING - - CACHED - - COMPLETED - - FAILED - - ABORTED - Team: - required: - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - readOnly: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - description: - maxLength: 250 - type: string - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - TeamDbDto: - type: object - properties: - teamId: - type: integer - format: int64 - name: - type: string - description: - type: string - avatarUrl: - type: string - membersCount: - type: integer - format: int64 - TraceBeginRequest: - type: object - properties: - launchId: - type: string - deprecated: true - workflow: - $ref: "#/components/schemas/Workflow" - processNames: - type: array - items: - type: string - towerLaunch: - type: boolean - TraceBeginResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - watchUrl: - type: string - TraceCompleteRequest: - type: object - properties: - workflow: - $ref: "#/components/schemas/Workflow" - metrics: - type: array - items: - $ref: "#/components/schemas/WorkflowMetrics" - progress: - $ref: "#/components/schemas/TraceProgressData" - TraceCompleteResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - TraceCreateRequest: - type: object - properties: - launchId: - type: string - deprecated: true - sessionId: - type: string - runName: - type: string - projectName: - type: string - repository: - type: string - workflowId: - type: string - TraceCreateResponse: - type: object - properties: - message: - type: string - workflowId: - type: string - TraceHeartbeatRequest: - type: object - properties: - progress: - $ref: "#/components/schemas/TraceProgressData" - TraceHeartbeatResponse: - type: object - properties: - message: - type: string - TraceProcessingStatus: - type: string - enum: - - OK - - KO - TraceProgressData: - type: object - properties: - pending: - type: integer - format: int32 - submitted: - type: integer - format: int32 - running: - type: integer - format: int32 - succeeded: - type: integer - format: int32 - cached: - type: integer - format: int32 - failed: - type: integer - format: int32 - aborted: - type: integer - format: int32 - stored: - type: integer - format: int32 - ignored: - type: integer - format: int32 - retries: - type: integer - format: int32 - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakRunning: - type: integer - format: int32 - peakCpus: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - processes: - type: array - items: - $ref: "#/components/schemas/TraceProgressDetail" - TraceProgressDetail: - type: object - properties: - index: - type: integer - format: int32 - name: - type: string - pending: - type: integer - format: int32 - submitted: - type: integer - format: int32 - running: - type: integer - format: int32 - succeeded: - type: integer - format: int32 - cached: - type: integer - format: int32 - failed: - type: integer - format: int32 - aborted: - type: integer - format: int32 - stored: - type: integer - format: int32 - ignored: - type: integer - format: int32 - retries: - type: integer - format: int32 - terminated: - type: boolean - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakRunning: - type: integer - format: int32 - peakCpus: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - TraceProgressRequest: - type: object - properties: - tasks: - type: array - items: - $ref: "#/components/schemas/Task" - progress: - $ref: "#/components/schemas/TraceProgressData" - containers: - type: array - items: - $ref: "#/components/schemas/ContainerData" - TraceProgressResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - UnivaComputeConfig: - title: Univa Grid Engine configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - UpdateActionRequest: - type: object - properties: - name: - type: string - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - UpdateComputeEnvRequest: - type: object - properties: - name: - type: string - credentialsId: - type: string - UpdateCredentialsRequest: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - UpdateDatasetRequest: - type: object - properties: - name: - type: string - description: - type: string - UpdateLabelRequest: - type: object - properties: - name: - type: string - value: - type: string - isDefault: - type: boolean - UpdateLabelResponse: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - isDefault: - type: boolean - UpdateManagedCredentialsRequest: - type: object - properties: - provider: - type: string - enum: - - ssh - credentials: - $ref: "#/components/schemas/Credentials" - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - UpdateManagedIdentityRequest: - type: object - properties: - managedIdentity: - $ref: "#/components/schemas/ManagedIdentityDbDto_AbstractGridConfig_" - UpdateMemberRoleRequest: - type: object - properties: - role: - $ref: "#/components/schemas/OrgRole" - UpdateOrganizationRequest: - type: object - properties: - fullName: - type: string - name: - type: string - description: - type: string - location: - type: string - website: - type: string - logoId: - type: string - paying: - type: boolean - nullable: true - deprecated: true - type: - nullable: true - allOf: - - $ref: "#/components/schemas/OrgType" - UpdateParticipantRoleRequest: - type: object - properties: - role: - $ref: "#/components/schemas/WspRole" - UpdatePipelineRequest: - type: object - properties: - name: - type: string - description: - type: string - icon: - type: string - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - labelIds: - type: array - items: - type: integer - format: int64 - UpdatePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - UpdatePipelineSecretRequest: - type: object - properties: - value: - type: string - UpdateTeamRequest: - type: object - properties: - name: - type: string - description: - type: string - avatarId: - type: string - UpdateWorkspaceRequest: - type: object - properties: - name: - type: string - fullName: - type: string - description: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - UploadDatasetVersionResponse: - type: object - properties: - version: - $ref: "#/components/schemas/DatasetVersionDto" - UploadEtag: - type: object - properties: - partNumber: - type: integer - format: int32 - eTag: - type: string - UserDbDto: - required: - - email - - userName - type: object - properties: - id: - type: integer - format: int64 - userName: - maxLength: 40 - type: string - email: - maxLength: 255 - type: string - format: email - firstName: - maxLength: 100 - type: string - lastName: - maxLength: 100 - type: string - organization: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - avatar: - type: string - avatarId: - type: string - notification: - type: boolean - termsOfUseConsent: - type: boolean - marketingConsent: - type: boolean - lastAccess: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - deleted: - type: boolean - UserInfo: - type: object - properties: - id: - type: integer - format: int64 - userName: - type: string - email: - type: string - avatar: - type: string - Visibility: - type: string - enum: - - PRIVATE - - SHARED - Vpc: - type: object - properties: - id: - type: string - isDefault: - type: boolean - WesErrorResponse: - type: object - properties: - msg: - type: string - status_code: - type: integer - format: int32 - WfFusionMeta: - type: object - properties: - enabled: - type: boolean - version: - maxLength: 20 - type: string - WfManifest: - type: object - properties: - nextflowVersion: - maxLength: 20 - type: string - defaultBranch: - maxLength: 20 - type: string - version: - maxLength: 20 - type: string - homePage: - maxLength: 200 - type: string - gitmodules: - maxLength: 150 - type: string - description: - maxLength: 1024 - type: string - name: - maxLength: 150 - type: string - mainScript: - maxLength: 100 - type: string - author: - maxLength: 150 - type: string - icon: - maxLength: 255 - type: string - WfNextflow: - type: object - properties: - version: - maxLength: 20 - type: string - build: - maxLength: 10 - type: string - timestamp: - type: string - format: date-time - WfStats: - type: object - properties: - computeTimeFmt: - maxLength: 50 - type: string - cachedCount: - type: integer - format: int32 - failedCount: - type: integer - format: int32 - ignoredCount: - type: integer - format: int32 - succeedCount: - type: integer - format: int32 - cachedCountFmt: - type: string - succeedCountFmt: - type: string - failedCountFmt: - type: string - ignoredCountFmt: - type: string - cachedPct: - type: number - format: float - failedPct: - type: number - format: float - succeedPct: - type: number - format: float - ignoredPct: - type: number - format: float - cachedDuration: - type: integer - format: int64 - failedDuration: - type: integer - format: int64 - succeedDuration: - type: integer - format: int64 - WfWaveMeta: - type: object - properties: - enabled: - type: boolean - Workflow: - required: - - commandLine - - projectName - - runName - - sessionId - - submit - - userName - - workDir - type: object - properties: - requiresAttention: - type: boolean - status: - $ref: "#/components/schemas/WorkflowStatus" - ownerId: - type: integer - format: int64 - readOnly: true - repository: - type: string - id: - maxLength: 16 - type: string - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - dateCreated: - type: string - format: date-time - nullable: true - readOnly: true - lastUpdated: - type: string - format: date-time - nullable: true - readOnly: true - runName: - maxLength: 80 - type: string - sessionId: - maxLength: 36 - type: string - profile: - maxLength: 100 - type: string - workDir: - type: string - commitId: - maxLength: 40 - type: string - userName: - maxLength: 40 - type: string - scriptId: - maxLength: 40 - type: string - revision: - maxLength: 100 - type: string - commandLine: - maxLength: 8096 - type: string - projectName: - maxLength: 200 - type: string - scriptName: - maxLength: 100 - type: string - launchId: - maxLength: 22 - type: string - configFiles: - type: array - items: - type: string - params: - type: object - additionalProperties: true - configText: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - nextflow: - $ref: "#/components/schemas/WfNextflow" - stats: - $ref: "#/components/schemas/WfStats" - fusion: - $ref: "#/components/schemas/WfFusionMeta" - wave: - $ref: "#/components/schemas/WfWaveMeta" - errorMessage: - type: string - errorReport: - type: string - deleted: - type: boolean - readOnly: true - projectDir: - type: string - homeDir: - type: string - container: - type: string - containerEngine: - type: string - scriptFile: - type: string - launchDir: - type: string - duration: - type: integer - format: int64 - exitStatus: - type: integer - format: int32 - resume: - type: boolean - success: - type: boolean - logFile: - maxLength: 255 - type: string - outFile: - maxLength: 255 - type: string - operationId: - maxLength: 110 - type: string - WorkflowDbDto: - type: object - properties: - messages: - type: array - items: - type: string - id: - type: string - ownerId: - type: integer - format: int64 - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - runName: - type: string - sessionId: - type: string - profile: - type: string - workDir: - type: string - commitId: - type: string - userName: - type: string - scriptId: - type: string - revision: - type: string - commandLine: - type: string - projectName: - type: string - scriptName: - type: string - launchId: - type: string - status: - $ref: "#/components/schemas/WorkflowStatus" - requiresAttention: - type: boolean - configFiles: - type: array - items: - type: string - params: - type: object - additionalProperties: true - configText: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - nextflow: - $ref: "#/components/schemas/WfNextflow" - stats: - $ref: "#/components/schemas/WfStats" - errorMessage: - type: string - errorReport: - type: string - deleted: - type: boolean - projectDir: - type: string - homeDir: - type: string - container: - type: string - repository: - type: string - containerEngine: - type: string - scriptFile: - type: string - launchDir: - type: string - duration: - type: integer - format: int64 - exitStatus: - type: integer - format: int32 - resume: - type: boolean - success: - type: boolean - WorkflowLaunchRequest: - type: object - properties: - id: - type: string - computeEnvId: - type: string - runName: - type: string - pipeline: - type: string - workDir: - type: string - revision: - type: string - commitId: - type: string - sessionId: - type: string - configProfiles: - type: array - items: - type: string - userSecrets: - type: array - items: - type: string - workspaceSecrets: - type: array - items: - type: string - configText: - type: string - towerConfig: - type: string - paramsText: - type: string - preRunScript: - type: string - postRunScript: - type: string - mainScript: - type: string - entryName: - type: string - schemaName: - type: string - resume: - type: boolean - pullLatest: - type: boolean - stubRun: - type: boolean - optimizationId: - type: string - optimizationTargets: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - launchContainer: - type: string - dateCreated: - type: string - format: date-time - WorkflowLaunchResponse: - type: object - properties: - id: - type: string - computeEnv: - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - pipeline: - type: string - pipelineId: - type: integer - format: int64 - workDir: - type: string - revision: - type: string - commitId: - type: string - sessionId: - type: string - configProfiles: - type: array - items: - type: string - userSecrets: - type: array - items: - type: string - workspaceSecrets: - type: array - items: - type: string - configText: - type: string - towerConfig: - type: string - paramsText: - type: string - preRunScript: - type: string - postRunScript: - type: string - mainScript: - type: string - entryName: - type: string - schemaName: - type: string - resume: - type: boolean - pullLatest: - type: boolean - stubRun: - type: boolean - resumeDir: - type: string - resumeCommitId: - type: string - headJobMemoryMb: - type: integer - format: int32 - headJobCpus: - type: integer - format: int32 - optimizationId: - type: string - optimizationTargets: - type: string - dateCreated: - type: string - format: date-time - WorkflowLoad: - required: - - aborted - - cached - - cpuLoad - - cpuTime - - cpus - - failed - - ignored - - invCtxSwitch - - loadCpus - - loadMemory - - loadTasks - - memoryReq - - memoryRss - - peakCpus - - peakMemory - - peakTasks - - pending - - readBytes - - retries - - running - - submitted - - succeeded - - volCtxSwitch - - writeBytes - type: object - properties: - pending: - type: integer - format: int64 - submitted: - type: integer - format: int64 - running: - type: integer - format: int64 - succeeded: - type: integer - format: int64 - failed: - type: integer - format: int64 - cached: - type: integer - format: int64 - aborted: - type: integer - format: int64 - retries: - type: integer - format: int64 - ignored: - type: integer - format: int64 - memoryEfficiency: - type: number - format: float - cpuEfficiency: - type: number - format: float - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - version: - type: integer - format: int64 - executors: - type: array - items: - type: string - cpus: - type: integer - format: int64 - cpuTime: - type: integer - format: int64 - cpuLoad: - type: integer - format: int64 - memoryRss: - type: integer - format: int64 - memoryReq: - type: integer - format: int64 - readBytes: - type: integer - format: int64 - writeBytes: - type: integer - format: int64 - volCtxSwitch: - type: integer - format: int64 - invCtxSwitch: - type: integer - format: int64 - loadTasks: - type: integer - format: int64 - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakCpus: - type: integer - format: int64 - peakTasks: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - cost: - type: number - netCpus: - type: integer - format: int64 - netCpuTime: - type: integer - format: int64 - netCpuLoad: - type: integer - format: int64 - netMemoryRss: - type: integer - format: int64 - netMemoryReq: - type: integer - format: int64 - netMemoryConsumption: - type: number - netReadBytes: - type: integer - format: int64 - netWriteBytes: - type: integer - format: int64 - netVolCtxSwitch: - type: integer - format: int64 - netInvCtxSwitch: - type: integer - format: int64 - netCost: - type: number - WorkflowLogResponse: - type: object - properties: - log: - $ref: "#/components/schemas/LogPage" - WorkflowMetrics: - required: - - process - type: object - properties: - id: - type: integer - format: int64 - nullable: true - process: - maxLength: 255 - type: string - cpu: - $ref: "#/components/schemas/ResourceData" - mem: - $ref: "#/components/schemas/ResourceData" - vmem: - $ref: "#/components/schemas/ResourceData" - time: - $ref: "#/components/schemas/ResourceData" - reads: - $ref: "#/components/schemas/ResourceData" - writes: - $ref: "#/components/schemas/ResourceData" - cpuUsage: - $ref: "#/components/schemas/ResourceData" - memUsage: - $ref: "#/components/schemas/ResourceData" - timeUsage: - $ref: "#/components/schemas/ResourceData" - WorkflowQueryAttribute: - type: string - enum: - - optimized - - labels - - messages - - minimal - x-enum-varnames: - - optimized - - labels - - messages - - minimal - WorkflowStatus: - type: string - enum: - - SUBMITTED - - RUNNING - - SUCCEEDED - - FAILED - - CANCELLED - - UNKNOWN - Workspace: - required: - - fullName - - name - - visibility - type: object - properties: - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - fullName: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - visibility: - $ref: "#/components/schemas/Visibility" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - WorkspaceDbDto: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - fullName: - type: string - description: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - WspRole: - type: string - enum: - - owner - - admin - - maintain - - launch - - connect - - view - x-enum-varnames: - - owner - - admin - - maintain - - launch - - connect - - view - securitySchemes: - BearerAuth: - type: http - scheme: bearer - bearerFormat: jwt diff --git a/platform-api-docs/scripts/specs/seqera-api-latest-decorated-mi.yaml b/platform-api-docs/scripts/specs/seqera-api-latest-decorated-mi.yaml deleted file mode 100644 index 7eac078e5..000000000 --- a/platform-api-docs/scripts/specs/seqera-api-latest-decorated-mi.yaml +++ /dev/null @@ -1,14302 +0,0 @@ -openapi: 3.0.1 -info: - title: Seqera API - description: Seqera Platform services API - contact: - url: https://seqera.io - email: info@seqera.io - version: 1.66.0 -tags: - - name: actions - description: Pipeline actions - - name: avatars - description: Avatars - - name: compute-envs - description: Compute environments - - name: credentials - description: Credentials - - name: data-links - description: Cloud storage directory paths in Data Explorer - - name: datasets - description: Pipeline input datasets (samplesheets) in CSV or TSV format - - name: ga4gh - description: GA4GH workflow execution service runs - - name: labels - description: Labels and resource labels - - name: launch - description: Workflow launch events - - name: orgs - description: Organizations - - name: pipelines - description: Pipelines - - name: pipeline-secrets - description: Pipeline secrets in a user or workspace context - - name: platforms - description: Computing platforms - - name: service-info - description: Seqera Platform API service information - - name: studios - description: Studios and Studio sessions - - name: teams - description: Teams in an organization context - - name: tokens - description: API access tokens - - name: trace - description: Workflow execution traces - - name: users - description: Users - - name: workflows - description: Workflow executions - - name: workspaces - description: Workspaces in an organization context -paths: - /actions: - get: - tags: - - actions - summary: List actions - description: "Lists all available actions in a user context, enriched by `attributes`. Append `?workspaceId` to list actions in a workspace context." - operationId: ListActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ActionQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListActionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - actions - summary: Create action - description: Creates a new pipeline action. Append `?workspaceId` to associate the action with the given workspace. - operationId: CreateAction - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateActionRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/add: - post: - tags: - - labels - summary: Add labels to actions - description: Adds the given list of labels to the given pipeline actions. Existing labels are preserved. - operationId: AddLabelsToActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/apply: - post: - tags: - - labels - summary: Replace action labels - description: Applies the given list of labels to the given pipeline actions. Existing labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/remove: - post: - tags: - - labels - summary: Remove labels from actions - description: Removes the given list of labels from the given pipeline actions. - operationId: RemoveLabelsFromActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/types: - get: - tags: - - actions - summary: List action event types - description: Lists the supported event types that trigger a pipeline action. Append `?workspaceId` to list event types in a workspace context. - operationId: ListActionTypes - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListEventTypesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/validate: - get: - tags: - - actions - summary: Validate action name - description: Confirms the validity of the given action name. Append `?name=`. - operationId: ValidateActionName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Action name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /actions/{actionId}: - get: - tags: - - actions - summary: Describe action - description: Retrieves the details of the action identified by the given `actionId`. - operationId: DescribeAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ActionQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - actions - summary: Update action - description: Updates the details of the action identified by the given `actionId`. The `source` of an existing action cannot be changed. - operationId: UpdateAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateActionRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - actions - summary: Delete action - description: Deletes the pipeline action identified by the given `actionId`. - operationId: DeleteAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/{actionId}/launch: - post: - tags: - - actions - summary: Trigger Tower Launch action - description: Triggers the execution of the Tower Launch action identified by the given `actionId`. - operationId: LaunchAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action launch request - content: - application/json: - schema: - $ref: "#/components/schemas/LaunchActionRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/LaunchActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/{actionId}/pause: - post: - tags: - - actions - summary: Pause or resume action - description: Pauses or resumes the pipeline action identified by the given `actionId`. - operationId: PauseAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /avatars: - post: - tags: - - avatars - summary: Create the avatar image - operationId: CreateAvatar - requestBody: - description: Image file request - content: - multipart/form-data: - schema: - type: object - properties: - image: - type: string - format: binary - encoding: - image: - contentType: application/octet-stream - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAvatarResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /avatars/{avatarId}: - get: - tags: - - avatars - summary: Download the avatar image - operationId: DownloadAvatar - parameters: - - name: avatarId - in: path - description: Avatar string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found element - security: - - BearerAuth: [] - /compute-envs: - get: - tags: - - compute-envs - summary: List compute environments - description: "Lists all available compute environments in a user context. Append `?workspaceId` to list compute environments in a workspace context, and `?status` to filter by compute environment status." - operationId: ListComputeEnvs - parameters: - - name: status - in: query - description: Filter by compute environment status. - schema: - type: string - enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID", "CREATING", "AVAILABLE", "ERRORED", "INVALID"] - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, lists compute environments in a user context. - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListComputeEnvsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - compute-envs - summary: Create compute environment - description: Creates a new compute environment. Append `?workspaceId` to create the environment in a workspace context. - operationId: CreateComputeEnv - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, creates compute environment in a user context. - schema: - type: integer - format: int64 - requestBody: - description: Compute environment create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateComputeEnvRequest" - examples: - AwsBatchForge: - description: "A minimal AWS Batch Forge compute environment with Wave and Fusion enabled." - value: - computeEnv: - name: "aws-batch-ce" - platform: "aws-batch" - credentialsId: "your-aws-credentials-id" - description: "Minimal AWS Batch Forge compute environment with Wave, Fusion, and fast instance storage enabled" - config: - region: "eu-west-2" - forge: - type: "SPOT" - minCpus: "0" - maxCpus: "100" - workDir: "s3://your-bucket/work" - waveEnabled: "true" - fusion2Enabled: "true" - nvnmeStorageEnabled: "true" - AwsCloud: - description: "Minimal AWS Cloud compute environment with default instance type and AMI" - value: - computeEnv: - name: "aws-cloud-ce" - description: "Minimal AWS Cloud compute environment with default instance type and AMI" - platform: "aws-cloud" - credentialsId: "your-aws-credentials-id" - config: - region: "eu-west-2" - workDir: "s3://your-bucket/work" - GoogleBatch: - description: "Minimal Google Cloud Batch compute environment with Wave and Fusion enabled" - value: - computeEnv: - name: "google-batch-ce" - description: "Minimal Google Cloud Batch compute environment with Wave and Fusion enabled" - platform: "google-batch" - credentialsId: "your-google-credentials-id" - config: - location: "europe-west2" - workDir: "gs://your-bucket/work" - spot: true - waveEnabled: true - fusion2Enabled: true - GoogleCloud: - description: "Minimal Google Cloud compute environment with default instance type and image ID" - value: - computeEnv: - name: "google-cloud-ce" - description: "Minimal Google Cloud compute environment with default instance type and image ID" - platform: "google-cloud" - credentialsId: "your-google-credentials-id" - config: - region: "europe-west2" - workDir: "gs://your-bucket/work" - AzureBatchForge: - description: "Minimal Azure Batch Forge compute environment with Wave and Fusion enabled" - value: - computeEnv: - name: "azure-batch-ce" - description: "Minimal Azure Batch Forge compute environment with Wave and Fusion enabled" - platform: "azure-batch" - credentialsId: "your-azure-credentials-id" - config: - region: "eastus" - workDir: "az://your-storage-account/work" - forge: - vmCount: 50 - autoScale: true - waveEnabled: true - fusion2Enabled: true - AwsEks: - description: "Minimal AWS EKS compute environment with Fusion storage" - value: - computeEnv: - name: "aws-eks-ce" - description: "Minimal AWS EKS compute environment with Fusion storage" - platform: "eks-platform" - credentialsId: "your-aws-credentials-id" - config: - region: "eu-west-2" - workDir: "s3://your-bucket/work" - clusterName: "your-cluster-name" - namespace: "your-namespace" - headServiceAccount: "your-service-account" - waveEnabled: "true" - fusion2Enabled: "true" - GoogleGke: - description: "Minimal Google Kubernetes Engine compute environment with Fusion storage" - value: - computeEnv: - name: "gke-ce" - description: "Minimal Google Kubernetes Engine compute environment with Fusion storage" - platform: "gke-platform" - credentialsId: "your-google-credentials-id" - config: - region: "europe-west2" - workDir: "gs://your-bucket/work" - clusterName: "your-cluster-name" - namespace: "your-namespace" - headServiceAccount: "your-service-account" - waveEnabled: "true" - fusion2Enabled: "true" - Kubernetes: - description: "Minimal Kubernetes compute environment with persistent volume storage" - value: - computeEnv: - name: "k8s-ce" - description: "Minimal Kubernetes compute environment with persistent volume storage" - platform: "k8s-platform" - credentialsId: "your-k8s-credentials-id" - config: - workDir: "/workspace" - server: "https://your-k8s-api-server:6443" - sslCert: "-----BEGIN CERTIFICATE-----\nYOUR_CERTIFICATE\n-----END CERTIFICATE-----" - namespace: "your-namespace" - headServiceAccount: "your-service-account" - storageClaimName: "your-storage-claim" - storageMountPath: "/workspace" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateComputeEnvResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /compute-envs/validate: - get: - tags: - - compute-envs - summary: Validate compute environment name - description: Confirms the validity of the given compute environment name in a user context. Append `?name=`. - operationId: ValidateComputeEnvName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, validates compute environment name in a user context. - schema: - type: integer - format: int64 - - name: name - in: query - description: Compute environment name to validate for uniqueness and format. - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /compute-envs/{computeEnvId}: - get: - tags: - - compute-envs - summary: Describe compute environment - description: Retrieves the details of the compute environment identified by the given `computeEnvId`. - operationId: DescribeComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment alphanumeric identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response. Returns `labels: null` if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ComputeEnvQueryAttribute" - type: string - enum: ["labels", "labels"] - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeComputeEnvResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - compute-envs - summary: Update compute environment - description: Updates the details of the compute environment identified by the given `computeEnvId`. - operationId: UpdateComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment alphanumeric identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - requestBody: - description: Compute environment update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateComputeEnvRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - compute-envs - summary: Delete compute environment - description: Deletes the compute environment identified by the given `computeEnvId`. - operationId: DeleteComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment alphanumeric identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Conflicting deletion - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /compute-envs/{computeEnvId}/primary: - post: - tags: - - compute-envs - summary: Define primary compute environment - description: Selects the compute environment identified by the given `computeEnvId` as the primary compute environment in the given workspace context. - operationId: UpdateComputeEnvPrimary - parameters: - - name: computeEnvId - in: path - description: Compute environment alphanumeric identifier. - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /credentials: - get: - tags: - - credentials - summary: List credentials - description: "Lists all available credentials in a user context. Append `?workspaceId` to list credentials in a workspace context, and `?platformId` to filter credentials by computing platform." - operationId: ListCredentials - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: platformId - in: query - description: Platform string identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - credentials - summary: Create credentials - description: Creates new credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. - operationId: CreateCredentials - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Credentials create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCredentialsRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /credentials/validate: - get: - tags: - - credentials - summary: Validate credential name - description: Validates the given credentials name. Append `?name=`. - operationId: ValidateCredentialsName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Credentials name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /credentials/{credentialsId}: - get: - tags: - - credentials - summary: Describe credentials - description: Retrieves the details of the credentials identified by the given `credentialsId`. - operationId: DescribeCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - credentials - summary: Update credentials - description: Updates the details of the credentials identified by the given `credentialsId`. - operationId: UpdateCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Credentials update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateCredentialsRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - credentials - summary: Delete credentials - description: Deletes the credentials identified by the given `credentialsId`. - operationId: DeleteCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: checked - in: query - description: If set credentials deletion will be blocked by running jobs that depend on them - schema: - type: boolean - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this credentials - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteCredentialsConflictResponse" - security: - - BearerAuth: [] - /data-links: - get: - tags: - - data-links - summary: List data-links - description: | - Retrieves all available data-links in a user context. Append `?workspaceId={your-workspace-id}` to retrieve data-links in a workspace context. - operationId: ListDataLinks - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials identifier - schema: - type: string - - name: search - in: query - description: "Free text search criteria — data-link name and keywords: `region`, `provider`." - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: visibility - in: query - description: Filter results by visibility - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinksListResponse" - "202": - description: Accepted - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinksListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, or the API is disabled in the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - data-links - summary: Create data-link - description: Creates a new data-link in a user context. Append `?workspaceId=` to create the data-link in a workspace context. - operationId: CreateCustomDataLink - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Data-link creation request - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkCreateRequest" - required: true - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled in the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/cache/refresh: - get: - tags: - - data-links - summary: Refresh data-link cache - description: Refreshes the data-link cache for the given `workspaceId` or `credentialsId` - operationId: RefreshDataLinkCache - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - responses: - "200": - description: OK - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}: - get: - tags: - - data-links - summary: Describe data-link - description: Retrieves the details of the data-link associated with the given `dataLinkId`. - operationId: DescribeDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - data-links - summary: Update data-link - description: Update the data-link associated with the given `dataLinkId`. - operationId: UpdateCustomDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Data-link update request - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkUpdateRequest" - required: true - responses: - "200": - description: Success — Data-link updated - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - data-links - summary: Delete data-link - description: Deletes the data-link associated with the given `dataLinkId`. - operationId: DeleteCustomDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: Success — Data-link deleted - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "204": - description: DeleteCustomDataLink 204 response - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse: - get: - tags: - - data-links - summary: Explore data-link path - description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." - operationId: ExploreDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: path - in: path - description: Content path - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: search - in: query - description: Prefix search of data-link content - schema: - type: string - - name: nextPageToken - in: query - description: Token used to fetch the next page of items - schema: - type: string - - name: pageSize - in: query - description: "Number of items to return per page. If ommitted, a default maximum value is returned." - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse-tree: - get: - tags: - - data-links - summary: Explore a data-link tree - description: Provides a list of all files in the provided paths (including files in sub-paths). - operationId: ExploreDataLinkTree - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: paths - in: query - description: List of paths - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentTreeListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse/{path}: - get: - tags: - - data-links - summary: Explore data-link path - description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." - operationId: ExploreDataLink_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: path - in: path - description: Content path - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: search - in: query - description: Prefix search of data-link content - schema: - type: string - - name: nextPageToken - in: query - description: Token used to fetch the next page of items - schema: - type: string - - name: pageSize - in: query - description: "Number of items to return per page. If ommitted, a default maximum value is returned." - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/content: - delete: - tags: - - data-links - summary: Delete data-link content - description: Deletes the content of the data-link associated with the given `dataLinkId`. The data-link itself is preserved. - operationId: DeleteDataLinkItem - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDeleteItemRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDeleteItemResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/download: - get: - tags: - - data-links - summary: Download data-link file at path - description: Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`. - operationId: DownloadDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: filePath - in: path - description: File path to download - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/generate-download-url: - get: - tags: - - data-links - summary: Generate data-link file download URL - description: Returns a URL to download files from the data-link associated with the given `dataLinkId`. - operationId: GenerateDownloadUrlDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: filePath - in: query - description: File path to download - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: preview - in: query - description: "Whether to generate the URL for preview purposes or direct download (default: false)" - schema: - type: boolean - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDownloadUrlResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/script/download: - get: - tags: - - data-links - summary: Generate download script - description: Creates a script to download files from the data-link associated with the given `dataLinkId`. Append `?dirs` or `?files` to specify a list of files or paths to download within the data-link. - operationId: GenerateDownloadScript - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: dirs - in: query - description: List of paths to directories to download - schema: - type: array - items: - type: object - - name: files - in: query - description: List of paths to files to download - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDownloadScriptResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload: - post: - tags: - - data-links - summary: Generate data-link file upload URL (to given path) - description: |- - Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). - For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - operationId: GenerateDataLinkUploadUrl - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: Origin - in: header - schema: - type: string - nullable: true - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/finish: - post: - tags: - - data-links - summary: Finish data-link file upload to given path - description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." - operationId: FinishDataLinkUpload - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkFinishMultiPartUploadRequest" - required: true - responses: - "202": - description: No content - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "200": - description: FinishDataLinkUpload 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/finish/{dirPath}: - post: - tags: - - data-links - summary: Finish data-link file upload to given path - description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." - operationId: FinishDataLinkUpload_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkFinishMultiPartUploadRequest" - required: true - responses: - "202": - description: No content - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "200": - description: FinishDataLinkUpload_1 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/{dirPath}: - post: - tags: - - data-links - summary: Generate data-link file upload URL (to given path) - description: |- - Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). - For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - operationId: GenerateDataLinkUploadUrl_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: Origin - in: header - schema: - type: string - nullable: true - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets: - get: - tags: - - datasets - summary: List datasets - description: Lists all available datasets in a user context. Append `?workspaceId` to list datasets in a workspace context. - operationId: ListDatasetsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - datasets - summary: Create dataset - description: Creates a new dataset in the user context. Include the dataset file and details in your request body. Append `?workspaceId` to create the dataset in a workspace context. - operationId: CreateDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Dataset create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /datasets/versions: - get: - tags: - - datasets - summary: List latest dataset versions - description: Lists the latest version of each dataset in the user context. Append `?workspaceId` to list latest versions in a workspace context. - operationId: ListLatestDatasetVersionsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: mimeType - in: query - description: Dataset MIME type - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}: - put: - tags: - - datasets - summary: Update dataset - description: Updates the details of the dataset identified by the given `datasetId`. - operationId: UpdateDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - requestBody: - description: Dataset update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateDatasetRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - datasets - summary: Delete dataset - description: Deletes the dataset identified by the given `datasetId`. - operationId: DeleteDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/metadata: - get: - tags: - - datasets - summary: Describe dataset - description: Retrieves the metadata of the dataset identified by the given `datasetId`. - operationId: DescribeDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/upload: - post: - tags: - - datasets - summary: Upload new dataset version - description: Uploads the CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. - operationId: UploadDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: header - in: query - description: Uploaded file has header - schema: - type: boolean - requestBody: - description: Dataset file request - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/MultiRequestFileSchema" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UploadDatasetVersionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/v/{version}/n/{fileName}: - get: - tags: - - datasets - summary: Download dataset content - description: Downloads the content of the dataset identified by the given `datasetId` and `version`. - operationId: DownloadDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: version - in: path - description: Version number to download - required: true - schema: - type: string - - name: fileName - in: path - description: File name for the downloaded dataset content - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /datasets/{datasetId}/versions: - get: - tags: - - datasets - summary: List all dataset versions - description: Lists all versions of the given `datasetId`. - operationId: ListDatasetVersionsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: mimeType - in: query - description: Optional MIME type filter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /ga4gh/wes/v1/runs: - get: - tags: - - ga4gh - summary: "GA4GH: List runs" - description: Uses the GA4GH workflow execution service API to list all run records. - operationId: Ga4ghRunList - parameters: - - name: page_size - in: query - description: Page size - schema: - type: integer - format: int32 - - name: page_token - in: query - description: Page token - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunListResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - post: - tags: - - ga4gh - summary: "GA4GH: Launch run" - description: "Uses the GA4GH workflow execution service API to launch a new run. Runs are launched in the user workspace context by default. To launch in an organization workspace context, include the `workspaceId` in `workflow_engine_parameters`. Runs are launched with the workspace primary compute environment by default. To launch with a different compute environment, include the `computeEnvId` in `workflow_engine_parameters`." - operationId: Ga4ghRunCreate - requestBody: - description: Run request - content: - application/json: - schema: - $ref: "#/components/schemas/RunRequest" - multipart/form-data: - schema: - $ref: "#/components/schemas/RunRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunId" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}: - get: - tags: - - ga4gh - summary: "GA4GH: Describe run" - description: Uses the GA4GH workflow execution service API to retrieve the details of the run assoiated with the given `run_id`. - operationId: Ga4ghRunDescribe - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunLog" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}/cancel: - post: - tags: - - ga4gh - summary: "GA4GH: Cancel run" - description: Uses the GA4GH workflow execution service API to cancel the run associated with the given `run_id`. - operationId: Ga4ghRunCancel - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunId" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}/status: - get: - tags: - - ga4gh - summary: "GA4GH: Retrieve run status" - description: Uses the GA4GH workflow execution service API to retrieve the status of the run associated with the given `run_id`. - operationId: Ga4ghRunStatus - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunStatus" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/service-info: - get: - tags: - - ga4gh - summary: GA4GH workflow execution service API info - operationId: Ga4ghServiceInfo - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ServiceInfo" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /identities: - get: - tags: - - identities - summary: List managed identities - description: Lists all available managed identities in an organization context. To list the managed identities for an organization other than the requester's default, append an `?orgId`. Only organizations accessible to the requester's access token can be queried. - operationId: ListManagedIdentities - parameters: - - name: orgId - in: query - description: Organization numeric identifier. Append to list managed identities within an organization other than the requester's default. - schema: - type: integer - format: int64 - - name: search - in: query - description: "Filter search parameter. Supports free text search on name and keywords: `platform:`." - schema: - type: string - nullable: true - - name: max - in: query - description: 'Maximum number of results to return. Default: `20`.' - schema: - type: integer - format: int32 - nullable: true - - name: offset - in: query - description: 'Number of results to skip for pagination. Default: `0`.' - schema: - type: integer - format: int32 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListManagedIdentitiesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - identities - summary: Create managed identity - description: Creates a new managed identity in an organization context. Managed identities enable centralized credential management for HPC environments. - operationId: CreateManagedIdentity - parameters: - - name: orgId - in: query - description: Organization numeric identifier. Append to create managed identity within an organization other than the requester's default. - schema: - type: integer - format: int64 - requestBody: - description: Managed identity create request. - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /identities/{managedIdentityId}: - get: - tags: - - identities - summary: Describe managed identity - description: Retrieves the details of the managed identity associated with the given `managedIdentityId`. - operationId: DescribeManagedIdentity - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - identities - summary: Update managed identity - description: Updates the details of the managed identity associated with the given `managedIdentityId`. - operationId: UpdateManagedIdentity - parameters: - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - requestBody: - description: Managed identity update request. - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateManagedIdentityRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - identities - summary: Delete managed identity - description: Deletes the managed identity associated with the given `managedIdentityId`. To optionally check whether the deletion will be blocked by running jobs that depend on associated managed credentials, append `?checked=true`. - operationId: DeleteManagedIdentity - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - - name: checked - in: query - description: 'If `true`, deletion is blocked if running jobs depend on associated managed credentials. Default: `false`.' - schema: - type: boolean - nullable: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this Managed Identity - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse" - security: - - BearerAuth: [] - /identities/{managedIdentityId}/credentials: - get: - tags: - - identities - summary: List managed credentials - description: Lists all managed credentials associated with the given `managedIdentityId`. Filter by user with `?userId`. - operationId: ListManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - - name: userId - in: query - description: User numeric identifier. Filter managed credentials by specific user. - schema: - type: integer - format: int64 - nullable: true - - name: search - in: query - description: "Filter search parameter. Supports free text search on `userName`, `firstName + lastName`, and keywords: `is:missing`, `is:added`." - schema: - type: string - - name: max - in: query - description: 'Maximum number of results to return. Default: `20`.' - schema: - type: integer - format: int32 - - name: offset - in: query - description: 'Number of results to skip for pagination. Default: `0`.' - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListManagedCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - identities - summary: Create managed credentials - description: Creates new managed credentials for the given `managedIdentityId`. To associate the credentials with a user other than the requester, append the `?userId`. - operationId: CreateManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - - name: userId - in: query - description: User numeric identifier. Append to associate managed credentials with a user other than the requester. - schema: - type: integer - format: int64 - nullable: true - requestBody: - description: Managed credentials create request, including provider type and authentication details. - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedCredentialsRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /identities/{managedIdentityId}/credentials/{managedCredentialsId}: - put: - tags: - - identities - summary: Update managed credentials - description: Updates the managed credentials identified by the given `managedCredentialsId` within the given `managedIdentityId`. - operationId: UpdateManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: managedCredentialsId - in: path - description: Managed credentials numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - requestBody: - description: Managed credentials update request. - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateManagedCredentialsRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - identities - summary: Delete managed credentials - description: Deletes the managed credentials identified by the given `managedCredentialsId` from the associated `managedIdentityId`. To optionally check whether the deletion will be blocked by running jobs that depend on the managed credentials, append `?checked=true`. - operationId: DeleteManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed identity numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: managedCredentialsId - in: path - description: Managed credentials numeric identifier. - required: true - schema: - type: integer - format: int64 - nullable: true - - name: orgId - in: query - description: Organization numeric identifier. - schema: - type: integer - format: int64 - - name: checked - in: query - description: 'If `true`, deletion is blocked if running jobs depend on the given managed credentials. Default: `false`.' - schema: - type: boolean - nullable: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this Managed Credentials - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse" - security: - - BearerAuth: [] - /labels: - get: - tags: - - labels - summary: List labels - description: Lists all available labels in a user context. Append `?workspaceId` to list labels in a workspace context. - operationId: ListLabels - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - - name: type - in: query - description: Label type - schema: - $ref: "#/components/schemas/LabelType" - - name: isDefault - in: query - description: Label default flag - schema: - type: boolean - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListLabelsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - labels - summary: Create label - description: "Creates a new label or returns an existing label based on name/value. By default the operation works in a user context, append `?workspaceId` to create/retrieve a label in a workspace context. Resource labels include `resource: true` and a `value`." - operationId: CreateLabel - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: "Provide a label `name`. Set `resource: true` for resource labels. Only resource labels have a `value` — if `resource: true`, include a `value`. Else, omit `value` from your request body." - content: - application/json: - schema: - $ref: "#/components/schemas/CreateLabelRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateLabelResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /labels/dynamic/allowed: - get: - tags: - - labels - operationId: GetAllowedDynamicLabels - responses: - "200": - description: Ok - content: - application/json: - schema: - $ref: "#/components/schemas/AllowedDynamicLabelsResponse" - "400": - description: Bad Request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /labels/{labelId}: - put: - tags: - - labels - summary: Update label - description: Updates the label identified by the given `labelId`. - operationId: UpdateLabel - parameters: - - name: labelId - in: path - description: Label numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Label update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateLabelRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateLabelResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - labels - summary: Delete label - description: Deletes the label identified by the given `labelId`. - operationId: DeleteLabel - parameters: - - name: labelId - in: path - description: Label numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /launch/{launchId}: - get: - tags: - - launch - summary: Describe Launch record - description: Retrieves the details of the launch identified by the given `launchId`. - operationId: DescribeLaunch - parameters: - - name: launchId - in: path - description: Launch string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /launch/{launchId}/datasets: - get: - tags: - - datasets - summary: Describe launch datasets - description: Retrieves the details of the datasets used in the launch identified by the given `launchId`. - operationId: ListLaunchDatasetVersions - parameters: - - name: launchId - in: path - description: Launch string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs: - get: - tags: - - orgs - summary: List organizations - description: Lists all available organizations in a user context. - operationId: ListOrganizations - parameters: - - name: role - in: query - description: Organization user role identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListOrganizationsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - orgs - summary: Create organization - description: Creates a new organization. - operationId: CreateOrganization - requestBody: - description: Organization create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateOrganizationRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateOrganizationResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/validate: - get: - tags: - - orgs - summary: Validate organization name - description: Confirms the validity of the given organization name. Append `?name=`. - operationId: ValidateOrganizationName - parameters: - - name: name - in: query - description: Organization name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}: - get: - tags: - - orgs - summary: Describe organization - description: Retrieves the details of the organization identified by the given `orgId`. - operationId: DescribeOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeOrganizationResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - orgs - summary: Update organization - description: Updates the details of the organization identified by the given `orgId`. - operationId: UpdateOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Organization update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateOrganizationRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - orgs - summary: Delete organization - description: Deletes the organization identified by the given `orgId`. - operationId: DeleteOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/collaborators: - get: - tags: - - orgs - summary: List organization collaborators - description: Lists the collaborators of the organization identified by the given `orgId`. - operationId: ListOrganizationCollaborators - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members: - get: - tags: - - orgs - summary: List organization members - description: Lists the members of the organization identified by the given `orgId`. - operationId: ListOrganizationMembers - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/add: - put: - tags: - - orgs - summary: Add organization member - description: Adds a new member to the organization identified by the given `orgId`. - operationId: CreateOrganizationMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Member addition request - content: - application/json: - schema: - $ref: "#/components/schemas/AddMemberRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddMemberResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/members/leave: - delete: - tags: - - orgs - summary: Leave organization - description: Removes the requesting user from the organization identified by the given `orgId`. - operationId: LeaveOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/{memberId}: - delete: - tags: - - orgs - summary: Delete member - description: Deletes the member identified by the given `memberId`. - operationId: DeleteOrganizationMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Organization member numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/{memberId}/role: - put: - tags: - - orgs - summary: Update member role - description: Updates the role of the member identified by the given `memberId`. - operationId: UpdateOrganizationMemberRole - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Organization member numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Member role update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateMemberRoleRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/quotas: - get: - tags: - - orgs - summary: Describe organization quotas - description: Retrieves the details of the organization quotas identified by the given `orgId`. - operationId: DescribeOrganizationQuotas - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: include - in: query - description: Optional list of quota names to include - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeOrganizationQuotasResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams: - get: - tags: - - teams - summary: List organization teams - description: Lists all teams in the organization identified by the given `orgId`. - operationId: ListOrganizationTeams - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - teams - summary: Create team - description: Creates a new team in the organization identified by the given `orgId`. - operationId: CreateOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/teams/validate: - get: - tags: - - teams - summary: Validate team name - description: Confirms the validity of the given team name. Append `?name=`. - operationId: ValidateTeamName - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: name - in: query - description: Team name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}: - get: - tags: - - teams - summary: Describe team - description: Retrieves the details of the team identified by the given `teamId`. - operationId: DescribeOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - teams - summary: Update team - description: Updates the details of the team identified by the given `teamId`. - operationId: UpdateOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateTeamRequest" - required: true - responses: - "200": - description: OK - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "204": - description: UpdateOrganizationTeam 204 response - security: - - BearerAuth: [] - delete: - tags: - - teams - summary: Delete team - description: Deletes the team identified by the given `teamId`. - operationId: DeleteOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/members: - get: - tags: - - teams - summary: List team members - description: Lists the team members associated with the given `teamId`. - operationId: ListOrganizationTeamMembers - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - schema: - type: string - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - teams - summary: Create team member - description: Adds a new member to the team identified by the given `teamId`. - operationId: CreateOrganizationTeamMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamMemberRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddTeamMemberResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/members/{memberId}/delete: - delete: - tags: - - teams - summary: Delete team member - description: Deletes the team member identified by the given `memberId`. - operationId: DeleteOrganizationTeamMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Member numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/workspaces: - get: - tags: - - teams - summary: List team workspaces - description: Lists all the workspaces of which the given `teamId` is a participant. - operationId: ListWorkspacesByTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Search criteria - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesResponse" - "404": - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "400": - description: Bad Request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces: - get: - tags: - - workspaces - summary: List organization workspaces - description: Lists the organization workspaces in `orgId` to which the requesting user belongs. - operationId: ListWorkspaces - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - workspaces - summary: Create workspace - description: Creates a new organization workspace. - operationId: CreateWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkspaceRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/validate: - get: - tags: - - workspaces - summary: Validate workspace name - description: Confirms the validity of the given workspace name. Append `?name=`. - operationId: WorkspaceValidate - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: name - in: query - description: Workspace name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}: - get: - tags: - - workspaces - summary: Describe workspace - description: Retrieves the details of the workspace identified by the given `workspaceId`. - operationId: DescribeWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - workspaces - summary: Update workspace - description: Updates the details of the workspace identified by the given `workspaceId`. - operationId: UpdateWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicate name - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workspaces - summary: Delete workspace - description: Deletes the workspace identified by the given `workspaceId`. - operationId: DeleteWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants: - get: - tags: - - workspaces - summary: List workspace participants - description: Lists the participants of the workspace identified by the given `workspaceId`. - operationId: ListWorkspaceParticipants - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListParticipantsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workspaces - summary: Leave workspace - description: Removes the requesting user from the given workspace. - operationId: LeaveWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/add: - put: - tags: - - workspaces - summary: Create workspace participant - description: Adds a new participant to the workspace identified by the given `workspaceId`. - operationId: CreateWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Participant addition request - content: - application/json: - schema: - $ref: "#/components/schemas/AddParticipantRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddParticipantResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/{participantId}: - delete: - tags: - - workspaces - summary: Delete workspace participant - description: Deletes the given participant from the given workspace. - operationId: DeleteWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: participantId - in: path - description: Participant numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/{participantId}/role: - put: - tags: - - workspaces - summary: Update participant role - description: Updates the role of the given participant in the given workspace. - operationId: UpdateWorkspaceParticipantRole - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: participantId - in: path - description: Participant numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Participant role update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateParticipantRoleRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/settings/studios: - get: - tags: - - workspaces - summary: List workspace Studios settings - description: Retrieves the Studios settings of the workspace identified by the given `workspaceId`. - operationId: FindDataStudiosWorkspaceSettings - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioWorkspaceSettingsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - put: - tags: - - workspaces - summary: Update workspace Studios settings - description: Updates the Studios settings of the workspace identified by the given `workspaceId`. - operationId: UpdateDataStudiosWorkspaceSettings - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "200": - description: UpdateDataStudiosWorkspaceSettings 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /pipeline-secrets: - get: - tags: - - pipeline-secrets - summary: List pipeline secrets - description: Lists all available pipeline secrets in a user context. Append `?workspaceId` to list secrets in a workspace context. - operationId: ListPipelineSecrets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelineSecretsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - pipeline-secrets - summary: Create pipeline secret - description: Creates a new pipeline secret in the user context. Append `?workspaceId` to create the secret in a workspace context. - operationId: CreatePipelineSecret - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Pipeline secret create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineSecretRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineSecretResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipeline-secrets/validate: - get: - tags: - - pipeline-secrets - summary: Validate secret name - description: Confirms the validity of the given pipeline secret name in a user context. Append `?name=`. Append `?workspaceId` to validate the name in a workspace context. - operationId: ValidatePipelineSecretName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Secret name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipeline-secrets/{secretId}: - get: - tags: - - pipeline-secrets - summary: Describe pipeline secret - description: Retrieves the details of the pipeline secret identified by the given `secretId`. - operationId: DescribePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineSecretResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - pipeline-secrets - summary: Update secret - description: Updates the pipeline secret identified by the given `secretId`. - operationId: UpdatePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Secret update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineSecretRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - pipeline-secrets - summary: Delete secret - description: Deletes the pipeline secret identified by the given `secretId`. - operationId: DeletePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines: - get: - tags: - - pipelines - summary: List pipelines - description: "Lists all available pipelines in a user context, enriched by `attributes`. Append `workspaceId` to list pipelines in a workspace context." - operationId: ListPipelines - parameters: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`, `optimized`, `computeEnv`). Returns empty values if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, lists pipelines in a user context. - schema: - type: integer - format: int64 - - name: max - in: query - description: 'Maximum number of results to return (pagination). Default: `50`, Maximum: `100`.' - schema: - type: integer - format: int32 - - name: offset - in: query - description: 'Number of results to skip for pagination. Default: `0`.' - schema: - type: integer - format: int32 - - name: search - in: query - description: Search string to filter pipelines by name or description. - schema: - type: string - - name: visibility - in: query - description: 'Filter pipelines by visibility. Valid values: `private`, `shared`, `all`.' - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelinesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - pipelines - summary: Create pipeline - description: Creates a new pipeline in a user context. Append `?workspaceId` to create the pipeline in a workspace context. - operationId: CreatePipeline - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, creates pipeline in a user context. - schema: - type: integer - format: int64 - requestBody: - description: Pipeline creation request - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineRequest" - examples: - BasicPipelineCreation: - summary: "Create a pipeline with nf-core/rnaseq" - description: "Minimal pipeline creation request using nf-core/rnaseq with the `test_full` configuration profile." - value: - name: "rnaseq-pipeline" - description: "Minimal nf-core/rnaseq pipeline configuration with the `test_full` profile." - launch: - pipeline: "https://github.com/nf-core/rnaseq" - computeEnvId: "your-compute-env-id" - revision: "master" - configProfiles: - - "test_full" - labelIds: - - "label_id_1" - - "label_id_2" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipelines/info: - get: - tags: - - pipelines - summary: Describe remote pipeline repository - description: Retrieves the details of a remote Nextflow pipeline Git repository. Append the repository name or full URL with `?name`. - operationId: DescribePipelineRepository - parameters: - - name: name - in: query - description: Pipeline repository name (e.g., `nextflow-io/hello`) or full URL. - schema: - type: string - - name: revision - in: query - description: 'Git revision, branch, or tag to describe. Default: repository default branch.' - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, describes pipeline in a user context. - schema: - type: integer - format: int64 - - name: mainScript - in: query - description: 'Alternative main script filename. Default: `main.nf`.' - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/add: - post: - tags: - - labels - summary: Add labels to pipelines - description: Adds the given list of labels to the given pipelines. Existing labels are preserved. - operationId: AddLabelsToPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/apply: - post: - tags: - - labels - summary: Replace pipeline labels - description: Applies the given list of labels to the given pipelines. Existing labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/remove: - post: - tags: - - labels - summary: Remove labels from pipelines - description: Removes the given list of labels from the given pipelines. - operationId: RemoveLabelsFromPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/repositories: - get: - tags: - - pipelines - summary: List user pipeline repositories - description: "Lists known Nextflow pipeline Git repositories, extracted from existing runs. Append `?workspaceId` to list repositories in a workspace context." - operationId: ListPipelineRepositories - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, lists repositories in a user context. - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelineInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/validate: - get: - tags: - - pipelines - summary: Validate pipeline name - description: Confirms the validity of the given pipeline `name` in a user context. Append `?name=`. Append `?workspaceId` to validate the name in a workspace context. - operationId: ValidatePipelineName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier. If omitted, validates pipeline name in a user context. - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier. Used for organization-level validation. - schema: - type: integer - format: int64 - - name: name - in: query - description: Pipeline name to validate for uniqueness and format. - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipelines/{pipelineId}: - get: - tags: - - pipelines - summary: Describe pipeline - description: "Retrieves the details of the pipeline identified by the given `pipelineId`, enriched by `attributes`." - operationId: DescribePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns empty values if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace. - required: false - schema: - type: integer - format: int64 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - pipelines - summary: Update pipeline - description: "Updates the details of the pipeline identified by the given `pipelineId`. \n **Note**: If `labelIds` is `null`, empty, or ommitted, existing pipeline labels are removed.\n Include `labelIds: [,]` to override existing labels. Labels to be preserved must be included.\n To append a list of labels to multiple pipelines, use `/pipelines/labels/add`." - operationId: UpdatePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - requestBody: - description: Pipeline update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - pipelines - summary: Delete pipeline - description: Deletes the pipeline identified by the given `pipelineId`. - operationId: DeletePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/{pipelineId}/launch: - get: - tags: - - pipelines - summary: Describe pipeline launch - description: Retrieves the launch details of the pipeline identified by the given `pipelineId`. - operationId: DescribePipelineLaunch - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace. - required: false - schema: - type: integer - format: int64 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/{pipelineId}/schema: - get: - tags: - - pipelines - summary: Describe pipeline schema - description: "Retrieves the pipeline schema of the pipeline identified by the given `pipelineId`, enriched by `attributes`.\n `200 - OK` responses include the pipeline schema.\n `204 - OK` responses indicate a successful request, with no saved schema found for the given pipeline ID.\n " - operationId: DescribePipelineSchema - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier. - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace. - required: false - schema: - type: integer - format: int64 - nullable: true - - name: attributes - in: query - description: "Attribute values to include in the response. `schema` returns the pipeline schema, `params` returns the pipeline config. Returns all if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineSchemaAttributes" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/PipelineSchemaResponse" - "204": - description: Request OK - No schema found for given pipeline ID - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms: - get: - tags: - - platforms - summary: List platforms - description: Lists all available computing platforms in a user context. Append `?workspaceId` to list platforms in a workspace context. - operationId: ListPlatforms - parameters: - - name: orgId - in: query - description: Organization numeric identifier - required: false - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - required: false - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPlatformsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms/{platformId}: - get: - tags: - - platforms - summary: Describe platform - description: Retrieves the details of the computing platform identified by the given `platformId`. - operationId: DescribePlatform - parameters: - - name: platformId - in: path - description: Platform string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: regionId - in: query - required: true - schema: - type: string - - name: credentialsId - in: query - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePlatformResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms/{platformId}/regions: - get: - tags: - - platforms - summary: List platform regions - description: Lists the available regions for the computing platform identified by the given `platformId`. - operationId: ListPlatformRegions - parameters: - - name: platformId - in: path - description: Platform string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListRegionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /service-info: - get: - tags: - - service-info - summary: General Seqera service features and version. - operationId: Info - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ServiceInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - /studios: - get: - tags: - - studios - summary: List Studios - description: Lists all available Studios in a user context. Append `?workspaceId` to list Studios in a workspace context. - operationId: ListDataStudios - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: search - in: query - description: "Optional search criteria, allowing free text search on name and templateUrl and keywords: `userId`, `computeEnvId` and `status`." - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: attributes - in: query - description: "Optional attribute values to be included in the response (`labels`). Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/DataStudioQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the workspace is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - post: - tags: - - studios - summary: Create Studio - description: "Creates a new Studio environment, starting it by default. Default behavior can be changed using the query parameter `autoStart=false`." - operationId: CreateDataStudio - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: autoStart - in: query - description: Optionally disable the Studio's automatic launch when it is created. - schema: - type: boolean - requestBody: - description: Create Studio request - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateRequest" - required: true - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateResponse" - "404": - description: "NotFound, when the workspace or compute environment is not found or when the API is disabled." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Conflict - duplicated name - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - "200": - description: CreateDataStudio 200 response - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateResponse" - security: - - BearerAuth: [] - /studios/data-links: - get: - tags: - - studios - summary: List mounted data-links - description: "Lists the IDs of all available data-links mounted in existing Studios. Append `orgId` or `?workspaceId` to list mounted data-links in an organization or workspace context, respectively." - operationId: ListMountedDataLinkIds - parameters: - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: status - in: query - description: Optional Studio status - schema: - type: string - - name: exclude - in: query - description: Optional Studio session ID to exclude in the request. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioMountedLinksResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/templates: - get: - tags: - - studios - summary: List available Studio templates - description: "Returns the list of available, configured Studio templates." - operationId: ListDataStudioTemplates - parameters: - - name: workspaceId - in: query - description: Workspace identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - responses: - "200": - description: Ok - paginated list of available Studio templates. - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioTemplatesListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/validate: - get: - tags: - - studios - summary: Validate Studio name - description: Confirms the availability of the given name for a Studio in the user context. Append `?workspaceId=` to validate the name in a workspace context. - operationId: ValidateDataStudioName - parameters: - - name: workspaceId - in: query - description: Workspace identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Studio name to validate - schema: - type: string - responses: - "204": - description: "Ok - No content, if the name is valid and available." - "400": - description: "Bad request, if the name is not valid." - "409": - description: "Conflict, name duplicated in the given context." - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}: - get: - tags: - - studios - summary: Describe Studio - description: Retrieves the details of the Studio session identified by the given `sessionId`. - operationId: DescribeDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "202": - description: "Accepted, when the Studio is fetching mounted data links in the background." - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - delete: - tags: - - studios - summary: Delete Studio - description: Deletes the Studio associated with the given Studio session ID. - operationId: DeleteDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/checkpoints: - get: - tags: - - studios - summary: List Studio checkpoints - description: "Retrieves the list of checkpoints for the given Studio session ID, sorted by creation date in descending order." - operationId: ListDataStudioCheckpoints - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: search - in: query - description: "Optional search criteria, allowing free text search on name and keywords: `status`, `before` and `after` for saved date" - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioListCheckpointsResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/checkpoints/{checkpointId}: - get: - tags: - - studios - summary: Get Studio checkpoint - description: Retrieves the details of the given Studio checkpoint ID. - operationId: GetDataStudioCheckpoint - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: checkpointId - in: path - description: Numeric identifier of the checkpoint. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the studio or the checkpoint is not found or when the API is disabled for the workspace" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - put: - tags: - - studios - summary: Update Studio checkpoint name - description: Updates the name of the given Studio checkpoint ID. - operationId: UpdateDataStudioCheckpoint - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: checkpointId - in: path - description: Numeric identifier of the checkpoint. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointUpdateRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the studio or the checkpoint is not found or when the API is disabled for the workspace" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: "Conflict, when the checkpoint name conflicts with an existing checkpoint for the same Studio." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/lifespan: - post: - tags: - - studios - description: Extends the lifespan of the given Studio session ID. - operationId: ExtendDataStudioLifespan - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/start: - put: - tags: - - studios - summary: Starts a Studio - description: Starts the given Studio session ID. - operationId: StartDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: An optional overriding configuration for the studio to be started. - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStartRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStartResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/stop: - put: - tags: - - studios - summary: Stop Studio - description: Stops the given Studio session ID. - operationId: StopDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStopResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /tokens: - get: - tags: - - tokens - summary: List tokens - description: Retrieves the list of all available API access tokens. - operationId: TokenList - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListAccessTokensResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - tokens - summary: Create token - description: Creates an API access token with the details in the given request body. - operationId: CreateToken - requestBody: - description: Access token create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAccessTokenRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAccessTokenResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /tokens/delete-all: - delete: - tags: - - tokens - summary: Delete all user tokens - description: Deletes all API access tokens in the user context. - operationId: DeleteAllTokens - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /tokens/{tokenId}: - delete: - tags: - - tokens - summary: Delete token - description: Deletes the given API access token ID. - operationId: DeleteToken - parameters: - - name: tokenId - in: path - description: Token numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/create: - post: - tags: - - trace - summary: Create workflow execution trace - description: Creates a new workflow execution trace. - operationId: CreateTrace - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace create request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCreateRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCreateResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/begin: - put: - tags: - - trace - summary: Signal workflow execution start - description: Updates the workflow execution trace for the given `workflowId`. - operationId: UpdateTraceBegin - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace begin request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceBeginRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceBeginResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/complete: - put: - tags: - - trace - summary: Signal workflow execution completion - description: Updates the workflow execution trace for the given `workflowId`. - operationId: UpdateTraceComplete - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace complete request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCompleteRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCompleteResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/heartbeat: - put: - tags: - - trace - summary: Signal workflow execution heartbeat - description: Update the workflow execution trace heartbeat for the given `workflowId` to signal that execution is ongoing. - operationId: UpdateTraceHeartbeat - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace heartbeat request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceHeartbeatRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceHeartbeatResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/progress: - put: - tags: - - trace - summary: Store workflow task execution metadata - description: Store the execution metadata for one or more tasks in the given `workflowId`. - operationId: UpdateTraceProgress - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace progress request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceProgressRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceProgressResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /user-info: - get: - tags: - - users - summary: Describe current user - operationId: UserInfo - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeUserResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /user/{userId}/workspaces: - get: - tags: - - workspaces - summary: List user workspaces and organizations - description: Lists the workspaces and organizations to which the user identified by the given `userId` belongs. - operationId: ListWorkspacesUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesAndOrgResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /users/validate: - get: - tags: - - users - summary: Check that the user name is valid - operationId: ValidateUserName - parameters: - - name: name - in: query - description: User name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /users/{userId}: - get: - tags: - - users - summary: Describe a user entity - operationId: DescribeUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeUserResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - post: - tags: - - users - summary: Update an user entity - operationId: UpdateUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: User update request - content: - application/json: - schema: - $ref: "#/components/schemas/UserDbDto" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - users - summary: Delete a user entity - operationId: DeleteUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow: - get: - tags: - - workflows - summary: List workflows - description: "Lists all workflow records, enriched with `attributes`. Append `?workspaceId` to list workflow records in a workspace context." - operationId: ListWorkflows - parameters: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`, `optimized` status). Returns an empty value (`labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/WorkflowQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkflowsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/delete: - post: - tags: - - workflows - summary: Delete workflows - description: Deletes the workflow records identified by the given list of `workflowIds`. - operationId: DeleteWorkflowMany - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Force the deletion even if any workflows are active - schema: - type: boolean - requestBody: - description: Delete workflows request - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteWorkflowsRequest" - required: true - responses: - "200": - description: "OK - Return the IDs of workflows that could not be deleted, if any" - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteWorkflowsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/add: - post: - tags: - - labels - summary: Add labels to workflows - description: Adds the given list of labels to the given workflows. Existing labels are preserved. - operationId: AddLabelsToWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/apply: - post: - tags: - - labels - summary: Replace workflow labels - description: Applies the given list of labels to the given workflows. Existing labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/remove: - post: - tags: - - labels - summary: Remove labels from workflows - description: Removes the given list of labels from the given workflows. - operationId: RemoveLabelsFromWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/launch: - post: - tags: - - workflows - summary: Launch workflow - description: Submits a workflow execution. - operationId: CreateWorkflowLaunch - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier - required: false - schema: - type: integer - format: int64 - nullable: true - requestBody: - description: Workflow launch request - content: - application/json: - schema: - $ref: "#/components/schemas/SubmitWorkflowLaunchRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/SubmitWorkflowLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/random-name: - get: - tags: - - workflows - summary: Generates a random name - operationId: GenerateRandomWorkflowName - responses: - "200": - description: Generated name - content: - application/json: - schema: - $ref: "#/components/schemas/RandomWorkflowNameResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/validate: - get: - tags: - - workflows - summary: Validate run name - description: "Check that the given run name of a workflow has a valid format. When the session ID is given: check that no other workflow in the system exists with the combination of both elements." - operationId: ValidateWorkflowConstraints - parameters: - - name: runName - in: query - description: Workflow run name to validate - schema: - type: string - - name: sessionId - in: query - description: Workflow session ID to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request. Invalid run name format - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicated element. Existing run name and session ID combination - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}: - get: - tags: - - workflows - summary: Describe workflow - description: Retrieves the details of the workflow record associated with the given `workflowId`. - operationId: DescribeWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: Comma-separated list of attributes to retrieve. Returns an empty value for each attribute not specified. - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/WorkflowQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkflowResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workflows - summary: Delete the Workflow entity with the given ID - operationId: DeleteWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Force the deletion even if the workflow is active - schema: - type: boolean - responses: - "204": - description: OK - Not content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/cancel: - post: - tags: - - workflows - summary: Cancel workflow - description: Cancels the workflow execution identified by the given `workflowId`. - operationId: CancelWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Cancel on the Platform side even if it cannot be cancelled on the CE provider side - schema: - type: boolean - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/download: - get: - tags: - - workflows - summary: Download workflow files - description: Downloads the workflow files for the Nextflow main job associated with the given `workflowId`. - operationId: DownloadWorkflowLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: fileName - in: query - description: Filename to download - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/download/{taskId}: - get: - tags: - - workflows - summary: Download workflow task files - description: Downloads the workflow files of the task identified by the given `taskId`. - operationId: DownloadWorkflowTaskLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: fileName - in: query - description: Filename to download - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/launch: - get: - tags: - - workflows - summary: Describe workflow launch - description: Retrieves the details of the workflow launch associated with the given `workflowId`. - operationId: DescribeWorkflowLaunch - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkflowLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element. Existing run name and session ID combination - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /workflow/{workflowId}/log: - get: - tags: - - workflows - summary: Get workflow logs - description: Retrieves the output logs for the Nextflow main job of the workflow identified by the given `workflowId`. - operationId: WorkflowLogs - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: next - in: query - description: Workflow log cursor - schema: - type: string - - name: maxLength - in: query - description: Maximum length in bytes of the log to retrieve - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/WorkflowLogResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/log/{taskId}: - get: - tags: - - workflows - summary: Get workflow task logs - description: Retrieves the output logs for the workflow task identified by the given `taskId`. - operationId: GetWorkflowTaskLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: next - in: query - description: Workflow log cursor - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: maxLength - in: query - description: Maximum length in bytes of the log to retrieve - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/WorkflowLogResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/metrics: - get: - tags: - - workflows - summary: Get the execution metrics for the given Workflow ID - operationId: DescribeWorkflowMetrics - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetWorkflowMetricsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/progress: - get: - tags: - - workflows - summary: Retrieve the execution progress for the given Workflow ID - operationId: DescribeWorkflowProgress - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetProgressResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/star: - get: - tags: - - workflows - summary: Check workflow star status - description: Confirms whether the given `workflowId` is starred. - operationId: DescribeWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - post: - tags: - - workflows - summary: Star workflow - description: Adds the workflow identified by the given `workflowId` to your list of starred workflows. - operationId: CreateWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - delete: - tags: - - workflows - summary: Unstar workflow - description: Removes the workflow identified by the given `workflowId` from your list of starred workflows. - operationId: DeleteWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - /workflow/{workflowId}/task/{taskId}: - get: - tags: - - workflows - summary: Describe a task entity with the given ID - operationId: DescribeWorkflowTask - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeTaskResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/tasks: - get: - tags: - - workflows - summary: List the tasks for the given Workflow ID and filter parameters - operationId: ListWorkflowTasks - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: sortBy - in: query - description: Field to sort by - schema: - type: string - - name: sortDir - in: query - description: Sorting direction (asc|desc) - schema: - type: string - - name: search - in: query - description: Search tasks by name - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListTasksResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets: - get: - tags: - - datasets - summary: List available datasets - description: Lists all available datasets in the workspace context identified by the given `workspaceId`. - operationId: ListDatasets - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - post: - tags: - - datasets - summary: Create dataset - description: Creates a new dataset in the given workspace context. Include the dataset file and details in your request body. - operationId: CreateDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Dataset create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/versions: - get: - tags: - - datasets - summary: List latest dataset versions - description: Lists the latest version of each dataset associated with the given `workspaceId`. - operationId: ListWorkspaceDatasetVersions - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: mimeType - in: query - schema: - type: string - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}: - put: - tags: - - datasets - summary: Update dataset - description: Updates the details of the dataset identified by the given `datasetId`. - operationId: UpdateDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - requestBody: - description: Dataset update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateDatasetRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - deprecated: true - security: - - BearerAuth: [] - delete: - tags: - - datasets - summary: Delete dataset - description: Deletes the dataset identified by the given `datasetId`. - operationId: DeleteDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/metadata: - get: - tags: - - datasets - summary: Describe dataset - description: Retrieves the metadata of the dataset identified by the given `datasetId`. - operationId: DescribeDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/upload: - post: - tags: - - datasets - summary: Upload new dataset version - description: Uploads the CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. - operationId: UploadDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: header - in: query - description: Uploaded file has header - schema: - type: boolean - requestBody: - description: Dataset file request - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/MultiRequestFileSchema" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UploadDatasetVersionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/v/{version}/n/{fileName}: - get: - tags: - - datasets - summary: Download dataset content - description: Downloads the content of the dataset identified by the given `datasetId` and `version`. - operationId: DownloadDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: version - in: path - description: Version number to download - required: true - schema: - type: string - - name: fileName - in: path - description: File name for the downloaded dataset content - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/versions: - get: - tags: - - datasets - summary: List all dataset versions - description: Lists all versions of the given `datasetId`. - operationId: ListDatasetVersions - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: mimeType - in: query - description: MIME type filter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] -components: - schemas: - AbstractGridConfig: - type: object - properties: - workDir: - type: string - description: Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access. - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - launchDir: - type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." - userName: - type: string - description: "Username for SSH connection to HPC head node." - hostName: - type: string - description: "Hostname or IP address of HPC head node." - port: - type: integer - format: int32 - description: "SSH port. Default: `22`." - headQueue: - type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." - computeQueue: - type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." - maxQueueSize: - type: integer - format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." - headJobOptions: - type: string - description: "Additional submit options for the Nextflow head job." - propagateHeadJobOptions: - type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." - AccessToken: - required: - - name - type: object - properties: - basicAuth: - type: string - deprecated: true - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 50 - minLength: 1 - type: string - lastUsed: - type: string - format: date-time - dateCreated: - type: string - format: date-time - Action.ConfigType: - type: object - properties: - discriminator: - type: string - readOnly: true - discriminator: - propertyName: discriminator - mapping: - github: "#/components/schemas/GithubActionConfig" - tower: "#/components/schemas/Action.TowerActionConfig" - oneOf: - - $ref: "#/components/schemas/Action.TowerActionConfig" - - $ref: "#/components/schemas/GithubActionConfig" - Action.EventType: - type: object - properties: - discriminator: - type: string - readOnly: true - timestamp: - type: string - format: date-time - discriminator: - propertyName: discriminator - mapping: - github: "#/components/schemas/GithubActionEvent" - tower: "#/components/schemas/Action.TowerActionEvent" - oneOf: - - $ref: "#/components/schemas/GithubActionEvent" - - $ref: "#/components/schemas/Action.TowerActionEvent" - Action.Source: - type: string - enum: - - github - - tower - x-enum-varnames: - - github - - tower - Action.Status: - type: string - enum: - - CREATING - - ACTIVE - - ERROR - - PAUSED - Action.TowerActionConfig: - type: object - properties: - discriminator: - type: string - readOnly: true - Action.TowerActionEvent: - type: object - properties: - discriminator: - type: string - readOnly: true - timestamp: - type: string - format: date-time - workflowId: - type: string - ActionQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - ActionResponseDto: - type: object - properties: - id: - type: string - launch: - $ref: "#/components/schemas/Launch" - name: - type: string - hookId: - type: string - hookUrl: - type: string - message: - type: string - source: - $ref: "#/components/schemas/Action.Source" - status: - $ref: "#/components/schemas/Action.Status" - config: - $ref: "#/components/schemas/Action.ConfigType" - event: - $ref: "#/components/schemas/Action.EventType" - lastSeen: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - ActiveConnection: - required: - - lastActive - type: object - allOf: - - $ref: "#/components/schemas/UserInfo" - - properties: - lastActive: - type: string - format: date-time - AddMemberRequest: - type: object - properties: - user: - type: string - AddMemberResponse: - type: object - properties: - member: - $ref: "#/components/schemas/MemberDbDto" - AddParticipantRequest: - type: object - properties: - memberId: - type: integer - format: int64 - teamId: - type: integer - format: int64 - userNameOrEmail: - type: string - AddParticipantResponse: - type: object - properties: - participant: - $ref: "#/components/schemas/ParticipantDbDto" - AddTeamMemberResponse: - type: object - properties: - member: - $ref: "#/components/schemas/MemberDbDto" - AgentSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - connectionId: - type: string - workDir: - type: string - shared: - type: boolean - AllowedDynamicLabelsResponse: - type: object - properties: - values: - type: array - items: - type: string - AltairPbsComputeConfig: - title: Altair PBS configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - Analytics: - type: object - properties: - hubspotId: - type: string - posthogApiKey: - type: string - posthogApiHost: - type: string - AssociateActionLabelsRequest: - type: object - properties: - actionIds: - type: array - items: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - AssociatePipelineLabelsRequest: - type: object - properties: - pipelineIds: - type: array - items: - type: integer - format: int64 - labelIds: - type: array - items: - type: integer - format: int64 - AssociateWorkflowLabelsRequest: - type: object - properties: - workflowIds: - type: array - items: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - Avatar: - type: object - properties: - id: - maxLength: 22 - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - AwsBatchConfig: - title: AWS Batch configuration - type: object - properties: - storageType: - type: string - deprecated: true - lustreId: - type: string - deprecated: true - volumes: - type: array - items: - type: string - description: "EBS volumes to mount (format: `/host/path:/container/path`)." - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - region: - type: string - description: "AWS region where resources will be created (e.g., `us-east-1`)." - computeQueue: - type: string - description: "AWS Batch compute queue for running jobs." - dragenQueue: - type: string - description: "AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)." - dragenInstanceType: - type: string - description: "EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)." - computeJobRole: - type: string - description: "Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs." - executionRole: - type: string - description: "IAM role ARN for ECS task execution." - headQueue: - type: string - description: "AWS Batch queue for the Nextflow head job." - headJobRole: - type: string - description: "Role ARN to grant fine-grained IAM permissions to the Nextflow head job." - cliPath: - type: string - description: "Path to the AWS CLI installation in the container." - workDir: - type: string - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - headJobCpus: - type: integer - format: int32 - description: "Number of CPUs allocated to the Nextflow head job." - headJobMemoryMb: - type: integer - format: int32 - description: "Memory allocation for the Nextflow head job, in megabytes." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - nvnmeStorageEnabled: - type: boolean - description: "Enable NVMe instance storage. Requires Fusion file system." - logGroup: - type: string - description: "CloudWatch Logs group for container logs." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - fusionSnapshots: - type: boolean - description: "Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system." - forge: - $ref: "#/components/schemas/ForgeConfig" - description: "Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#batch-forge-compute-environment) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines." - forgedResources: - type: array - items: - type: object - additionalProperties: true - description: "Resources created by Batch Forge (read-only)." - required: ["region", "workDir", "region", "workDir"] - AwsBatchPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - jobQueues: - type: array - items: - $ref: "#/components/schemas/JobQueue" - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - fileSystems: - type: array - items: - $ref: "#/components/schemas/FsxFileSystem" - efsFileSystems: - type: array - items: - $ref: "#/components/schemas/EfsFileSystem" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceFamilies: - type: array - items: - type: string - allocStrategy: - type: array - items: - type: string - AwsCloudConfig: - title: AWS Cloud configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - allowBuckets: - type: array - items: - type: string - description: "Comma-separated list of S3 buckets accessible to the compute environment." - region: - type: string - description: "AWS region for EC2 instances (e.g., `us-east-1`)." - instanceType: - type: string - description: "EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used." - imageId: - type: string - description: "The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance." - workDir: - type: string - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - logGroup: - type: string - description: "CloudWatch Logs group for container logs." - arm64Enabled: - type: boolean - description: "Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs." - gpuEnabled: - type: boolean - description: "Enable GPU instances to run compute jobs." - ec2KeyPair: - type: string - description: "EC2 key pair name for SSH access to instances." - ebsBootSize: - type: integer - format: int32 - description: "EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default." - instanceProfileArn: - type: string - description: "The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run." - subnetId: - type: string - description: "Subnet ID for instance placement (single subnet)." - securityGroups: - type: array - items: - type: string - description: "Security group IDs that control network access." - forgedResources: - type: array - items: - type: object - additionalProperties: true - description: "Resources created by Cloud Forge (read-only)." - required: ["region", "workDir", "region", "workDir"] - AwsCloudPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceTypes: - type: array - items: - $ref: "#/components/schemas/InstanceType" - AwsSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - accessKey: - type: string - secretKey: - type: string - writeOnly: true - assumeRoleArn: - type: string - AzBatchConfig: - title: Azure batch configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - region: - type: string - description: "Azure region (e.g., `eastus`)." - headPool: - type: string - description: "Batch pool for the Nextflow head job." - autoPoolMode: - type: boolean - deprecated: true - forge: - $ref: "#/components/schemas/AzBatchForgeConfig" - description: "Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation." - tokenDuration: - type: string - description: "Duration of the SAS token created by Nextflow. Default: `12h`." - deleteJobsOnCompletion: - $ref: "#/components/schemas/JobCleanupPolicy" - description: "Automatically delete Batch jobs after completion." - enum: ["on_success", "always", "never", "on_success", "always", "never"] - deletePoolsOnCompletion: - type: boolean - description: "Automatically delete Batch pools after completion. Default: `false`." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - managedIdentityClientId: - type: string - nullable: true - description: "The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage." - required: ["region", "workDir", "region", "workDir"] - AzBatchForgeConfig: - type: object - properties: - vmType: - type: string - description: "Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`." - vmCount: - type: integer - format: int32 - description: "Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused." - autoScale: - type: boolean - description: "Enable auto-scaling for the Batch pool." - disposeOnDeletion: - type: boolean - description: "Delete Batch compute pool when the compute environment is deleted." - containerRegIds: - type: array - items: - type: string - description: "Container registry resource IDs." - AzBatchPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - pools: - type: array - items: - type: string - containers: - type: array - items: - type: string - vmTypes: - type: array - items: - type: string - AzCloudConfig: - title: Azure Cloud configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - nextflowConfig: - type: string - instanceType: - type: string - description: "Azure VM size (e.g., `Standard_D2s_v3`)." - region: - type: string - resourceGroup: - type: string - description: "Azure resource group for VMs." - networkId: - type: string - description: "Virtual network resource ID." - subscriptionId: - type: string - description: "Azure subscription ID." - managedIdentityId: - type: string - description: "User-assigned managed identity resource ID." - managedIdentityClientId: - type: string - description: "Managed identity client ID for authentication." - logWorkspaceId: - type: string - description: "Log Analytics workspace ID for monitoring." - logTableName: - type: string - description: "Custom table name in Log Analytics." - dataCollectionEndpoint: - type: string - description: "Data collection endpoint for logs." - dataCollectionRuleId: - type: string - description: "Data collection rule ID for log routing." - forgedResources: - type: array - items: - $ref: "#/components/schemas/Map.Entry_String.String_" - description: "Resources created by Cloud Forge (read-only)." - required: ["location", "workDir", "location", "workDir"] - AzureEntraKeys: - type: object - allOf: - - $ref: "#/components/schemas/AzureSecurityKeys" - - properties: - discriminator: - type: string - readOnly: true - tenantId: - type: string - clientId: - type: string - clientSecret: - type: string - writeOnly: true - AzureReposSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - AzureSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - batchName: - type: string - storageName: - type: string - batchKey: - type: string - writeOnly: true - storageKey: - type: string - writeOnly: true - BitBucketSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - token: - type: string - writeOnly: true - username: - type: string - password: - type: string - writeOnly: true - Bucket: - type: object - properties: - path: - type: string - CloudPriceModel: - type: string - enum: - - standard - - spot - x-enum-varnames: - - standard - - spot - CodeCommitSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - ComputeConfig: - type: object - properties: - workDir: - type: string - description: Work directory path for storing intermediate workflow files. - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - description: "Environment variables to set in the compute environment." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - discriminator: - type: string - description: Platform type discriminator (read-only, set based on platform selection). - readOnly: true - discriminator: - propertyName: discriminator - mapping: - moab-platform: "#/components/schemas/MoabComputeConfig" - aws-batch: "#/components/schemas/AwsBatchConfig" - google-cloud: "#/components/schemas/GoogleCloudConfig" - azure-cloud: "#/components/schemas/AzCloudConfig" - gke-platform: "#/components/schemas/GkeComputeConfig" - google-batch: "#/components/schemas/GoogleBatchConfig" - aws-cloud: "#/components/schemas/AwsCloudConfig" - slurm-platform: "#/components/schemas/SlurmComputeConfig" - k8s-platform: "#/components/schemas/K8sComputeConfig" - altair-platform: "#/components/schemas/AltairPbsComputeConfig" - lsf-platform: "#/components/schemas/LsfComputeConfig" - azure-batch: "#/components/schemas/AzBatchConfig" - seqeracompute-platform: "#/components/schemas/SeqeraComputeConfig" - eks-platform: "#/components/schemas/EksComputeConfig" - google-lifesciences: "#/components/schemas/GoogleLifeSciencesConfig" - uge-platform: "#/components/schemas/UnivaComputeConfig" - oneOf: - - $ref: "#/components/schemas/AwsBatchConfig" - - $ref: "#/components/schemas/AwsCloudConfig" - - $ref: "#/components/schemas/SeqeraComputeConfig" - - $ref: "#/components/schemas/GoogleLifeSciencesConfig" - - $ref: "#/components/schemas/GoogleBatchConfig" - - $ref: "#/components/schemas/AzBatchConfig" - - $ref: "#/components/schemas/LsfComputeConfig" - - $ref: "#/components/schemas/SlurmComputeConfig" - - $ref: "#/components/schemas/K8sComputeConfig" - - $ref: "#/components/schemas/EksComputeConfig" - - $ref: "#/components/schemas/GkeComputeConfig" - - $ref: "#/components/schemas/UnivaComputeConfig" - - $ref: "#/components/schemas/AltairPbsComputeConfig" - - $ref: "#/components/schemas/MoabComputeConfig" - ComputeEnv.Status: - type: string - readOnly: true - enum: - - CREATING - - AVAILABLE - - ERRORED - - INVALID - ComputeEnvDbDto: - type: object - properties: - id: - type: string - name: - type: string - platform: - type: string - region: - type: string - ComputeEnvQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - ComputeEnvResponseDto: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - platform: - type: string - enum: - - aws-batch - - aws-cloud - - seqeracompute-platform - - google-lifesciences - - google-batch - - azure-batch - - k8s-platform - - eks-platform - - gke-platform - - uge-platform - - slurm-platform - - lsf-platform - - altair-platform - config: - $ref: "#/components/schemas/ComputeConfig" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - lastUsed: - type: string - format: date-time - deleted: - type: boolean - status: - $ref: "#/components/schemas/ComputeEnv.Status" - message: - type: string - primary: - type: boolean - credentialsId: - type: string - managedIdentityId: - type: string - orgId: - type: integer - format: int64 - workspaceId: - type: integer - format: int64 - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - ComputeEnv_ComputeConfig_: - required: - - config - - name - - platform - - "name" - - "platform" - - "config" - - "name" - - "platform" - - "config" - type: object - properties: - credentialsId: - type: string - description: "Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See [Create credentials](https://docs.seqera.io/platform-api/create-credentials)." - orgId: - type: integer - format: int64 - readOnly: true - description: "Organization numeric identifier (read-only, set by system)." - workspaceId: - type: integer - format: int64 - readOnly: true - description: "Workspace numeric identifier (read-only, set by system)." - id: - maxLength: 22 - type: string - readOnly: true - description: "Compute environment alphanumeric identifier (read-only, generated by system)." - name: - maxLength: 100 - type: string - description: "Unique name for the compute environment. Must consist of 1-100 alphanumeric, dash, or underscore characters." - description: - maxLength: 2000 - type: string - description: "Description of the compute environment. Maximum length: 2000 characters." - platform: - maxLength: 25 - type: string - enum: - - aws-batch - - aws-cloud - - google-lifesciences - - google-batch - - google-cloud - - azure-batch - - azure-cloud - - k8s-platform - - eks-platform - - gke-platform - - uge-platform - - slurm-platform - - lsf-platform - - altair-platform - - moab-platform - - local-platform - - seqeracompute-platform - - "aws-batch" - - "aws-cloud" - - "google-batch" - - "google-cloud" - - "azure-batch" - - "k8s-platform" - - "eks-platform" - - "gke-platform" - - "slurm-platform" - - "lsf-platform" - - "uge-platform" - - "moab-platform" - - "altair-platform" - - "local-platform" - - "seqeracompute-platform" - - "aws-batch" - - "aws-cloud" - - "google-batch" - - "google-cloud" - - "azure-batch" - - "azure-cloud" - - "k8s-platform" - - "eks-platform" - - "gke-platform" - - "slurm-platform" - - "lsf-platform" - - "uge-platform" - - "moab-platform" - - "altair-platform" - - "local-platform" - - "seqeracompute-platform" - description: "Compute platform provider." - config: - $ref: "#/components/schemas/ComputeConfig" - description: "Platform-specific configuration. Structure depends on the selected platform." - dateCreated: - type: string - format: date-time - readOnly: true - description: "Creation timestamp (read-only, set by system)." - lastUpdated: - type: string - format: date-time - readOnly: true - description: "Last update timestamp (read-only, updated by system)." - lastUsed: - type: string - format: date-time - readOnly: true - description: "Last usage timestamp (read-only, updated by system)." - deleted: - type: boolean - readOnly: true - description: "Deletion status flag (read-only, updated by system)." - status: - type: string - readOnly: true - allOf: - - $ref: "#/components/schemas/ComputeEnv.Status" - description: "Current status of the compute environment (read-only)." - enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID", "CREATING", "AVAILABLE", "ERRORED", "INVALID"] - message: - maxLength: 4096 - type: string - primary: - type: boolean - readOnly: true - ComputePlatform: - type: object - properties: - id: - type: string - name: - type: string - credentialsProviders: - type: array - items: - type: string - ComputePlatformDto: - type: object - properties: - id: - type: string - name: - type: string - ComputeRegion: - type: object - properties: - id: - type: string - name: - type: string - ConfigEnvVariable: - type: object - properties: - name: - type: string - description: "Environment variable name." - value: - type: string - description: "Environment variable value." - head: - type: boolean - description: "Apply this variable to the Nextflow head job." - compute: - type: boolean - description: "Apply this variable to the Nextflow compute jobs." - required: ["name", "value", "name", "value"] - ContainerData: - required: - - targetImage - type: object - properties: - requestId: - type: string - sourceImage: - type: string - targetImage: - type: string - buildId: - type: string - scanId: - type: string - mirrorId: - type: string - cached: - type: boolean - freeze: - type: boolean - requestTime: - type: string - format: date-time - ContainerRegistryKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - userName: - type: string - password: - type: string - writeOnly: true - registry: - type: string - CreateAccessTokenRequest: - type: object - properties: - name: - type: string - CreateAccessTokenResponse: - type: object - properties: - accessKey: - type: string - token: - $ref: "#/components/schemas/AccessToken" - CreateActionRequest: - type: object - properties: - name: - type: string - source: - $ref: "#/components/schemas/Action.Source" - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - CreateActionResponse: - type: object - properties: - actionId: - type: string - CreateAvatarResponse: - type: object - properties: - avatar: - $ref: "#/components/schemas/Avatar" - url: - type: string - CreateComputeEnvRequest: - type: object - properties: - computeEnv: - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - description: "Compute environment configuration object." - labelIds: - type: array - items: - type: integer - format: int64 - description: "Array of label IDs to assign to the compute environment." - required: ["computeEnv", "computeEnv"] - CreateComputeEnvResponse: - type: object - properties: - computeEnvId: - type: string - CreateCredentialsRequest: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - CreateCredentialsResponse: - type: object - properties: - credentialsId: - type: string - CreateDatasetRequest: - type: object - properties: - name: - type: string - description: - type: string - CreateDatasetResponse: - type: object - properties: - dataset: - $ref: "#/components/schemas/DatasetDto" - CreateLabelRequest: - type: object - properties: - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - CreateLabelResponse: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - CreateManagedCredentialsRequest: - type: object - properties: - provider: - type: string - enum: - - ssh - description: "Authentication provider type. Currently supports `ssh`." - credentials: - $ref: "#/components/schemas/Credentials" - description: "Authentication credentials configuration object." - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - description: "Additional metadata for the managed credentials." - CreateManagedCredentialsResponse: - type: object - properties: - managedCredentials: - $ref: "#/components/schemas/ManagedCredentialsDbDto" - description: "Created managed credentials object." - CreateManagedIdentityRequest: - type: object - properties: - name: - type: string - description: "Unique name for the managed identity. Must consist of alphanumeric, dash, or underscore characters." - platform: - type: string - enum: - - altair-platform - - lsf-platform - - moab-platform - - slurm-platform - - uge-platform - description: "HPC platform type for this managed identity." - config: - $ref: "#/components/schemas/AbstractGridConfig" - description: "Platform-specific configuration. Structure depends on the selected platform." - CreateManagedIdentityResponse: - type: object - properties: - id: - type: integer - format: int64 - description: "Managed identity numeric identifier." - name: - type: string - description: "Name of the created managed identity." - platform: - type: string - description: "HPC platform type." - config: - $ref: "#/components/schemas/ComputeConfig" - description: "Platform-specific configuration." - CreateOrganizationRequest: - type: object - properties: - organization: - $ref: "#/components/schemas/Organization" - logoId: - type: string - CreateOrganizationResponse: - type: object - properties: - organization: - $ref: "#/components/schemas/OrganizationDbDto" - CreatePipelineRequest: - type: object - properties: - name: - type: string - description: "Pipeline name. Must be unique within the workspace." - description: - type: string - description: "Pipeline description." - icon: - type: string - description: "Pipeline icon URL." - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - description: "Launch configuration for the pipeline." - labelIds: - type: array - items: - type: integer - format: int64 - description: "Array of label IDs to apply to the pipeline." - CreatePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - CreatePipelineSecretRequest: - type: object - properties: - name: - type: string - value: - type: string - CreatePipelineSecretResponse: - type: object - properties: - secretId: - type: integer - format: int64 - CreateTeamMemberRequest: - type: object - properties: - userNameOrEmail: - type: string - CreateTeamRequest: - type: object - properties: - team: - $ref: "#/components/schemas/Team" - avatarId: - type: string - CreateTeamResponse: - type: object - properties: - team: - $ref: "#/components/schemas/TeamDbDto" - CreateWorkflowStarResponse: - type: object - properties: - workflowId: - type: string - CreateWorkspaceRequest: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - CreateWorkspaceResponse: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - Credentials: - required: - - name - - provider - type: object - properties: - id: - maxLength: 22 - type: string - name: - maxLength: 100 - type: string - description: - type: string - provider: - maxLength: 16 - type: string - enum: - - aws - - azure - - azure_entra - - google - - github - - gitlab - - bitbucket - - ssh - - k8s - - container-reg - - tw-agent - - codecommit - - gitea - - azurerepos - - seqeracompute - - azure-cloud - - s3 - baseUrl: - maxLength: 200 - pattern: "" - type: string - category: - maxLength: 20 - type: string - deleted: - type: boolean - readOnly: true - lastUsed: - type: string - format: date-time - readOnly: true - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - keys: - $ref: "#/components/schemas/SecurityKeys" - DataLink.Status: - type: string - readOnly: true - enum: - - VALID - - INVALID - DataLinkContentResponse: - type: object - properties: - originalPath: - type: string - objects: - type: array - items: - $ref: "#/components/schemas/DataLinkItem" - nextPageToken: - type: string - DataLinkContentTreeListResponse: - required: - - items - type: object - properties: - items: - type: array - items: - $ref: "#/components/schemas/DataLinkSimpleItem" - DataLinkCreateRequest: - type: object - properties: - name: - type: string - description: - type: string - type: - $ref: "#/components/schemas/DataLinkType" - provider: - $ref: "#/components/schemas/DataLinkProvider" - resourceRef: - type: string - publicAccessible: - type: boolean - credentialsId: - type: string - DataLinkCredentials: - required: - - id - - name - - provider - type: object - properties: - id: - type: string - name: - type: string - provider: - $ref: "#/components/schemas/DataLinkProvider" - DataLinkDeleteItemRequest: - type: object - properties: - files: - type: array - items: - type: string - dirs: - type: array - items: - type: string - DataLinkDeleteItemResponse: - type: object - properties: - deletionFailures: - type: array - items: - $ref: "#/components/schemas/DataLinkItemDeletionFailure" - DataLinkDownloadScriptResponse: - type: object - properties: - script: - type: string - DataLinkDownloadUrlResponse: - type: object - properties: - url: - type: string - DataLinkDto: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - resourceRef: - type: string - type: - $ref: "#/components/schemas/DataLinkType" - provider: - $ref: "#/components/schemas/DataLinkProvider" - region: - type: string - credentials: - type: array - items: - $ref: "#/components/schemas/DataLinkCredentials" - publicAccessible: - type: boolean - hidden: - type: boolean - status: - type: string - readOnly: true - allOf: - - $ref: "#/components/schemas/DataLink.Status" - message: - type: string - DataLinkFinishMultiPartUploadRequest: - type: object - properties: - uploadId: - type: string - fileName: - type: string - tags: - type: array - items: - $ref: "#/components/schemas/UploadEtag" - withError: - type: boolean - DataLinkItem: - type: object - properties: - type: - $ref: "#/components/schemas/DataLinkItemType" - name: - type: string - size: - type: integer - format: int64 - mimeType: - type: string - DataLinkItemDeletionFailure: - required: - - dataLinkItem - - errorMessage - type: object - properties: - dataLinkItem: - $ref: "#/components/schemas/DataLinkItem" - errorMessage: - type: string - DataLinkItemType: - type: string - enum: - - FOLDER - - FILE - DataLinkMultiPartUploadRequest: - type: object - properties: - fileName: - type: string - contentLength: - type: integer - format: int64 - contentType: - type: string - DataLinkMultiPartUploadResponse: - type: object - properties: - uploadId: - type: string - uploadUrls: - type: array - items: - type: string - DataLinkProvider: - type: string - enum: - - aws - - google - - azure - - azure_entra - - azure-cloud - - seqeracompute - - s3 - DataLinkResponse: - type: object - properties: - dataLink: - $ref: "#/components/schemas/DataLinkDto" - DataLinkSimpleItem: - required: - - path - - size - type: object - properties: - path: - type: string - size: - type: integer - format: int64 - DataLinkType: - type: string - enum: - - bucket - x-enum-varnames: - - bucket - DataLinkUpdateRequest: - type: object - properties: - name: - type: string - description: - type: string - credentialsId: - type: string - DataLinksListResponse: - type: object - properties: - dataLinks: - type: array - items: - $ref: "#/components/schemas/DataLinkDto" - totalSize: - type: integer - format: int64 - DataStudioCheckpointDto: - required: - - author - - dateCreated - - dateSaved - - id - - name - - path - - status - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - dateCreated: - type: string - format: date-time - dateSaved: - type: string - format: date-time - author: - $ref: "#/components/schemas/UserInfo" - path: - type: string - status: - $ref: "#/components/schemas/StudioCheckpointStatus" - DataStudioCheckpointUpdateRequest: - type: object - properties: - name: - type: string - DataStudioComputeEnvDto: - type: object - allOf: - - $ref: "#/components/schemas/ComputeEnvDbDto" - - properties: - credentialsId: - type: string - workDir: - type: string - DataStudioConfiguration: - type: object - properties: - gpu: - minimum: 0 - type: integer - format: int32 - cpu: - minimum: 0 - type: integer - format: int32 - memory: - minimum: 0 - type: integer - format: int32 - mountData: - type: array - items: - type: string - environment: - type: object - additionalProperties: - type: string - nullable: true - condaEnvironment: - maxLength: 2048 - type: string - lifespanHours: - minimum: 0 - type: integer - format: int32 - DataStudioCreateRequest: - required: - - computeEnvId - - dataStudioToolUrl - - name - type: object - properties: - name: - maxLength: 80 - minLength: 1 - type: string - description: - maxLength: 2048 - type: string - dataStudioToolUrl: - minLength: 1 - type: string - computeEnvId: - minLength: 1 - type: string - initialCheckpointId: - type: integer - format: int64 - configuration: - $ref: "#/components/schemas/DataStudioConfiguration" - isPrivate: - type: boolean - labelIds: - type: array - nullable: true - items: - type: integer - format: int64 - spot: - type: boolean - nullable: true - DataStudioCreateResponse: - type: object - properties: - studio: - $ref: "#/components/schemas/DataStudioDto" - DataStudioDto: - type: object - properties: - sessionId: - type: string - workspaceId: - type: integer - format: int64 - parentCheckpoint: - $ref: "#/components/schemas/DataStudioDto.ParentCheckpoint" - user: - $ref: "#/components/schemas/UserInfo" - name: - type: string - description: - type: string - studioUrl: - type: string - computeEnv: - $ref: "#/components/schemas/DataStudioComputeEnvDto" - template: - $ref: "#/components/schemas/DataStudioTemplate" - configuration: - $ref: "#/components/schemas/DataStudioConfiguration" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - lastStarted: - type: string - format: date-time - effectiveLifespanHours: - type: integer - format: int32 - activeConnections: - type: array - items: - $ref: "#/components/schemas/ActiveConnection" - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - waveBuildUrl: - type: string - baseImage: - type: string - customImage: - type: boolean - isPrivate: - type: boolean - mountedDataLinks: - type: array - items: - $ref: "#/components/schemas/DataLinkDto" - progress: - type: array - items: - $ref: "#/components/schemas/DataStudioProgressStep" - labels: - type: array - nullable: true - items: - $ref: "#/components/schemas/LabelDbDto" - DataStudioDto.ParentCheckpoint: - type: object - properties: - checkpointId: - type: integer - format: int64 - checkpointName: - type: string - sessionId: - type: string - studioName: - type: string - DataStudioListCheckpointsResponse: - required: - - checkpoints - - totalSize - type: object - properties: - checkpoints: - type: array - items: - $ref: "#/components/schemas/DataStudioCheckpointDto" - totalSize: - type: integer - format: int64 - DataStudioListResponse: - required: - - studios - - totalSize - type: object - properties: - studios: - type: array - items: - $ref: "#/components/schemas/DataStudioDto" - totalSize: - type: integer - format: int64 - DataStudioMountedLinksResponse: - type: object - properties: - dataLinkIds: - type: array - items: - type: string - DataStudioProgressStep: - type: object - properties: - status: - $ref: "#/components/schemas/DataStudioProgressStep.Status" - message: - type: string - warnings: - type: array - items: - type: string - DataStudioProgressStep.Status: - type: string - enum: - - pending - - in-progress - - succeeded - - errored - DataStudioQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - DataStudioStartRequest: - type: object - properties: - configuration: - nullable: true - allOf: - - $ref: "#/components/schemas/DataStudioConfiguration" - description: - type: string - nullable: true - labelIds: - type: array - nullable: true - items: - type: integer - format: int64 - spot: - type: boolean - nullable: true - DataStudioStartResponse: - required: - - jobSubmitted - - sessionId - - statusInfo - type: object - properties: - jobSubmitted: - type: boolean - sessionId: - type: string - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - DataStudioStatus: - type: string - enum: - - starting - - running - - stopping - - stopped - - errored - - building - - buildFailed - x-enum-varnames: - - starting - - running - - stopping - - stopped - - errored - - building - - buildFailed - DataStudioStatusInfo: - type: object - properties: - status: - $ref: "#/components/schemas/DataStudioStatus" - message: - type: string - lastUpdate: - type: string - format: date-time - stopReason: - $ref: "#/components/schemas/DataStudioStopReason" - DataStudioStopReason: - type: string - enum: - - CREDITS_RUN_OUT - - LIFESPAN_EXPIRED - - SPOT_RECLAMATION - DataStudioStopResponse: - required: - - jobSubmitted - - sessionId - - statusInfo - type: object - properties: - jobSubmitted: - type: boolean - sessionId: - type: string - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - DataStudioTemplate: - type: object - properties: - repository: - type: string - icon: - type: string - status: - $ref: "#/components/schemas/DataStudioVersionStatus" - tool: - type: string - DataStudioTemplatesListResponse: - required: - - templates - - totalSize - type: object - properties: - templates: - type: array - items: - $ref: "#/components/schemas/DataStudioTemplate" - totalSize: - type: integer - format: int64 - DataStudioVersionStatus: - type: string - enum: - - recommended - - deprecated - - experimental - - unsupported - x-enum-varnames: - - recommended - - deprecated - - experimental - - unsupported - DataStudioWorkspaceSettingsResponse: - required: - - lifespanHours - - orgId - - wspId - type: object - properties: - orgId: - type: integer - format: int64 - wspId: - type: integer - format: int64 - lifespanHours: - type: integer - format: int32 - DatasetDto: - type: object - properties: - id: - type: string - user: - $ref: "#/components/schemas/UserInfo" - workspaceId: - type: integer - format: int64 - organizationId: - type: integer - format: int64 - name: - type: string - lastUpdatedBy: - $ref: "#/components/schemas/UserInfo" - description: - type: string - mediaType: - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - deleted: - type: boolean - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - version: - type: integer - format: int64 - DatasetVersionDto: - type: object - properties: - datasetId: - type: string - datasetName: - type: string - datasetDescription: - type: string - hasHeader: - type: boolean - version: - type: integer - format: int64 - createdBy: - $ref: "#/components/schemas/UserInfo" - lastUpdated: - type: string - format: date-time - fileName: - type: string - mediaType: - type: string - workspaceId: - type: integer - format: int64 - url: - type: string - DeleteCredentialsConflictResponse: - type: object - properties: - credentialsId: - type: string - conflicts: - type: array - items: - $ref: "#/components/schemas/DeleteCredentialsConflictResponse.Conflict" - DeleteCredentialsConflictResponse.Conflict: - type: object - properties: - type: - type: string - id: - type: string - name: - type: string - url: - type: string - DeleteManagedCredentialsConflictResponse: - type: object - properties: - managedCredentialsId: - type: string - description: "Identifier of credentials that could not be deleted." - conflicts: - type: array - items: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse.Conflict" - description: "Array of conflicts preventing deletion." - DeleteManagedCredentialsConflictResponse.Conflict: - type: object - properties: - type: - type: string - id: - type: string - name: - type: string - url: - type: string - DeleteWorkflowsRequest: - type: object - properties: - workflowIds: - type: array - items: - type: string - DeleteWorkflowsResponse: - type: object - properties: - failedWorkflowIds: - type: array - items: - type: string - DescribeActionResponse: - type: object - properties: - action: - $ref: "#/components/schemas/ActionResponseDto" - DescribeComputeEnvResponse: - type: object - properties: - computeEnv: - $ref: "#/components/schemas/ComputeEnvResponseDto" - DescribeCredentialsResponse: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - DescribeDatasetResponse: - type: object - properties: - dataset: - $ref: "#/components/schemas/DatasetDto" - DescribeLaunchResponse: - type: object - properties: - launch: - $ref: "#/components/schemas/Launch" - DescribeOrganizationQuotasResponse: - type: object - properties: - quotas: - $ref: "#/components/schemas/OrganizationQuotas" - DescribeOrganizationResponse: - type: object - properties: - organization: - $ref: "#/components/schemas/OrganizationDbDto" - DescribePipelineInfoResponse: - type: object - properties: - pipelineInfo: - $ref: "#/components/schemas/PipelineInfo" - DescribePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - DescribePipelineSecretResponse: - type: object - properties: - pipelineSecret: - $ref: "#/components/schemas/PipelineSecret" - DescribePlatformResponse: - type: object - properties: - metainfo: - $ref: "#/components/schemas/PlatformMetainfo" - DescribeTaskResponse: - type: object - properties: - task: - $ref: "#/components/schemas/Task" - DescribeTeamResponse: - type: object - properties: - team: - $ref: "#/components/schemas/TeamDbDto" - DescribeUserResponse: - type: object - properties: - user: - $ref: "#/components/schemas/UserDbDto" - needConsent: - type: boolean - defaultWorkspaceId: - type: integer - format: int64 - DescribeWorkflowLaunchResponse: - type: object - properties: - launch: - $ref: "#/components/schemas/WorkflowLaunchResponse" - DescribeWorkflowResponse: - type: object - properties: - workflow: - $ref: "#/components/schemas/Workflow" - progress: - $ref: "#/components/schemas/ProgressData" - platform: - $ref: "#/components/schemas/ComputePlatformDto" - jobInfo: - $ref: "#/components/schemas/JobInfoDto" - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - optimized: - type: boolean - messages: - type: array - items: - type: string - DescribeWorkspaceResponse: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - EfsFileSystem: - type: object - properties: - id: - type: string - EksComputeConfig: - title: Amazon EKS cluster configuration - type: object - allOf: - - $ref: "#/components/schemas/K8sComputeConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - nextflowConfig: - type: string - region: - type: string - description: AWS region - clusterName: - type: string - description: The AWS EKS cluster name - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - required: ["region", "clusterName", "workDir", "region", "clusterName", "workDir"] - EksPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - clusters: - type: array - items: - type: string - EmptyBodyRequest: - type: object - ErrorResponse: - required: - - message - type: object - properties: - message: - type: string - EventType: - type: object - properties: - source: - type: string - display: - type: string - description: - type: string - enabled: - type: boolean - ForgeConfig: - type: object - properties: - type: - type: string - enum: - - SPOT - - EC2 - - "SPOT" - - "EC2" - - "SPOT" - - "EC2" - description: "Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)." - minCpus: - type: integer - format: int32 - description: "Minimum CPUs provisioned in the compute environment." - maxCpus: - type: integer - format: int32 - description: "Maximum CPUs provisioned in the compute environment." - gpuEnabled: - type: boolean - description: "Enable GPU instances." - ebsAutoScale: - type: boolean - description: "If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system." - instanceTypes: - type: array - items: - type: string - description: "Comma-separated list of allowed EC2 instance types." - allocStrategy: - type: string - enum: - - BEST_FIT - - BEST_FIT_PROGRESSIVE - - SPOT_CAPACITY_OPTIMIZED - - SPOT_PRICE_CAPACITY_OPTIMIZED - - "BEST_FIT" - - "BEST_FIT_PROGRESSIVE" - - "SPOT_CAPACITY_OPTIMIZED" - - "SPOT_PRICE_CAPACITY_OPTIMIZED" - - "BEST_FIT" - - "BEST_FIT_PROGRESSIVE" - - "SPOT_CAPACITY_OPTIMIZED" - - "SPOT_PRICE_CAPACITY_OPTIMIZED" - description: "Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances." - imageId: - type: string - description: "Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used." - vpcId: - type: string - description: "VPC ID for networking." - subnets: - type: array - items: - type: string - description: "List of VPC subnets to isolate EC2 resources from each other, or the internet." - securityGroups: - type: array - items: - type: string - description: "List of security group IDs to define a set of firewall rules that control EC2 compute node traffic." - fsxMount: - type: string - description: "FSx for Lustre mount point." - fsxName: - type: string - description: "FSx for Lustre file system name." - fsxSize: - type: integer - format: int32 - description: "FSx for Lustre file system size in GB." - disposeOnDeletion: - type: boolean - description: "If true, delete AWS resources when compute environment is deleted." - ec2KeyPair: - type: string - description: "EC2 key pair for SSH access." - allowBuckets: - type: array - items: - type: string - description: "List of additional S3 buckets accessible to compute environment." - ebsBlockSize: - type: integer - format: int32 - description: "EBS volume size in GB." - fusionEnabled: - type: boolean - description: "(Deprecated) Enable Fusion file system (v1)." - bidPercentage: - type: integer - format: int32 - description: "Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`." - efsCreate: - type: boolean - description: "If true, creates new EFS file system." - efsId: - type: string - description: "Existing EFS file system ID." - efsMount: - type: string - description: "EFS file system mount point in containers." - dragenEnabled: - type: boolean - description: "Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support." - dragenAmiId: - type: string - description: "AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances." - ebsBootSize: - type: integer - format: int32 - description: "Boot disk size for instances, in GB." - ecsConfig: - type: string - description: "Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)." - fargateHeadEnabled: - type: boolean - description: "Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems." - arm64Enabled: - type: boolean - description: "Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system." - dragenInstanceType: - type: string - description: "Instance type for DRAGEN workflows." - FsxFileSystem: - type: object - properties: - id: - type: string - dns: - type: string - mount: - type: string - GetProgressResponse: - type: object - properties: - progress: - $ref: "#/components/schemas/ProgressData" - GetWorkflowMetricsResponse: - type: object - properties: - metrics: - type: array - items: - $ref: "#/components/schemas/WorkflowMetrics" - GitHubSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - GitLabSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - token: - type: string - writeOnly: true - username: - type: string - password: - type: string - writeOnly: true - GiteaSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - GithubActionConfig: - type: object - properties: - discriminator: - type: string - readOnly: true - events: - type: array - items: - type: string - GithubActionEvent: - type: object - properties: - discriminator: - type: string - readOnly: true - ref: - type: string - commitId: - type: string - commitMessage: - type: string - pusherName: - type: string - pusherEmail: - type: string - timestamp: - type: string - format: date-time - GkeComputeConfig: - title: Google GKE cluster configuration - type: object - allOf: - - $ref: "#/components/schemas/K8sComputeConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - nextflowConfig: - type: string - region: - type: string - description: The GKE cluster region - or - zone - clusterName: - type: string - description: The GKE cluster name - fusion2Enabled: - type: boolean - waveEnabled: - type: boolean - required: ["region", "clusterName", "workDir", "region", "clusterName", "workDir"] - GkePlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - clusters: - type: array - items: - type: string - GoogleBatchConfig: - title: Google Batch service configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - location: - type: string - description: "Google Cloud location (region) for Batch jobs (e.g., `us-central1`)." - workDir: - type: string - spot: - type: boolean - description: "Use Spot instances." - bootDiskSizeGb: - type: integer - format: int32 - description: "Boot disk size in GB for compute instances." - cpuPlatform: - type: string - description: "Google Cloud Batch CPU platform." - machineType: - type: string - description: "Machine type for compute instances (e.g., `n1-standard-4`)." - projectId: - type: string - description: "Google Cloud project ID." - sshDaemon: - type: boolean - description: "Enable SSH daemon for debugging." - sshImage: - type: string - description: "Container image for SSH daemon." - debugMode: - type: integer - format: int32 - description: "Debug level (0-3) for troubleshooting." - copyImage: - type: string - description: "Container image for copying files." - usePrivateAddress: - type: boolean - description: "Use private IP addresses only (no external IPs)." - labels: - type: object - additionalProperties: - type: string - description: "Comma-separated list of labels to apply to Batch resources." - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - headJobCpus: - type: integer - format: int32 - description: "Number of CPUs allocated for the Nextflow head job." - headJobMemoryMb: - type: integer - format: int32 - description: "Memory allocation for the Nextflow head job in megabytes." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - nfsTarget: - type: string - description: "NFS server target for shared storage." - nfsMount: - type: string - description: "NFS mount path in containers." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - serviceAccount: - type: string - description: "Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)." - network: - type: string - description: "VPC network name." - subnetwork: - type: string - description: "Subnetwork name within the VPC." - headJobInstanceTemplate: - type: string - description: "Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job." - computeJobsInstanceTemplate: - type: string - description: "Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs." - required: ["location", "workDir", "location", "workDir"] - GoogleBucket: - type: object - properties: - path: - type: string - GoogleCloudConfig: - title: Google Cloud configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - workDir: - type: string - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - description: "Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`." - fusion2Enabled: - type: boolean - description: "Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`." - projectId: - type: string - description: "Google Cloud project ID." - region: - type: string - description: "Google Cloud region (e.g., `us-central1`)." - zone: - type: string - description: "Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list." - serviceAccountEmail: - type: string - description: "Service account email for IAM access to instances." - instanceType: - type: string - description: "Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used." - imageId: - type: string - description: "ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release." - arm64Enabled: - type: boolean - description: "Enable ARM64 instances." - gpuEnabled: - type: boolean - description: "Enable GPU instances." - bootDiskSizeGb: - type: integer - format: int32 - description: "Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used." - forgedResources: - type: array - items: - type: object - additionalProperties: true - description: "Resources created by Cloud Forge (read-only)." - required: ["region", "workDir", "region", "workDir"] - GoogleCloudPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - zones: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/GoogleBucket" - instanceTypes: - type: array - items: - $ref: "#/components/schemas/GoogleInstanceType" - images: - type: array - items: - $ref: "#/components/schemas/GoogleImage" - GoogleImage: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - arch: - type: string - GoogleInstanceType: - type: object - properties: - id: - type: string - arch: - type: string - GoogleLifeSciencesConfig: - title: Google life sciences configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - region: - type: string - zones: - type: array - items: - type: string - location: - type: string - workDir: - type: string - preemptible: - type: boolean - bootDiskSizeGb: - type: integer - format: int32 - projectId: - type: string - sshDaemon: - type: boolean - sshImage: - type: string - debugMode: - type: integer - format: int32 - copyImage: - type: string - usePrivateAddress: - type: boolean - labels: - type: object - additionalProperties: - type: string - preRunScript: - type: string - postRunScript: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - nextflowConfig: - type: string - nfsTarget: - type: string - nfsMount: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - GooglePlatformMetainfo: - type: object - properties: - locations: - type: array - items: - type: string - discriminator: - type: string - warnings: - type: array - items: - type: string - zones: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/GooglePlatformMetainfo.Bucket" - filestores: - type: array - items: - $ref: "#/components/schemas/GooglePlatformMetainfo.Filestore" - GooglePlatformMetainfo.Bucket: - type: object - properties: - path: - type: string - GooglePlatformMetainfo.Filestore: - type: object - properties: - target: - type: string - name: - type: string - location: - type: string - GoogleSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - data: - type: string - writeOnly: true - GridPlatformMetainfo: - type: object - properties: - discriminator: - type: string - Image: - required: - - arch - - description - - id - - name - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - arch: - type: string - InstanceType: - required: - - arch - type: object - properties: - id: - type: string - arch: - type: string - Iterator_String_: - type: object - JobCleanupPolicy: - type: string - enum: - - on_success - - always - - never - x-enum-varnames: - - on_success - - always - - never - JobInfoDto: - type: object - properties: - id: - type: integer - format: int64 - operationId: - type: string - message: - type: string - status: - type: string - exitCode: - type: integer - format: int32 - JobQueue: - required: - - name - - state - type: object - properties: - name: - type: string - state: - type: string - K8sComputeConfig: - title: Kubernetes compute configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - server: - type: string - description: "Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)." - sslCert: - type: string - description: "SSL certificate to authenticate the connection with the Kubernetes cluster." - namespace: - type: string - description: "Kubernetes namespace for workflow execution. Default: `default`." - computeServiceAccount: - type: string - description: "Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`." - headServiceAccount: - type: string - description: "Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)." - storageClaimName: - type: string - description: "PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode." - storageMountPath: - type: string - description: "Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`." - podCleanup: - $ref: "#/components/schemas/PodCleanupPolicy" - description: "Pod cleanup policy after job completion." - enum: ["on_success", "always", "never", "on_success", "always", "never"] - headPodSpec: - type: string - description: "Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`." - servicePodSpec: - type: string - description: "Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - headJobCpus: - type: integer - format: int32 - description: "Number of CPUs allocated for the Nextflow head job." - headJobMemoryMb: - type: integer - format: int32 - description: "Memory allocation for the Nextflow head job in megabytes." - nextflowConfig: - type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - required: ["server", "sslCert", "workDir", "server", "sslCert", "workDir"] - K8sPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - K8sSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - certificate: - type: string - privateKey: - type: string - writeOnly: true - token: - type: string - writeOnly: true - LabelDbDto: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - isDynamic: - type: boolean - isInterpolated: - type: boolean - dateCreated: - type: string - format: date-time - LabelType: - type: string - enum: - - simple - - resource - - all - x-enum-varnames: - - simple - - resource - - all - Launch: - required: - - dateCreated - - pipeline - type: object - properties: - id: - maxLength: 22 - type: string - computeEnv: - nullable: true - allOf: - - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - pipeline: - maxLength: 200 - type: string - workDir: - type: string - revision: - maxLength: 100 - type: string - configText: - type: string - towerConfig: - type: string - paramsText: - type: string - preRunScript: - type: string - postRunScript: - type: string - mainScript: - maxLength: 200 - type: string - entryName: - maxLength: 80 - type: string - schemaName: - maxLength: 100 - pattern: "[\\p{Graph}&&[^/]]\\p{Graph}+" - type: string - resume: - type: boolean - resumeLaunchId: - maxLength: 22 - type: string - pullLatest: - type: boolean - stubRun: - type: boolean - sessionId: - maxLength: 36 - type: string - runName: - maxLength: 80 - type: string - configProfiles: - type: array - items: - type: string - userSecrets: - type: array - items: - type: string - workspaceSecrets: - type: array - items: - type: string - optimizationId: - maxLength: 32 - type: string - optimizationTargets: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - launchContainer: - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - LaunchActionRequest: - type: object - properties: - params: - type: object - additionalProperties: true - LaunchActionResponse: - type: object - properties: - workflowId: - type: string - ListAccessTokensResponse: - type: object - properties: - tokens: - type: array - items: - $ref: "#/components/schemas/AccessToken" - ListActionsResponse: - type: object - properties: - actions: - type: array - items: - $ref: "#/components/schemas/ListActionsResponse.ActionInfo" - ListActionsResponse.ActionInfo: - type: object - properties: - id: - type: string - name: - type: string - pipeline: - type: string - source: - $ref: "#/components/schemas/Action.Source" - status: - $ref: "#/components/schemas/Action.Status" - lastSeen: - type: string - format: date-time - dateCreated: - type: string - format: date-time - event: - $ref: "#/components/schemas/Action.EventType" - endpoint: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - usageCmd: - type: string - ListComputeEnvsResponse: - type: object - properties: - computeEnvs: - type: array - items: - $ref: "#/components/schemas/ListComputeEnvsResponse.Entry" - ListComputeEnvsResponse.Entry: - type: object - properties: - id: - type: string - name: - type: string - platform: - type: string - status: - $ref: "#/components/schemas/ComputeEnv.Status" - message: - type: string - lastUsed: - type: string - format: date-time - primary: - type: boolean - workspaceName: - type: string - visibility: - type: string - workDir: - type: string - credentialsId: - type: string - region: - type: string - ListCredentialsResponse: - type: object - properties: - credentials: - type: array - items: - $ref: "#/components/schemas/Credentials" - ListDatasetVersionsResponse: - type: object - properties: - versions: - type: array - items: - $ref: "#/components/schemas/DatasetVersionDto" - ListDatasetsResponse: - type: object - properties: - datasets: - type: array - items: - $ref: "#/components/schemas/DatasetDto" - ListEventTypesResponse: - type: object - properties: - eventTypes: - type: array - items: - $ref: "#/components/schemas/EventType" - ListLabelsResponse: - type: object - properties: - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - totalSize: - type: integer - format: int64 - ListManagedCredentialsRespDto: - type: object - properties: - managedCredentialsId: - type: integer - format: int64 - description: "Managed credentials numeric identifier." - userId: - type: integer - format: int64 - description: "User numeric identifier associated with these credentials." - userName: - type: string - description: "Username of the associated user." - firstName: - type: string - description: "First name of the associated user." - lastName: - type: string - description: "Last name of the associated user." - avatarUrl: - type: string - description: "URL of the user's avatar image." - provider: - type: string - enum: - - ssh - description: "Authentication provider type." - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - description: "Additional metadata for the managed credentials." - ListManagedCredentialsResponse: - type: object - properties: - managedCredentials: - type: array - items: - $ref: "#/components/schemas/ListManagedCredentialsRespDto" - description: "Array of managed credentials objects." - totalSize: - type: integer - format: int64 - description: "Total number of managed credentials matching the query." - ListManagedIdentitiesResponse: - type: object - properties: - managedIdentities: - type: array - items: - $ref: "#/components/schemas/ManagedIdentityDbDto_AbstractGridConfig_" - description: "Array of managed identities." - totalSize: - type: integer - format: int64 - description: "Total number of managed identities matching the query." - ListMembersResponse: - type: object - properties: - members: - type: array - items: - $ref: "#/components/schemas/MemberDbDto" - totalSize: - type: integer - format: int64 - ListOrganizationsResponse: - type: object - properties: - organizations: - type: array - items: - $ref: "#/components/schemas/OrganizationDbDto" - totalSize: - type: integer - format: int32 - ListParticipantsResponse: - type: object - properties: - participants: - type: array - items: - $ref: "#/components/schemas/ParticipantDbDto" - totalSize: - type: integer - format: int64 - ListPipelineInfoResponse: - type: object - properties: - pipelines: - type: array - items: - type: string - ListPipelineSecretsResponse: - type: object - properties: - pipelineSecrets: - type: array - items: - $ref: "#/components/schemas/PipelineSecret" - totalSize: - type: integer - format: int64 - ListPipelinesResponse: - type: object - properties: - pipelines: - type: array - items: - $ref: "#/components/schemas/PipelineDbDto" - totalSize: - type: integer - format: int64 - ListPlatformsResponse: - type: object - properties: - platforms: - type: array - items: - $ref: "#/components/schemas/ComputePlatform" - ListRegionsResponse: - type: object - properties: - regions: - type: array - items: - $ref: "#/components/schemas/ComputeRegion" - ListTasksResponse: - type: object - properties: - tasks: - type: array - items: - $ref: "#/components/schemas/DescribeTaskResponse" - total: - type: integer - format: int64 - ListTeamResponse: - type: object - properties: - teams: - type: array - items: - $ref: "#/components/schemas/TeamDbDto" - totalSize: - type: integer - format: int64 - ListWorkflowsResponse: - type: object - properties: - workflows: - type: array - items: - $ref: "#/components/schemas/ListWorkflowsResponse.ListWorkflowsElement" - totalSize: - type: integer - format: int64 - ListWorkflowsResponse.ListWorkflowsElement: - type: object - properties: - workflow: - $ref: "#/components/schemas/WorkflowDbDto" - progress: - $ref: "#/components/schemas/ProgressData" - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - starred: - type: boolean - optimized: - type: boolean - ListWorkspacesAndOrgResponse: - type: object - properties: - orgsAndWorkspaces: - type: array - items: - $ref: "#/components/schemas/OrgAndWorkspaceDto" - ListWorkspacesResponse: - type: object - properties: - workspaces: - type: array - items: - $ref: "#/components/schemas/WorkspaceDbDto" - LocalPlatformMetainfo: - type: object - properties: - discriminator: - type: string - Log: - type: object - properties: - name: - type: string - cmd: - type: array - items: - type: string - start_time: - type: string - end_time: - type: string - stdout: - type: string - stderr: - type: string - exit_code: - type: integer - format: int32 - LogPage: - type: object - properties: - truncated: - type: boolean - entries: - $ref: "#/components/schemas/Iterator_String_" - rewindToken: - type: string - forwardToken: - type: string - pending: - type: boolean - message: - type: string - downloads: - type: array - items: - $ref: "#/components/schemas/LogPage.Download" - LogPage.Download: - type: object - properties: - saveName: - type: string - fileName: - type: string - displayText: - type: string - LsfComputeConfig: - title: IBM LSF configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - unitForLimits: - type: string - perJobMemLimit: - type: boolean - perTaskReserve: - type: boolean - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - ManagedCredentialsDbDto: - type: object - properties: - id: - type: integer - format: int64 - description: "Managed credentials numeric identifier." - ManagedCredentialsMetadata: - type: object - properties: - discriminator: - type: string - readOnly: true - description: "Type discriminator for metadata structure (read-only)." - ManagedIdentityDbDto_AbstractGridConfig_: - type: object - properties: - id: - type: integer - format: int64 - description: "Managed identity numeric identifier." - name: - type: string - description: "Name of the managed identity." - platform: - type: string - enum: - - altair-platform - - lsf-platform - - moab-platform - - slurm-platform - - uge-platform - description: "HPC platform type." - config: - $ref: "#/components/schemas/AbstractGridConfig" - description: "HPC platform-specific configuration for the managed identity." - Map.Entry_String.String_: - type: object - properties: - key: - type: string - value: - type: string - MemberDbDto: - type: object - properties: - memberId: - type: integer - format: int64 - userId: - type: integer - format: int64 - userName: - type: string - email: - type: string - firstName: - type: string - lastName: - type: string - avatar: - type: string - role: - $ref: "#/components/schemas/OrgRole" - MoabComputeConfig: - title: Moab configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - MultiRequestFileSchema: - type: object - properties: - file: - type: string - format: binary - NavbarConfig: - type: object - properties: - menus: - type: array - items: - $ref: "#/components/schemas/NavbarConfig.NavbarMenu" - NavbarConfig.NavbarMenu: - type: object - properties: - label: - type: string - url: - type: string - OrgAndWorkspaceDto: - type: object - properties: - orgId: - type: integer - format: int64 - orgName: - type: string - orgLogoUrl: - type: string - orgType: - $ref: "#/components/schemas/OrgType" - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - workspaceFullName: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - roles: - type: array - items: - type: string - OrgRole: - type: string - enum: - - owner - - member - - collaborator - x-enum-varnames: - - owner - - member - - collaborator - OrgType: - type: string - enum: - - academic - - evaluating - - pro - - basic - - internal - x-enum-varnames: - - academic - - evaluating - - pro - - basic - - internal - Organization: - required: - - fullName - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - readOnly: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - fullName: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - location: - maxLength: 100 - type: string - website: - pattern: "" - type: string - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - OrganizationDbDto: - type: object - properties: - paying: - type: boolean - deprecated: true - orgId: - type: integer - format: int64 - name: - type: string - fullName: - type: string - description: - type: string - location: - type: string - website: - type: string - logoId: - type: string - logoUrl: - type: string - memberId: - type: integer - format: int64 - memberRole: - $ref: "#/components/schemas/OrgRole" - type: - $ref: "#/components/schemas/OrgType" - OrganizationQuotas: - type: object - properties: - maxWorkspaces: - type: integer - format: int64 - maxMembers: - type: integer - format: int64 - maxTeams: - type: integer - format: int64 - maxPipelinesPerWorkspace: - type: integer - format: int64 - maxParticipantsPerWorkspace: - type: integer - format: int64 - maxDatasetsPerWorkspace: - type: integer - format: int64 - maxVersionsPerDataset: - type: integer - format: int64 - maxRuns: - type: integer - format: int64 - maxRunHistory: - type: integer - format: int64 - maxLabelsPerWorkspace: - type: integer - format: int64 - maxDataStudiosRunning: - type: integer - format: int64 - maxSeqeraComputeComputeEnvs: - type: integer - format: int64 - maxFusionThroughputBytes: - type: integer - format: int64 - ParticipantDbDto: - type: object - properties: - participantId: - type: integer - format: int64 - memberId: - type: integer - format: int64 - userName: - type: string - firstName: - type: string - lastName: - type: string - email: - type: string - orgRole: - $ref: "#/components/schemas/OrgRole" - teamId: - type: integer - format: int64 - teamName: - type: string - wspRole: - $ref: "#/components/schemas/WspRole" - type: - $ref: "#/components/schemas/ParticipantType" - teamAvatarUrl: - type: string - userAvatarUrl: - type: string - ParticipantType: - type: string - enum: - - MEMBER - - TEAM - - COLLABORATOR - PipelineDbDto: - type: object - properties: - pipelineId: - type: integer - format: int64 - name: - type: string - description: - type: string - icon: - type: string - repository: - type: string - userId: - type: integer - format: int64 - userName: - type: string - userFirstName: - type: string - userLastName: - type: string - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - visibility: - type: string - deleted: - type: boolean - lastUpdated: - type: string - format: date-time - optimizationId: - type: string - optimizationTargets: - type: string - optimizationStatus: - $ref: "#/components/schemas/PipelineOptimizationStatus" - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - computeEnv: - $ref: "#/components/schemas/ComputeEnvDbDto" - PipelineInfo: - type: object - properties: - projectName: - type: string - simpleName: - type: string - repositoryUrl: - type: string - cloneUrl: - type: string - provider: - type: string - configFiles: - type: array - items: - type: string - workDirs: - type: array - items: - type: string - revisions: - type: array - items: - type: string - profiles: - type: array - items: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - warnings: - type: array - items: - type: string - PipelineOptimizationStatus: - type: string - enum: - - OPTIMIZED - - OPTIMIZABLE - - UNAVAILABLE - PipelineQueryAttribute: - type: string - enum: - - optimized - - labels - - computeEnv - x-enum-varnames: - - optimized - - labels - - computeEnv - PipelineSchemaAttributes: - type: string - enum: - - schema - - params - x-enum-varnames: - - schema - - params - PipelineSchemaResponse: - required: - - schema - type: object - properties: - schema: - type: string - params: - type: string - PipelineSecret: - required: - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 100 - pattern: "^[a-zA-Z_](?:[0-9A-Za-z]+|(_)(?!\\1)){1,49}$" - type: string - lastUsed: - type: string - format: date-time - readOnly: true - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - PlatformMetainfo: - type: object - discriminator: - propertyName: discriminator - mapping: - gke-platform: "#/components/schemas/GkePlatformMetaInfo" - aws-cloud: "#/components/schemas/AwsCloudPlatformMetainfo" - seqeracompute: "#/components/schemas/SeqeraComputePlatformMetainfo" - k8s-platform: "#/components/schemas/K8sPlatformMetaInfo" - grid: "#/components/schemas/GridPlatformMetainfo" - aws-batch: "#/components/schemas/AwsBatchPlatformMetainfo" - google-cloud: "#/components/schemas/GoogleCloudPlatformMetaInfo" - local-platform: "#/components/schemas/LocalPlatformMetainfo" - azure-batch: "#/components/schemas/AzBatchPlatformMetainfo" - eks-platform: "#/components/schemas/EksPlatformMetaInfo" - oneOf: - - $ref: "#/components/schemas/AwsBatchPlatformMetainfo" - - $ref: "#/components/schemas/AwsCloudPlatformMetainfo" - - $ref: "#/components/schemas/GooglePlatformMetainfo" - - $ref: "#/components/schemas/GoogleCloudPlatformMetaInfo" - - $ref: "#/components/schemas/AzBatchPlatformMetainfo" - - $ref: "#/components/schemas/EksPlatformMetaInfo" - - $ref: "#/components/schemas/GkePlatformMetaInfo" - - $ref: "#/components/schemas/K8sPlatformMetaInfo" - - $ref: "#/components/schemas/GridPlatformMetainfo" - - $ref: "#/components/schemas/SeqeraComputePlatformDescriber" - - $ref: "#/components/schemas/LocalPlatformMetainfo" - PodCleanupPolicy: - type: string - enum: - - on_success - - always - - never - x-enum-varnames: - - on_success - - always - - never - ProcessLoad: - required: - - aborted - - cached - - cpuLoad - - cpuTime - - cpus - - failed - - ignored - - invCtxSwitch - - loadCpus - - loadMemory - - loadTasks - - memoryReq - - memoryRss - - peakCpus - - peakMemory - - peakTasks - - pending - - process - - readBytes - - retries - - running - - submitted - - succeeded - - volCtxSwitch - - writeBytes - type: object - properties: - pending: - type: integer - format: int64 - submitted: - type: integer - format: int64 - running: - type: integer - format: int64 - succeeded: - type: integer - format: int64 - failed: - type: integer - format: int64 - cached: - type: integer - format: int64 - aborted: - type: integer - format: int64 - retries: - type: integer - format: int64 - ignored: - type: integer - format: int64 - memoryEfficiency: - type: number - format: float - cpuEfficiency: - type: number - format: float - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - version: - type: integer - format: int64 - process: - type: string - cpus: - type: integer - format: int64 - deprecated: true - cpuTime: - type: integer - format: int64 - deprecated: true - cpuLoad: - type: integer - format: int64 - deprecated: true - memoryRss: - type: integer - format: int64 - deprecated: true - memoryReq: - type: integer - format: int64 - deprecated: true - readBytes: - type: integer - format: int64 - deprecated: true - writeBytes: - type: integer - format: int64 - deprecated: true - volCtxSwitch: - type: integer - format: int64 - deprecated: true - invCtxSwitch: - type: integer - format: int64 - deprecated: true - loadTasks: - type: integer - format: int64 - deprecated: true - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakCpus: - type: integer - format: int64 - peakTasks: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - ProgressData: - type: object - properties: - workflowProgress: - $ref: "#/components/schemas/WorkflowLoad" - processesProgress: - type: array - items: - $ref: "#/components/schemas/ProcessLoad" - totalProcesses: - type: integer - format: int32 - RandomWorkflowNameResponse: - type: object - properties: - name: - type: string - ResourceData: - type: object - properties: - warnings: - type: array - items: - type: string - mean: - type: number - format: float - min: - type: number - format: float - q1: - type: number - format: float - q2: - type: number - format: float - q3: - type: number - format: float - max: - type: number - format: float - minLabel: - type: string - maxLabel: - type: string - q1Label: - type: string - q2Label: - type: string - q3Label: - type: string - RunId: - type: object - properties: - run_id: - type: string - RunListResponse: - type: object - properties: - runs: - type: array - items: - $ref: "#/components/schemas/RunStatus" - next_page_token: - type: string - RunLog: - type: object - properties: - run_id: - type: string - request: - $ref: "#/components/schemas/RunRequest" - state: - $ref: "#/components/schemas/State" - run_log: - $ref: "#/components/schemas/Log" - task_logs: - type: array - items: - $ref: "#/components/schemas/Log" - outputs: {} - RunRequest: - type: object - properties: - workflow_params: - type: string - workflow_type: - type: string - workflow_type_version: - type: string - tags: - type: object - additionalProperties: - type: string - workflow_engine_parameters: - type: object - additionalProperties: - type: string - workflow_url: - type: string - RunStatus: - type: object - properties: - run_id: - type: string - state: - $ref: "#/components/schemas/State" - S3SecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - accessKey: - type: string - secretKey: - type: string - writeOnly: true - pathStyleAccessEnabled: - type: boolean - SSHSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - privateKey: - type: string - writeOnly: true - passphrase: - type: string - writeOnly: true - SecurityGroup: - type: object - properties: - id: - type: string - name: - type: string - vpcId: - type: string - SecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - discriminator: - propertyName: discriminator - mapping: - s3: "#/components/schemas/S3SecurityKeys" - github: "#/components/schemas/GitHubSecurityKeys" - azurerepos: "#/components/schemas/AzureReposSecurityKeys" - azure_entra: "#/components/schemas/AzureEntraKeys" - container-reg: "#/components/schemas/ContainerRegistryKeys" - tw-agent: "#/components/schemas/AgentSecurityKeys" - k8s: "#/components/schemas/K8sSecurityKeys" - ssh: "#/components/schemas/SSHSecurityKeys" - google: "#/components/schemas/GoogleSecurityKeys" - bitbucket: "#/components/schemas/BitBucketSecurityKeys" - gitea: "#/components/schemas/GiteaSecurityKeys" - seqeracompute: "#/components/schemas/SeqeraComputeSecurityKeys" - codecommit: "#/components/schemas/CodeCommitSecurityKeys" - gitlab: "#/components/schemas/GitLabSecurityKeys" - aws: "#/components/schemas/AwsSecurityKeys" - azure: "#/components/schemas/AzureSecurityKeys" - oneOf: - - $ref: "#/components/schemas/AwsSecurityKeys" - - $ref: "#/components/schemas/GoogleSecurityKeys" - - $ref: "#/components/schemas/GitHubSecurityKeys" - - $ref: "#/components/schemas/GitLabSecurityKeys" - - $ref: "#/components/schemas/BitBucketSecurityKeys" - - $ref: "#/components/schemas/GiteaSecurityKeys" - - $ref: "#/components/schemas/SSHSecurityKeys" - - $ref: "#/components/schemas/K8sSecurityKeys" - - $ref: "#/components/schemas/AzureSecurityKeys" - - $ref: "#/components/schemas/AzureReposSecurityKeys" - - $ref: "#/components/schemas/ContainerRegistryKeys" - - $ref: "#/components/schemas/AgentSecurityKeys" - - $ref: "#/components/schemas/CodeCommitSecurityKeys" - - $ref: "#/components/schemas/AzureEntraKeys" - - $ref: "#/components/schemas/SeqeraComputeSecurityKeys" - - $ref: "#/components/schemas/S3SecurityKeys" - SeqeraComputeConfig: - title: Seqera Compute configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - region: - type: string - description: "Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)." - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - defaultDataRetentionPolicy: - type: boolean - description: "If true, intermediary files are deleted after 28 days to manage storage cost/usage." - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - required: ["region", "workDir", "region", "workDir"] - SeqeraComputePlatformDescriber: - type: object - SeqeraComputePlatformMetainfo: - type: object - properties: - warnings: - type: array - items: - type: string - jobQueues: - type: array - items: - $ref: "#/components/schemas/JobQueue" - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - fileSystems: - type: array - items: - $ref: "#/components/schemas/FsxFileSystem" - efsFileSystems: - type: array - items: - $ref: "#/components/schemas/EfsFileSystem" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceFamilies: - type: array - items: - type: string - allocStrategy: - type: array - items: - type: string - instanceTypes: - type: array - items: - $ref: "#/components/schemas/InstanceType" - discriminator: - type: string - SeqeraComputeSecurityKeys: - type: object - allOf: - - $ref: "#/components/schemas/AwsSecurityKeys" - - properties: - discriminator: - type: string - readOnly: true - ServiceInfo: - type: object - properties: - version: - type: string - apiVersion: - type: string - commitId: - type: string - authTypes: - type: array - items: - type: string - loginPath: - type: string - navbar: - $ref: "#/components/schemas/NavbarConfig" - heartbeatInterval: - type: integer - format: int32 - userWorkspaceEnabled: - type: boolean - allowInstanceCredentials: - type: boolean - landingUrl: - type: string - termsOfUseUrl: - type: string - contentUrl: - type: string - analytics: - $ref: "#/components/schemas/Analytics" - allowLocalRepos: - type: boolean - deprecated: true - contentMaxFileSize: - type: integer - format: int64 - waveEnabled: - type: boolean - groundswellEnabled: - type: boolean - groundswellAllowedWorkspaces: - type: array - items: - type: integer - format: int64 - scmsServerUrl: - type: string - forgePrefix: - type: string - seqeraCloud: - type: boolean - evalWorkspaceIds: - type: array - items: - type: integer - format: int64 - contactEmail: - type: string - allowNextflowCliLogs: - type: boolean - logoutUrl: - type: string - nullable: true - ServiceInfoResponse: - type: object - properties: - serviceInfo: - $ref: "#/components/schemas/ServiceInfo" - SlurmComputeConfig: - title: Slurm configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - State: - type: string - enum: - - UNKNOWN - - QUEUED - - INITIALIZING - - RUNNING - - PAUSED - - COMPLETE - - EXECUTOR_ERROR - - SYSTEM_ERROR - - CANCELED - - CANCELING - StudioCheckpointStatus: - type: string - enum: - - empty - - interim - - finalized - - invalid - x-enum-varnames: - - empty - - interim - - finalized - - invalid - SubmitWorkflowLaunchRequest: - type: object - properties: - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - SubmitWorkflowLaunchResponse: - type: object - properties: - workflowId: - type: string - Subnet: - type: object - properties: - id: - type: string - zone: - type: string - vpcId: - type: string - Task: - required: - - status - - taskId - type: object - properties: - hash: - type: string - name: - type: string - process: - type: string - tag: - type: string - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - module: - type: array - items: - type: string - container: - type: string - attempt: - type: integer - format: int32 - script: - type: string - scratch: - type: string - workdir: - type: string - queue: - type: string - cpus: - type: integer - format: int32 - memory: - type: integer - format: int64 - disk: - type: integer - format: int64 - time: - type: integer - format: int64 - env: - type: string - executor: - type: string - machineType: - type: string - cloudZone: - type: string - priceModel: - $ref: "#/components/schemas/CloudPriceModel" - cost: - type: number - errorAction: - type: string - exitStatus: - type: integer - format: int32 - duration: - type: integer - format: int64 - realtime: - type: integer - format: int64 - nativeId: - type: string - pcpu: - type: number - format: double - pmem: - type: number - format: double - rss: - type: integer - format: int64 - vmem: - type: integer - format: int64 - peakRss: - type: integer - format: int64 - peakVmem: - type: integer - format: int64 - rchar: - type: integer - format: int64 - wchar: - type: integer - format: int64 - syscr: - type: integer - format: int64 - syscw: - type: integer - format: int64 - readBytes: - type: integer - format: int64 - writeBytes: - type: integer - format: int64 - volCtxt: - type: integer - format: int64 - invCtxt: - type: integer - format: int64 - exit: - type: integer - format: int32 - id: - type: integer - format: int64 - nullable: true - taskId: - type: integer - format: int64 - status: - $ref: "#/components/schemas/TaskStatus" - dateCreated: - type: string - format: date-time - nullable: true - lastUpdated: - type: string - format: date-time - nullable: true - TaskStatus: - type: string - enum: - - NEW - - SUBMITTED - - RUNNING - - CACHED - - COMPLETED - - FAILED - - ABORTED - Team: - required: - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - readOnly: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - description: - maxLength: 250 - type: string - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - TeamDbDto: - type: object - properties: - teamId: - type: integer - format: int64 - name: - type: string - description: - type: string - avatarUrl: - type: string - membersCount: - type: integer - format: int64 - TraceBeginRequest: - type: object - properties: - launchId: - type: string - deprecated: true - workflow: - $ref: "#/components/schemas/Workflow" - processNames: - type: array - items: - type: string - towerLaunch: - type: boolean - TraceBeginResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - watchUrl: - type: string - TraceCompleteRequest: - type: object - properties: - workflow: - $ref: "#/components/schemas/Workflow" - metrics: - type: array - items: - $ref: "#/components/schemas/WorkflowMetrics" - progress: - $ref: "#/components/schemas/TraceProgressData" - TraceCompleteResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - TraceCreateRequest: - type: object - properties: - launchId: - type: string - deprecated: true - sessionId: - type: string - runName: - type: string - projectName: - type: string - repository: - type: string - workflowId: - type: string - TraceCreateResponse: - type: object - properties: - message: - type: string - workflowId: - type: string - TraceHeartbeatRequest: - type: object - properties: - progress: - $ref: "#/components/schemas/TraceProgressData" - TraceHeartbeatResponse: - type: object - properties: - message: - type: string - TraceProcessingStatus: - type: string - enum: - - OK - - KO - TraceProgressData: - type: object - properties: - pending: - type: integer - format: int32 - submitted: - type: integer - format: int32 - running: - type: integer - format: int32 - succeeded: - type: integer - format: int32 - cached: - type: integer - format: int32 - failed: - type: integer - format: int32 - aborted: - type: integer - format: int32 - stored: - type: integer - format: int32 - ignored: - type: integer - format: int32 - retries: - type: integer - format: int32 - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakRunning: - type: integer - format: int32 - peakCpus: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - processes: - type: array - items: - $ref: "#/components/schemas/TraceProgressDetail" - TraceProgressDetail: - type: object - properties: - index: - type: integer - format: int32 - name: - type: string - pending: - type: integer - format: int32 - submitted: - type: integer - format: int32 - running: - type: integer - format: int32 - succeeded: - type: integer - format: int32 - cached: - type: integer - format: int32 - failed: - type: integer - format: int32 - aborted: - type: integer - format: int32 - stored: - type: integer - format: int32 - ignored: - type: integer - format: int32 - retries: - type: integer - format: int32 - terminated: - type: boolean - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakRunning: - type: integer - format: int32 - peakCpus: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - TraceProgressRequest: - type: object - properties: - tasks: - type: array - items: - $ref: "#/components/schemas/Task" - progress: - $ref: "#/components/schemas/TraceProgressData" - containers: - type: array - items: - $ref: "#/components/schemas/ContainerData" - TraceProgressResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - UnivaComputeConfig: - title: Univa Grid Engine configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - UpdateActionRequest: - type: object - properties: - name: - type: string - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - UpdateComputeEnvRequest: - type: object - properties: - name: - type: string - description: "New name for the compute environment. Must be unique within workspace." - credentialsId: - type: string - description: "Updated credentials identifier. Changing credentials may affect running workflows." - UpdateCredentialsRequest: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - UpdateDatasetRequest: - type: object - properties: - name: - type: string - description: - type: string - UpdateLabelRequest: - type: object - properties: - name: - type: string - value: - type: string - isDefault: - type: boolean - UpdateLabelResponse: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - isDefault: - type: boolean - UpdateManagedCredentialsRequest: - type: object - properties: - provider: - type: string - enum: - - ssh - description: "Authentication provider type. Currently supports `ssh`." - credentials: - $ref: "#/components/schemas/Credentials" - description: "Updated authentication credentials configuration." - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - description: "Additional metadata for the managed credentials." - UpdateManagedIdentityRequest: - type: object - properties: - managedIdentity: - $ref: "#/components/schemas/ManagedIdentityDbDto_AbstractGridConfig_" - description: "Updated managed identity configuration object." - UpdateMemberRoleRequest: - type: object - properties: - role: - $ref: "#/components/schemas/OrgRole" - UpdateOrganizationRequest: - type: object - properties: - fullName: - type: string - name: - type: string - description: - type: string - location: - type: string - website: - type: string - logoId: - type: string - paying: - type: boolean - nullable: true - deprecated: true - type: - nullable: true - allOf: - - $ref: "#/components/schemas/OrgType" - UpdateParticipantRoleRequest: - type: object - properties: - role: - $ref: "#/components/schemas/WspRole" - UpdatePipelineRequest: - type: object - properties: - name: - type: string - description: "Pipeline name. Must be unique within the workspace." - description: - type: string - description: "Pipeline description." - icon: - type: string - description: "Pipeline icon URL." - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - description: "Launch configuration for the pipeline." - labelIds: - type: array - items: - type: integer - format: int64 - description: "Array of label IDs to assign to the pipeline. If null, empty, or omitted, all existing labels are removed. Label IDs to be preserved must be included in your request." - UpdatePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - UpdatePipelineSecretRequest: - type: object - properties: - value: - type: string - UpdateTeamRequest: - type: object - properties: - name: - type: string - description: - type: string - avatarId: - type: string - UpdateWorkspaceRequest: - type: object - properties: - name: - type: string - fullName: - type: string - description: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - UploadDatasetVersionResponse: - type: object - properties: - version: - $ref: "#/components/schemas/DatasetVersionDto" - UploadEtag: - type: object - properties: - partNumber: - type: integer - format: int32 - eTag: - type: string - UserDbDto: - required: - - email - - userName - type: object - properties: - id: - type: integer - format: int64 - userName: - maxLength: 40 - type: string - email: - maxLength: 255 - type: string - format: email - firstName: - maxLength: 100 - type: string - lastName: - maxLength: 100 - type: string - organization: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - avatar: - type: string - avatarId: - type: string - notification: - type: boolean - termsOfUseConsent: - type: boolean - marketingConsent: - type: boolean - lastAccess: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - deleted: - type: boolean - UserInfo: - required: - - avatar - - email - - id - - userName - type: object - properties: - id: - type: integer - format: int64 - userName: - type: string - email: - type: string - avatar: - type: string - Visibility: - type: string - enum: - - PRIVATE - - SHARED - Vpc: - type: object - properties: - id: - type: string - isDefault: - type: boolean - WesErrorResponse: - type: object - properties: - msg: - type: string - status_code: - type: integer - format: int32 - WfFusionMeta: - type: object - properties: - enabled: - type: boolean - version: - maxLength: 20 - type: string - WfManifest: - type: object - properties: - nextflowVersion: - maxLength: 20 - type: string - defaultBranch: - maxLength: 20 - type: string - version: - maxLength: 20 - type: string - homePage: - maxLength: 200 - type: string - gitmodules: - maxLength: 150 - type: string - description: - maxLength: 1024 - type: string - name: - maxLength: 150 - type: string - mainScript: - maxLength: 100 - type: string - author: - maxLength: 150 - type: string - icon: - maxLength: 255 - type: string - WfNextflow: - type: object - properties: - version: - maxLength: 20 - type: string - build: - maxLength: 10 - type: string - timestamp: - type: string - format: date-time - WfStats: - type: object - properties: - computeTimeFmt: - maxLength: 50 - type: string - cachedCount: - type: integer - format: int32 - failedCount: - type: integer - format: int32 - ignoredCount: - type: integer - format: int32 - succeedCount: - type: integer - format: int32 - cachedCountFmt: - type: string - succeedCountFmt: - type: string - failedCountFmt: - type: string - ignoredCountFmt: - type: string - cachedPct: - type: number - format: float - failedPct: - type: number - format: float - succeedPct: - type: number - format: float - ignoredPct: - type: number - format: float - cachedDuration: - type: integer - format: int64 - failedDuration: - type: integer - format: int64 - succeedDuration: - type: integer - format: int64 - WfWaveMeta: - type: object - properties: - enabled: - type: boolean - Workflow: - required: - - commandLine - - projectName - - runName - - sessionId - - submit - - userName - - workDir - type: object - properties: - requiresAttention: - type: boolean - status: - $ref: "#/components/schemas/WorkflowStatus" - ownerId: - type: integer - format: int64 - readOnly: true - repository: - type: string - id: - maxLength: 16 - type: string - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - dateCreated: - type: string - format: date-time - nullable: true - readOnly: true - lastUpdated: - type: string - format: date-time - nullable: true - readOnly: true - runName: - maxLength: 80 - type: string - sessionId: - maxLength: 36 - type: string - profile: - maxLength: 100 - type: string - workDir: - type: string - commitId: - maxLength: 40 - type: string - userName: - maxLength: 40 - type: string - scriptId: - maxLength: 40 - type: string - revision: - maxLength: 100 - type: string - commandLine: - maxLength: 8096 - type: string - projectName: - maxLength: 200 - type: string - scriptName: - maxLength: 100 - type: string - launchId: - maxLength: 22 - type: string - configFiles: - type: array - items: - type: string - params: - type: object - additionalProperties: true - configText: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - nextflow: - $ref: "#/components/schemas/WfNextflow" - stats: - $ref: "#/components/schemas/WfStats" - fusion: - $ref: "#/components/schemas/WfFusionMeta" - wave: - $ref: "#/components/schemas/WfWaveMeta" - errorMessage: - type: string - errorReport: - type: string - deleted: - type: boolean - readOnly: true - projectDir: - type: string - homeDir: - type: string - container: - type: string - containerEngine: - type: string - scriptFile: - type: string - launchDir: - type: string - duration: - type: integer - format: int64 - exitStatus: - type: integer - format: int32 - resume: - type: boolean - success: - type: boolean - logFile: - maxLength: 255 - type: string - outFile: - maxLength: 255 - type: string - operationId: - maxLength: 110 - type: string - WorkflowDbDto: - type: object - properties: - messages: - type: array - items: - type: string - id: - type: string - ownerId: - type: integer - format: int64 - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - runName: - type: string - sessionId: - type: string - profile: - type: string - workDir: - type: string - commitId: - type: string - userName: - type: string - scriptId: - type: string - revision: - type: string - commandLine: - type: string - projectName: - type: string - scriptName: - type: string - launchId: - type: string - status: - $ref: "#/components/schemas/WorkflowStatus" - requiresAttention: - type: boolean - configFiles: - type: array - items: - type: string - params: - type: object - additionalProperties: true - configText: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - nextflow: - $ref: "#/components/schemas/WfNextflow" - stats: - $ref: "#/components/schemas/WfStats" - errorMessage: - type: string - errorReport: - type: string - deleted: - type: boolean - projectDir: - type: string - homeDir: - type: string - container: - type: string - repository: - type: string - containerEngine: - type: string - scriptFile: - type: string - launchDir: - type: string - duration: - type: integer - format: int64 - exitStatus: - type: integer - format: int32 - resume: - type: boolean - success: - type: boolean - WorkflowLaunchRequest: - type: object - properties: - id: - type: string - description: "Launch configuration identifier." - computeEnvId: - type: string - description: "Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted." - runName: - type: string - description: "Custom run name for the workflow execution." - pipeline: - type: string - description: "Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`)." - workDir: - type: string - description: "Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted." - revision: - type: string - description: "Git revision, branch, or tag to use." - sessionId: - type: string - description: "Nextflow session identifier for resuming failed runs." - configProfiles: - type: array - items: - type: string - description: "Array of Nextflow configuration profile names to apply." - userSecrets: - type: array - items: - type: string - description: "Array of user secrets to make available to the pipeline." - workspaceSecrets: - type: array - items: - type: string - description: "Array of workspace secrets to make available to the pipeline." - configText: - type: string - description: "Nextflow configuration as text (overrides config files)." - towerConfig: - type: string - description: "Platform-specific configuration options." - paramsText: - type: string - description: "Pipeline parameters in JSON or YAML format." - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - mainScript: - type: string - description: "Alternative main script filename. Default: `main.nf`." - entryName: - type: string - description: "Workflow entry point name when using Nextflow DSL2." - schemaName: - type: string - description: "Name of the pipeline schema to use." - resume: - type: boolean - description: "Enable resume to restart workflow execution from the last successful process. See [Resume a workflow run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run)." - pullLatest: - type: boolean - description: "Pull the latest version of the pipeline from the repository." - stubRun: - type: boolean - description: "Execute a stub run for testing (processes return dummy results)." - optimizationId: - type: string - description: "Optimization configuration identifier. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)." - optimizationTargets: - type: string - description: "Comma-separated list of optimization targets. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)." - labelIds: - type: array - items: - type: integer - format: int64 - description: "Array of label IDs to assign to each pipeline run." - headJobCpus: - type: integer - format: int32 - description: "Number of CPUs allocated for the Nextflow head job." - headJobMemoryMb: - type: integer - format: int32 - description: "Memory allocation for the Nextflow head job in megabytes." - launchContainer: - type: string - description: "Container image to use for the Nextflow launcher." - dateCreated: - type: string - format: date-time - description: "Timestamp when the launch configuration was created." - WorkflowLaunchResponse: - type: object - properties: - id: - type: string - computeEnv: - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - pipeline: - type: string - pipelineId: - type: integer - format: int64 - workDir: - type: string - revision: - type: string - sessionId: - type: string - configProfiles: - type: array - items: - type: string - userSecrets: - type: array - items: - type: string - workspaceSecrets: - type: array - items: - type: string - configText: - type: string - towerConfig: - type: string - paramsText: - type: string - preRunScript: - type: string - postRunScript: - type: string - mainScript: - type: string - entryName: - type: string - schemaName: - type: string - resume: - type: boolean - pullLatest: - type: boolean - stubRun: - type: boolean - resumeDir: - type: string - resumeCommitId: - type: string - headJobMemoryMb: - type: integer - format: int32 - headJobCpus: - type: integer - format: int32 - optimizationId: - type: string - optimizationTargets: - type: string - dateCreated: - type: string - format: date-time - WorkflowLoad: - required: - - aborted - - cached - - cpuLoad - - cpuTime - - cpus - - failed - - ignored - - invCtxSwitch - - loadCpus - - loadMemory - - loadTasks - - memoryReq - - memoryRss - - peakCpus - - peakMemory - - peakTasks - - pending - - readBytes - - retries - - running - - submitted - - succeeded - - volCtxSwitch - - writeBytes - type: object - properties: - pending: - type: integer - format: int64 - submitted: - type: integer - format: int64 - running: - type: integer - format: int64 - succeeded: - type: integer - format: int64 - failed: - type: integer - format: int64 - cached: - type: integer - format: int64 - aborted: - type: integer - format: int64 - retries: - type: integer - format: int64 - ignored: - type: integer - format: int64 - memoryEfficiency: - type: number - format: float - cpuEfficiency: - type: number - format: float - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - version: - type: integer - format: int64 - executors: - type: array - items: - type: string - cpus: - type: integer - format: int64 - cpuTime: - type: integer - format: int64 - cpuLoad: - type: integer - format: int64 - memoryRss: - type: integer - format: int64 - memoryReq: - type: integer - format: int64 - readBytes: - type: integer - format: int64 - writeBytes: - type: integer - format: int64 - volCtxSwitch: - type: integer - format: int64 - invCtxSwitch: - type: integer - format: int64 - loadTasks: - type: integer - format: int64 - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakCpus: - type: integer - format: int64 - peakTasks: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - cost: - type: number - netCpus: - type: integer - format: int64 - netCpuTime: - type: integer - format: int64 - netCpuLoad: - type: integer - format: int64 - netMemoryRss: - type: integer - format: int64 - netMemoryReq: - type: integer - format: int64 - netMemoryConsumption: - type: number - netReadBytes: - type: integer - format: int64 - netWriteBytes: - type: integer - format: int64 - netVolCtxSwitch: - type: integer - format: int64 - netInvCtxSwitch: - type: integer - format: int64 - netCost: - type: number - WorkflowLogResponse: - type: object - properties: - log: - $ref: "#/components/schemas/LogPage" - WorkflowMetrics: - required: - - process - type: object - properties: - id: - type: integer - format: int64 - nullable: true - process: - maxLength: 255 - type: string - cpu: - $ref: "#/components/schemas/ResourceData" - mem: - $ref: "#/components/schemas/ResourceData" - vmem: - $ref: "#/components/schemas/ResourceData" - time: - $ref: "#/components/schemas/ResourceData" - reads: - $ref: "#/components/schemas/ResourceData" - writes: - $ref: "#/components/schemas/ResourceData" - cpuUsage: - $ref: "#/components/schemas/ResourceData" - memUsage: - $ref: "#/components/schemas/ResourceData" - timeUsage: - $ref: "#/components/schemas/ResourceData" - WorkflowQueryAttribute: - type: string - enum: - - optimized - - labels - - messages - - minimal - x-enum-varnames: - - optimized - - labels - - messages - - minimal - WorkflowStatus: - type: string - enum: - - SUBMITTED - - RUNNING - - SUCCEEDED - - FAILED - - CANCELLED - - UNKNOWN - Workspace: - required: - - fullName - - name - - visibility - type: object - properties: - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - fullName: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - visibility: - $ref: "#/components/schemas/Visibility" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - WorkspaceDbDto: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - fullName: - type: string - description: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - WspRole: - type: string - enum: - - owner - - admin - - maintain - - launch - - connect - - view - x-enum-varnames: - - owner - - admin - - maintain - - launch - - connect - - view - securitySchemes: - BearerAuth: - type: http - scheme: bearer - bearerFormat: jwt diff --git a/platform-api-docs/scripts/specs/seqera-api-old-base.yml b/platform-api-docs/scripts/specs/seqera-api-old-base.yml deleted file mode 100644 index 55b4a19d0..000000000 --- a/platform-api-docs/scripts/specs/seqera-api-old-base.yml +++ /dev/null @@ -1,14021 +0,0 @@ -openapi: 3.0.1 -info: - title: Seqera API - description: Seqera Platform services API - contact: - url: https://seqera.io - email: info@seqera.io - version: 1.66.0 -tags: -- name: actions - description: Pipeline actions -- name: avatars - description: Avatars -- name: compute-envs - description: Compute environments -- name: credentials - description: Credentials -- name: data-links - description: Cloud storage directory paths in Data Explorer -- name: datasets - description: Pipeline input datasets (samplesheets) in CSV or TSV format -- name: ga4gh - description: GA4GH workflow execution service runs -- name: labels - description: Labels and resource labels -- name: launch - description: Workflow launch events -- name: orgs - description: Organizations -- name: pipelines - description: Pipelines -- name: pipeline-secrets - description: Pipeline secrets in a user or workspace context -- name: platforms - description: Computing platforms -- name: service-info - description: Seqera Platform API service information -- name: studios - description: Studios and Studio sessions -- name: teams - description: Teams in an organization context -- name: tokens - description: API access tokens -- name: trace - description: Workflow execution traces -- name: users - description: Users -- name: workflows - description: Workflow executions -- name: workspaces - description: Workspaces in an organization context -paths: - /actions: - get: - tags: - - actions - summary: List actions - description: "Lists all available actions in a user context, enriched by `attributes`.\ - \ Append `?workspaceId` to list actions in a workspace context." - operationId: ListActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ActionQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListActionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - actions - summary: Create action - description: Creates a new pipeline action. Append `?workspaceId` to associate - the action with the given workspace. - operationId: CreateAction - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateActionRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/add: - post: - tags: - - labels - summary: Add labels to actions - description: Adds the given list of labels to the given pipeline actions. Existing - labels are preserved. - operationId: AddLabelsToActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/apply: - post: - tags: - - labels - summary: Replace action labels - description: Applies the given list of labels to the given pipeline actions. - Existing labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/labels/remove: - post: - tags: - - labels - summary: Remove labels from actions - description: Removes the given list of labels from the given pipeline actions. - operationId: RemoveLabelsFromActions - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateActionLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/types: - get: - tags: - - actions - summary: List action event types - description: Lists the supported event types that trigger a pipeline action. - Append `?workspaceId` to list event types in a workspace context. - operationId: ListActionTypes - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListEventTypesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/validate: - get: - tags: - - actions - summary: Validate action name - description: Confirms the validity of the given action name. Append `?name=`. - operationId: ValidateActionName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Action name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /actions/{actionId}: - get: - tags: - - actions - summary: Describe action - description: Retrieves the details of the action identified by the given `actionId`. - operationId: DescribeAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ActionQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - actions - summary: Update action - description: Updates the details of the action identified by the given `actionId`. - The `source` of an existing action cannot be changed. - operationId: UpdateAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateActionRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - actions - summary: Delete action - description: Deletes the pipeline action identified by the given `actionId`. - operationId: DeleteAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/{actionId}/launch: - post: - tags: - - actions - summary: Trigger Tower Launch action - description: Triggers the execution of the Tower Launch action identified by - the given `actionId`. - operationId: LaunchAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Action launch request - content: - application/json: - schema: - $ref: "#/components/schemas/LaunchActionRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/LaunchActionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /actions/{actionId}/pause: - post: - tags: - - actions - summary: Pause or resume action - description: Pauses or resumes the pipeline action identified by the given `actionId`. - operationId: PauseAction - parameters: - - name: actionId - in: path - description: Action string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /avatars: - post: - tags: - - avatars - summary: Create the avatar image - operationId: CreateAvatar - requestBody: - description: Image file request - content: - multipart/form-data: - schema: - type: object - properties: - image: - type: string - format: binary - encoding: - image: - contentType: application/octet-stream - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAvatarResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /avatars/{avatarId}: - get: - tags: - - avatars - summary: Download the avatar image - operationId: DownloadAvatar - parameters: - - name: avatarId - in: path - description: Avatar string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found element - security: - - BearerAuth: [] - /compute-envs: - get: - tags: - - compute-envs - summary: List compute environments - description: "Lists all available compute environments in a user context. Append\ - \ `?workspaceId` to list compute environments in a workspace context, and\ - \ `?status` to filter by compute environment status." - operationId: ListComputeEnvs - parameters: - - name: status - in: query - description: Compute environment status - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListComputeEnvsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - compute-envs - summary: Create compute environment - description: Creates a new compute environment. Append `?workspaceId` to create - the environment in a workspace context. - operationId: CreateComputeEnv - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Compute environment create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateComputeEnvRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateComputeEnvResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /compute-envs/validate: - get: - tags: - - compute-envs - summary: Validate compute environment name - description: Confirms the validity of the given compute environment name in - a user context. Append `?name=`. - operationId: ValidateComputeEnvName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Compute environment name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /compute-envs/{computeEnvId}: - get: - tags: - - compute-envs - summary: Describe compute environment - description: Retrieves the details of the compute environment identified by - the given `computeEnvId`. - operationId: DescribeComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/ComputeEnvQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeComputeEnvResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - compute-envs - summary: Update compute environment - description: Updates the details of the compute environment identified by the - given `computeEnvId`. - operationId: UpdateComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Compute environment update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateComputeEnvRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - compute-envs - summary: Delete compute environment - description: Deletes the compute environment identified by the given `computeEnvId`. - operationId: DeleteComputeEnv - parameters: - - name: computeEnvId - in: path - description: Compute environment string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Conflicting deletion - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /compute-envs/{computeEnvId}/primary: - post: - tags: - - compute-envs - summary: Define primary compute environment - description: Selects the compute environment identified by the given `computeEnvId` - as the primary compute environment in the given workspace context. - operationId: UpdateComputeEnvPrimary - parameters: - - name: computeEnvId - in: path - description: Compute environment string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /credentials: - get: - tags: - - credentials - summary: List credentials - description: "Lists all available credentials in a user context. Append `?workspaceId`\ - \ to list credentials in a workspace context, and `?platformId` to filter\ - \ credentials by computing platform." - operationId: ListCredentials - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: platformId - in: query - description: Platform string identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - credentials - summary: Create credentials - description: Creates new credentials in a user context. Append `?workspaceId` - to create the credentials in a workspace context. - operationId: CreateCredentials - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Credentials create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCredentialsRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /credentials/validate: - get: - tags: - - credentials - summary: Validate credential name - description: Validates the given credentials name. Append `?name=`. - operationId: ValidateCredentialsName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Credentials name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /credentials/{credentialsId}: - get: - tags: - - credentials - summary: Describe credentials - description: Retrieves the details of the credentials identified by the given - `credentialsId`. - operationId: DescribeCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - credentials - summary: Update credentials - description: Updates the details of the credentials identified by the given - `credentialsId`. - operationId: UpdateCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Credentials update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateCredentialsRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - credentials - summary: Delete credentials - description: Deletes the credentials identified by the given `credentialsId`. - operationId: DeleteCredentials - parameters: - - name: credentialsId - in: path - description: Credentials string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: checked - in: query - description: If set credentials deletion will be blocked by running jobs that - depend on them - schema: - type: boolean - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this credentials - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteCredentialsConflictResponse" - security: - - BearerAuth: [] - /data-links: - get: - tags: - - data-links - summary: List data-links - description: | - Retrieves all available data-links in a user context. Append `?workspaceId={your-workspace-id}` to retrieve data-links in a workspace context. - operationId: ListDataLinks - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials identifier - schema: - type: string - - name: search - in: query - description: "Free text search criteria — data-link name and keywords: `region`,\ - \ `provider`." - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: visibility - in: query - description: Filter results by visibility - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinksListResponse" - "202": - description: Accepted - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinksListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, or the API\ - \ is disabled in the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - data-links - summary: Create data-link - description: Creates a new data-link in a user context. Append `?workspaceId=` - to create the data-link in a workspace context. - operationId: CreateCustomDataLink - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Data-link creation request - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkCreateRequest" - required: true - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ in the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/cache/refresh: - get: - tags: - - data-links - summary: Refresh data-link cache - description: Refreshes the data-link cache for the given `workspaceId` or `credentialsId` - operationId: RefreshDataLinkCache - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - responses: - "200": - description: OK - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}: - get: - tags: - - data-links - summary: Describe data-link - description: Retrieves the details of the data-link associated with the given - `dataLinkId`. - operationId: DescribeDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - data-links - summary: Update data-link - description: Update the data-link associated with the given `dataLinkId`. - operationId: UpdateCustomDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Data-link update request - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkUpdateRequest" - required: true - responses: - "200": - description: Success — Data-link updated - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - data-links - summary: Delete data-link - description: Deletes the data-link associated with the given `dataLinkId`. - operationId: DeleteCustomDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: Success — Data-link deleted - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "204": - description: DeleteCustomDataLink 204 response - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse: - get: - tags: - - data-links - summary: Explore data-link path - description: "Retrieves the content of the data-link associated with the given\ - \ `dataLinkId`, at the given `path`." - operationId: ExploreDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: path - in: path - description: Content path - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: search - in: query - description: Prefix search of data-link content - schema: - type: string - - name: nextPageToken - in: query - description: Token used to fetch the next page of items - schema: - type: string - - name: pageSize - in: query - description: "Number of items to return per page. If ommitted, a default maximum\ - \ value is returned." - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse-tree: - get: - tags: - - data-links - summary: Explore a data-link tree - description: Provides a list of all files in the provided paths (including files - in sub-paths). - operationId: ExploreDataLinkTree - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: paths - in: query - description: List of paths - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentTreeListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/browse/{path}: - get: - tags: - - data-links - summary: Explore data-link path - description: "Retrieves the content of the data-link associated with the given\ - \ `dataLinkId`, at the given `path`." - operationId: ExploreDataLink_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: path - in: path - description: Content path - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: search - in: query - description: Prefix search of data-link content - schema: - type: string - - name: nextPageToken - in: query - description: Token used to fetch the next page of items - schema: - type: string - - name: pageSize - in: query - description: "Number of items to return per page. If ommitted, a default maximum\ - \ value is returned." - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkContentResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/content: - delete: - tags: - - data-links - summary: Delete data-link content - description: Deletes the content of the data-link associated with the given - `dataLinkId`. The data-link itself is preserved. - operationId: DeleteDataLinkItem - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDeleteItemRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDeleteItemResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/download: - get: - tags: - - data-links - summary: Download data-link file at path - description: Downloads the content at the given `filePath` in the data-link - associated with the given `dataLinkId`. - operationId: DownloadDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: filePath - in: path - description: File path to download - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/generate-download-url: - get: - tags: - - data-links - summary: Generate data-link file download URL - description: Returns a URL to download files from the data-link associated with - the given `dataLinkId`. - operationId: GenerateDownloadUrlDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: filePath - in: query - description: File path to download - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: preview - in: query - description: "Whether to generate the URL for preview purposes or direct download\ - \ (default: false)" - schema: - type: boolean - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDownloadUrlResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/script/download: - get: - tags: - - data-links - summary: Generate download script - description: Creates a script to download files from the data-link associated - with the given `dataLinkId`. Append `?dirs` or `?files` to specify a list - of files or paths to download within the data-link. - operationId: GenerateDownloadScript - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: dirs - in: query - description: List of paths to directories to download - schema: - type: array - items: - type: object - - name: files - in: query - description: List of paths to files to download - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkDownloadScriptResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload: - post: - tags: - - data-links - summary: Generate data-link file upload URL (to given path) - description: |- - Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). - For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - operationId: GenerateDataLinkUploadUrl - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: Origin - in: header - schema: - type: string - nullable: true - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/finish: - post: - tags: - - data-links - summary: Finish data-link file upload to given path - description: "Finish upload of a data-link file, specifying a file path (`dirPath`).\ - \ This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize\ - \ a successful file upload, or abort an upload if an error was encountered\ - \ while uploading a file using an upload URL from the `/upload` endpoint." - operationId: FinishDataLinkUpload - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkFinishMultiPartUploadRequest" - required: true - responses: - "202": - description: No content - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "200": - description: FinishDataLinkUpload 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/finish/{dirPath}: - post: - tags: - - data-links - summary: Finish data-link file upload to given path - description: "Finish upload of a data-link file, specifying a file path (`dirPath`).\ - \ This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize\ - \ a successful file upload, or abort an upload if an error was encountered\ - \ while uploading a file using an upload URL from the `/upload` endpoint." - operationId: FinishDataLinkUpload_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkFinishMultiPartUploadRequest" - required: true - responses: - "202": - description: No content - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "200": - description: FinishDataLinkUpload_1 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /data-links/{dataLinkId}/upload/{dirPath}: - post: - tags: - - data-links - summary: Generate data-link file upload URL (to given path) - description: |- - Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). - For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - operationId: GenerateDataLinkUploadUrl_1 - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: Origin - in: header - schema: - type: string - nullable: true - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataLinkMultiPartUploadResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets: - get: - tags: - - datasets - summary: List datasets - description: Lists all available datasets in a user context. Append `?workspaceId` - to list datasets in a workspace context. - operationId: ListDatasetsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - datasets - summary: Create dataset - description: Creates a new dataset in the user context. Include the dataset - file and details in your request body. Append `?workspaceId` to create the - dataset in a workspace context. - operationId: CreateDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Dataset create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /datasets/versions: - get: - tags: - - datasets - summary: List latest dataset versions - description: Lists the latest version of each dataset in the user context. Append - `?workspaceId` to list latest versions in a workspace context. - operationId: ListLatestDatasetVersionsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: mimeType - in: query - description: Dataset MIME type - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}: - put: - tags: - - datasets - summary: Update dataset - description: Updates the details of the dataset identified by the given `datasetId`. - operationId: UpdateDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - requestBody: - description: Dataset update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateDatasetRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - datasets - summary: Delete dataset - description: Deletes the dataset identified by the given `datasetId`. - operationId: DeleteDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/metadata: - get: - tags: - - datasets - summary: Describe dataset - description: Retrieves the metadata of the dataset identified by the given `datasetId`. - operationId: DescribeDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/upload: - post: - tags: - - datasets - summary: Upload new dataset version - description: Uploads the CSV or TSV content to create a new version of the dataset - identified by the given `datasetId`. - operationId: UploadDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: header - in: query - description: Uploaded file has header - schema: - type: boolean - requestBody: - description: Dataset file request - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/MultiRequestFileSchema" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UploadDatasetVersionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /datasets/{datasetId}/v/{version}/n/{fileName}: - get: - tags: - - datasets - summary: Download dataset content - description: Downloads the content of the dataset identified by the given `datasetId` - and `version`. - operationId: DownloadDatasetV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: version - in: path - description: Version number to download - required: true - schema: - type: string - - name: fileName - in: path - description: File name for the downloaded dataset content - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /datasets/{datasetId}/versions: - get: - tags: - - datasets - summary: List all dataset versions - description: Lists all versions of the given `datasetId`. - operationId: ListDatasetVersionsV2 - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: mimeType - in: query - description: Optional MIME type filter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /ga4gh/wes/v1/runs: - get: - tags: - - ga4gh - summary: "GA4GH: List runs" - description: Uses the GA4GH workflow execution service API to list all run records. - operationId: Ga4ghRunList - parameters: - - name: page_size - in: query - description: Page size - schema: - type: integer - format: int32 - - name: page_token - in: query - description: Page token - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunListResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - post: - tags: - - ga4gh - summary: "GA4GH: Launch run" - description: "Uses the GA4GH workflow execution service API to launch a new\ - \ run. Runs are launched in the user workspace context by default. To launch\ - \ in an organization workspace context, include the `workspaceId` in `workflow_engine_parameters`.\ - \ Runs are launched with the workspace primary compute environment by default.\ - \ To launch with a different compute environment, include the `computeEnvId`\ - \ in `workflow_engine_parameters`." - operationId: Ga4ghRunCreate - requestBody: - description: Run request - content: - application/json: - schema: - $ref: "#/components/schemas/RunRequest" - multipart/form-data: - schema: - $ref: "#/components/schemas/RunRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunId" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}: - get: - tags: - - ga4gh - summary: "GA4GH: Describe run" - description: Uses the GA4GH workflow execution service API to retrieve the details - of the run assoiated with the given `run_id`. - operationId: Ga4ghRunDescribe - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunLog" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}/cancel: - post: - tags: - - ga4gh - summary: "GA4GH: Cancel run" - description: Uses the GA4GH workflow execution service API to cancel the run - associated with the given `run_id`. - operationId: Ga4ghRunCancel - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunId" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/runs/{run_id}/status: - get: - tags: - - ga4gh - summary: "GA4GH: Retrieve run status" - description: Uses the GA4GH workflow execution service API to retrieve the status - of the run associated with the given `run_id`. - operationId: Ga4ghRunStatus - parameters: - - name: run_id - in: path - description: Run string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/RunStatus" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /ga4gh/wes/v1/service-info: - get: - tags: - - ga4gh - summary: GA4GH workflow execution service API info - operationId: Ga4ghServiceInfo - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ServiceInfo" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/WesErrorResponse" - "403": - description: Operation not allowed - /identities: - get: - tags: - - identities - summary: List Managed Identities - description: List all Managed Identities in an organization. - operationId: ListManagedIdentities - parameters: - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: search - in: query - description: "Optional search criteria, allowing free text search on name\ - \ and keywords: `platform:`" - schema: - type: string - nullable: true - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - nullable: true - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListManagedIdentitiesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - identities - summary: Create Managed Identity - description: Create a new Managed Identity in an organization. - operationId: CreateManagedIdentity - parameters: - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Managed Identity create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /identities/{managedIdentityId}: - get: - tags: - - identities - summary: Describe a Managed Identity - description: Describe a Managed Identity in an organization. - operationId: DescribeManagedIdentity - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedIdentityResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - identities - summary: Update a Managed Identity - description: Update a Managed Identity identified by the given ID. - operationId: UpdateManagedIdentity - parameters: - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Managed Identity update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateManagedIdentityRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - identities - summary: Delete a Managed Identity - description: Delete a Managed Identity identified by the given ID. - operationId: DeleteManagedIdentity - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: checked - in: query - description: If deletion of associated Managed Credentials will be blocked - by running jobs that depend on them - schema: - type: boolean - nullable: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this Managed Identity - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse" - security: - - BearerAuth: [] - /identities/{managedIdentityId}/credentials: - get: - tags: - - identities - summary: List Managed Credentials - description: List Managed Credentials belonging to a Managed Identity. - operationId: ListManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: userId - in: query - description: User numeric identifier to filter records by - schema: - type: integer - format: int64 - nullable: true - - name: search - in: query - description: "Optional filtering on Managed Credentials for the given Managed\ - \ Identity: Allows free text\ - \ search on `userName` or `firstName + lastName`. \ - \ Accepts keywords: `is:missing` or `is:added` to\ - \ filter on credentials status. \ - \ If not provided (or both provided), all are returned." - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListManagedCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - identities - summary: Creates Managed Credentials - description: Creates Managed Credentials for the given Managed Identity - operationId: CreateManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: userId - in: query - description: User numeric identifier - schema: - type: integer - format: int64 - nullable: true - requestBody: - description: Managed Credentials create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedCredentialsRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateManagedCredentialsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /identities/{managedIdentityId}/credentials/{managedCredentialsId}: - put: - tags: - - identities - summary: Updates Managed Credentials - description: Update Managed Credentials for the given Managed Identity - operationId: UpdateManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: managedCredentialsId - in: path - description: Managed Credentials numeric identifier - required: true - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Managed Credentials update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateManagedCredentialsRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - identities - summary: Delete a user's Managed Credentials record belonging to a Managed Identity - description: Delete Managed Credentials - operationId: DeleteManagedCredentials - parameters: - - name: managedIdentityId - in: path - description: Managed Identity numeric identifier - required: true - schema: - type: integer - format: int64 - - name: managedCredentialsId - in: path - description: Managed Credentials numeric identifier - required: true - schema: - type: integer - format: int64 - nullable: true - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: checked - in: query - description: If Managed Credentials deletion will be blocked by running jobs - that depend on them - schema: - type: boolean - nullable: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Running jobs block the deletion of this Managed Credentials - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse" - security: - - BearerAuth: [] - /labels: - get: - tags: - - labels - summary: List labels - description: Lists all available labels in a user context. Append `?workspaceId` - to list labels in a workspace context. - operationId: ListLabels - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - - name: type - in: query - description: Label type - schema: - $ref: "#/components/schemas/LabelType" - - name: isDefault - in: query - description: Label default flag - schema: - type: boolean - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListLabelsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - labels - summary: Create label - description: "Creates a new label or returns an existing label based on name/value.\ - \ By default the operation works in a user context, append `?workspaceId`\ - \ to create/retrieve a label in a workspace context. Resource labels include\ - \ `resource: true` and a `value`." - operationId: CreateLabel - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: "Provide a label `name`. Set `resource: true` for resource labels.\ - \ Only resource labels have a `value` — if `resource: true`, include a `value`.\ - \ Else, omit `value` from your request body." - content: - application/json: - schema: - $ref: "#/components/schemas/CreateLabelRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateLabelResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /labels/dynamic/allowed: - get: - tags: - - labels - operationId: GetAllowedDynamicLabels - responses: - "200": - description: Ok - content: - application/json: - schema: - $ref: "#/components/schemas/AllowedDynamicLabelsResponse" - "400": - description: Bad Request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /labels/{labelId}: - put: - tags: - - labels - summary: Update label - description: Updates the label identified by the given `labelId`. - operationId: UpdateLabel - parameters: - - name: labelId - in: path - description: Label numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Label update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateLabelRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateLabelResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - labels - summary: Delete label - description: Deletes the label identified by the given `labelId`. - operationId: DeleteLabel - parameters: - - name: labelId - in: path - description: Label numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /launch/{launchId}: - get: - tags: - - launch - summary: Describe Launch record - description: Retrieves the details of the launch identified by the given `launchId`. - operationId: DescribeLaunch - parameters: - - name: launchId - in: path - description: Launch string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /launch/{launchId}/datasets: - get: - tags: - - datasets - summary: Describe launch datasets - description: Retrieves the details of the datasets used in the launch identified - by the given `launchId`. - operationId: ListLaunchDatasetVersions - parameters: - - name: launchId - in: path - description: Launch string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs: - get: - tags: - - orgs - summary: List organizations - description: Lists all available organizations in a user context. - operationId: ListOrganizations - parameters: - - name: role - in: query - description: Organization user role identifier - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListOrganizationsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - orgs - summary: Create organization - description: Creates a new organization. - operationId: CreateOrganization - requestBody: - description: Organization create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateOrganizationRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateOrganizationResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/validate: - get: - tags: - - orgs - summary: Validate organization name - description: Confirms the validity of the given organization name. Append `?name=`. - operationId: ValidateOrganizationName - parameters: - - name: name - in: query - description: Organization name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}: - get: - tags: - - orgs - summary: Describe organization - description: Retrieves the details of the organization identified by the given - `orgId`. - operationId: DescribeOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeOrganizationResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - orgs - summary: Update organization - description: Updates the details of the organization identified by the given - `orgId`. - operationId: UpdateOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Organization update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateOrganizationRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - orgs - summary: Delete organization - description: Deletes the organization identified by the given `orgId`. - operationId: DeleteOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/collaborators: - get: - tags: - - orgs - summary: List organization collaborators - description: Lists the collaborators of the organization identified by the given - `orgId`. - operationId: ListOrganizationCollaborators - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members: - get: - tags: - - orgs - summary: List organization members - description: Lists the members of the organization identified by the given `orgId`. - operationId: ListOrganizationMembers - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/add: - put: - tags: - - orgs - summary: Add organization member - description: Adds a new member to the organization identified by the given `orgId`. - operationId: CreateOrganizationMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Member addition request - content: - application/json: - schema: - $ref: "#/components/schemas/AddMemberRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddMemberResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/members/leave: - delete: - tags: - - orgs - summary: Leave organization - description: Removes the requesting user from the organization identified by - the given `orgId`. - operationId: LeaveOrganization - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/{memberId}: - delete: - tags: - - orgs - summary: Delete member - description: Deletes the member identified by the given `memberId`. - operationId: DeleteOrganizationMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Organization member numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/members/{memberId}/role: - put: - tags: - - orgs - summary: Update member role - description: Updates the role of the member identified by the given `memberId`. - operationId: UpdateOrganizationMemberRole - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Organization member numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Member role update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateMemberRoleRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/quotas: - get: - tags: - - orgs - summary: Describe organization quotas - description: Retrieves the details of the organization quotas identified by - the given `orgId`. - operationId: DescribeOrganizationQuotas - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: include - in: query - description: Optional list of quota names to include - schema: - type: array - items: - type: object - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeOrganizationQuotasResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams: - get: - tags: - - teams - summary: List organization teams - description: Lists all teams in the organization identified by the given `orgId`. - operationId: ListOrganizationTeams - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - teams - summary: Create team - description: Creates a new team in the organization identified by the given - `orgId`. - operationId: CreateOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/teams/validate: - get: - tags: - - teams - summary: Validate team name - description: Confirms the validity of the given team name. Append `?name=`. - operationId: ValidateTeamName - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: name - in: query - description: Team name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}: - get: - tags: - - teams - summary: Describe team - description: Retrieves the details of the team identified by the given `teamId`. - operationId: DescribeOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeTeamResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - teams - summary: Update team - description: Updates the details of the team identified by the given `teamId`. - operationId: UpdateOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateTeamRequest" - required: true - responses: - "200": - description: OK - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "204": - description: UpdateOrganizationTeam 204 response - security: - - BearerAuth: [] - delete: - tags: - - teams - summary: Delete team - description: Deletes the team identified by the given `teamId`. - operationId: DeleteOrganizationTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/members: - get: - tags: - - teams - summary: List team members - description: Lists the team members associated with the given `teamId`. - operationId: ListOrganizationTeamMembers - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - schema: - type: string - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListMembersResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - teams - summary: Create team member - description: Adds a new member to the team identified by the given `teamId`. - operationId: CreateOrganizationTeamMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Team create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTeamMemberRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddTeamMemberResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/members/{memberId}/delete: - delete: - tags: - - teams - summary: Delete team member - description: Deletes the team member identified by the given `memberId`. - operationId: DeleteOrganizationTeamMember - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: memberId - in: path - description: Member numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/teams/{teamId}/workspaces: - get: - tags: - - teams - summary: List team workspaces - description: Lists all the workspaces of which the given `teamId` is a participant. - operationId: ListWorkspacesByTeam - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: teamId - in: path - description: Team numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Search criteria - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesResponse" - "404": - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "400": - description: Bad Request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces: - get: - tags: - - workspaces - summary: List organization workspaces - description: Lists the organization workspaces in `orgId` to which the requesting - user belongs. - operationId: ListWorkspaces - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - workspaces - summary: Create workspace - description: Creates a new organization workspace. - operationId: CreateWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkspaceRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/validate: - get: - tags: - - workspaces - summary: Validate workspace name - description: Confirms the validity of the given workspace name. Append `?name=`. - operationId: WorkspaceValidate - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: name - in: query - description: Workspace name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}: - get: - tags: - - workspaces - summary: Describe workspace - description: Retrieves the details of the workspace identified by the given - `workspaceId`. - operationId: DescribeWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - workspaces - summary: Update workspace - description: Updates the details of the workspace identified by the given `workspaceId`. - operationId: UpdateWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkspaceResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicate name - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workspaces - summary: Delete workspace - description: Deletes the workspace identified by the given `workspaceId`. - operationId: DeleteWorkspace - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants: - get: - tags: - - workspaces - summary: List workspace participants - description: Lists the participants of the workspace identified by the given - `workspaceId`. - operationId: ListWorkspaceParticipants - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListParticipantsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workspaces - summary: Leave workspace - description: Removes the requesting user from the given workspace. - operationId: LeaveWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/add: - put: - tags: - - workspaces - summary: Create workspace participant - description: Adds a new participant to the workspace identified by the given - `workspaceId`. - operationId: CreateWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Participant addition request - content: - application/json: - schema: - $ref: "#/components/schemas/AddParticipantRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/AddParticipantResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/{participantId}: - delete: - tags: - - workspaces - summary: Delete workspace participant - description: Deletes the given participant from the given workspace. - operationId: DeleteWorkspaceParticipant - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: participantId - in: path - description: Participant numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/participants/{participantId}/role: - put: - tags: - - workspaces - summary: Update participant role - description: Updates the role of the given participant in the given workspace. - operationId: UpdateWorkspaceParticipantRole - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: participantId - in: path - description: Participant numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Participant role update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateParticipantRoleRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /orgs/{orgId}/workspaces/{workspaceId}/settings/studios: - get: - tags: - - workspaces - summary: List workspace Studios settings - description: Retrieves the Studios settings of the workspace identified by the - given `workspaceId`. - operationId: FindDataStudiosWorkspaceSettings - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioWorkspaceSettingsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - put: - tags: - - workspaces - summary: Update workspace Studios settings - description: Updates the Studios settings of the workspace identified by the - given `workspaceId`. - operationId: UpdateDataStudiosWorkspaceSettings - parameters: - - name: orgId - in: path - description: Organization numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Workspace update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateWorkspaceRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "200": - description: UpdateDataStudiosWorkspaceSettings 200 response - content: - application/json: - schema: - type: object - security: - - BearerAuth: [] - /pipeline-secrets: - get: - tags: - - pipeline-secrets - summary: List pipeline secrets - description: Lists all available pipeline secrets in a user context. Append - `?workspaceId` to list secrets in a workspace context. - operationId: ListPipelineSecrets - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelineSecretsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - pipeline-secrets - summary: Create pipeline secret - description: Creates a new pipeline secret in the user context. Append `?workspaceId` - to create the secret in a workspace context. - operationId: CreatePipelineSecret - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Pipeline secret create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineSecretRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineSecretResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipeline-secrets/validate: - get: - tags: - - pipeline-secrets - summary: Validate secret name - description: Confirms the validity of the given pipeline secret name in a user - context. Append `?name=`. Append `?workspaceId` to validate - the name in a workspace context. - operationId: ValidatePipelineSecretName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Secret name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipeline-secrets/{secretId}: - get: - tags: - - pipeline-secrets - summary: Describe pipeline secret - description: Retrieves the details of the pipeline secret identified by the - given `secretId`. - operationId: DescribePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineSecretResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - pipeline-secrets - summary: Update secret - description: Updates the pipeline secret identified by the given `secretId`. - operationId: UpdatePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Secret update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineSecretRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - pipeline-secrets - summary: Delete secret - description: Deletes the pipeline secret identified by the given `secretId`. - operationId: DeletePipelineSecret - parameters: - - name: secretId - in: path - description: Secret numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines: - get: - tags: - - pipelines - summary: List pipelines - description: "Lists all available pipelines in a user context, enriched by `attributes`.\ - \ Append `workspaceId` to list pipelines in a workspace context." - operationId: ListPipelines - parameters: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`,\ - \ `optimized` status, `computeEnv`). Returns an empty value (`labels: null`,\ - \ etc.) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - - name: visibility - in: query - description: Filter visibility parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelinesResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - pipelines - summary: Create pipeline - description: Creates a new pipeline in a user context. Append `?workspaceId` - to create the pipeline in a workspace context. - operationId: CreatePipeline - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Pipeline creation request - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreatePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipelines/info: - get: - tags: - - pipelines - summary: Describe remote pipeline repository - description: Retrieves the details of a remote Nextflow pipeline Git repository. - Append the repository name or full URL with `?name`. - operationId: DescribePipelineRepository - parameters: - - name: name - in: query - description: Pipeline repository name or URL - schema: - type: string - - name: revision - in: query - description: Pipeline revision - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: mainScript - in: query - description: Pipeline alternative main.nf - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/add: - post: - tags: - - labels - summary: Add labels to pipelines - description: Adds the given list of labels to the given pipelines. Existing - labels are preserved. - operationId: AddLabelsToPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/apply: - post: - tags: - - labels - summary: Replace pipeline labels - description: Applies the given list of labels to the given pipelines. Existing - labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/labels/remove: - post: - tags: - - labels - summary: Remove labels from pipelines - description: Removes the given list of labels from the given pipelines. - operationId: RemoveLabelsFromPipelines - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociatePipelineLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/repositories: - get: - tags: - - pipelines - summary: List user pipeline repositories - description: "Lists known Nextflow pipeline Git repositories, extracted from\ - \ existing runs. Append `?workspaceId` to list repositories in a workspace\ - \ context." - operationId: ListPipelineRepositories - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPipelineInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/validate: - get: - tags: - - pipelines - summary: Validate pipeline name - description: Confirms the validity of the given pipeline `name` in a user context. - Append `?name=`. Append `?workspaceId` to validate the - name in a workspace context. - operationId: ValidatePipelineName - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Pipeline name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /pipelines/{pipelineId}: - get: - tags: - - pipelines - summary: Describe pipeline - description: "Retrieves the details of the pipeline identified by the given\ - \ `pipelineId`, enriched by `attributes`." - operationId: DescribePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier - required: true - schema: - type: integer - format: int64 - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`,\ - \ `optimized` status, `computeEnv`). Returns an empty value (`labels: null`,\ - \ etc.) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier - required: false - schema: - type: integer - format: int64 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - put: - tags: - - pipelines - summary: Update pipeline - description: "Updates the details of the pipeline identified by the given `pipelineId`.\ - \ \n **Note**: If `labelIds` is `null`, empty, or ommitted, existing\ - \ pipeline labels are removed.\n Include `labelIds: [,]`\ - \ to override existing labels. Labels to be preserved must be included.\n\ - \ To append a list of labels to multiple pipelines, use `/pipelines/labels/add`." - operationId: UpdatePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Pipeline update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UpdatePipelineResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - delete: - tags: - - pipelines - summary: Delete pipeline - description: Deletes the pipeline identified by the given `pipelineId`. - operationId: DeletePipeline - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/{pipelineId}/launch: - get: - tags: - - pipelines - summary: Describe pipeline launch - description: Retrieves the launch details of the pipeline identified by the - given `pipelineId`. - operationId: DescribePipelineLaunch - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier - required: false - schema: - type: integer - format: int64 - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /pipelines/{pipelineId}/schema: - get: - tags: - - pipelines - summary: Describe pipeline schema - description: "Retrieves the pipeline schema of the pipeline identified by the\ - \ given `pipelineId`, enriched by `attributes`.\n `200 - OK` responses\ - \ include the pipeline schema.\n `204 - OK` responses indicate\ - \ a successful request, with no saved schema found for the given pipeline\ - \ ID.\n " - operationId: DescribePipelineSchema - parameters: - - name: pipelineId - in: path - description: Pipeline numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier - required: false - schema: - type: integer - format: int64 - nullable: true - - name: attributes - in: query - description: "Additional attribute values to include in the response: `schema`\ - \ returns the pipeline schema, `params` returns the pipeline config. Returns\ - \ all if `attributes` is omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/PipelineSchemaAttributes" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/PipelineSchemaResponse" - "204": - description: Request OK - No schema found for given pipeline ID - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms: - get: - tags: - - platforms - summary: List platforms - description: Lists all available computing platforms in a user context. Append - `?workspaceId` to list platforms in a workspace context. - operationId: ListPlatforms - parameters: - - name: orgId - in: query - description: Organization numeric identifier - required: false - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - required: false - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListPlatformsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms/{platformId}: - get: - tags: - - platforms - summary: Describe platform - description: Retrieves the details of the computing platform identified by the - given `platformId`. - operationId: DescribePlatform - parameters: - - name: platformId - in: path - description: Platform string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: regionId - in: query - required: true - schema: - type: string - - name: credentialsId - in: query - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribePlatformResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /platforms/{platformId}/regions: - get: - tags: - - platforms - summary: List platform regions - description: Lists the available regions for the computing platform identified - by the given `platformId`. - operationId: ListPlatformRegions - parameters: - - name: platformId - in: path - description: Platform string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListRegionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /service-info: - get: - tags: - - service-info - summary: General Seqera service features and version. - operationId: Info - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ServiceInfoResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - /studios: - get: - tags: - - studios - summary: List Studios - description: Lists all available Studios in a user context. Append `?workspaceId` - to list Studios in a workspace context. - operationId: ListDataStudios - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: search - in: query - description: "Optional search criteria, allowing free text search on name\ - \ and templateUrl and keywords: `userId`, `computeEnvId` and `status`." - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: attributes - in: query - description: "Optional attribute values to be included in the response (`labels`).\ - \ Returns an empty value (`labels: null`) if omitted." - schema: - type: array - items: - $ref: "#/components/schemas/DataStudioQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the workspace is not found or when the API\ - \ is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - post: - tags: - - studios - summary: Create Studio - description: "Creates a new Studio environment, starting it by default. Default\ - \ behavior can be changed using the query parameter `autoStart=false`." - operationId: CreateDataStudio - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: autoStart - in: query - description: Optionally disable the Studio's automatic launch when it is created. - schema: - type: boolean - requestBody: - description: Create Studio request - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateRequest" - required: true - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateResponse" - "404": - description: "NotFound, when the workspace or compute environment is not\ - \ found or when the API is disabled." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Conflict - duplicated name - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - "200": - description: CreateDataStudio 200 response - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCreateResponse" - security: - - BearerAuth: [] - /studios/data-links: - get: - tags: - - studios - summary: List mounted data-links - description: "Lists the IDs of all available data-links mounted in existing\ - \ Studios. Append `orgId` or `?workspaceId` to list mounted data-links in\ - \ an organization or workspace context, respectively." - operationId: ListMountedDataLinkIds - parameters: - - name: orgId - in: query - description: Organization numeric identifier - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: status - in: query - description: Optional Studio status - schema: - type: string - - name: exclude - in: query - description: Optional Studio session ID to exclude in the request. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioMountedLinksResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/templates: - get: - tags: - - studios - summary: List available Studio templates - description: "Returns the list of available, configured Studio templates." - operationId: ListDataStudioTemplates - parameters: - - name: workspaceId - in: query - description: Workspace identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - responses: - "200": - description: Ok - paginated list of available Studio templates. - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioTemplatesListResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the API is disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/validate: - get: - tags: - - studios - summary: Validate Studio name - description: Confirms the availability of the given name for a Studio in the - user context. Append `?workspaceId=` to validate the name in a workspace context. - operationId: ValidateDataStudioName - parameters: - - name: workspaceId - in: query - description: Workspace identifier - schema: - type: integer - format: int64 - - name: name - in: query - description: Studio name to validate - schema: - type: string - responses: - "204": - description: "Ok - No content, if the name is valid and available." - "400": - description: "Bad request, if the name is not valid." - "409": - description: "Conflict, name duplicated in the given context." - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}: - get: - tags: - - studios - summary: Describe Studio - description: Retrieves the details of the Studio session identified by the given - `sessionId`. - operationId: DescribeDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "202": - description: "Accepted, when the Studio is fetching mounted data links in\ - \ the background." - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - delete: - tags: - - studios - summary: Delete Studio - description: Deletes the Studio associated with the given Studio session ID. - operationId: DeleteDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/checkpoints: - get: - tags: - - studios - summary: List Studio checkpoints - description: "Retrieves the list of checkpoints for the given Studio session\ - \ ID, sorted by creation date in descending order." - operationId: ListDataStudioCheckpoints - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: search - in: query - description: "Optional search criteria, allowing free text search on name\ - \ and keywords: `status`, `before` and `after` for saved date" - schema: - type: string - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioListCheckpointsResponse" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/checkpoints/{checkpointId}: - get: - tags: - - studios - summary: Get Studio checkpoint - description: Retrieves the details of the given Studio checkpoint ID. - operationId: GetDataStudioCheckpoint - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: checkpointId - in: path - description: Numeric identifier of the checkpoint. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the studio or the checkpoint is not found or\ - \ when the API is disabled for the workspace" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - put: - tags: - - studios - summary: Update Studio checkpoint name - description: Updates the name of the given Studio checkpoint ID. - operationId: UpdateDataStudioCheckpoint - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: checkpointId - in: path - description: Numeric identifier of the checkpoint. - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointUpdateRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioCheckpointDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the studio or the checkpoint is not found or\ - \ when the API is disabled for the workspace" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: "Conflict, when the checkpoint name conflicts with an existing\ - \ checkpoint for the same Studio." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/lifespan: - post: - tags: - - studios - description: Extends the lifespan of the given Studio session ID. - operationId: ExtendDataStudioLifespan - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioDto" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/start: - put: - tags: - - studios - summary: Starts a Studio - description: Starts the given Studio session ID. - operationId: StartDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: An optional overriding configuration for the studio to be started. - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStartRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStartResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /studios/{sessionId}/stop: - put: - tags: - - studios - summary: Stop Studio - description: Stops the given Studio session ID. - operationId: StopDataStudio - parameters: - - name: sessionId - in: path - description: Studio session numeric identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DataStudioStopResponse" - "404": - description: "NotFound, when the Studio is not found or when the API is\ - \ disabled for the workspace." - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed. - security: - - BearerAuth: [] - /tokens: - get: - tags: - - tokens - summary: List tokens - description: Retrieves the list of all available API access tokens. - operationId: TokenList - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListAccessTokensResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - post: - tags: - - tokens - summary: Create token - description: Creates an API access token with the details in the given request - body. - operationId: CreateToken - requestBody: - description: Access token create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAccessTokenRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateAccessTokenResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /tokens/delete-all: - delete: - tags: - - tokens - summary: Delete all user tokens - description: Deletes all API access tokens in the user context. - operationId: DeleteAllTokens - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /tokens/{tokenId}: - delete: - tags: - - tokens - summary: Delete token - description: Deletes the given API access token ID. - operationId: DeleteToken - parameters: - - name: tokenId - in: path - description: Token numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/create: - post: - tags: - - trace - summary: Create workflow execution trace - description: Creates a new workflow execution trace. - operationId: CreateTrace - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace create request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCreateRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCreateResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/begin: - put: - tags: - - trace - summary: Signal workflow execution start - description: Updates the workflow execution trace for the given `workflowId`. - operationId: UpdateTraceBegin - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace begin request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceBeginRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceBeginResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/complete: - put: - tags: - - trace - summary: Signal workflow execution completion - description: Updates the workflow execution trace for the given `workflowId`. - operationId: UpdateTraceComplete - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace complete request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCompleteRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceCompleteResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/heartbeat: - put: - tags: - - trace - summary: Signal workflow execution heartbeat - description: Update the workflow execution trace heartbeat for the given `workflowId` - to signal that execution is ongoing. - operationId: UpdateTraceHeartbeat - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace heartbeat request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceHeartbeatRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceHeartbeatResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /trace/{workflowId}/progress: - put: - tags: - - trace - summary: Store workflow task execution metadata - description: Store the execution metadata for one or more tasks in the given - `workflowId`. - operationId: UpdateTraceProgress - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Trace progress request - content: - application/json: - schema: - $ref: "#/components/schemas/TraceProgressRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/TraceProgressResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /user-info: - get: - tags: - - users - summary: Describe current user - operationId: UserInfo - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeUserResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /user/{userId}/workspaces: - get: - tags: - - workspaces - summary: List user workspaces and organizations - description: Lists the workspaces and organizations to which the user identified - by the given `userId` belongs. - operationId: ListWorkspacesUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkspacesAndOrgResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /users/validate: - get: - tags: - - users - summary: Check that the user name is valid - operationId: ValidateUserName - parameters: - - name: name - in: query - description: User name to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /users/{userId}: - get: - tags: - - users - summary: Describe a user entity - operationId: DescribeUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeUserResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - post: - tags: - - users - summary: Update an user entity - operationId: UpdateUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: User update request - content: - application/json: - schema: - $ref: "#/components/schemas/UserDbDto" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - users - summary: Delete a user entity - operationId: DeleteUser - parameters: - - name: userId - in: path - description: User numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow: - get: - tags: - - workflows - summary: List workflows - description: "Lists all workflow records, enriched with `attributes`. Append\ - \ `?workspaceId` to list workflow records in a workspace context." - operationId: ListWorkflows - parameters: - - name: attributes - in: query - description: "Additional attribute values to include in the response (`labels`,\ - \ `optimized` status). Returns an empty value (`labels: null`) if omitted." - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/WorkflowQueryAttribute" - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: search - in: query - description: Filter search parameter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListWorkflowsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/delete: - post: - tags: - - workflows - summary: Delete workflows - description: Deletes the workflow records identified by the given list of `workflowIds`. - operationId: DeleteWorkflowMany - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Force the deletion even if any workflows are active - schema: - type: boolean - requestBody: - description: Delete workflows request - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteWorkflowsRequest" - required: true - responses: - "200": - description: "OK - Return the IDs of workflows that could not be deleted,\ - \ if any" - content: - application/json: - schema: - $ref: "#/components/schemas/DeleteWorkflowsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/add: - post: - tags: - - labels - summary: Add labels to workflows - description: Adds the given list of labels to the given workflows. Existing - labels are preserved. - operationId: AddLabelsToWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels add request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/apply: - post: - tags: - - labels - summary: Replace workflow labels - description: Applies the given list of labels to the given workflows. Existing - labels are replaced — include labels to be preserved in `labelIds`. - operationId: ApplyLabelsToWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels apply request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/labels/remove: - post: - tags: - - labels - summary: Remove labels from workflows - description: Removes the given list of labels from the given workflows. - operationId: RemoveLabelsFromWorkflows - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - requestBody: - description: Labels remove request - content: - application/json: - schema: - $ref: "#/components/schemas/AssociateWorkflowLabelsRequest" - required: true - responses: - "204": - description: OK - No content - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/launch: - post: - tags: - - workflows - summary: Launch workflow - description: Submits a workflow execution. - operationId: CreateWorkflowLaunch - parameters: - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: sourceWorkspaceId - in: query - description: Source workspace numeric identifier - required: false - schema: - type: integer - format: int64 - nullable: true - requestBody: - description: Workflow launch request - content: - application/json: - schema: - $ref: "#/components/schemas/SubmitWorkflowLaunchRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/SubmitWorkflowLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/random-name: - get: - tags: - - workflows - summary: Generates a random name - operationId: GenerateRandomWorkflowName - responses: - "200": - description: Generated name - content: - application/json: - schema: - $ref: "#/components/schemas/RandomWorkflowNameResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/validate: - get: - tags: - - workflows - summary: Validate run name - description: "Check that the given run name of a workflow has a valid format.\ - \ When the session ID is given: check that no other workflow in the system\ - \ exists with the combination of both elements." - operationId: ValidateWorkflowConstraints - parameters: - - name: runName - in: query - description: Workflow run name to validate - schema: - type: string - - name: sessionId - in: query - description: Workflow session ID to validate - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request. Invalid run name format - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicated element. Existing run name and session ID combination - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}: - get: - tags: - - workflows - summary: Describe workflow - description: Retrieves the details of the workflow record associated with the - given `workflowId`. - operationId: DescribeWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: attributes - in: query - description: Comma-separated list of attributes to retrieve. Returns an empty - value for each attribute not specified. - explode: false - schema: - type: array - items: - $ref: "#/components/schemas/WorkflowQueryAttribute" - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkflowResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - delete: - tags: - - workflows - summary: Delete the Workflow entity with the given ID - operationId: DeleteWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Force the deletion even if the workflow is active - schema: - type: boolean - responses: - "204": - description: OK - Not content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/cancel: - post: - tags: - - workflows - summary: Cancel workflow - description: Cancels the workflow execution identified by the given `workflowId`. - operationId: CancelWorkflow - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: force - in: query - description: Cancel on the Platform side even if it cannot be cancelled on - the CE provider side - schema: - type: boolean - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/EmptyBodyRequest" - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/download: - get: - tags: - - workflows - summary: Download workflow files - description: Downloads the workflow files for the Nextflow main job associated - with the given `workflowId`. - operationId: DownloadWorkflowLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: fileName - in: query - description: Filename to download - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/download/{taskId}: - get: - tags: - - workflows - summary: Download workflow task files - description: Downloads the workflow files of the task identified by the given - `taskId`. - operationId: DownloadWorkflowTaskLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: fileName - in: query - description: Filename to download - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/launch: - get: - tags: - - workflows - summary: Describe workflow launch - description: Retrieves the details of the workflow launch associated with the - given `workflowId`. - operationId: DescribeWorkflowLaunch - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeWorkflowLaunchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element. Existing run name and session ID combination - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /workflow/{workflowId}/log: - get: - tags: - - workflows - summary: Get workflow logs - description: Retrieves the output logs for the Nextflow main job of the workflow - identified by the given `workflowId`. - operationId: WorkflowLogs - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: next - in: query - description: Workflow log cursor - schema: - type: string - - name: maxLength - in: query - description: Maximum length in bytes of the log to retrieve - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/WorkflowLogResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/log/{taskId}: - get: - tags: - - workflows - summary: Get workflow task logs - description: Retrieves the output logs for the workflow task identified by the - given `taskId`. - operationId: GetWorkflowTaskLog - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: next - in: query - description: Workflow log cursor - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: maxLength - in: query - description: Maximum length in bytes of the log to retrieve - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/WorkflowLogResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/metrics: - get: - tags: - - workflows - summary: Get the execution metrics for the given Workflow ID - operationId: DescribeWorkflowMetrics - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetWorkflowMetricsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/progress: - get: - tags: - - workflows - summary: Retrieve the execution progress for the given Workflow ID - operationId: DescribeWorkflowProgress - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/GetProgressResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/star: - get: - tags: - - workflows - summary: Check workflow star status - description: Confirms whether the given `workflowId` is starred. - operationId: DescribeWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - post: - tags: - - workflows - summary: Star workflow - description: Adds the workflow identified by the given `workflowId` to your - list of starred workflows. - operationId: CreateWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "409": - description: Duplicated element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - delete: - tags: - - workflows - summary: Unstar workflow - description: Removes the workflow identified by the given `workflowId` from - your list of starred workflows. - operationId: DeleteWorkflowStar - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateWorkflowStarResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - /workflow/{workflowId}/task/{taskId}: - get: - tags: - - workflows - summary: Describe a task entity with the given ID - operationId: DescribeWorkflowTask - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: taskId - in: path - description: Task numeric identifier - required: true - schema: - type: integer - format: int64 - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeTaskResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workflow/{workflowId}/tasks: - get: - tags: - - workflows - summary: List the tasks for the given Workflow ID and filter parameters - operationId: ListWorkflowTasks - parameters: - - name: workflowId - in: path - description: Workflow string identifier - required: true - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - - name: max - in: query - description: Pagination max results - schema: - type: integer - format: int32 - - name: offset - in: query - description: Pagination offset - schema: - type: integer - format: int32 - - name: sortBy - in: query - description: Field to sort by - schema: - type: string - - name: sortDir - in: query - description: Sorting direction (asc|desc) - schema: - type: string - - name: search - in: query - description: Search tasks by name - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListTasksResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets: - get: - tags: - - datasets - summary: List available datasets - description: Lists all available datasets in the workspace context identified - by the given `workspaceId`. - operationId: ListDatasets - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - post: - tags: - - datasets - summary: Create dataset - description: Creates a new dataset in the given workspace context. Include the - dataset file and details in your request body. - operationId: CreateDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - requestBody: - description: Dataset create request - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetRequest" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/versions: - get: - tags: - - datasets - summary: List latest dataset versions - description: Lists the latest version of each dataset associated with the given - `workspaceId`. - operationId: ListWorkspaceDatasetVersions - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: mimeType - in: query - schema: - type: string - nullable: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}: - put: - tags: - - datasets - summary: Update dataset - description: Updates the details of the dataset identified by the given `datasetId`. - operationId: UpdateDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - requestBody: - description: Dataset update request - content: - application/json: - schema: - $ref: "#/components/schemas/UpdateDatasetRequest" - required: true - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "409": - description: Duplicate element - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - deprecated: true - security: - - BearerAuth: [] - delete: - tags: - - datasets - summary: Delete dataset - description: Deletes the dataset identified by the given `datasetId`. - operationId: DeleteDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "204": - description: OK - No content - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/metadata: - get: - tags: - - datasets - summary: Describe dataset - description: Retrieves the metadata of the dataset identified by the given `datasetId`. - operationId: DescribeDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/DescribeDatasetResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/upload: - post: - tags: - - datasets - summary: Upload new dataset version - description: Uploads the CSV or TSV content to create a new version of the dataset - identified by the given `datasetId`. - operationId: UploadDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: header - in: query - description: Uploaded file has header - schema: - type: boolean - requestBody: - description: Dataset file request - content: - multipart/form-data: - schema: - $ref: "#/components/schemas/MultiRequestFileSchema" - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/UploadDatasetVersionResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/v/{version}/n/{fileName}: - get: - tags: - - datasets - summary: Download dataset content - description: Downloads the content of the dataset identified by the given `datasetId` - and `version`. - operationId: DownloadDataset - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: version - in: path - description: Version number to download - required: true - schema: - type: string - - name: fileName - in: path - description: File name for the downloaded dataset content - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - "404": - description: Not found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - security: - - BearerAuth: [] - /workspaces/{workspaceId}/datasets/{datasetId}/versions: - get: - tags: - - datasets - summary: List all dataset versions - description: Lists all versions of the given `datasetId`. - operationId: ListDatasetVersions - parameters: - - name: workspaceId - in: path - description: Workspace numeric identifier - required: true - schema: - type: integer - format: int64 - - name: datasetId - in: path - description: Dataset string identifier - required: true - schema: - type: string - - name: mimeType - in: query - description: MIME type filter - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/ListDatasetVersionsResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - deprecated: true - security: - - BearerAuth: [] -components: - schemas: - AbstractGridConfig: - type: object - properties: - workDir: - type: string - description: Compute environment working directory - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to\ - \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have\ - \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - nextflowConfig: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - AccessToken: - required: - - name - type: object - properties: - basicAuth: - type: string - deprecated: true - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 50 - minLength: 1 - type: string - lastUsed: - type: string - format: date-time - dateCreated: - type: string - format: date-time - Action.ConfigType: - type: object - properties: - discriminator: - type: string - readOnly: true - discriminator: - propertyName: discriminator - mapping: - github: "#/components/schemas/GithubActionConfig" - tower: "#/components/schemas/Action.TowerActionConfig" - oneOf: - - $ref: "#/components/schemas/Action.TowerActionConfig" - - $ref: "#/components/schemas/GithubActionConfig" - Action.EventType: - type: object - properties: - discriminator: - type: string - readOnly: true - timestamp: - type: string - format: date-time - discriminator: - propertyName: discriminator - mapping: - github: "#/components/schemas/GithubActionEvent" - tower: "#/components/schemas/Action.TowerActionEvent" - oneOf: - - $ref: "#/components/schemas/GithubActionEvent" - - $ref: "#/components/schemas/Action.TowerActionEvent" - Action.Source: - type: string - enum: - - github - - tower - x-enum-varnames: - - github - - tower - Action.Status: - type: string - enum: - - CREATING - - ACTIVE - - ERROR - - PAUSED - Action.TowerActionConfig: - type: object - properties: - discriminator: - type: string - readOnly: true - Action.TowerActionEvent: - type: object - properties: - discriminator: - type: string - readOnly: true - timestamp: - type: string - format: date-time - workflowId: - type: string - ActionQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - ActionResponseDto: - type: object - properties: - id: - type: string - launch: - $ref: "#/components/schemas/Launch" - name: - type: string - hookId: - type: string - hookUrl: - type: string - message: - type: string - source: - $ref: "#/components/schemas/Action.Source" - status: - $ref: "#/components/schemas/Action.Status" - config: - $ref: "#/components/schemas/Action.ConfigType" - event: - $ref: "#/components/schemas/Action.EventType" - lastSeen: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - ActiveConnection: - required: - - lastActive - type: object - allOf: - - $ref: "#/components/schemas/UserInfo" - - properties: - lastActive: - type: string - format: date-time - AddMemberRequest: - type: object - properties: - user: - type: string - AddMemberResponse: - type: object - properties: - member: - $ref: "#/components/schemas/MemberDbDto" - AddParticipantRequest: - type: object - properties: - memberId: - type: integer - format: int64 - teamId: - type: integer - format: int64 - userNameOrEmail: - type: string - AddParticipantResponse: - type: object - properties: - participant: - $ref: "#/components/schemas/ParticipantDbDto" - AddTeamMemberResponse: - type: object - properties: - member: - $ref: "#/components/schemas/MemberDbDto" - AgentSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - connectionId: - type: string - workDir: - type: string - shared: - type: boolean - AllowedDynamicLabelsResponse: - type: object - properties: - values: - type: array - items: - type: string - AltairPbsComputeConfig: - title: Altair PBS configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - Analytics: - type: object - properties: - hubspotId: - type: string - posthogApiKey: - type: string - posthogApiHost: - type: string - AssociateActionLabelsRequest: - type: object - properties: - actionIds: - type: array - items: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - AssociatePipelineLabelsRequest: - type: object - properties: - pipelineIds: - type: array - items: - type: integer - format: int64 - labelIds: - type: array - items: - type: integer - format: int64 - AssociateWorkflowLabelsRequest: - type: object - properties: - workflowIds: - type: array - items: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - Avatar: - type: object - properties: - id: - maxLength: 22 - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - AwsBatchConfig: - title: AWS Batch configuration - type: object - properties: - storageType: - type: string - deprecated: true - lustreId: - type: string - deprecated: true - volumes: - type: array - items: - type: string - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - region: - type: string - computeQueue: - type: string - dragenQueue: - type: string - dragenInstanceType: - type: string - computeJobRole: - type: string - executionRole: - type: string - headQueue: - type: string - headJobRole: - type: string - cliPath: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - nvnmeStorageEnabled: - type: boolean - logGroup: - type: string - nextflowConfig: - type: string - fusionSnapshots: - type: boolean - forge: - $ref: "#/components/schemas/ForgeConfig" - forgedResources: - type: array - items: - type: object - additionalProperties: true - AwsBatchPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - jobQueues: - type: array - items: - $ref: "#/components/schemas/JobQueue" - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - fileSystems: - type: array - items: - $ref: "#/components/schemas/FsxFileSystem" - efsFileSystems: - type: array - items: - $ref: "#/components/schemas/EfsFileSystem" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceFamilies: - type: array - items: - type: string - allocStrategy: - type: array - items: - type: string - AwsCloudConfig: - title: AWS Cloud configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - allowBuckets: - type: array - items: - type: string - region: - type: string - instanceType: - type: string - imageId: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - logGroup: - type: string - arm64Enabled: - type: boolean - gpuEnabled: - type: boolean - ec2KeyPair: - type: string - ebsBootSize: - type: integer - format: int32 - instanceProfileArn: - type: string - subnetId: - type: string - securityGroups: - type: array - items: - type: string - forgedResources: - type: array - items: - type: object - additionalProperties: true - AwsCloudPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceTypes: - type: array - items: - $ref: "#/components/schemas/InstanceType" - AwsSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - accessKey: - type: string - secretKey: - type: string - writeOnly: true - assumeRoleArn: - type: string - AzBatchConfig: - title: Azure batch configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - region: - type: string - headPool: - type: string - autoPoolMode: - type: boolean - deprecated: true - forge: - $ref: "#/components/schemas/AzBatchForgeConfig" - tokenDuration: - type: string - deleteJobsOnCompletion: - $ref: "#/components/schemas/JobCleanupPolicy" - deletePoolsOnCompletion: - type: boolean - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - nextflowConfig: - type: string - managedIdentityClientId: - type: string - nullable: true - AzBatchForgeConfig: - type: object - properties: - vmType: - type: string - vmCount: - type: integer - format: int32 - autoScale: - type: boolean - disposeOnDeletion: - type: boolean - containerRegIds: - type: array - items: - type: string - AzBatchPlatformMetainfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - pools: - type: array - items: - type: string - containers: - type: array - items: - type: string - vmTypes: - type: array - items: - type: string - AzCloudConfig: - title: Azure Cloud configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - nextflowConfig: - type: string - instanceType: - type: string - region: - type: string - resourceGroup: - type: string - networkId: - type: string - subscriptionId: - type: string - managedIdentityId: - type: string - managedIdentityClientId: - type: string - logWorkspaceId: - type: string - logTableName: - type: string - dataCollectionEndpoint: - type: string - dataCollectionRuleId: - type: string - forgedResources: - type: array - items: - $ref: "#/components/schemas/Map.Entry_String.String_" - AzureEntraKeys: - type: object - allOf: - - $ref: "#/components/schemas/AzureSecurityKeys" - - properties: - discriminator: - type: string - readOnly: true - tenantId: - type: string - clientId: - type: string - clientSecret: - type: string - writeOnly: true - AzureReposSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - AzureSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - batchName: - type: string - storageName: - type: string - batchKey: - type: string - writeOnly: true - storageKey: - type: string - writeOnly: true - BitBucketSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - token: - type: string - writeOnly: true - username: - type: string - password: - type: string - writeOnly: true - Bucket: - type: object - properties: - path: - type: string - CloudPriceModel: - type: string - enum: - - standard - - spot - x-enum-varnames: - - standard - - spot - CodeCommitSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - ComputeConfig: - type: object - properties: - workDir: - type: string - description: Compute environment working directory - preRunScript: - type: string - description: "Add a script that executes in the nf-launch script prior to\ - \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - postRunScript: - type: string - description: "Add a script that executes after all Nextflow processes have\ - \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - nextflowConfig: - type: string - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - discriminator: - propertyName: discriminator - mapping: - moab-platform: "#/components/schemas/MoabComputeConfig" - aws-batch: "#/components/schemas/AwsBatchConfig" - google-cloud: "#/components/schemas/GoogleCloudConfig" - azure-cloud: "#/components/schemas/AzCloudConfig" - gke-platform: "#/components/schemas/GkeComputeConfig" - google-batch: "#/components/schemas/GoogleBatchConfig" - aws-cloud: "#/components/schemas/AwsCloudConfig" - slurm-platform: "#/components/schemas/SlurmComputeConfig" - k8s-platform: "#/components/schemas/K8sComputeConfig" - altair-platform: "#/components/schemas/AltairPbsComputeConfig" - lsf-platform: "#/components/schemas/LsfComputeConfig" - azure-batch: "#/components/schemas/AzBatchConfig" - seqeracompute-platform: "#/components/schemas/SeqeraComputeConfig" - eks-platform: "#/components/schemas/EksComputeConfig" - google-lifesciences: "#/components/schemas/GoogleLifeSciencesConfig" - uge-platform: "#/components/schemas/UnivaComputeConfig" - oneOf: - - $ref: "#/components/schemas/AwsBatchConfig" - - $ref: "#/components/schemas/AwsCloudConfig" - - $ref: "#/components/schemas/SeqeraComputeConfig" - - $ref: "#/components/schemas/GoogleLifeSciencesConfig" - - $ref: "#/components/schemas/GoogleBatchConfig" - - $ref: "#/components/schemas/AzBatchConfig" - - $ref: "#/components/schemas/LsfComputeConfig" - - $ref: "#/components/schemas/SlurmComputeConfig" - - $ref: "#/components/schemas/K8sComputeConfig" - - $ref: "#/components/schemas/EksComputeConfig" - - $ref: "#/components/schemas/GkeComputeConfig" - - $ref: "#/components/schemas/UnivaComputeConfig" - - $ref: "#/components/schemas/AltairPbsComputeConfig" - - $ref: "#/components/schemas/MoabComputeConfig" - ComputeEnv.Status: - type: string - readOnly: true - enum: - - CREATING - - AVAILABLE - - ERRORED - - INVALID - ComputeEnvDbDto: - type: object - properties: - id: - type: string - name: - type: string - platform: - type: string - region: - type: string - ComputeEnvQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - ComputeEnvResponseDto: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - platform: - type: string - enum: - - aws-batch - - aws-cloud - - seqeracompute-platform - - google-lifesciences - - google-batch - - azure-batch - - k8s-platform - - eks-platform - - gke-platform - - uge-platform - - slurm-platform - - lsf-platform - - altair-platform - config: - $ref: "#/components/schemas/ComputeConfig" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - lastUsed: - type: string - format: date-time - deleted: - type: boolean - status: - $ref: "#/components/schemas/ComputeEnv.Status" - message: - type: string - primary: - type: boolean - credentialsId: - type: string - managedIdentityId: - type: string - orgId: - type: integer - format: int64 - workspaceId: - type: integer - format: int64 - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - ComputeEnv_ComputeConfig_: - required: - - config - - name - - platform - type: object - properties: - credentialsId: - type: string - orgId: - type: integer - format: int64 - readOnly: true - workspaceId: - type: integer - format: int64 - readOnly: true - id: - maxLength: 22 - type: string - readOnly: true - name: - maxLength: 100 - type: string - description: - maxLength: 2000 - type: string - platform: - maxLength: 25 - type: string - enum: - - aws-batch - - aws-cloud - - google-lifesciences - - google-batch - - google-cloud - - azure-batch - - azure-cloud - - k8s-platform - - eks-platform - - gke-platform - - uge-platform - - slurm-platform - - lsf-platform - - altair-platform - - moab-platform - - local-platform - - seqeracompute-platform - config: - $ref: "#/components/schemas/ComputeConfig" - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - lastUsed: - type: string - format: date-time - readOnly: true - deleted: - type: boolean - readOnly: true - status: - type: string - readOnly: true - allOf: - - $ref: "#/components/schemas/ComputeEnv.Status" - message: - maxLength: 4096 - type: string - primary: - type: boolean - readOnly: true - ComputePlatform: - type: object - properties: - id: - type: string - name: - type: string - credentialsProviders: - type: array - items: - type: string - ComputePlatformDto: - type: object - properties: - id: - type: string - name: - type: string - ComputeRegion: - type: object - properties: - id: - type: string - name: - type: string - ConfigEnvVariable: - type: object - properties: - name: - type: string - value: - type: string - head: - type: boolean - compute: - type: boolean - ContainerData: - required: - - targetImage - type: object - properties: - requestId: - type: string - sourceImage: - type: string - targetImage: - type: string - buildId: - type: string - scanId: - type: string - mirrorId: - type: string - cached: - type: boolean - freeze: - type: boolean - requestTime: - type: string - format: date-time - ContainerRegistryKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - userName: - type: string - password: - type: string - writeOnly: true - registry: - type: string - CreateAccessTokenRequest: - type: object - properties: - name: - type: string - CreateAccessTokenResponse: - type: object - properties: - accessKey: - type: string - token: - $ref: "#/components/schemas/AccessToken" - CreateActionRequest: - type: object - properties: - name: - type: string - source: - $ref: "#/components/schemas/Action.Source" - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - CreateActionResponse: - type: object - properties: - actionId: - type: string - CreateAvatarResponse: - type: object - properties: - avatar: - $ref: "#/components/schemas/Avatar" - url: - type: string - CreateComputeEnvRequest: - type: object - properties: - computeEnv: - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - labelIds: - type: array - items: - type: integer - format: int64 - CreateComputeEnvResponse: - type: object - properties: - computeEnvId: - type: string - CreateCredentialsRequest: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - CreateCredentialsResponse: - type: object - properties: - credentialsId: - type: string - CreateDatasetRequest: - type: object - properties: - name: - type: string - description: - type: string - CreateDatasetResponse: - type: object - properties: - dataset: - $ref: "#/components/schemas/DatasetDto" - CreateLabelRequest: - type: object - properties: - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - CreateLabelResponse: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - CreateManagedCredentialsRequest: - type: object - properties: - provider: - type: string - enum: - - ssh - credentials: - $ref: "#/components/schemas/Credentials" - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - CreateManagedCredentialsResponse: - type: object - properties: - managedCredentials: - $ref: "#/components/schemas/ManagedCredentialsDbDto" - CreateManagedIdentityRequest: - type: object - properties: - name: - type: string - platform: - type: string - enum: - - altair-platform - - lsf-platform - - moab-platform - - slurm-platform - - uge-platform - config: - $ref: "#/components/schemas/AbstractGridConfig" - CreateManagedIdentityResponse: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - platform: - type: string - config: - $ref: "#/components/schemas/ComputeConfig" - CreateOrganizationRequest: - type: object - properties: - organization: - $ref: "#/components/schemas/Organization" - logoId: - type: string - CreateOrganizationResponse: - type: object - properties: - organization: - $ref: "#/components/schemas/OrganizationDbDto" - CreatePipelineRequest: - type: object - properties: - name: - type: string - description: - type: string - icon: - type: string - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - labelIds: - type: array - items: - type: integer - format: int64 - CreatePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - CreatePipelineSecretRequest: - type: object - properties: - name: - type: string - value: - type: string - CreatePipelineSecretResponse: - type: object - properties: - secretId: - type: integer - format: int64 - CreateTeamMemberRequest: - type: object - properties: - userNameOrEmail: - type: string - CreateTeamRequest: - type: object - properties: - team: - $ref: "#/components/schemas/Team" - avatarId: - type: string - CreateTeamResponse: - type: object - properties: - team: - $ref: "#/components/schemas/TeamDbDto" - CreateWorkflowStarResponse: - type: object - properties: - workflowId: - type: string - CreateWorkspaceRequest: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - CreateWorkspaceResponse: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - Credentials: - required: - - name - - provider - type: object - properties: - id: - maxLength: 22 - type: string - name: - maxLength: 100 - type: string - description: - type: string - provider: - maxLength: 16 - type: string - enum: - - aws - - azure - - azure_entra - - google - - github - - gitlab - - bitbucket - - ssh - - k8s - - container-reg - - tw-agent - - codecommit - - gitea - - azurerepos - - seqeracompute - - azure-cloud - - s3 - baseUrl: - maxLength: 200 - pattern: "" - type: string - category: - maxLength: 20 - type: string - deleted: - type: boolean - readOnly: true - lastUsed: - type: string - format: date-time - readOnly: true - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - keys: - $ref: "#/components/schemas/SecurityKeys" - DataLink.Status: - type: string - readOnly: true - enum: - - VALID - - INVALID - DataLinkContentResponse: - type: object - properties: - originalPath: - type: string - objects: - type: array - items: - $ref: "#/components/schemas/DataLinkItem" - nextPageToken: - type: string - DataLinkContentTreeListResponse: - required: - - items - type: object - properties: - items: - type: array - items: - $ref: "#/components/schemas/DataLinkSimpleItem" - DataLinkCreateRequest: - type: object - properties: - name: - type: string - description: - type: string - type: - $ref: "#/components/schemas/DataLinkType" - provider: - $ref: "#/components/schemas/DataLinkProvider" - resourceRef: - type: string - publicAccessible: - type: boolean - credentialsId: - type: string - DataLinkCredentials: - required: - - id - - name - - provider - type: object - properties: - id: - type: string - name: - type: string - provider: - $ref: "#/components/schemas/DataLinkProvider" - DataLinkDeleteItemRequest: - type: object - properties: - files: - type: array - items: - type: string - dirs: - type: array - items: - type: string - DataLinkDeleteItemResponse: - type: object - properties: - deletionFailures: - type: array - items: - $ref: "#/components/schemas/DataLinkItemDeletionFailure" - DataLinkDownloadScriptResponse: - type: object - properties: - script: - type: string - DataLinkDownloadUrlResponse: - type: object - properties: - url: - type: string - DataLinkDto: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - resourceRef: - type: string - type: - $ref: "#/components/schemas/DataLinkType" - provider: - $ref: "#/components/schemas/DataLinkProvider" - region: - type: string - credentials: - type: array - items: - $ref: "#/components/schemas/DataLinkCredentials" - publicAccessible: - type: boolean - hidden: - type: boolean - status: - type: string - readOnly: true - allOf: - - $ref: "#/components/schemas/DataLink.Status" - message: - type: string - DataLinkFinishMultiPartUploadRequest: - type: object - properties: - uploadId: - type: string - fileName: - type: string - tags: - type: array - items: - $ref: "#/components/schemas/UploadEtag" - withError: - type: boolean - DataLinkItem: - type: object - properties: - type: - $ref: "#/components/schemas/DataLinkItemType" - name: - type: string - size: - type: integer - format: int64 - mimeType: - type: string - DataLinkItemDeletionFailure: - required: - - dataLinkItem - - errorMessage - type: object - properties: - dataLinkItem: - $ref: "#/components/schemas/DataLinkItem" - errorMessage: - type: string - DataLinkItemType: - type: string - enum: - - FOLDER - - FILE - DataLinkMultiPartUploadRequest: - type: object - properties: - fileName: - type: string - contentLength: - type: integer - format: int64 - contentType: - type: string - DataLinkMultiPartUploadResponse: - type: object - properties: - uploadId: - type: string - uploadUrls: - type: array - items: - type: string - DataLinkProvider: - type: string - enum: - - aws - - google - - azure - - azure_entra - - azure-cloud - - seqeracompute - - s3 - DataLinkResponse: - type: object - properties: - dataLink: - $ref: "#/components/schemas/DataLinkDto" - DataLinkSimpleItem: - required: - - path - - size - type: object - properties: - path: - type: string - size: - type: integer - format: int64 - DataLinkType: - type: string - enum: - - bucket - x-enum-varnames: - - bucket - DataLinkUpdateRequest: - type: object - properties: - name: - type: string - description: - type: string - credentialsId: - type: string - DataLinksListResponse: - type: object - properties: - dataLinks: - type: array - items: - $ref: "#/components/schemas/DataLinkDto" - totalSize: - type: integer - format: int64 - DataStudioCheckpointDto: - required: - - author - - dateCreated - - dateSaved - - id - - name - - path - - status - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - dateCreated: - type: string - format: date-time - dateSaved: - type: string - format: date-time - author: - $ref: "#/components/schemas/UserInfo" - path: - type: string - status: - $ref: "#/components/schemas/StudioCheckpointStatus" - DataStudioCheckpointUpdateRequest: - type: object - properties: - name: - type: string - DataStudioComputeEnvDto: - type: object - allOf: - - $ref: "#/components/schemas/ComputeEnvDbDto" - - properties: - credentialsId: - type: string - workDir: - type: string - DataStudioConfiguration: - type: object - properties: - gpu: - minimum: 0 - type: integer - format: int32 - cpu: - minimum: 0 - type: integer - format: int32 - memory: - minimum: 0 - type: integer - format: int32 - mountData: - type: array - items: - type: string - environment: - type: object - additionalProperties: - type: string - nullable: true - condaEnvironment: - maxLength: 2048 - type: string - lifespanHours: - minimum: 0 - type: integer - format: int32 - DataStudioCreateRequest: - required: - - computeEnvId - - dataStudioToolUrl - - name - type: object - properties: - name: - maxLength: 80 - minLength: 1 - type: string - description: - maxLength: 2048 - type: string - dataStudioToolUrl: - minLength: 1 - type: string - computeEnvId: - minLength: 1 - type: string - initialCheckpointId: - type: integer - format: int64 - configuration: - $ref: "#/components/schemas/DataStudioConfiguration" - isPrivate: - type: boolean - labelIds: - type: array - nullable: true - items: - type: integer - format: int64 - spot: - type: boolean - nullable: true - DataStudioCreateResponse: - type: object - properties: - studio: - $ref: "#/components/schemas/DataStudioDto" - DataStudioDto: - type: object - properties: - sessionId: - type: string - workspaceId: - type: integer - format: int64 - parentCheckpoint: - $ref: "#/components/schemas/DataStudioDto.ParentCheckpoint" - user: - $ref: "#/components/schemas/UserInfo" - name: - type: string - description: - type: string - studioUrl: - type: string - computeEnv: - $ref: "#/components/schemas/DataStudioComputeEnvDto" - template: - $ref: "#/components/schemas/DataStudioTemplate" - configuration: - $ref: "#/components/schemas/DataStudioConfiguration" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - lastStarted: - type: string - format: date-time - effectiveLifespanHours: - type: integer - format: int32 - activeConnections: - type: array - items: - $ref: "#/components/schemas/ActiveConnection" - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - waveBuildUrl: - type: string - baseImage: - type: string - customImage: - type: boolean - isPrivate: - type: boolean - mountedDataLinks: - type: array - items: - $ref: "#/components/schemas/DataLinkDto" - progress: - type: array - items: - $ref: "#/components/schemas/DataStudioProgressStep" - labels: - type: array - nullable: true - items: - $ref: "#/components/schemas/LabelDbDto" - DataStudioDto.ParentCheckpoint: - type: object - properties: - checkpointId: - type: integer - format: int64 - checkpointName: - type: string - sessionId: - type: string - studioName: - type: string - DataStudioListCheckpointsResponse: - required: - - checkpoints - - totalSize - type: object - properties: - checkpoints: - type: array - items: - $ref: "#/components/schemas/DataStudioCheckpointDto" - totalSize: - type: integer - format: int64 - DataStudioListResponse: - required: - - studios - - totalSize - type: object - properties: - studios: - type: array - items: - $ref: "#/components/schemas/DataStudioDto" - totalSize: - type: integer - format: int64 - DataStudioMountedLinksResponse: - type: object - properties: - dataLinkIds: - type: array - items: - type: string - DataStudioProgressStep: - type: object - properties: - status: - $ref: "#/components/schemas/DataStudioProgressStep.Status" - message: - type: string - warnings: - type: array - items: - type: string - DataStudioProgressStep.Status: - type: string - enum: - - pending - - in-progress - - succeeded - - errored - DataStudioQueryAttribute: - type: string - enum: - - labels - x-enum-varnames: - - labels - DataStudioStartRequest: - type: object - properties: - configuration: - nullable: true - allOf: - - $ref: "#/components/schemas/DataStudioConfiguration" - description: - type: string - nullable: true - labelIds: - type: array - nullable: true - items: - type: integer - format: int64 - spot: - type: boolean - nullable: true - DataStudioStartResponse: - required: - - jobSubmitted - - sessionId - - statusInfo - type: object - properties: - jobSubmitted: - type: boolean - sessionId: - type: string - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - DataStudioStatus: - type: string - enum: - - starting - - running - - stopping - - stopped - - errored - - building - - buildFailed - x-enum-varnames: - - starting - - running - - stopping - - stopped - - errored - - building - - buildFailed - DataStudioStatusInfo: - type: object - properties: - status: - $ref: "#/components/schemas/DataStudioStatus" - message: - type: string - lastUpdate: - type: string - format: date-time - stopReason: - $ref: "#/components/schemas/DataStudioStopReason" - DataStudioStopReason: - type: string - enum: - - CREDITS_RUN_OUT - - LIFESPAN_EXPIRED - - SPOT_RECLAMATION - DataStudioStopResponse: - required: - - jobSubmitted - - sessionId - - statusInfo - type: object - properties: - jobSubmitted: - type: boolean - sessionId: - type: string - statusInfo: - $ref: "#/components/schemas/DataStudioStatusInfo" - DataStudioTemplate: - type: object - properties: - repository: - type: string - icon: - type: string - status: - $ref: "#/components/schemas/DataStudioVersionStatus" - tool: - type: string - DataStudioTemplatesListResponse: - required: - - templates - - totalSize - type: object - properties: - templates: - type: array - items: - $ref: "#/components/schemas/DataStudioTemplate" - totalSize: - type: integer - format: int64 - DataStudioVersionStatus: - type: string - enum: - - recommended - - deprecated - - experimental - - unsupported - x-enum-varnames: - - recommended - - deprecated - - experimental - - unsupported - DataStudioWorkspaceSettingsResponse: - required: - - lifespanHours - - orgId - - wspId - type: object - properties: - orgId: - type: integer - format: int64 - wspId: - type: integer - format: int64 - lifespanHours: - type: integer - format: int32 - DatasetDto: - type: object - properties: - id: - type: string - user: - $ref: "#/components/schemas/UserInfo" - workspaceId: - type: integer - format: int64 - organizationId: - type: integer - format: int64 - name: - type: string - lastUpdatedBy: - $ref: "#/components/schemas/UserInfo" - description: - type: string - mediaType: - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - deleted: - type: boolean - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - version: - type: integer - format: int64 - DatasetVersionDto: - type: object - properties: - datasetId: - type: string - datasetName: - type: string - datasetDescription: - type: string - hasHeader: - type: boolean - version: - type: integer - format: int64 - createdBy: - $ref: "#/components/schemas/UserInfo" - lastUpdated: - type: string - format: date-time - fileName: - type: string - mediaType: - type: string - workspaceId: - type: integer - format: int64 - url: - type: string - DeleteCredentialsConflictResponse: - type: object - properties: - credentialsId: - type: string - conflicts: - type: array - items: - $ref: "#/components/schemas/DeleteCredentialsConflictResponse.Conflict" - DeleteCredentialsConflictResponse.Conflict: - type: object - properties: - type: - type: string - id: - type: string - name: - type: string - url: - type: string - DeleteManagedCredentialsConflictResponse: - type: object - properties: - managedCredentialsId: - type: string - conflicts: - type: array - items: - $ref: "#/components/schemas/DeleteManagedCredentialsConflictResponse.Conflict" - DeleteManagedCredentialsConflictResponse.Conflict: - type: object - properties: - type: - type: string - id: - type: string - name: - type: string - url: - type: string - DeleteWorkflowsRequest: - type: object - properties: - workflowIds: - type: array - items: - type: string - DeleteWorkflowsResponse: - type: object - properties: - failedWorkflowIds: - type: array - items: - type: string - DescribeActionResponse: - type: object - properties: - action: - $ref: "#/components/schemas/ActionResponseDto" - DescribeComputeEnvResponse: - type: object - properties: - computeEnv: - $ref: "#/components/schemas/ComputeEnvResponseDto" - DescribeCredentialsResponse: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - DescribeDatasetResponse: - type: object - properties: - dataset: - $ref: "#/components/schemas/DatasetDto" - DescribeLaunchResponse: - type: object - properties: - launch: - $ref: "#/components/schemas/Launch" - DescribeOrganizationQuotasResponse: - type: object - properties: - quotas: - $ref: "#/components/schemas/OrganizationQuotas" - DescribeOrganizationResponse: - type: object - properties: - organization: - $ref: "#/components/schemas/OrganizationDbDto" - DescribePipelineInfoResponse: - type: object - properties: - pipelineInfo: - $ref: "#/components/schemas/PipelineInfo" - DescribePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - DescribePipelineSecretResponse: - type: object - properties: - pipelineSecret: - $ref: "#/components/schemas/PipelineSecret" - DescribePlatformResponse: - type: object - properties: - metainfo: - $ref: "#/components/schemas/PlatformMetainfo" - DescribeTaskResponse: - type: object - properties: - task: - $ref: "#/components/schemas/Task" - DescribeTeamResponse: - type: object - properties: - team: - $ref: "#/components/schemas/TeamDbDto" - DescribeUserResponse: - type: object - properties: - user: - $ref: "#/components/schemas/UserDbDto" - needConsent: - type: boolean - defaultWorkspaceId: - type: integer - format: int64 - DescribeWorkflowLaunchResponse: - type: object - properties: - launch: - $ref: "#/components/schemas/WorkflowLaunchResponse" - DescribeWorkflowResponse: - type: object - properties: - workflow: - $ref: "#/components/schemas/Workflow" - progress: - $ref: "#/components/schemas/ProgressData" - platform: - $ref: "#/components/schemas/ComputePlatformDto" - jobInfo: - $ref: "#/components/schemas/JobInfoDto" - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - optimized: - type: boolean - messages: - type: array - items: - type: string - DescribeWorkspaceResponse: - type: object - properties: - workspace: - $ref: "#/components/schemas/Workspace" - EfsFileSystem: - type: object - properties: - id: - type: string - EksComputeConfig: - title: Amazon EKS cluster configuration - type: object - allOf: - - $ref: "#/components/schemas/K8sComputeConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - nextflowConfig: - type: string - region: - type: string - description: AWS region - clusterName: - type: string - description: The AWS EKS cluster name - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - EksPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - clusters: - type: array - items: - type: string - EmptyBodyRequest: - type: object - ErrorResponse: - required: - - message - type: object - properties: - message: - type: string - EventType: - type: object - properties: - source: - type: string - display: - type: string - description: - type: string - enabled: - type: boolean - ForgeConfig: - type: object - properties: - type: - type: string - enum: - - SPOT - - EC2 - minCpus: - type: integer - format: int32 - maxCpus: - type: integer - format: int32 - gpuEnabled: - type: boolean - ebsAutoScale: - type: boolean - instanceTypes: - type: array - items: - type: string - allocStrategy: - type: string - enum: - - BEST_FIT - - BEST_FIT_PROGRESSIVE - - SPOT_CAPACITY_OPTIMIZED - - SPOT_PRICE_CAPACITY_OPTIMIZED - imageId: - type: string - vpcId: - type: string - subnets: - type: array - items: - type: string - securityGroups: - type: array - items: - type: string - fsxMount: - type: string - fsxName: - type: string - fsxSize: - type: integer - format: int32 - disposeOnDeletion: - type: boolean - ec2KeyPair: - type: string - allowBuckets: - type: array - items: - type: string - ebsBlockSize: - type: integer - format: int32 - fusionEnabled: - type: boolean - bidPercentage: - type: integer - format: int32 - efsCreate: - type: boolean - efsId: - type: string - efsMount: - type: string - dragenEnabled: - type: boolean - dragenAmiId: - type: string - ebsBootSize: - type: integer - format: int32 - ecsConfig: - type: string - fargateHeadEnabled: - type: boolean - arm64Enabled: - type: boolean - dragenInstanceType: - type: string - FsxFileSystem: - type: object - properties: - id: - type: string - dns: - type: string - mount: - type: string - GetProgressResponse: - type: object - properties: - progress: - $ref: "#/components/schemas/ProgressData" - GetWorkflowMetricsResponse: - type: object - properties: - metrics: - type: array - items: - $ref: "#/components/schemas/WorkflowMetrics" - GitHubSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - GitLabSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - token: - type: string - writeOnly: true - username: - type: string - password: - type: string - writeOnly: true - GiteaSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - username: - type: string - password: - type: string - writeOnly: true - GithubActionConfig: - type: object - properties: - discriminator: - type: string - readOnly: true - events: - type: array - items: - type: string - GithubActionEvent: - type: object - properties: - discriminator: - type: string - readOnly: true - ref: - type: string - commitId: - type: string - commitMessage: - type: string - pusherName: - type: string - pusherEmail: - type: string - timestamp: - type: string - format: date-time - GkeComputeConfig: - title: Google GKE cluster configuration - type: object - allOf: - - $ref: "#/components/schemas/K8sComputeConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - nextflowConfig: - type: string - region: - type: string - description: The GKE cluster region - or - zone - clusterName: - type: string - description: The GKE cluster name - fusion2Enabled: - type: boolean - waveEnabled: - type: boolean - GkePlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - clusters: - type: array - items: - type: string - GoogleBatchConfig: - title: Google Batch service configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - location: - type: string - workDir: - type: string - spot: - type: boolean - bootDiskSizeGb: - type: integer - format: int32 - cpuPlatform: - type: string - machineType: - type: string - projectId: - type: string - sshDaemon: - type: boolean - sshImage: - type: string - debugMode: - type: integer - format: int32 - copyImage: - type: string - usePrivateAddress: - type: boolean - labels: - type: object - additionalProperties: - type: string - preRunScript: - type: string - postRunScript: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - nextflowConfig: - type: string - nfsTarget: - type: string - nfsMount: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - serviceAccount: - type: string - network: - type: string - subnetwork: - type: string - headJobInstanceTemplate: - type: string - computeJobsInstanceTemplate: - type: string - GoogleBucket: - type: object - properties: - path: - type: string - GoogleCloudConfig: - title: Google Cloud configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - preRunScript: - type: string - postRunScript: - type: string - workDir: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean - projectId: - type: string - region: - type: string - zone: - type: string - serviceAccountEmail: - type: string - instanceType: - type: string - imageId: - type: string - arm64Enabled: - type: boolean - gpuEnabled: - type: boolean - bootDiskSizeGb: - type: integer - format: int32 - forgedResources: - type: array - items: - type: object - additionalProperties: true - GoogleCloudPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - warnings: - type: array - items: - type: string - zones: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/GoogleBucket" - instanceTypes: - type: array - items: - $ref: "#/components/schemas/GoogleInstanceType" - images: - type: array - items: - $ref: "#/components/schemas/GoogleImage" - GoogleImage: - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - arch: - type: string - GoogleInstanceType: - type: object - properties: - id: - type: string - arch: - type: string - GoogleLifeSciencesConfig: - title: Google life sciences configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - region: - type: string - zones: - type: array - items: - type: string - location: - type: string - workDir: - type: string - preemptible: - type: boolean - bootDiskSizeGb: - type: integer - format: int32 - projectId: - type: string - sshDaemon: - type: boolean - sshImage: - type: string - debugMode: - type: integer - format: int32 - copyImage: - type: string - usePrivateAddress: - type: boolean - labels: - type: object - additionalProperties: - type: string - preRunScript: - type: string - postRunScript: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - nextflowConfig: - type: string - nfsTarget: - type: string - nfsMount: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - GooglePlatformMetainfo: - type: object - properties: - locations: - type: array - items: - type: string - discriminator: - type: string - warnings: - type: array - items: - type: string - zones: - type: array - items: - type: string - buckets: - type: array - items: - $ref: "#/components/schemas/GooglePlatformMetainfo.Bucket" - filestores: - type: array - items: - $ref: "#/components/schemas/GooglePlatformMetainfo.Filestore" - GooglePlatformMetainfo.Bucket: - type: object - properties: - path: - type: string - GooglePlatformMetainfo.Filestore: - type: object - properties: - target: - type: string - name: - type: string - location: - type: string - GoogleSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - data: - type: string - writeOnly: true - GridPlatformMetainfo: - type: object - properties: - discriminator: - type: string - Image: - required: - - arch - - description - - id - - name - type: object - properties: - id: - type: string - name: - type: string - description: - type: string - arch: - type: string - InstanceType: - required: - - arch - type: object - properties: - id: - type: string - arch: - type: string - Iterator_String_: - type: object - JobCleanupPolicy: - type: string - enum: - - on_success - - always - - never - x-enum-varnames: - - on_success - - always - - never - JobInfoDto: - type: object - properties: - id: - type: integer - format: int64 - operationId: - type: string - message: - type: string - status: - type: string - exitCode: - type: integer - format: int32 - JobQueue: - required: - - name - - state - type: object - properties: - name: - type: string - state: - type: string - K8sComputeConfig: - title: Kubernetes compute configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - server: - type: string - sslCert: - type: string - namespace: - type: string - computeServiceAccount: - type: string - headServiceAccount: - type: string - storageClaimName: - type: string - storageMountPath: - type: string - podCleanup: - $ref: "#/components/schemas/PodCleanupPolicy" - headPodSpec: - type: string - servicePodSpec: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - nextflowConfig: - type: string - K8sPlatformMetaInfo: - type: object - properties: - discriminator: - type: string - K8sSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - certificate: - type: string - privateKey: - type: string - writeOnly: true - token: - type: string - writeOnly: true - LabelDbDto: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - resource: - type: boolean - isDefault: - type: boolean - isDynamic: - type: boolean - isInterpolated: - type: boolean - dateCreated: - type: string - format: date-time - LabelType: - type: string - enum: - - simple - - resource - - all - x-enum-varnames: - - simple - - resource - - all - Launch: - required: - - dateCreated - - pipeline - type: object - properties: - id: - maxLength: 22 - type: string - computeEnv: - nullable: true - allOf: - - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - pipeline: - maxLength: 200 - type: string - workDir: - type: string - revision: - maxLength: 100 - type: string - configText: - type: string - towerConfig: - type: string - paramsText: - type: string - preRunScript: - type: string - postRunScript: - type: string - mainScript: - maxLength: 200 - type: string - entryName: - maxLength: 80 - type: string - schemaName: - maxLength: 100 - pattern: "[\\p{Graph}&&[^/]]\\p{Graph}+" - type: string - resume: - type: boolean - resumeLaunchId: - maxLength: 22 - type: string - pullLatest: - type: boolean - stubRun: - type: boolean - sessionId: - maxLength: 36 - type: string - runName: - maxLength: 80 - type: string - configProfiles: - type: array - items: - type: string - userSecrets: - type: array - items: - type: string - workspaceSecrets: - type: array - items: - type: string - optimizationId: - maxLength: 32 - type: string - optimizationTargets: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - launchContainer: - type: string - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - LaunchActionRequest: - type: object - properties: - params: - type: object - additionalProperties: true - LaunchActionResponse: - type: object - properties: - workflowId: - type: string - ListAccessTokensResponse: - type: object - properties: - tokens: - type: array - items: - $ref: "#/components/schemas/AccessToken" - ListActionsResponse: - type: object - properties: - actions: - type: array - items: - $ref: "#/components/schemas/ListActionsResponse.ActionInfo" - ListActionsResponse.ActionInfo: - type: object - properties: - id: - type: string - name: - type: string - pipeline: - type: string - source: - $ref: "#/components/schemas/Action.Source" - status: - $ref: "#/components/schemas/Action.Status" - lastSeen: - type: string - format: date-time - dateCreated: - type: string - format: date-time - event: - $ref: "#/components/schemas/Action.EventType" - endpoint: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - usageCmd: - type: string - ListComputeEnvsResponse: - type: object - properties: - computeEnvs: - type: array - items: - $ref: "#/components/schemas/ListComputeEnvsResponse.Entry" - ListComputeEnvsResponse.Entry: - type: object - properties: - id: - type: string - name: - type: string - platform: - type: string - status: - $ref: "#/components/schemas/ComputeEnv.Status" - message: - type: string - lastUsed: - type: string - format: date-time - primary: - type: boolean - workspaceName: - type: string - visibility: - type: string - workDir: - type: string - credentialsId: - type: string - region: - type: string - ListCredentialsResponse: - type: object - properties: - credentials: - type: array - items: - $ref: "#/components/schemas/Credentials" - ListDatasetVersionsResponse: - type: object - properties: - versions: - type: array - items: - $ref: "#/components/schemas/DatasetVersionDto" - ListDatasetsResponse: - type: object - properties: - datasets: - type: array - items: - $ref: "#/components/schemas/DatasetDto" - ListEventTypesResponse: - type: object - properties: - eventTypes: - type: array - items: - $ref: "#/components/schemas/EventType" - ListLabelsResponse: - type: object - properties: - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - totalSize: - type: integer - format: int64 - ListManagedCredentialsRespDto: - type: object - properties: - managedCredentialsId: - type: integer - format: int64 - userId: - type: integer - format: int64 - userName: - type: string - firstName: - type: string - lastName: - type: string - avatarUrl: - type: string - provider: - type: string - enum: - - ssh - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - ListManagedCredentialsResponse: - type: object - properties: - managedCredentials: - type: array - items: - $ref: "#/components/schemas/ListManagedCredentialsRespDto" - totalSize: - type: integer - format: int64 - ListManagedIdentitiesResponse: - type: object - properties: - managedIdentities: - type: array - items: - $ref: "#/components/schemas/ManagedIdentityDbDto_AbstractGridConfig_" - totalSize: - type: integer - format: int64 - ListMembersResponse: - type: object - properties: - members: - type: array - items: - $ref: "#/components/schemas/MemberDbDto" - totalSize: - type: integer - format: int64 - ListOrganizationsResponse: - type: object - properties: - organizations: - type: array - items: - $ref: "#/components/schemas/OrganizationDbDto" - totalSize: - type: integer - format: int32 - ListParticipantsResponse: - type: object - properties: - participants: - type: array - items: - $ref: "#/components/schemas/ParticipantDbDto" - totalSize: - type: integer - format: int64 - ListPipelineInfoResponse: - type: object - properties: - pipelines: - type: array - items: - type: string - ListPipelineSecretsResponse: - type: object - properties: - pipelineSecrets: - type: array - items: - $ref: "#/components/schemas/PipelineSecret" - totalSize: - type: integer - format: int64 - ListPipelinesResponse: - type: object - properties: - pipelines: - type: array - items: - $ref: "#/components/schemas/PipelineDbDto" - totalSize: - type: integer - format: int64 - ListPlatformsResponse: - type: object - properties: - platforms: - type: array - items: - $ref: "#/components/schemas/ComputePlatform" - ListRegionsResponse: - type: object - properties: - regions: - type: array - items: - $ref: "#/components/schemas/ComputeRegion" - ListTasksResponse: - type: object - properties: - tasks: - type: array - items: - $ref: "#/components/schemas/DescribeTaskResponse" - total: - type: integer - format: int64 - ListTeamResponse: - type: object - properties: - teams: - type: array - items: - $ref: "#/components/schemas/TeamDbDto" - totalSize: - type: integer - format: int64 - ListWorkflowsResponse: - type: object - properties: - workflows: - type: array - items: - $ref: "#/components/schemas/ListWorkflowsResponse.ListWorkflowsElement" - totalSize: - type: integer - format: int64 - ListWorkflowsResponse.ListWorkflowsElement: - type: object - properties: - workflow: - $ref: "#/components/schemas/WorkflowDbDto" - progress: - $ref: "#/components/schemas/ProgressData" - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - starred: - type: boolean - optimized: - type: boolean - ListWorkspacesAndOrgResponse: - type: object - properties: - orgsAndWorkspaces: - type: array - items: - $ref: "#/components/schemas/OrgAndWorkspaceDto" - ListWorkspacesResponse: - type: object - properties: - workspaces: - type: array - items: - $ref: "#/components/schemas/WorkspaceDbDto" - LocalPlatformMetainfo: - type: object - properties: - discriminator: - type: string - Log: - type: object - properties: - name: - type: string - cmd: - type: array - items: - type: string - start_time: - type: string - end_time: - type: string - stdout: - type: string - stderr: - type: string - exit_code: - type: integer - format: int32 - LogPage: - type: object - properties: - truncated: - type: boolean - entries: - $ref: "#/components/schemas/Iterator_String_" - rewindToken: - type: string - forwardToken: - type: string - pending: - type: boolean - message: - type: string - downloads: - type: array - items: - $ref: "#/components/schemas/LogPage.Download" - LogPage.Download: - type: object - properties: - saveName: - type: string - fileName: - type: string - displayText: - type: string - LsfComputeConfig: - title: IBM LSF configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - unitForLimits: - type: string - perJobMemLimit: - type: boolean - perTaskReserve: - type: boolean - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - ManagedCredentialsDbDto: - type: object - properties: - id: - type: integer - format: int64 - ManagedCredentialsMetadata: - type: object - properties: - discriminator: - type: string - readOnly: true - ManagedIdentityDbDto_AbstractGridConfig_: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - platform: - type: string - enum: - - altair-platform - - lsf-platform - - moab-platform - - slurm-platform - - uge-platform - config: - $ref: "#/components/schemas/AbstractGridConfig" - Map.Entry_String.String_: - type: object - properties: - key: - type: string - value: - type: string - MemberDbDto: - type: object - properties: - memberId: - type: integer - format: int64 - userId: - type: integer - format: int64 - userName: - type: string - email: - type: string - firstName: - type: string - lastName: - type: string - avatar: - type: string - role: - $ref: "#/components/schemas/OrgRole" - MoabComputeConfig: - title: Moab configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - MultiRequestFileSchema: - type: object - properties: - file: - type: string - format: binary - NavbarConfig: - type: object - properties: - menus: - type: array - items: - $ref: "#/components/schemas/NavbarConfig.NavbarMenu" - NavbarConfig.NavbarMenu: - type: object - properties: - label: - type: string - url: - type: string - OrgAndWorkspaceDto: - type: object - properties: - orgId: - type: integer - format: int64 - orgName: - type: string - orgLogoUrl: - type: string - orgType: - $ref: "#/components/schemas/OrgType" - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - workspaceFullName: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - roles: - type: array - items: - type: string - OrgRole: - type: string - enum: - - owner - - member - - collaborator - x-enum-varnames: - - owner - - member - - collaborator - OrgType: - type: string - enum: - - academic - - evaluating - - pro - - basic - - internal - x-enum-varnames: - - academic - - evaluating - - pro - - basic - - internal - Organization: - required: - - fullName - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - readOnly: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - fullName: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - location: - maxLength: 100 - type: string - website: - pattern: "" - type: string - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - OrganizationDbDto: - type: object - properties: - paying: - type: boolean - deprecated: true - orgId: - type: integer - format: int64 - name: - type: string - fullName: - type: string - description: - type: string - location: - type: string - website: - type: string - logoId: - type: string - logoUrl: - type: string - memberId: - type: integer - format: int64 - memberRole: - $ref: "#/components/schemas/OrgRole" - type: - $ref: "#/components/schemas/OrgType" - OrganizationQuotas: - type: object - properties: - maxWorkspaces: - type: integer - format: int64 - maxMembers: - type: integer - format: int64 - maxTeams: - type: integer - format: int64 - maxPipelinesPerWorkspace: - type: integer - format: int64 - maxParticipantsPerWorkspace: - type: integer - format: int64 - maxDatasetsPerWorkspace: - type: integer - format: int64 - maxVersionsPerDataset: - type: integer - format: int64 - maxRuns: - type: integer - format: int64 - maxRunHistory: - type: integer - format: int64 - maxLabelsPerWorkspace: - type: integer - format: int64 - maxDataStudiosRunning: - type: integer - format: int64 - maxSeqeraComputeComputeEnvs: - type: integer - format: int64 - maxFusionThroughputBytes: - type: integer - format: int64 - ParticipantDbDto: - type: object - properties: - participantId: - type: integer - format: int64 - memberId: - type: integer - format: int64 - userName: - type: string - firstName: - type: string - lastName: - type: string - email: - type: string - orgRole: - $ref: "#/components/schemas/OrgRole" - teamId: - type: integer - format: int64 - teamName: - type: string - wspRole: - $ref: "#/components/schemas/WspRole" - type: - $ref: "#/components/schemas/ParticipantType" - teamAvatarUrl: - type: string - userAvatarUrl: - type: string - ParticipantType: - type: string - enum: - - MEMBER - - TEAM - - COLLABORATOR - PipelineDbDto: - type: object - properties: - pipelineId: - type: integer - format: int64 - name: - type: string - description: - type: string - icon: - type: string - repository: - type: string - userId: - type: integer - format: int64 - userName: - type: string - userFirstName: - type: string - userLastName: - type: string - orgId: - type: integer - format: int64 - orgName: - type: string - workspaceId: - type: integer - format: int64 - workspaceName: - type: string - visibility: - type: string - deleted: - type: boolean - lastUpdated: - type: string - format: date-time - optimizationId: - type: string - optimizationTargets: - type: string - optimizationStatus: - $ref: "#/components/schemas/PipelineOptimizationStatus" - labels: - type: array - items: - $ref: "#/components/schemas/LabelDbDto" - computeEnv: - $ref: "#/components/schemas/ComputeEnvDbDto" - PipelineInfo: - type: object - properties: - projectName: - type: string - simpleName: - type: string - repositoryUrl: - type: string - cloneUrl: - type: string - provider: - type: string - configFiles: - type: array - items: - type: string - workDirs: - type: array - items: - type: string - revisions: - type: array - items: - type: string - profiles: - type: array - items: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - warnings: - type: array - items: - type: string - PipelineOptimizationStatus: - type: string - enum: - - OPTIMIZED - - OPTIMIZABLE - - UNAVAILABLE - PipelineQueryAttribute: - type: string - enum: - - optimized - - labels - - computeEnv - x-enum-varnames: - - optimized - - labels - - computeEnv - PipelineSchemaAttributes: - type: string - enum: - - schema - - params - x-enum-varnames: - - schema - - params - PipelineSchemaResponse: - required: - - schema - type: object - properties: - schema: - type: string - params: - type: string - PipelineSecret: - required: - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 100 - pattern: "^[a-zA-Z_](?:[0-9A-Za-z]+|(_)(?!\\1)){1,49}$" - type: string - lastUsed: - type: string - format: date-time - readOnly: true - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - PlatformMetainfo: - type: object - discriminator: - propertyName: discriminator - mapping: - gke-platform: "#/components/schemas/GkePlatformMetaInfo" - aws-cloud: "#/components/schemas/AwsCloudPlatformMetainfo" - seqeracompute: "#/components/schemas/SeqeraComputePlatformMetainfo" - k8s-platform: "#/components/schemas/K8sPlatformMetaInfo" - grid: "#/components/schemas/GridPlatformMetainfo" - aws-batch: "#/components/schemas/AwsBatchPlatformMetainfo" - google-cloud: "#/components/schemas/GoogleCloudPlatformMetaInfo" - local-platform: "#/components/schemas/LocalPlatformMetainfo" - azure-batch: "#/components/schemas/AzBatchPlatformMetainfo" - eks-platform: "#/components/schemas/EksPlatformMetaInfo" - oneOf: - - $ref: "#/components/schemas/AwsBatchPlatformMetainfo" - - $ref: "#/components/schemas/AwsCloudPlatformMetainfo" - - $ref: "#/components/schemas/GooglePlatformMetainfo" - - $ref: "#/components/schemas/GoogleCloudPlatformMetaInfo" - - $ref: "#/components/schemas/AzBatchPlatformMetainfo" - - $ref: "#/components/schemas/EksPlatformMetaInfo" - - $ref: "#/components/schemas/GkePlatformMetaInfo" - - $ref: "#/components/schemas/K8sPlatformMetaInfo" - - $ref: "#/components/schemas/GridPlatformMetainfo" - - $ref: "#/components/schemas/SeqeraComputePlatformDescriber" - - $ref: "#/components/schemas/LocalPlatformMetainfo" - PodCleanupPolicy: - type: string - enum: - - on_success - - always - - never - x-enum-varnames: - - on_success - - always - - never - ProcessLoad: - required: - - aborted - - cached - - cpuLoad - - cpuTime - - cpus - - failed - - ignored - - invCtxSwitch - - loadCpus - - loadMemory - - loadTasks - - memoryReq - - memoryRss - - peakCpus - - peakMemory - - peakTasks - - pending - - process - - readBytes - - retries - - running - - submitted - - succeeded - - volCtxSwitch - - writeBytes - type: object - properties: - pending: - type: integer - format: int64 - submitted: - type: integer - format: int64 - running: - type: integer - format: int64 - succeeded: - type: integer - format: int64 - failed: - type: integer - format: int64 - cached: - type: integer - format: int64 - aborted: - type: integer - format: int64 - retries: - type: integer - format: int64 - ignored: - type: integer - format: int64 - memoryEfficiency: - type: number - format: float - cpuEfficiency: - type: number - format: float - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - version: - type: integer - format: int64 - process: - type: string - cpus: - type: integer - format: int64 - deprecated: true - cpuTime: - type: integer - format: int64 - deprecated: true - cpuLoad: - type: integer - format: int64 - deprecated: true - memoryRss: - type: integer - format: int64 - deprecated: true - memoryReq: - type: integer - format: int64 - deprecated: true - readBytes: - type: integer - format: int64 - deprecated: true - writeBytes: - type: integer - format: int64 - deprecated: true - volCtxSwitch: - type: integer - format: int64 - deprecated: true - invCtxSwitch: - type: integer - format: int64 - deprecated: true - loadTasks: - type: integer - format: int64 - deprecated: true - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakCpus: - type: integer - format: int64 - peakTasks: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - ProgressData: - type: object - properties: - workflowProgress: - $ref: "#/components/schemas/WorkflowLoad" - processesProgress: - type: array - items: - $ref: "#/components/schemas/ProcessLoad" - totalProcesses: - type: integer - format: int32 - RandomWorkflowNameResponse: - type: object - properties: - name: - type: string - ResourceData: - type: object - properties: - warnings: - type: array - items: - type: string - mean: - type: number - format: float - min: - type: number - format: float - q1: - type: number - format: float - q2: - type: number - format: float - q3: - type: number - format: float - max: - type: number - format: float - minLabel: - type: string - maxLabel: - type: string - q1Label: - type: string - q2Label: - type: string - q3Label: - type: string - RunId: - type: object - properties: - run_id: - type: string - RunListResponse: - type: object - properties: - runs: - type: array - items: - $ref: "#/components/schemas/RunStatus" - next_page_token: - type: string - RunLog: - type: object - properties: - run_id: - type: string - request: - $ref: "#/components/schemas/RunRequest" - state: - $ref: "#/components/schemas/State" - run_log: - $ref: "#/components/schemas/Log" - task_logs: - type: array - items: - $ref: "#/components/schemas/Log" - outputs: {} - RunRequest: - type: object - properties: - workflow_params: - type: string - workflow_type: - type: string - workflow_type_version: - type: string - tags: - type: object - additionalProperties: - type: string - workflow_engine_parameters: - type: object - additionalProperties: - type: string - workflow_url: - type: string - RunStatus: - type: object - properties: - run_id: - type: string - state: - $ref: "#/components/schemas/State" - S3SecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - accessKey: - type: string - secretKey: - type: string - writeOnly: true - pathStyleAccessEnabled: - type: boolean - SSHSecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - privateKey: - type: string - writeOnly: true - passphrase: - type: string - writeOnly: true - SecurityGroup: - type: object - properties: - id: - type: string - name: - type: string - vpcId: - type: string - SecurityKeys: - type: object - properties: - discriminator: - type: string - readOnly: true - discriminator: - propertyName: discriminator - mapping: - s3: "#/components/schemas/S3SecurityKeys" - github: "#/components/schemas/GitHubSecurityKeys" - azurerepos: "#/components/schemas/AzureReposSecurityKeys" - azure_entra: "#/components/schemas/AzureEntraKeys" - container-reg: "#/components/schemas/ContainerRegistryKeys" - tw-agent: "#/components/schemas/AgentSecurityKeys" - k8s: "#/components/schemas/K8sSecurityKeys" - ssh: "#/components/schemas/SSHSecurityKeys" - google: "#/components/schemas/GoogleSecurityKeys" - bitbucket: "#/components/schemas/BitBucketSecurityKeys" - gitea: "#/components/schemas/GiteaSecurityKeys" - seqeracompute: "#/components/schemas/SeqeraComputeSecurityKeys" - codecommit: "#/components/schemas/CodeCommitSecurityKeys" - gitlab: "#/components/schemas/GitLabSecurityKeys" - aws: "#/components/schemas/AwsSecurityKeys" - azure: "#/components/schemas/AzureSecurityKeys" - oneOf: - - $ref: "#/components/schemas/AwsSecurityKeys" - - $ref: "#/components/schemas/GoogleSecurityKeys" - - $ref: "#/components/schemas/GitHubSecurityKeys" - - $ref: "#/components/schemas/GitLabSecurityKeys" - - $ref: "#/components/schemas/BitBucketSecurityKeys" - - $ref: "#/components/schemas/GiteaSecurityKeys" - - $ref: "#/components/schemas/SSHSecurityKeys" - - $ref: "#/components/schemas/K8sSecurityKeys" - - $ref: "#/components/schemas/AzureSecurityKeys" - - $ref: "#/components/schemas/AzureReposSecurityKeys" - - $ref: "#/components/schemas/ContainerRegistryKeys" - - $ref: "#/components/schemas/AgentSecurityKeys" - - $ref: "#/components/schemas/CodeCommitSecurityKeys" - - $ref: "#/components/schemas/AzureEntraKeys" - - $ref: "#/components/schemas/SeqeraComputeSecurityKeys" - - $ref: "#/components/schemas/S3SecurityKeys" - SeqeraComputeConfig: - title: Seqera Compute configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - region: - type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string - defaultDataRetentionPolicy: - type: boolean - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - SeqeraComputePlatformDescriber: - type: object - SeqeraComputePlatformMetainfo: - type: object - properties: - warnings: - type: array - items: - type: string - jobQueues: - type: array - items: - $ref: "#/components/schemas/JobQueue" - buckets: - type: array - items: - $ref: "#/components/schemas/Bucket" - fileSystems: - type: array - items: - $ref: "#/components/schemas/FsxFileSystem" - efsFileSystems: - type: array - items: - $ref: "#/components/schemas/EfsFileSystem" - keyPairs: - type: array - items: - type: string - vpcs: - type: array - items: - $ref: "#/components/schemas/Vpc" - images: - type: array - items: - $ref: "#/components/schemas/Image" - securityGroups: - type: array - items: - $ref: "#/components/schemas/SecurityGroup" - subnets: - type: array - items: - $ref: "#/components/schemas/Subnet" - instanceFamilies: - type: array - items: - type: string - allocStrategy: - type: array - items: - type: string - instanceTypes: - type: array - items: - $ref: "#/components/schemas/InstanceType" - discriminator: - type: string - SeqeraComputeSecurityKeys: - type: object - allOf: - - $ref: "#/components/schemas/AwsSecurityKeys" - - properties: - discriminator: - type: string - readOnly: true - ServiceInfo: - type: object - properties: - version: - type: string - apiVersion: - type: string - commitId: - type: string - authTypes: - type: array - items: - type: string - loginPath: - type: string - navbar: - $ref: "#/components/schemas/NavbarConfig" - heartbeatInterval: - type: integer - format: int32 - userWorkspaceEnabled: - type: boolean - allowInstanceCredentials: - type: boolean - landingUrl: - type: string - termsOfUseUrl: - type: string - contentUrl: - type: string - analytics: - $ref: "#/components/schemas/Analytics" - allowLocalRepos: - type: boolean - deprecated: true - contentMaxFileSize: - type: integer - format: int64 - waveEnabled: - type: boolean - groundswellEnabled: - type: boolean - groundswellAllowedWorkspaces: - type: array - items: - type: integer - format: int64 - scmsServerUrl: - type: string - forgePrefix: - type: string - seqeraCloud: - type: boolean - evalWorkspaceIds: - type: array - items: - type: integer - format: int64 - contactEmail: - type: string - allowNextflowCliLogs: - type: boolean - logoutUrl: - type: string - nullable: true - ServiceInfoResponse: - type: object - properties: - serviceInfo: - $ref: "#/components/schemas/ServiceInfo" - SlurmComputeConfig: - title: Slurm configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - State: - type: string - enum: - - UNKNOWN - - QUEUED - - INITIALIZING - - RUNNING - - PAUSED - - COMPLETE - - EXECUTOR_ERROR - - SYSTEM_ERROR - - CANCELED - - CANCELING - StudioCheckpointStatus: - type: string - enum: - - empty - - interim - - finalized - - invalid - x-enum-varnames: - - empty - - interim - - finalized - - invalid - SubmitWorkflowLaunchRequest: - type: object - properties: - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - SubmitWorkflowLaunchResponse: - type: object - properties: - workflowId: - type: string - Subnet: - type: object - properties: - id: - type: string - zone: - type: string - vpcId: - type: string - Task: - required: - - status - - taskId - type: object - properties: - hash: - type: string - name: - type: string - process: - type: string - tag: - type: string - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - module: - type: array - items: - type: string - container: - type: string - attempt: - type: integer - format: int32 - script: - type: string - scratch: - type: string - workdir: - type: string - queue: - type: string - cpus: - type: integer - format: int32 - memory: - type: integer - format: int64 - disk: - type: integer - format: int64 - time: - type: integer - format: int64 - env: - type: string - executor: - type: string - machineType: - type: string - cloudZone: - type: string - priceModel: - $ref: "#/components/schemas/CloudPriceModel" - cost: - type: number - errorAction: - type: string - exitStatus: - type: integer - format: int32 - duration: - type: integer - format: int64 - realtime: - type: integer - format: int64 - nativeId: - type: string - pcpu: - type: number - format: double - pmem: - type: number - format: double - rss: - type: integer - format: int64 - vmem: - type: integer - format: int64 - peakRss: - type: integer - format: int64 - peakVmem: - type: integer - format: int64 - rchar: - type: integer - format: int64 - wchar: - type: integer - format: int64 - syscr: - type: integer - format: int64 - syscw: - type: integer - format: int64 - readBytes: - type: integer - format: int64 - writeBytes: - type: integer - format: int64 - volCtxt: - type: integer - format: int64 - invCtxt: - type: integer - format: int64 - exit: - type: integer - format: int32 - id: - type: integer - format: int64 - nullable: true - taskId: - type: integer - format: int64 - status: - $ref: "#/components/schemas/TaskStatus" - dateCreated: - type: string - format: date-time - nullable: true - lastUpdated: - type: string - format: date-time - nullable: true - TaskStatus: - type: string - enum: - - NEW - - SUBMITTED - - RUNNING - - CACHED - - COMPLETED - - FAILED - - ABORTED - Team: - required: - - name - type: object - properties: - id: - type: integer - format: int64 - nullable: true - readOnly: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - description: - maxLength: 250 - type: string - dateCreated: - type: string - format: date-time - readOnly: true - lastUpdated: - type: string - format: date-time - readOnly: true - TeamDbDto: - type: object - properties: - teamId: - type: integer - format: int64 - name: - type: string - description: - type: string - avatarUrl: - type: string - membersCount: - type: integer - format: int64 - TraceBeginRequest: - type: object - properties: - launchId: - type: string - deprecated: true - workflow: - $ref: "#/components/schemas/Workflow" - processNames: - type: array - items: - type: string - towerLaunch: - type: boolean - TraceBeginResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - watchUrl: - type: string - TraceCompleteRequest: - type: object - properties: - workflow: - $ref: "#/components/schemas/Workflow" - metrics: - type: array - items: - $ref: "#/components/schemas/WorkflowMetrics" - progress: - $ref: "#/components/schemas/TraceProgressData" - TraceCompleteResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - TraceCreateRequest: - type: object - properties: - launchId: - type: string - deprecated: true - sessionId: - type: string - runName: - type: string - projectName: - type: string - repository: - type: string - workflowId: - type: string - TraceCreateResponse: - type: object - properties: - message: - type: string - workflowId: - type: string - TraceHeartbeatRequest: - type: object - properties: - progress: - $ref: "#/components/schemas/TraceProgressData" - TraceHeartbeatResponse: - type: object - properties: - message: - type: string - TraceProcessingStatus: - type: string - enum: - - OK - - KO - TraceProgressData: - type: object - properties: - pending: - type: integer - format: int32 - submitted: - type: integer - format: int32 - running: - type: integer - format: int32 - succeeded: - type: integer - format: int32 - cached: - type: integer - format: int32 - failed: - type: integer - format: int32 - aborted: - type: integer - format: int32 - stored: - type: integer - format: int32 - ignored: - type: integer - format: int32 - retries: - type: integer - format: int32 - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakRunning: - type: integer - format: int32 - peakCpus: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - processes: - type: array - items: - $ref: "#/components/schemas/TraceProgressDetail" - TraceProgressDetail: - type: object - properties: - index: - type: integer - format: int32 - name: - type: string - pending: - type: integer - format: int32 - submitted: - type: integer - format: int32 - running: - type: integer - format: int32 - succeeded: - type: integer - format: int32 - cached: - type: integer - format: int32 - failed: - type: integer - format: int32 - aborted: - type: integer - format: int32 - stored: - type: integer - format: int32 - ignored: - type: integer - format: int32 - retries: - type: integer - format: int32 - terminated: - type: boolean - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakRunning: - type: integer - format: int32 - peakCpus: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - TraceProgressRequest: - type: object - properties: - tasks: - type: array - items: - $ref: "#/components/schemas/Task" - progress: - $ref: "#/components/schemas/TraceProgressData" - containers: - type: array - items: - $ref: "#/components/schemas/ContainerData" - TraceProgressResponse: - type: object - properties: - status: - $ref: "#/components/schemas/TraceProcessingStatus" - workflowId: - type: string - UnivaComputeConfig: - title: Univa Grid Engine configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - UpdateActionRequest: - type: object - properties: - name: - type: string - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - UpdateComputeEnvRequest: - type: object - properties: - name: - type: string - credentialsId: - type: string - UpdateCredentialsRequest: - type: object - properties: - credentials: - $ref: "#/components/schemas/Credentials" - UpdateDatasetRequest: - type: object - properties: - name: - type: string - description: - type: string - UpdateLabelRequest: - type: object - properties: - name: - type: string - value: - type: string - isDefault: - type: boolean - UpdateLabelResponse: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - value: - type: string - isDefault: - type: boolean - UpdateManagedCredentialsRequest: - type: object - properties: - provider: - type: string - enum: - - ssh - credentials: - $ref: "#/components/schemas/Credentials" - metadata: - $ref: "#/components/schemas/ManagedCredentialsMetadata" - UpdateManagedIdentityRequest: - type: object - properties: - managedIdentity: - $ref: "#/components/schemas/ManagedIdentityDbDto_AbstractGridConfig_" - UpdateMemberRoleRequest: - type: object - properties: - role: - $ref: "#/components/schemas/OrgRole" - UpdateOrganizationRequest: - type: object - properties: - fullName: - type: string - name: - type: string - description: - type: string - location: - type: string - website: - type: string - logoId: - type: string - paying: - type: boolean - nullable: true - deprecated: true - type: - nullable: true - allOf: - - $ref: "#/components/schemas/OrgType" - UpdateParticipantRoleRequest: - type: object - properties: - role: - $ref: "#/components/schemas/WspRole" - UpdatePipelineRequest: - type: object - properties: - name: - type: string - description: - type: string - icon: - type: string - launch: - $ref: "#/components/schemas/WorkflowLaunchRequest" - labelIds: - type: array - items: - type: integer - format: int64 - UpdatePipelineResponse: - type: object - properties: - pipeline: - $ref: "#/components/schemas/PipelineDbDto" - UpdatePipelineSecretRequest: - type: object - properties: - value: - type: string - UpdateTeamRequest: - type: object - properties: - name: - type: string - description: - type: string - avatarId: - type: string - UpdateWorkspaceRequest: - type: object - properties: - name: - type: string - fullName: - type: string - description: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - UploadDatasetVersionResponse: - type: object - properties: - version: - $ref: "#/components/schemas/DatasetVersionDto" - UploadEtag: - type: object - properties: - partNumber: - type: integer - format: int32 - eTag: - type: string - UserDbDto: - required: - - email - - userName - type: object - properties: - id: - type: integer - format: int64 - userName: - maxLength: 40 - type: string - email: - maxLength: 255 - type: string - format: email - firstName: - maxLength: 100 - type: string - lastName: - maxLength: 100 - type: string - organization: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - avatar: - type: string - avatarId: - type: string - notification: - type: boolean - termsOfUseConsent: - type: boolean - marketingConsent: - type: boolean - lastAccess: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - deleted: - type: boolean - UserInfo: - required: - - avatar - - email - - id - - userName - type: object - properties: - id: - type: integer - format: int64 - userName: - type: string - email: - type: string - avatar: - type: string - Visibility: - type: string - enum: - - PRIVATE - - SHARED - Vpc: - type: object - properties: - id: - type: string - isDefault: - type: boolean - WesErrorResponse: - type: object - properties: - msg: - type: string - status_code: - type: integer - format: int32 - WfFusionMeta: - type: object - properties: - enabled: - type: boolean - version: - maxLength: 20 - type: string - WfManifest: - type: object - properties: - nextflowVersion: - maxLength: 20 - type: string - defaultBranch: - maxLength: 20 - type: string - version: - maxLength: 20 - type: string - homePage: - maxLength: 200 - type: string - gitmodules: - maxLength: 150 - type: string - description: - maxLength: 1024 - type: string - name: - maxLength: 150 - type: string - mainScript: - maxLength: 100 - type: string - author: - maxLength: 150 - type: string - icon: - maxLength: 255 - type: string - WfNextflow: - type: object - properties: - version: - maxLength: 20 - type: string - build: - maxLength: 10 - type: string - timestamp: - type: string - format: date-time - WfStats: - type: object - properties: - computeTimeFmt: - maxLength: 50 - type: string - cachedCount: - type: integer - format: int32 - failedCount: - type: integer - format: int32 - ignoredCount: - type: integer - format: int32 - succeedCount: - type: integer - format: int32 - cachedCountFmt: - type: string - succeedCountFmt: - type: string - failedCountFmt: - type: string - ignoredCountFmt: - type: string - cachedPct: - type: number - format: float - failedPct: - type: number - format: float - succeedPct: - type: number - format: float - ignoredPct: - type: number - format: float - cachedDuration: - type: integer - format: int64 - failedDuration: - type: integer - format: int64 - succeedDuration: - type: integer - format: int64 - WfWaveMeta: - type: object - properties: - enabled: - type: boolean - Workflow: - required: - - commandLine - - projectName - - runName - - sessionId - - submit - - userName - - workDir - type: object - properties: - requiresAttention: - type: boolean - status: - $ref: "#/components/schemas/WorkflowStatus" - ownerId: - type: integer - format: int64 - readOnly: true - repository: - type: string - id: - maxLength: 16 - type: string - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - dateCreated: - type: string - format: date-time - nullable: true - readOnly: true - lastUpdated: - type: string - format: date-time - nullable: true - readOnly: true - runName: - maxLength: 80 - type: string - sessionId: - maxLength: 36 - type: string - profile: - maxLength: 100 - type: string - workDir: - type: string - commitId: - maxLength: 40 - type: string - userName: - maxLength: 40 - type: string - scriptId: - maxLength: 40 - type: string - revision: - maxLength: 100 - type: string - commandLine: - maxLength: 8096 - type: string - projectName: - maxLength: 200 - type: string - scriptName: - maxLength: 100 - type: string - launchId: - maxLength: 22 - type: string - configFiles: - type: array - items: - type: string - params: - type: object - additionalProperties: true - configText: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - nextflow: - $ref: "#/components/schemas/WfNextflow" - stats: - $ref: "#/components/schemas/WfStats" - fusion: - $ref: "#/components/schemas/WfFusionMeta" - wave: - $ref: "#/components/schemas/WfWaveMeta" - errorMessage: - type: string - errorReport: - type: string - deleted: - type: boolean - readOnly: true - projectDir: - type: string - homeDir: - type: string - container: - type: string - containerEngine: - type: string - scriptFile: - type: string - launchDir: - type: string - duration: - type: integer - format: int64 - exitStatus: - type: integer - format: int32 - resume: - type: boolean - success: - type: boolean - logFile: - maxLength: 255 - type: string - outFile: - maxLength: 255 - type: string - operationId: - maxLength: 110 - type: string - WorkflowDbDto: - type: object - properties: - messages: - type: array - items: - type: string - id: - type: string - ownerId: - type: integer - format: int64 - submit: - type: string - format: date-time - start: - type: string - format: date-time - complete: - type: string - format: date-time - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - runName: - type: string - sessionId: - type: string - profile: - type: string - workDir: - type: string - commitId: - type: string - userName: - type: string - scriptId: - type: string - revision: - type: string - commandLine: - type: string - projectName: - type: string - scriptName: - type: string - launchId: - type: string - status: - $ref: "#/components/schemas/WorkflowStatus" - requiresAttention: - type: boolean - configFiles: - type: array - items: - type: string - params: - type: object - additionalProperties: true - configText: - type: string - manifest: - $ref: "#/components/schemas/WfManifest" - nextflow: - $ref: "#/components/schemas/WfNextflow" - stats: - $ref: "#/components/schemas/WfStats" - errorMessage: - type: string - errorReport: - type: string - deleted: - type: boolean - projectDir: - type: string - homeDir: - type: string - container: - type: string - repository: - type: string - containerEngine: - type: string - scriptFile: - type: string - launchDir: - type: string - duration: - type: integer - format: int64 - exitStatus: - type: integer - format: int32 - resume: - type: boolean - success: - type: boolean - WorkflowLaunchRequest: - type: object - properties: - id: - type: string - computeEnvId: - type: string - runName: - type: string - pipeline: - type: string - workDir: - type: string - revision: - type: string - sessionId: - type: string - configProfiles: - type: array - items: - type: string - userSecrets: - type: array - items: - type: string - workspaceSecrets: - type: array - items: - type: string - configText: - type: string - towerConfig: - type: string - paramsText: - type: string - preRunScript: - type: string - postRunScript: - type: string - mainScript: - type: string - entryName: - type: string - schemaName: - type: string - resume: - type: boolean - pullLatest: - type: boolean - stubRun: - type: boolean - optimizationId: - type: string - optimizationTargets: - type: string - labelIds: - type: array - items: - type: integer - format: int64 - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - launchContainer: - type: string - dateCreated: - type: string - format: date-time - WorkflowLaunchResponse: - type: object - properties: - id: - type: string - computeEnv: - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" - pipeline: - type: string - pipelineId: - type: integer - format: int64 - workDir: - type: string - revision: - type: string - sessionId: - type: string - configProfiles: - type: array - items: - type: string - userSecrets: - type: array - items: - type: string - workspaceSecrets: - type: array - items: - type: string - configText: - type: string - towerConfig: - type: string - paramsText: - type: string - preRunScript: - type: string - postRunScript: - type: string - mainScript: - type: string - entryName: - type: string - schemaName: - type: string - resume: - type: boolean - pullLatest: - type: boolean - stubRun: - type: boolean - resumeDir: - type: string - resumeCommitId: - type: string - headJobMemoryMb: - type: integer - format: int32 - headJobCpus: - type: integer - format: int32 - optimizationId: - type: string - optimizationTargets: - type: string - dateCreated: - type: string - format: date-time - WorkflowLoad: - required: - - aborted - - cached - - cpuLoad - - cpuTime - - cpus - - failed - - ignored - - invCtxSwitch - - loadCpus - - loadMemory - - loadTasks - - memoryReq - - memoryRss - - peakCpus - - peakMemory - - peakTasks - - pending - - readBytes - - retries - - running - - submitted - - succeeded - - volCtxSwitch - - writeBytes - type: object - properties: - pending: - type: integer - format: int64 - submitted: - type: integer - format: int64 - running: - type: integer - format: int64 - succeeded: - type: integer - format: int64 - failed: - type: integer - format: int64 - cached: - type: integer - format: int64 - aborted: - type: integer - format: int64 - retries: - type: integer - format: int64 - ignored: - type: integer - format: int64 - memoryEfficiency: - type: number - format: float - cpuEfficiency: - type: number - format: float - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - version: - type: integer - format: int64 - executors: - type: array - items: - type: string - cpus: - type: integer - format: int64 - cpuTime: - type: integer - format: int64 - cpuLoad: - type: integer - format: int64 - memoryRss: - type: integer - format: int64 - memoryReq: - type: integer - format: int64 - readBytes: - type: integer - format: int64 - writeBytes: - type: integer - format: int64 - volCtxSwitch: - type: integer - format: int64 - invCtxSwitch: - type: integer - format: int64 - loadTasks: - type: integer - format: int64 - loadCpus: - type: integer - format: int64 - loadMemory: - type: integer - format: int64 - peakCpus: - type: integer - format: int64 - peakTasks: - type: integer - format: int64 - peakMemory: - type: integer - format: int64 - cost: - type: number - netCpus: - type: integer - format: int64 - netCpuTime: - type: integer - format: int64 - netCpuLoad: - type: integer - format: int64 - netMemoryRss: - type: integer - format: int64 - netMemoryReq: - type: integer - format: int64 - netMemoryConsumption: - type: number - netReadBytes: - type: integer - format: int64 - netWriteBytes: - type: integer - format: int64 - netVolCtxSwitch: - type: integer - format: int64 - netInvCtxSwitch: - type: integer - format: int64 - netCost: - type: number - WorkflowLogResponse: - type: object - properties: - log: - $ref: "#/components/schemas/LogPage" - WorkflowMetrics: - required: - - process - type: object - properties: - id: - type: integer - format: int64 - nullable: true - process: - maxLength: 255 - type: string - cpu: - $ref: "#/components/schemas/ResourceData" - mem: - $ref: "#/components/schemas/ResourceData" - vmem: - $ref: "#/components/schemas/ResourceData" - time: - $ref: "#/components/schemas/ResourceData" - reads: - $ref: "#/components/schemas/ResourceData" - writes: - $ref: "#/components/schemas/ResourceData" - cpuUsage: - $ref: "#/components/schemas/ResourceData" - memUsage: - $ref: "#/components/schemas/ResourceData" - timeUsage: - $ref: "#/components/schemas/ResourceData" - WorkflowQueryAttribute: - type: string - enum: - - optimized - - labels - - messages - - minimal - x-enum-varnames: - - optimized - - labels - - messages - - minimal - WorkflowStatus: - type: string - enum: - - SUBMITTED - - RUNNING - - SUCCEEDED - - FAILED - - CANCELLED - - UNKNOWN - Workspace: - required: - - fullName - - name - - visibility - type: object - properties: - id: - type: integer - format: int64 - nullable: true - name: - maxLength: 40 - pattern: "^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$" - type: string - fullName: - maxLength: 100 - type: string - description: - maxLength: 1000 - type: string - visibility: - $ref: "#/components/schemas/Visibility" - dateCreated: - type: string - format: date-time - lastUpdated: - type: string - format: date-time - WorkspaceDbDto: - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - fullName: - type: string - description: - type: string - visibility: - $ref: "#/components/schemas/Visibility" - WspRole: - type: string - enum: - - owner - - admin - - maintain - - launch - - connect - - view - x-enum-varnames: - - owner - - admin - - maintain - - launch - - connect - - view - securitySchemes: - BearerAuth: - type: http - scheme: bearer - bearerFormat: jwt diff --git a/platform-api-docs/scripts/specs/servers-overlay.yaml b/platform-api-docs/scripts/specs/servers-overlay.yaml deleted file mode 100644 index 416b61924..000000000 --- a/platform-api-docs/scripts/specs/servers-overlay.yaml +++ /dev/null @@ -1,12 +0,0 @@ -overlay: 1.0.0 -info: - title: Seqera Platform API servers configuration - version: 1.0.0 - description: Adds the production API server URL to enable 'Try it out' functionality in API documentation. - -actions: - - target: "$" - update: - servers: - - url: https://api.cloud.seqera.io - description: Seqera Platform Cloud API \ No newline at end of file diff --git a/wave_docs/sidebar.json b/wave_docs/sidebar.json deleted file mode 100644 index f80c7513e..000000000 --- a/wave_docs/sidebar.json +++ /dev/null @@ -1,104 +0,0 @@ -{ - "sidebar": [ - { - "type": "category", - "label": "Wave containers", - "link": {"type": "doc", "id": "index"}, - "collapsed": true, - "items": [ - "provisioning" - ] - }, - { - "type": "category", - "label": "Tutorials", - "link": {"type": "doc", "id": "tutorials/index"}, - "collapsed": true, - "items": [ - "tutorials/nextflow-wave", - "tutorials/nextflow-seqera-containers", - "tutorials/wave-cli" - ] - }, - { - "type": "category", - "label": "Nextflow integration", - "collapsed": true, - "items": [ - "nextflow/index", - "nextflow/use-cases", - "nextflow/configuration" - ] - }, - { - "type": "category", - "label": "Developer tools", - "collapsed": true, - "items": [ - "api", - { - "type": "category", - "label": "CLI", - "collapsed": true, - "items": [ - "cli/index", - "cli/installation", - "cli/use-cases" - ] - } - ] - }, - { - "type": "category", - "label": "Self-hosted Wave", - "collapsed": true, - "items": [ - { - "type": "category", - "label": "Installation", - "collapsed": true, - "items": [ - "install/docker-compose", - "install/kubernetes", - "install/configure-wave-build" - ] - }, - { - "type": "category", - "label": "Configuration", - "collapsed": true, - "items": [ - "wave-lite", - "configure-wave", - "configuration" - ] - }, - { - "type": "category", - "label": "Migration notes", - "link": {"type": "doc", "id": "migrations/index"}, - "collapsed": true, - "items": [ - "migrations/1-25-0", - "migrations/1-24-0", - "migrations/1-21-0" - ] - }, - { - "type": "category", - "label": "Guides", - "collapsed": true, - "items": [ - "db-migration" - ] - } - ] - }, - "faq", - { - "type": "link", - "label": "Changelog", - "href": "/changelog/tags/wave" - } - ] -}