Skip to content

Commit 87ce9ad

Browse files
committed
adding ability to pass in tokens for accessing inputs
1 parent 4f8367e commit 87ce9ad

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

openapi/workflow_execution_service.openapi.yaml

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1291,10 +1291,27 @@ components:
12911291
specification (2.0.0)
12921292
outputs:
12931293
type: object
1294-
description: The outputs from the workflow run (legacy format)
1294+
description: >-
1295+
The outputs from the workflow run (legacy format).
1296+
For outputs that require authentication to access (such as restricted files or directories),
1297+
use the 'output_credentials' section of this response to obtain the necessary authentication
1298+
credentials. The mapping between specific output files and credentials is implementation-specific
1299+
for this legacy format - use 'structured_outputs' for explicit credential references.
12951300
structured_outputs:
12961301
$ref: '#/components/schemas/WorkflowOutputs'
12971302
description: Structured workflow outputs with rich metadata and type safety
1303+
output_credentials:
1304+
type: object
1305+
description: >-
1306+
Named credentials required to access workflow output files and directories.
1307+
Each credential is identified by a unique key and can be referenced by multiple
1308+
outputs via their 'credential_id' field. These credentials allow clients to
1309+
authenticate and authorize access to restricted output resources.
1310+
additionalProperties:
1311+
oneOf:
1312+
- $ref: '#/components/schemas/PassportCredential'
1313+
- $ref: '#/components/schemas/BearerTokenCredential'
1314+
- $ref: '#/components/schemas/ApiKeyCredential'
12981315
Log:
12991316
title: Log
13001317
type: object
@@ -1544,6 +1561,9 @@ components:
15441561
contents:
15451562
type: string
15461563
description: File contents for small files (≤64 KiB)
1564+
credential_id:
1565+
type: string
1566+
description: Reference to a credential ID defined in the 'output_credentials' section of the RunLog response. This credential is required to authenticate and authorize access to this File or Directory output resource.
15471567
required:
15481568
- class
15491569
- value

0 commit comments

Comments
 (0)