Skip to content

Commit 8004ed0

Browse files
authored
fix variable name datasetList (#84)
1 parent 9f622e3 commit 8004ed0

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Development/v4.x/backend/configuration/jobconfig.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,15 @@ Jobs follow a standard Create-Read-Update-Delete (CRUD) lifecycle:
9797
### Referencing datasets
9898

9999
Many (but not all) jobs relate to datasets. These are specified during job creation in
100-
the `jobParams.datasetsList` array. The array should contain objects with a `pid` string
100+
the `jobParams.datasetList` array. The array should contain objects with a `pid` string
101101
and a `files` array listing individual files that the job should be applied to. An empty
102102
`files` array indicates that the job should apply to all files.
103103

104104
```json
105105
{
106106
"type": ...,
107107
"jobParams": {
108-
"datasetsList": [
108+
"datasetList": [
109109
{
110110
"pid": "12.3456...",
111111
"files": []
@@ -145,7 +145,7 @@ are given as examples for archive and retrieve jobs:
145145
| finishedUnsuccessful | A system error occurred |
146146

147147
Additional status changes may be associated with datasets referenced in
148-
`jobParams.datasetsList`, for example in the `datasetlifecycle.archiveStatusMessage`
148+
`jobParams.datasetList`, for example in the `datasetlifecycle.archiveStatusMessage`
149149
field.
150150

151151
It is recommended that values of `statusCode` be configured for each job type using a
@@ -249,7 +249,7 @@ top-level variables are availabe in the handlebars context:
249249
| ------------------ | ------------------------------------ | ---------------------------------------------- | ----------------------------------------------------------------------- |
250250
| `request` | `CreateJobDto` or<br/>`UpdateJobDto` | `{{{request.type}}}`<br/>`{{{request.jobParams}}}` | HTTP Request body |
251251
| `job` | `JobClass` | `{{{job.id}}}` | The job. During the validate phase this is the previous job values (if any); during the perform phase it will be the current database value. |
252-
| `datasets` | `DatasetClass[]` | `{{#each datasets}}{{{pid}}}{{/each}}` | Array of all datasets referenced in `job.jobParams.datasetsList`. |
252+
| `datasets` | `DatasetClass[]` | `{{#each datasets}}{{{pid}}}{{/each}}` | Array of all datasets referenced in `job.jobParams.datasetList`. |
253253
| `env` | `object` | `{{{env.SECRET_TOKEN}}}` | Access environmental variables |
254254
{% endraw %}
255255

0 commit comments

Comments
 (0)