Fix dsl-reference.md / schema/workflow.yaml mismatches (evaluate, certificate auth, MCP client version)#1157
Closed
dimastbk wants to merge 1 commit into
Closed
Conversation
dimastbk
force-pushed
the
fix/dsl-reference-schema-mismatches
branch
from
73283fd to
fe33381
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns the DSL reference documentation with the authoritative workflow JSON Schema by resolving the key divergences reported in #1156 (adding evaluate to the schema, removing undocumented certificate auth from docs, and fixing the MCP client version field in the schema).
Changes:
- Added
evaluate(language,mode) toschema/workflow.yamlwith defaults and strict property enforcement. - Corrected the MCP client schema to define
version(instead of a mis-keyeddescription) while keepingrequired: [ name, version ]meaningful. - Removed certificate authentication from
dsl-reference.mdand updated the Evaluate table required flags to reflect optional-by-default fields.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| schema/workflow.yaml | Adds evaluate to the root schema and fixes MCP client version property definition to match required fields. |
| dsl-reference.md | Removes certificate auth documentation and updates Evaluate required flags 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`.* | |
| | 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`.* |
Resolves the substantive divergences reported in #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
fe33381 to
739d247
Compare
Member
|
@dimastbk why did you close this PR? It seems reasonable to me. |
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.
What
Fixes the three substantive divergences between
dsl-reference.mdandschema/workflow.yamlreported in #1156.evaluateworkflow property documented but missing from the schemaevaluate(language,mode) toschema/workflow.yamldsl.mdreferencesevaluate.languageand documents thestrict/loosemodesdsl-reference.md(TOC, auth properties-table row, empty section)dsl.mdmention, noexamples/, noctk/; the doc section was emptyversionrequired but never defined (schema bug)description→versionrequired: [ name, version ]but defined noversionproperty — it was mis-keyed asdescription(its title was alreadyMcpClientVersion)Also flips the
Evaluatetable'slanguage/modefromyes→no, since both have defaults and are therefore optional — matching the schema (this is item #6 from the issue, an internal contradiction in the same table).Scope
This addresses the High-priority items (#1, #2, #3) plus the closely-related #6 from #1156. The remaining medium/minor items in that issue are left for follow-up, as several are direction-dependent and benefit from maintainer guidance.
schema/workflow.yamlwas validated as parseable YAML after the change.Addresses #1156
🤖 Generated with Claude Code