Skip to content

Fix dsl-reference.md / schema/workflow.yaml mismatches (evaluate, certificate auth, MCP client version) #1157

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.

Sign up for GitHub

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

Closed
dimastbk wants to merge 1 commit into from
Closed

Fix dsl-reference.md / schema/workflow.yaml mismatches (evaluate, certificate auth, MCP client version) #1157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 2 additions & 7 deletions dsl-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@
+ [Authentication](#authentication)
- [Basic](#basic-authentication)
- [Bearer](#bearer-authentication)
- [Certificate](#certificate-authentication)
- [Digest](#digest-authentication)
- [OAUTH2](#oauth2-authentication)
- [OpenIdConnect](#openidconnect-authentication)
Expand Down Expand Up @@ -156,8 +155,8 @@ Configures a workflow's runtime expression evaluation.

| Name | Type | Required | Description|
|:--|:---:|:---:|:---|
| language | `string` | `yes` | The language used for writting runtime expressions.<br>*Defaults to `jq`.* |
| mode | `string` | `yes` | The runtime expression evaluation mode.<br>*Supported values are:*<br>- `strict`: requires all expressions to be enclosed within `${ }` for proper identification and evaluation.<br>- `loose`: evaluates any value provided. If the evaluation fails, it results in a string with the expression as its content.<br>*Defaults to `strict`.*
| language | `string` | `no` | The language used for writting runtime expressions.<br>*Defaults to `jq`.* |
| mode | `string` | `no` | The runtime expression evaluation mode.<br>*Supported values are:*<br>- `strict`: requires all expressions to be enclosed within `${ }` for proper identification and evaluation.<br>- `loose`: evaluates any value provided. If the evaluation fails, it results in a string with the expression as its content.<br>*Defaults to `strict`.*

#### Examples

Expand Down Expand Up @@ -1708,7 +1707,6 @@ Defines the mechanism used to authenticate users and workflows attempting to acc
| use | `string` | `no` | The name of the top-level authentication definition to use. Cannot be used by authentication definitions defined at top level. |
| basic | [`basicAuthentication`](#basic-authentication) | `no` | The `basic` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| bearer | [`bearerAuthentication`](#bearer-authentication) | `no` | The `bearer` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| certificate | [`certificateAuthentication`](#certificate-authentication) | `no` | The `certificate` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| digest | [`digestAuthentication`](#digest-authentication) | `no` | The `digest` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| oauth2 | [`oauth2`](#oauth2-authentication) | `no` | The `oauth2` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| oidc | [`oidc`](#openidconnect-authentication) | `no` | The `oidc` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
Expand Down Expand Up @@ -1805,9 +1803,6 @@ do:
token: ${ .user.token }
```

#### Certificate Authentication


#### Digest Authentication

Defines the fundamentals of a 'digest' authentication.
Expand Down
19 changes: 18 additions & 1 deletion schema/workflow.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,23 @@ properties:
$ref: '#/$defs/eventConsumptionStrategy'
title: ScheduleOn
description: Specifies the events that trigger the workflow execution.
evaluate:
type: object
title: Evaluate
description: Configures the workflow's runtime expression evaluation.
unevaluatedProperties: false
properties:
language:
type: string
default: jq
title: EvaluateLanguage
description: The language used for writing runtime expressions. Defaults to 'jq'.
mode:
type: string
enum: [ strict, loose ]
default: strict
title: EvaluateMode
description: The runtime expression evaluation mode. Defaults to 'strict'.
$defs:
taskList:
title: TaskList
Expand Down Expand Up @@ -569,7 +586,7 @@ $defs:
type: string
title: McpClientName
description: The name of the client used to connect to the MCP server.
description:
version:
type: string
title: McpClientVersion
description: The version of the client used to connect to the MCP server.
Expand Down
Loading