Skip to content

Commit 44be731

Browse files
committed
feat: document runInput parameter
1 parent a2b3117 commit 44be731

File tree

4 files changed

+29
-0
lines changed

4 files changed

+29
-0
lines changed

specs/ingestion/common/schemas/source.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -474,6 +474,12 @@ RunSourcePayload:
474474
description: List of entityIDs to update.
475475
entityType:
476476
$ref: '#/EntityType'
477+
runInput:
478+
type:
479+
- type: string
480+
- type: object
481+
- type: array
482+
description: Additional information that will be passed to the created runs.
477483

478484
EntityType:
479485
type: string

specs/ingestion/common/schemas/task.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -627,3 +627,14 @@ PushTaskPayload:
627627
required:
628628
- action
629629
- records
630+
631+
RunTaskPayload:
632+
type: object
633+
additionalProperties: false
634+
properties:
635+
runInput:
636+
type:
637+
- type: string
638+
- type: object
639+
- type: array
640+
description: Additional information that will be passed to the created run.

specs/ingestion/paths/tasks/v1/runTask.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ post:
1111
- editSettings
1212
parameters:
1313
- $ref: '../../../common/parameters.yml#/pathTaskID'
14+
requestBody:
15+
description: ''
16+
content:
17+
application/json:
18+
schema:
19+
$ref: '../../../common/schemas/task.yml#/RunTaskPayload'
1420
responses:
1521
'200':
1622
description: OK

specs/ingestion/paths/tasks/v2/runTask.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ post:
1010
- editSettings
1111
parameters:
1212
- $ref: '../../../common/parameters.yml#/pathTaskID'
13+
requestBody:
14+
description: ''
15+
content:
16+
application/json:
17+
schema:
18+
$ref: '../../../common/schemas/task.yml#/RunTaskPayload'
1319
responses:
1420
'200':
1521
description: OK

0 commit comments

Comments
 (0)