From 17cface7ba70656817ffe18e237a7ce5d8dbd6c2 Mon Sep 17 00:00:00 2001 From: Devin Beeuwkes <46448173+DevinCodes@users.noreply.github.com> Date: Tue, 8 Jul 2025 16:23:21 +0200 Subject: [PATCH 1/2] feat: document runInput parameter --- specs/ingestion/common/schemas/source.yml | 6 ++++++ specs/ingestion/common/schemas/task.yml | 11 +++++++++++ specs/ingestion/paths/tasks/v1/runTask.yml | 6 ++++++ specs/ingestion/paths/tasks/v2/runTask.yml | 6 ++++++ 4 files changed, 29 insertions(+) diff --git a/specs/ingestion/common/schemas/source.yml b/specs/ingestion/common/schemas/source.yml index ab7babb27f2..cbcf2aa3abc 100644 --- a/specs/ingestion/common/schemas/source.yml +++ b/specs/ingestion/common/schemas/source.yml @@ -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 diff --git a/specs/ingestion/common/schemas/task.yml b/specs/ingestion/common/schemas/task.yml index d0b0ad0fe82..b69a7a646a2 100644 --- a/specs/ingestion/common/schemas/task.yml +++ b/specs/ingestion/common/schemas/task.yml @@ -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. diff --git a/specs/ingestion/paths/tasks/v1/runTask.yml b/specs/ingestion/paths/tasks/v1/runTask.yml index 6f6fbc267bc..e428e2f60e2 100644 --- a/specs/ingestion/paths/tasks/v1/runTask.yml +++ b/specs/ingestion/paths/tasks/v1/runTask.yml @@ -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 diff --git a/specs/ingestion/paths/tasks/v2/runTask.yml b/specs/ingestion/paths/tasks/v2/runTask.yml index 83dbd5fc067..0c7bf5cd040 100644 --- a/specs/ingestion/paths/tasks/v2/runTask.yml +++ b/specs/ingestion/paths/tasks/v2/runTask.yml @@ -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 From 81a4192a064041e17a06091a18b7f85febcbe4bd Mon Sep 17 00:00:00 2001 From: Devin Beeuwkes <46448173+DevinCodes@users.noreply.github.com> Date: Wed, 9 Jul 2025 11:03:22 +0200 Subject: [PATCH 2/2] type change --- specs/ingestion/common/schemas/source.yml | 8 +++----- specs/ingestion/common/schemas/task.yml | 8 +++----- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/specs/ingestion/common/schemas/source.yml b/specs/ingestion/common/schemas/source.yml index cbcf2aa3abc..7c2975ba258 100644 --- a/specs/ingestion/common/schemas/source.yml +++ b/specs/ingestion/common/schemas/source.yml @@ -474,11 +474,9 @@ RunSourcePayload: description: List of entityIDs to update. entityType: $ref: '#/EntityType' - runInput: - type: - - type: string - - type: object - - type: array + runMetadata: + type: object + additionalProperties: true description: Additional information that will be passed to the created runs. EntityType: diff --git a/specs/ingestion/common/schemas/task.yml b/specs/ingestion/common/schemas/task.yml index b69a7a646a2..727b9348c8f 100644 --- a/specs/ingestion/common/schemas/task.yml +++ b/specs/ingestion/common/schemas/task.yml @@ -632,9 +632,7 @@ RunTaskPayload: type: object additionalProperties: false properties: - runInput: - type: - - type: string - - type: object - - type: array + runMetadata: + type: object + additionalProperties: true description: Additional information that will be passed to the created run.