[Schema Consistency] 🔍 Schema Consistency Check - 2026-07-25 #47930
Closed
Replies: 1 comment
|
This discussion has been marked as outdated by Schema Consistency Checker. A newer discussion is available at Discussion #48137. |
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.
Summary
Critical Issues
engine.idbuilt-in engine list is stale in the schema/docs while runtime and workflows supportantigravity.antigravityas built-in inpkg/workflow/engine_definition.go:18andpkg/workflow/engine_definition.go:285..github/workflows/smoke-antigravity.md:37.engine.idascodex,claude,copilot,gemini,opencode,pionly inpkg/parser/schemas/main_workflow_schema.json:12532-12533.docs/src/content/docs/reference/engines.mdalso omitsantigravityfrom the available engines table.Schema is looser than the parser/runtime for
engine.id.pkg/parser/schemas/main_workflow_schema.json:12530-12533leavesengine.idas an unconstrained string, even though the runtime resolves against a fixed built-in catalog and rejects unknown engines.Documentation Gaps
frontmatter-full.mdstill surfaces deprecatedsafe-outputs.dispatch_repository.pkg/workflow/dispatch_repository.go:36-41.dispatch_repositoryas deprecated alias inpkg/parser/schemas/main_workflow_schema.json:9637-9639.docs/src/content/docs/reference/frontmatter-full.md:8464-8468still documents the deprecated alias as a normal config block instead of minimizing it as migration-only guidance.dispatch-repositorynested key naming remains snake_case-only in a kebab-case surface.frontmatter-full.md:8388+explicitly documents nested keys such asevent_typeandallowed_repositories.pkg/workflow/dispatch_repository.go:10,:29,:112.safe-outputs, increasing user confusion and making configs harder to predict.Schema Improvements Needed
engine.iddescription/examples inpkg/parser/schemas/main_workflow_schema.json:12532-12533to includeantigravity.enum(or generated enum) for known built-inengine.idvalues, or document clearly that arbitrary IDs are allowed only for custom runtimes if that is intentional.dispatch_repositoryin schema only as a deprecated compatibility alias and de-emphasize it in generated docs.Parser Updates Required
dispatch-repository; parser behavior is actually ahead of docs because it warns on deprecated alias usage.engine.idshould remain open-ended, parser/docs/schema should all state that explicitly; otherwise schema should align with runtime validation.Workflow Violations
.github/workflows/smoke-antigravity.md:37is valid against runtime behavior but demonstrates the schema/docs drift aroundantigravity.Recommendations
antigravityeverywhere the built-in engine catalog is enumerated, especially schema descriptions/examples anddocs/src/content/docs/reference/engines.md.engine.idschema validation or document the intentional runtime-vs-schema split.dispatch_repositoryto a short deprecated migration note infrontmatter-full.mdinstead of a full surfaced block.dispatch-repositorynested keys should keep snake_case forever; if yes, call out the exception consistently across docs/reference pages.Strategy Performance
Next Steps
engine.idengine.idenum vs open-ended contractengines.mdengine tablefrontmatter-full.mddispatch-repositorysnake_case nested key exceptionReferences:
All reactions