Skip to content

Commit 97f9f20

Browse files
committed
Work on the readme a bit
1 parent ab238ae commit 97f9f20

File tree

1 file changed

+54
-47
lines changed

1 file changed

+54
-47
lines changed

README.md

Lines changed: 54 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,16 @@
88

99
A Node-RED node for interacting with the Seqera Platform API.
1010

11+
Gives new Node-RED node types for your automation workflows, which are designed to work together:
12+
13+
- [Create Dataset](#create-dataset)
14+
- [Launch and Monitor a Run](#launch-and-monitor-a-run)
15+
16+
Also [Launch](#launch) and [Workflow](#workflow) nodes for more custom workflows where polling workflow status is not required and it's helpful to have full control.
17+
1118
# Installation
1219

13-
Install via the Node-RED palette manager **or** from the command line inside your Node-RED user directory (`~/.node-red`):
20+
Install via the Node-RED palette manager **or** from _ the command line inside your Node-RED user directory _ (`~/.node-red`):
1421

1522
```bash
1623
npm install node-red-contrib-seqera
@@ -26,7 +33,28 @@ Create a Seqera Config node to store your API credentials and default settings.
2633
- **Workspace ID**: Your Seqera workspace ID
2734
- **Token**: Your Seqera API token
2835

29-
## Seqera Launch Monitor Node
36+
## Create Dataset
37+
38+
Creates a new dataset and uploads its file contents in one step.
39+
40+
### Inputs
41+
42+
- `datasetName`: Name of the dataset to create
43+
- `fileContents`: CSV/TSV (string or Buffer) to upload. Defaults to `msg.payload`.
44+
- `fileType`: _csv_ or _tsv_ – Select the MIME type for the upload (defaults to **csv**). This is required by Seqera Platform to validate the file contents.
45+
- `description`: Optional description string for the dataset
46+
- `workspaceId`: Override the workspace ID from the \* config node
47+
48+
### Outputs (one output)
49+
50+
Fired once when the upload completes successfully.
51+
52+
- `msg.payload`: Upload response from the API
53+
- `msg.datasetId`: The ID of the created dataset
54+
- `msg._seqera_request`: Details of the dataset creation request (for debugging)
55+
- `msg._seqera_upload_request`: Details of the file-upload request (for debugging)
56+
57+
## Launch and Monitor a Run
3058

3159
Launches a workflow and then periodically checks its status until completion.
3260

@@ -35,7 +63,7 @@ Launches a workflow and then periodically checks its status until completion.
3563
- `pollInterval`: How frequently to check workflow status (in seconds)
3664
- `launchpadName`: The Human-readable name of a pipeline in the launchpad to use
3765
- `params`: JSON object containing parameters to merge with the launchpad's default parameters
38-
- `workspaceId`: Override the workspace ID from the config node
66+
- `workspaceId`: Override the workspace ID from the \* config node
3967
- `sourceWorkspaceId`: The source workspace ID (if a shared workflow and different to workspaceId)
4068

4169
Alternative input:
@@ -55,57 +83,15 @@ Each message contains:
5583
- `msg._seqera_request`: The request details sent to the API (when error occurs)
5684
- `msg._seqera_error`: Error details (when error occurs)
5785

58-
## Seqera Workflow Node
59-
60-
Queries the status of a workflow.
61-
62-
### Inputs
63-
64-
- **workflowId**: The ID of the workflow to query
65-
- **workspaceId**: Override the workspace ID from the config node
66-
67-
### Outputs (two outputs)
68-
69-
1. Only receives messages when the workflow is active (submitted, running, or pending)
70-
2. Receives messages when the workflow has completed (success or failure) OR when an API error occurs
71-
72-
Each message contains:
73-
74-
- `msg.payload`: The workflow details from the API
75-
- `msg.workflowId`: The ID of the workflow
76-
- `msg._seqera_request`: The request details sent to the API (when error occurs)
77-
- `msg._seqera_error`: Error details (when error occurs)
78-
79-
## Seqera Dataset Create Node
80-
81-
Creates a new dataset and uploads its file contents in one step.
82-
83-
### Inputs
84-
85-
- `datasetName`: Name of the dataset to create
86-
- `fileContents`: CSV/TSV (string or Buffer) to upload. Defaults to `msg.payload`.
87-
- `fileType`: _csv_ or _tsv_ – Select the MIME type for the upload (defaults to **csv**). This is required by Seqera Platform to validate the file contents.
88-
- `description`: Optional description string for the dataset
89-
- `workspaceId`: Override the workspace ID from the config node
90-
91-
### Outputs (one output)
92-
93-
Fired once when the upload completes successfully.
94-
95-
- `msg.payload`: Upload response from the API
96-
- `msg.datasetId`: The ID of the created dataset
97-
- `msg._seqera_request`: Details of the dataset creation request (for debugging)
98-
- `msg._seqera_upload_request`: Details of the file-upload request (for debugging)
99-
100-
## Seqera Launch Node
86+
## Launch
10187

10288
Launches a workflow using the Seqera API.
10389

10490
### Inputs
10591

10692
- `launchpadName`: The Human-readable name of a pipeline in the launchpad to use
10793
- `params`: JSON object containing parameters to merge with the launchpad's default parameters
108-
- `workspaceId`: Override the workspace ID from the config node
94+
- `workspaceId`: Override the workspace ID from the \* config node
10995
- `sourceWorkspaceId`: The source workspace ID (if a shared workflow and different to workspaceId)
11096

11197
Alternative input:
@@ -119,6 +105,27 @@ Alternative input:
119105
- `msg._seqera_request`: The request details sent to the API (when error occurs)
120106
- `msg._seqera_error`: Any error details if the request fails
121107

108+
## Workflow
109+
110+
Queries the status of a workflow.
111+
112+
### Inputs
113+
114+
- **workflowId**: The ID of the workflow to query
115+
- **workspaceId**: Override the workspace ID from the \* config node
116+
117+
### Outputs (two outputs)
118+
119+
1. Only receives messages when the workflow is active (submitted, running, or pending)
120+
2. Receives messages when the workflow has completed (success or failure) OR when an API error occurs
121+
122+
Each message contains:
123+
124+
- `msg.payload`: The workflow details from the API
125+
- `msg.workflowId`: The ID of the workflow
126+
- `msg._seqera_request`: The request details sent to the API (when error occurs)
127+
- `msg._seqera_error`: Error details (when error occurs)
128+
122129
# License
123130

124131
MIT

0 commit comments

Comments
 (0)