feat(specs): document runMetadata parameter (#5087)

Author: DevinCodes

specs/ingestion/common/schemas/source.yml

@@ -474,6 +474,10 @@ RunSourcePayload:
       description: List of entityIDs to update.
     entityType:
       $ref: '#/EntityType'
+    runMetadata:
+      type: object
+      additionalProperties: true
+      description: Additional information that will be passed to the created runs.
 
 EntityType:
   type: string

specs/ingestion/common/schemas/task.yml

@@ -627,3 +627,12 @@ PushTaskPayload:
   required:
     - action
     - records
+
+RunTaskPayload:
+  type: object
+  additionalProperties: false
+  properties:
+    runMetadata:
+      type: object
+      additionalProperties: true
+      description: Additional information that will be passed to the created run.

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

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