feat(api): add engine-specific extra extension field for smoother adoption#23
Merged
Merged
Conversation
tanmayv25
requested review from
alec-flowers,
connorcarpenter15,
dagil-nvidia,
nv-anants,
nvda-mesharma and
saturley-hall
as code owners
July 16, 2026 19:16
tanmayv25
commented
Jul 16, 2026
connorcarpenter15
previously approved these changes
Jul 16, 2026
Address PR ai-dynamo#23 review: the gap at field 2 was a leftover from a removed field during development, not a retired tag. Renumber bypass_prefix_cache (3->2) and cache_salt (4->3) and drop the reserved statement. Safe while pre-adoption at schema revision 1. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Summary
Adds a capability-optional, engine-specific extension field (
google.protobuf.Struct extra) to the request and discovery surfaces, plus one field-number hygiene fix. All changes are purely additive — verified wire-compatible againstmain.The goal is to lower adoption friction: an engine can expose OpenEngine (and surface a native knob or native discovery metadata) without waiting for the spec to grow a typed field for it.
extrais explicitly outside the portable contract — an engine may ignore keys it doesn't recognize, every request stays valid with it empty, and clients never depend on it for correctness. Parameters that prove broadly useful get promoted to typed fields in a later revision.Changes
GenerateRequestextra = 12TaskRequestContextextra = 4ServerInfoextra = 12ModelInfoextra = 28KvOptionsreserved 2;docs/api.mdupdated to match, with a prose note documenting theextrapolicy.Why these four locations
They are the surfaces where heterogeneous engines diverge — two request roots and two discovery responses. The other open-ended surfaces already have an escape hatch (
EngineError.details,KvSessionRef.attributes_structasStruct;LoadInfo/RuntimeEventviaattributesmaps), so no new field was added there. Per-request sub-messages (SamplingParams,*Options) and per-output messages were intentionally left typed to avoid a stringly-typed sprawl.Compatibility & verification
protoccompile: OKbuf lint(STANDARD): PASSbuf breakingvsmain: PASS — no wire-incompatible changes🤖 Generated with Claude Code