Fix three dsl-reference.md / schema/workflow.yaml mismatches#1160
Merged
cdavernas merged 1 commit intoJun 29, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns the Serverless Workflow DSL reference documentation with the authoritative JSON Schema by fixing a few concrete mismatches identified in #1156.
Changes:
- Added the top-level
evaluateworkflow property (language,mode) toschema/workflow.yaml. - Removed Certificate authentication from
dsl-reference.md(TOC, auth properties table, and empty section). - Fixed the MCP client schema property name by renaming
description→versionto matchrequired: [ name, version ].
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| schema/workflow.yaml | Adds missing evaluate definition and corrects MCP client version property key. |
| dsl-reference.md | Removes unsupported Certificate auth docs and marks Evaluate fields optional to match schema defaults. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| |:--|:---:|:---:|:---| | ||
| | 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`.* | |
Resolves the substantive divergences reported in serverlessworkflow#1156: - Add the `evaluate` workflow property (`language`, `mode`) to schema/workflow.yaml. It is documented in dsl-reference.md and referenced by dsl.md (`evaluate.language`) but was missing from the schema. - Remove certificate authentication from dsl-reference.md (TOC entry, authentication properties-table row, and the empty section). It is not defined in the schema, dsl.md, examples, or the CTK. - Rename the MCP client schema property `description` -> `version`. The schema declared `required: [ name, version ]` but defined no `version` property (it was mis-keyed as `description`). Also align the Evaluate table in dsl-reference.md: `language` and `mode` are now `no` (both have defaults, so they are optional), matching the schema. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Dmitriy <dimastbk@proton.me>
dimastbk
force-pushed
the
fix/dsl-reference-schema-mismatches
branch
from
739d247 to
00a8198
Compare
ricardozanini
approved these changes
Jun 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves the substantive divergences reported in #1156:
evaluateworkflow property (language,mode) to schema/workflow.yaml. It is documented in dsl-reference.md and referenced by dsl.md (evaluate.language) but was missing from the schema.description->version. The schema declaredrequired: [ name, version ]but defined noversionproperty (it was mis-keyed asdescription).Also align the Evaluate table in dsl-reference.md:
languageandmodeare nowno(both have defaults, so they are optional), matching the schema.