Repository navigation
[Schema Consistency] 🔍 Schema Consistency Check - 2026-10-28 #72587
Closed
Replies: 1 comment
|
This discussion has been marked as outdated by Schema Consistency Checker. A newer discussion is available at Discussion #72873. |
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.
Overview
Found 3 actionable documentation inconsistencies across schema, parser/compiler, documentation, and workflow analysis at commit
e75f0a24487015b1c384f64498c05266559f39ed. No source files were changed.Key Issues
Security-related documentation gap:
tools.github.refusal-labelsis advertised but unsupported by the local authoring contract.docs/src/content/docs/reference/mcp-gateway.md:1617describes label-based integrity demotion and gives examples at lines 1625 and 1636. The GitHub tool schema lists other guard fields aroundpkg/parser/schemas/main_workflow_schema.json:5131–5185, but contains norefusal-labels; neither doespkg/workflowcontain that field. Guard parsing inpkg/workflow/tools_parser.go:306and typed configuration inpkg/workflow/tools_types.go:435implement trusted users and approval labels instead. A minimal example withmin-integrity: approvedplusrefusal-labels: [review]fails schema validation; substitutingapproval-labelspasses. Impact: Users cannot compile the documented configuration and may expect an unavailable exclusion control. Fix: Mark the feature as unavailable in current frontmatter docs, or implement and validate the schema/parser/serialization contract together before advertising support. This finding makes no claim about external gateway capabilities.FAQ MCP example puts server configuration under an unsupported key.
docs/src/content/docs/reference/faq.md:227showstools.mcp-servers.my-server.imagewith a nested network allowlist. The schema rejectstools.mcp-serversas an additional property. The compiler extracts the separate frontmatter MCP server map atpkg/workflow/compiler_orchestrator_tools.go:231, and the typed field is defined atpkg/workflow/frontmatter_types.go:382. Existing shared usage at.github/workflows/shared/mcp/ast-grep.md:2also uses rootmcp-servers. Fix: Rewrite the example using rootmcp-servers, the supportedcontainerproperty, and explicitallowedtools; show network configuration at its supported location separately. A rootmcp-serversexample withcontainerandallowed: ["*"]passes local validation. Merely moving the FAQ block without correcting its server properties is insufficient.Rate-limiting example places
stop-afterat the workflow root instead of underon.docs/src/content/docs/reference/rate-limiting-controls.md:46–52advertises rootstop-after: +48h. That exact shape fails validation with an unexpected-property error. The schema defines the field under trigger properties atpkg/parser/schemas/main_workflow_schema.json:2282; the implementation explicitly records extraction fromon.stop-afteratpkg/workflow/frontmatter_types.go:394. Fix: Showon: {workflow_dispatch: {}, stop-after: +48h}or an equivalent multiline mapping preserving the intended trigger. The corrected mapping passes validation.Validation scope, false positives, and limitations
Evidence and Method
Started from the supplied precomputed schema diff rather than repeating field enumeration. Both reported top-level type gaps are false positives:
docker-image-pull-policyis read fromRawFrontmatterinpkg/workflow/docker.go:294;work-queue-policyis processed bypkg/workflow/work_queue_policy.goand repository conflict/deprecation logic inpkg/workflow/work_queue_repo_config.go. No corrective change is recommended for these gaps.Validated reference-document YAML snippets with the local Draft7 schema and YAML loading that preserves the
onkey. Removed non-frontmatter examples, incomplete fragments, and previously cached findings from report candidates. Reduced each reported mismatch to an inert data example and checked a passing control. No workflow code was executed.Checked all 349 parsable top-level workflow frontmatters for errors other than root required-field errors; none were observed. Required-field errors were excluded to avoid classifying redirects and import-oriented documents as standalone workflows. Shared-component coverage was targeted, including the root MCP configuration example above; full import expansion and whole-repository compilation were not performed. Thus no workflow violation is claimed, and required-field consistency is not certified.
AWF Canonical-Source Warning — Non-authoritative
The supplied
awf-config-drift.jsonhasdegraded: true: canonical-source retrieval failed fordocs/awf-config-spec.md,docs/awf-config.schema.json, andsrc/awf-config-schema.json. AWF config-source drift could not be established. No required-check failure, corrective pull request, or drift issue is recommended from that incomplete comparison.Strategy Performance
strategies.jsonwith this run and its findings.Recommendations and Next Steps
References: §40637878127
All reactions