Skip to content

Commit c4bc1f5

Browse files
committed
Pre-commit on readme
1 parent 47ad874 commit c4bc1f5

1 file changed

Lines changed: 57 additions & 69 deletions

File tree

README.md

Lines changed: 57 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -96,33 +96,31 @@ Launch a new workflow (pipeline run) on Seqera Platform.
9696

9797
### Inputs
9898

99-
* **launchpadName**: Name of a Launchpad entry. If supplied the node will look up the pipeline, fetch its default launch configuration and submit the run.
100-
* **params**: Key/value pairs to merge into `paramsText`. By default these are read from `msg.params` but this property can be changed in the node.
101-
* **body**: A fully-formed request body placed on `msg.body` or `msg.payload`. If present it is sent as-is and the `launchpadName` lookup is skipped.
102-
* **workspaceId**: Override the workspace ID from the Config node.
103-
* **sourceWorkspaceId**: Workspace that owns the source pipeline when launching a shared workflow.
104-
* **baseUrl**: Override the Seqera API URL.
99+
- **launchpadName**: Name of a Launchpad entry. If supplied the node will look up the pipeline, fetch its default launch configuration and submit the run.
100+
- **params**: Key/value pairs to merge into `paramsText`. By default these are read from `msg.params` but this property can be changed in the node.
101+
- **body**: A fully-formed request body placed on `msg.body` or `msg.payload`. If present it is sent as-is and the `launchpadName` lookup is skipped.
102+
- **workspaceId**: Override the workspace ID from the Config node.
103+
- **sourceWorkspaceId**: Workspace that owns the source pipeline when launching a shared workflow.
104+
- **baseUrl**: Override the Seqera API URL.
105105

106106
### Outputs (one)
107107

108-
* `msg.payload` – Raw API response.
109-
* `msg.workflowId` – Convenience copy of the submitted workflow ID.
110-
111-
108+
- `msg.payload` – Raw API response.
109+
- `msg.workflowId` – Convenience copy of the submitted workflow ID.
112110

113111
## Monitor a workflow
114112

115113
Poll the status of an existing workflow run until it reaches a terminal state.
116114

117115
### Inputs
118116

119-
* **workflowId** (required, default: `msg.workflowId`): ID of the workflow to monitor.
120-
* **workspaceId**: Override the workspace ID from the Config node.
117+
- **workflowId** (required, default: `msg.workflowId`): ID of the workflow to monitor.
118+
- **workspaceId**: Override the workspace ID from the Config node.
121119

122120
### Configuration
123121

124-
* **keepPolling** (default **true**): Continue polling until the workflow is finished.
125-
* **pollInterval** (default **5 seconds**): Frequency of status checks.
122+
- **keepPolling** (default **true**): Continue polling until the workflow is finished.
123+
- **pollInterval** (default **5 seconds**): Frequency of status checks.
126124

127125
### Outputs (three)
128126

@@ -132,54 +130,48 @@ Poll the status of an existing workflow run until it reaches a terminal state.
132130

133131
Each message contains:
134132

135-
* `msg.payload` – Full workflow object from the API.
136-
* `msg.workflowId` – Convenience copy of the workflow ID.
137-
138-
133+
- `msg.payload` – Full workflow object from the API.
134+
- `msg.workflowId` – Convenience copy of the workflow ID.
139135

140136
## Create Dataset
141137

142138
Create a new Dataset and upload its tabular contents in one step.
143139

144140
### Inputs
145141

146-
* **datasetName** (required): Name of the Dataset to create.
147-
* **fileContents** (required, default `msg.payload`): CSV/TSV content to upload.
148-
* **fileType** (default **csv**): Either `csv` or `tsv`. Determines the MIME type and file extension.
149-
* **description**: Dataset description.
150-
* **workspaceId**: Override the workspace ID from the Config node.
151-
* **baseUrl**: Override the Seqera API URL.
142+
- **datasetName** (required): Name of the Dataset to create.
143+
- **fileContents** (required, default `msg.payload`): CSV/TSV content to upload.
144+
- **fileType** (default **csv**): Either `csv` or `tsv`. Determines the MIME type and file extension.
145+
- **description**: Dataset description.
146+
- **workspaceId**: Override the workspace ID from the Config node.
147+
- **baseUrl**: Override the Seqera API URL.
152148

153149
### Outputs (one)
154150

155-
* `msg.payload` – API response from the upload request.
156-
* `msg.datasetId` – ID of the newly-created Dataset.
157-
158-
151+
- `msg.payload` – API response from the upload request.
152+
- `msg.datasetId` – ID of the newly-created Dataset.
159153

160154
## List Files from Data Explorer
161155

162156
Retrieve objects from a Seqera **Data Explorer** link (Data Link).
163157

164158
### Inputs
165159

166-
* **dataLinkName** (required): Display name of the Data Link.
167-
* **basePath**: Path within the Data Link to start from.
168-
* **prefix**: Prefix filter applied to both files and folders.
169-
* **pattern**: Regular-expression filter applied to files *after* the prefix filter.
170-
* **returnType** (default **files**): `files`, `folders` or `all`.
171-
* **maxResults** (default **100**): Maximum number of objects to return.
172-
* **depth** (default **0**): Folder recursion depth (`0` = current dir only).
173-
* **workspaceId**: Override the workspace ID from the Config node.
174-
* **baseUrl**: Override the Seqera API URL.
160+
- **dataLinkName** (required): Display name of the Data Link.
161+
- **basePath**: Path within the Data Link to start from.
162+
- **prefix**: Prefix filter applied to both files and folders.
163+
- **pattern**: Regular-expression filter applied to files _after_ the prefix filter.
164+
- **returnType** (default **files**): `files`, `folders` or `all`.
165+
- **maxResults** (default **100**): Maximum number of objects to return.
166+
- **depth** (default **0**): Folder recursion depth (`0` = current dir only).
167+
- **workspaceId**: Override the workspace ID from the Config node.
168+
- **baseUrl**: Override the Seqera API URL.
175169

176170
### Outputs (one)
177171

178-
* `msg.payload.files` – Array of objects returned by the API (after filtering).
179-
* `msg.payload.resourceType`, `msg.payload.resourceRef`, `msg.payload.provider` – Metadata describing the Data Link.
180-
* `msg.files` – Convenience array containing fully-qualified object names.
181-
182-
172+
- `msg.payload.files` – Array of objects returned by the API (after filtering).
173+
- `msg.payload.resourceType`, `msg.payload.resourceRef`, `msg.payload.provider` – Metadata describing the Data Link.
174+
- `msg.files` – Convenience array containing fully-qualified object names.
183175

184176
## Poll Data Link Files
185177

@@ -189,50 +181,46 @@ Periodically list a Data Link and emit messages when new objects appear. The nod
189181

190182
All of the inputs from _List Files from Data Explorer_ node, plus:
191183

192-
* **pollFrequency** (default **15 min**): Interval between polls expressed as seconds (`90`), `MM:SS`, `HH:MM:SS` or `DD-HH:MM:SS`.
184+
- **pollFrequency** (default **15 min**): Interval between polls expressed as seconds (`90`), `MM:SS`, `HH:MM:SS` or `DD-HH:MM:SS`.
193185

194186
### Outputs (two)
195187

196188
1. **All results** – Emitted every poll with the full, filtered list.
197-
2. **New results** – Emitted only when one or more *new* objects are detected since the last poll.
189+
2. **New results** – Emitted only when one or more _new_ objects are detected since the last poll.
198190

199191
Both messages include the same properties:
200192

201-
* `msg.payload.files`, `msg.payload.resourceType`, `msg.payload.resourceRef`, `msg.payload.provider`.
202-
* `msg.files` – Convenience array of fully-qualified object names.
203-
* `msg.payload.nextPoll` (only on the *All results* output) – ISO timestamp of the next scheduled poll.
204-
205-
193+
- `msg.payload.files`, `msg.payload.resourceType`, `msg.payload.resourceRef`, `msg.payload.provider`.
194+
- `msg.files` – Convenience array of fully-qualified object names.
195+
- `msg.payload.nextPoll` (only on the _All results_ output) – ISO timestamp of the next scheduled poll.
206196

207197
## Create Studio
208198

209199
Create a new **Studio** (interactive workspace) on Seqera Platform.
210200

211201
### Inputs
212202

213-
* **studioName** (required): Studio display name.
214-
* **containerUri** (required): Container image URI for the Studio tool.
215-
* **computeEnvId** (required): ID of the Compute Environment to run on.
216-
* **description**: Text description for the Studio.
217-
* **mountData**: One or more Data Link names to mount inside the Studio.
218-
* **cpu** (default **2**)
219-
* **memory** (default **8192**)
220-
* **gpu** (default **0**)
221-
* **initialCheckpointId**
222-
* **condaEnvironment**
223-
* **lifespanHours**: Maximum lifetime before auto-stop.
224-
* **isPrivate** (default **false**)
225-
* **spot** (default **false**)
226-
* **autoStart** (default **true**)
227-
* **workspaceId**: Override the workspace ID from the Config node.
228-
* **baseUrl**: Override the Seqera API URL.
203+
- **studioName** (required): Studio display name.
204+
- **containerUri** (required): Container image URI for the Studio tool.
205+
- **computeEnvId** (required): ID of the Compute Environment to run on.
206+
- **description**: Text description for the Studio.
207+
- **mountData**: One or more Data Link names to mount inside the Studio.
208+
- **cpu** (default **2**)
209+
- **memory** (default **8192**)
210+
- **gpu** (default **0**)
211+
- **initialCheckpointId**
212+
- **condaEnvironment**
213+
- **lifespanHours**: Maximum lifetime before auto-stop.
214+
- **isPrivate** (default **false**)
215+
- **spot** (default **false**)
216+
- **autoStart** (default **true**)
217+
- **workspaceId**: Override the workspace ID from the Config node.
218+
- **baseUrl**: Override the Seqera API URL.
229219

230220
### Outputs (one)
231221

232-
* `msg.payload` – Full API response.
233-
* `msg.studioId` – ID of the created Studio.
234-
235-
222+
- `msg.payload` – Full API response.
223+
- `msg.studioId` – ID of the created Studio.
236224

237225
# License
238226

0 commit comments

Comments
 (0)