Reference external proto enum types#1286
Open
jwils wants to merge 2 commits into
Open
Conversation
Adds `elasticgraph-protobuf`, a self-contained schema-definition extension that generates Protocol Buffers schema artifacts from an ElasticGraph schema. Running `schema_artifacts:dump` emits: - `schema.proto` — the generated Protobuf schema for the indexed types - `proto_field_numbers.yaml` — a sidecar that reserves field numbers so they stay stable as the schema evolves (including across field renames) Capabilities: - Maps built-in ElasticGraph scalars to proto types, with `proto_field` to configure custom scalars. - Generates messages for object/interface/union types and enums (with a zero-valued `*_UNSPECIFIED` entry), escaping proto reserved words and wrapping nested lists so the output stays valid. - `proto_enum_mappings` reuses enum values already maintained elsewhere. The generator emits `proto3` by default and can emit `proto2` via `syntax: :proto2` (which labels every field `optional`/`repeated`). Arbitrary file-level headers (e.g. `option` declarations) can be injected verbatim via `headers:`, so language-specific options can be set without baking any particular convention into the gem.
Some schemas already have canonical protobuf enum definitions, and generating duplicate enums in `schema.proto` makes consumers deal with parallel types. - Add `proto_external_types` to import and reference existing proto enum types - Validate external enum references against exactly one option-free `proto_enum_mappings` source - Render `import` statements for referenced proto files
jwils
requested review from
BrianSigafoos-SQ,
bsorbo,
ellisandrews-toast,
jwondrusch,
marcdaniels-toast,
myronmarston and
rossroberts-toast
as code owners
jwils
force-pushed
the
joshuaw/protobuf-schema-generation
branch
3 times, most recently
from
4fe8938 to
474788d
Compare
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
1 participant
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.
Why
Some schemas already have canonical protobuf enum definitions, and generating duplicate enums in
schema.protomakes Java consumers deal with parallel types.What
proto_external_typesto import and reference existing proto enum typesproto_enum_mappingssourceRisk Assessment
Low — this only affects the unreleased
elasticgraph-protobufextension from #1080, and external references are opt-in with validation.References