[Schema Consistency] 🔍 Schema Consistency Check - 2026-07-08 #44217
Closed
Replies: 1 comment
-
|
This discussion was automatically closed because it expired on 2026-07-09T06:18:50.579Z.
|
Beta Was this translation helpful? Give feedback.
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
safe-outputs.dispatch-repositorynested keys are documented/schema-exposed in snake_case, while adjacent safe-output surfaces are kebab-case-heavyevent_typeandallowed_repositoriesunderdispatch-repositoryinpkg/parser/schemas/main_workflow_schema.json:9450-9467.pkg/workflow/dispatch_repository.go:73-88.dispatch-repositoryand with nearby safe-output fields likeallowed-repos, which makes authoring error-prone.event-type/allowed-reposand fail validation/runtime despite surrounding docs favoring kebab-case.frontmatter-fullunder-documentsdispatch-repositorydispatch-repository: {}atdocs/src/content/docs/reference/frontmatter-full.md:7494-7499; it does not expand the nested object shape there.workflow,event_type, optionallyrepository,allowed_repositories,inputs,max, etc.).engine.driverschema/docs are narrower than the implementation and specialized docsengine.driveris for engines “(e.g. pi)” and only allows workspace-relative path syntax matching filenames/bare basenames, with description limited to.js/.cjs/.mjs(main_workflow_schema.json:12415-12420).frontmatter-fullrepeats the same Pi-oriented, JS-only description atdocs/src/content/docs/reference/frontmatter-full.md:2323-2329..js,.cjs,.mjs,.py,.ts,.mts,.rb, or a bare command name (pkg/workflow/engine.go:61, parsing atpkg/workflow/engine.go:437-441).docs/src/content/docs/reference/engines.md:345-365,399also documents Copilot SDK driver usage and TS examples.Runtime/workflows support
antigravity, but engine reference docs still omit itpkg/workflow/antigravity_engine.go,pkg/workflow/data/engines/antigravity.md).engine: id: antigravityin.github/workflows/smoke-antigravity.md:1-34.docs/src/content/docs/reference/engines.mdsections inspected around the engine catalog/driver guidance do not mentionantigravity.pkg/workflow/engine_definition.gostill says built-ins are onlyclaude, codex, copilot, gemini, opencode, crushin both top comments andNewEngineCatalogcomment, omittingpiandantigravity.Documentation Gaps
dispatch-repositoryinfrontmatter-full.mdwith its nested fields and examples, not just{}.antigravitytodocs/reference/engines.mdsupported-engine listings/examples.Schema Improvements Needed
dispatch-repositorynested naming: either add kebab-case aliases (event-type,allowed-repos) or clearly document snake_case as intentional.engine.driverschema description/pattern/examples so they match Copilot SDK support and non-JS drivers.antigravity.Parser Updates Required
pkg/workflow/dispatch_repository.goshould accept aliases forevent-type/allowed-repos.pkg/workflow/engine_definition.goto match the actual catalog.Workflow Violations
dispatch-repositoryusage was found in checked workflow files..github/workflows/smoke-antigravity.mddemonstrates thatantigravityis a real supported engine, which increases the severity of the docs drift.Recommendations
dispatch-repositorynaming internally consistent: canonical kebab-case or fully documented snake_case, but not a mixed surface.dispatch-repositoryshows the real object schema and example.engine.driverschema text and validation with the runtime’s Copilot SDK driver support.antigravity(andpiwhere omitted).Strategy Performance
Next Steps
dispatch-repositorynaming/docs driftengine.driverschema/docsantigravityandpiReferences:
Beta Was this translation helpful? Give feedback.
All reactions