Skip to content

Commit a1d8d01

Browse files
Enhance OpenAPI schema for MCP integrations
- Added support for secret mappings in MCP integration requests and responses, allowing dynamic resolution of secrets from secret references. - Introduced a new value_format field to specify the format of secret values (string or json) for better handling of structured objects.
1 parent 37bdd21 commit a1d8d01

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

openapi.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32678,6 +32678,7 @@ components:
3267832678
The field on the entity to populate from the secret reference. Must be unique within the array.
3267932679
- **Integrations**: `key` or `configurations.<field>` (e.g. `configurations.aws_secret_access_key`)
3268032680
- **Virtual Keys**: `key` or `model_config.<field>` (e.g. `model_config.awsSecretAccessKey`)
32681+
- **MCP Integrations**: `configurations.<field>` (e.g. `configurations.oauth_metadata`)
3268132682
example: "key"
3268232683
secret_reference_id:
3268332684
type: string
@@ -32687,6 +32688,17 @@ components:
3268732688
type: string
3268832689
nullable: true
3268932690
description: Override the secret_key defined on the secret reference. Use to pick a specific key from a multi-value secret.
32691+
value_format:
32692+
type: string
32693+
nullable: true
32694+
enum:
32695+
- json
32696+
- string
32697+
description: |
32698+
Format of the secret value.
32699+
- `string`: The secret value is treated as a plain string.
32700+
- `json`: The secret value is parsed as JSON before being applied to the target field. Use this when the target field expects a structured object (e.g. `configurations.oauth_metadata`).
32701+
example: "json"
3269032702

3269132703
CreateSecretReferenceRequest:
3269232704
type: object
@@ -36977,6 +36989,11 @@ components:
3697736989
enum:
3697836990
- http
3697936991
- sse
36992+
secret_mappings:
36993+
type: array
36994+
items:
36995+
$ref: '#/components/schemas/SecretMapping'
36996+
description: Dynamically resolve secrets from secret references at runtime. Valid target_field values are "configurations.<field>" (e.g. "configurations.oauth_metadata"). Each target_field must be unique.
3698036997

3698136998
McpIntegrationCreateResponse:
3698236999
type: object
@@ -37041,6 +37058,11 @@ components:
3704137058
enum:
3704237059
- workspace
3704337060
- organisation
37061+
secret_mappings:
37062+
type: array
37063+
items:
37064+
$ref: '#/components/schemas/SecretMapping'
37065+
description: Secret reference mappings for this MCP integration. Valid target_field values are "configurations.<field>".
3704437066

3704537067
McpIntegrationListItem:
3704637068
type: object
@@ -37093,6 +37115,11 @@ components:
3709337115
workspaces_count:
3709437116
type: number
3709537117
nullable: true
37118+
secret_mappings:
37119+
type: array
37120+
items:
37121+
$ref: '#/components/schemas/SecretMapping'
37122+
description: Secret reference mappings for this MCP integration. Valid target_field values are "configurations.<field>".
3709637123

3709737124
McpIntegrationListResponse:
3709837125
type: object
@@ -37152,6 +37179,11 @@ components:
3715237179
enum:
3715337180
- http
3715437181
- sse
37182+
secret_mappings:
37183+
type: array
37184+
items:
37185+
$ref: '#/components/schemas/SecretMapping'
37186+
description: Dynamically resolve secrets from secret references at runtime. Valid target_field values are "configurations.<field>" (e.g. "configurations.oauth_metadata"). Each target_field must be unique.
3715537187

3715637188
McpIntegrationWorkspaceItem:
3715737189
type: object

0 commit comments

Comments
 (0)