Skip to content

feat(specs): document runMetadata parameter #5087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 9, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions specs/ingestion/common/schemas/source.yml
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,12 @@ RunSourcePayload:
description: List of entityIDs to update.
entityType:
$ref: '#/EntityType'
runInput:
type:
- type: string
- type: object
- type: array
description: Additional information that will be passed to the created runs.

EntityType:
type: string
Expand Down
11 changes: 11 additions & 0 deletions specs/ingestion/common/schemas/task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -627,3 +627,14 @@ PushTaskPayload:
required:
- action
- records

RunTaskPayload:
type: object
additionalProperties: false
properties:
runInput:
type:
- type: string
- type: object
- type: array
description: Additional information that will be passed to the created run.
6 changes: 6 additions & 0 deletions specs/ingestion/paths/tasks/v1/runTask.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ post:
- editSettings
parameters:
- $ref: '../../../common/parameters.yml#/pathTaskID'
requestBody:
description: ''
content:
application/json:
schema:
$ref: '../../../common/schemas/task.yml#/RunTaskPayload'
responses:
'200':
description: OK
Expand Down
6 changes: 6 additions & 0 deletions specs/ingestion/paths/tasks/v2/runTask.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ post:
- editSettings
parameters:
- $ref: '../../../common/parameters.yml#/pathTaskID'
requestBody:
description: ''
content:
application/json:
schema:
$ref: '../../../common/schemas/task.yml#/RunTaskPayload'
responses:
'200':
description: OK
Expand Down
Loading