Repository navigation
[Schema Consistency] Schema Consistency Check — 2026-10-21 #70798
Closed
Replies: 1 comment
|
This discussion has been marked as outdated by Schema Consistency Checker. A newer discussion is available at Discussion #71050. |
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
🔍 Schema Consistency Check — 2026-10-21
Three confirmed documentation inconsistencies affect configuration accepted by the schema/compiler. No critical runtime bug was established.
Key Issues
High —
tools.github.refusal-labelspromises an unavailable authoring control.docs/src/content/docs/reference/mcp-gateway.md:1597and:1608show this configuration; the surrounding section promises label-based integrity demotion. An isolated configuration withmin-integrity: approvedandrefusal-labels: [needs-security-review]fails schema validation with an unexpected-property error. The GitHub schema properties nearpkg/parser/schemas/main_workflow_schema.json:5152and compiler fields atpkg/workflow/tools_types.go:425support approval labels but lack refusal labels; no compiler Go reference torefusal-labelswas found. Impact: Authors cannot compile the documented suppression policy. Fix: Mark this as a proposed gateway capability unavailable in workflow frontmatter, or implement and test schema acceptance and end-to-end compiler forwarding together before advertising it. This finding concerns authoring support; gateway runtime enforcement was not tested.Medium — OIDC frontmatter example puts custom MCP servers under the wrong parent.
docs/src/content/docs/reference/mcp-gateway.md:1312showstools.mcp-servers.my-mcp-server. The schema rejectsmcp-serversas an additional property oftools. Supported top-levelmcp-serversis defined atpkg/parser/schemas/main_workflow_schema.json:4898, extracted atpkg/workflow/frontmatter_extraction_metadata.go:343, and merged with tools atpkg/workflow/tools.go:443. Impact: Copying the example fails schema validation before OIDC configuration can be used. Fix: Remove thetoolswrapper and placemcp-serversat the frontmatter root; validate the corrected complete example.Medium — PR review-comment example advertises unsupported
footer.docs/src/content/docs/reference/safe-outputs-pull-requests.md:292includesfooter: if-bodyforcreate-pull-request-review-comment. The isolated option fails schema validation becausefooteris an additional property. The handler schema begins atpkg/parser/schemas/main_workflow_schema.json:9189and closes withadditionalProperties: falsenear:9273.pkg/workflow/create_pr_review_comment.go:10and generated handler configuration atpkg/workflow/safe_outputs_handler_registry_pull_requests.go:190contain no footer setting. Impact: The documented example cannot compile. Fix: Remove this option from the example, or add explicit schema/parser/handler support with behavior tests if footer control is intended.Analysis details, exclusions, and limitations
Started from
/tmp/gh-aw/agent/schema-diff.jsonand cached strategies. Both apparent schema-to-struct gaps were false positives:docker-image-pull-policyis consumed through RawFrontmatter inpkg/workflow/docker.go:294;work-queue-policyis consumed inpkg/workflow/work_queue_policy.go:184. The precomputed diff has no workflow keys missing from the schema.Scanned reference-document YAML examples using a loader that preserves the YAML
onkey and recognizes true/false booleans; confirmed each reported rejection with a minimal inert JSON configuration and traced relevant compiler code. Excluded incomplete examples, other configuration formats, and findings recorded in prior strategy-cache results. No workflow scripts or runtime security controls were executed or probed. Root workflow validation covered.github/workflows/*.md; shared components were not independently certified as complete workflows.Non-authoritative AWF warning:
/tmp/gh-aw/agent/awf-config-drift.jsonreportsdegraded: truebecause canonical spec/schema retrieval failed. AWF drift cannot be concluded from this run. This warning is excluded from the inconsistency count and must not drive a required-check failure, corrective PR, or drift issue.Schema improvements / parser updates: No standalone schema/compiler discrepancy was established by these three findings. If the documented features are intended, acceptance and implementation must change together. Otherwise documentation corrections suffice.
Strategy performance: 3 confirmed findings; high effectiveness; reuse recommended. Updated strategy-2 in the persistent strategy database. Repository source files were unchanged.
Recommendations and Next Steps
References: §39550062313
All reactions