feat: add short_description to dataplane v1 FieldSpec - #2605
Merged
Conversation
Adds an optional short_description field to the pipeline component schema FieldSpec, carrying the plain-text inline help introduced in Redpanda Connect 4.104.0 (redpanda-data/connect#4638). The field is empty until the connect-api populates it; adding field 14 is wire- and JSON-compatible in both directions, so no coordination with deployed pipelines or older UI builds is required. Generated code (Go, TypeScript, OpenAPI) regenerated via task proto:generate. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
The latest Buf updates on your PR. Results from workflow Buf CI / validate (pull_request).
|
r-vasquez
approved these changes
Aug 17, 2026
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
2 participants
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.
What
Adds an optional
string short_description = 14;tomessage FieldSpecinproto/redpanda/api/dataplane/v1/pipeline.proto, plus the regenerated Go / TypeScript / OpenAPI code (task proto:generate).Why
Redpanda Connect ≥ v4.104.0 emits a
short_descriptionfor config fields (redpanda-data/connect#4638, benthos redpanda-data/benthos#463): a plain-text, ≤140-char summary suitable for inline help in the pipeline config editor, unlikedescriptionwhich is Asciidoc documentation prose often hundreds of characters long (e.g. postgres_cdcheartbeat_intervalis 715 chars).This proto field is the transport hop that lets the value reach the Console UI. Follow-ups (separate PRs): the connect-api mapping in cloudv2 to populate it, and frontend rendering.
Compatibility
Adding a new proto3 field is wire- and JSON-compatible in both directions: servers that don't populate it send nothing (clients see
""), and older clients ignore the unknown field.FieldSpecis component-schema metadata for the config editor only — running pipelines never consume it — so no coordination with deployed Connect versions is required.Testing
buf lint/buf formatpass (run as part oftask proto:generate).go build ./pkg/protogen/...passes.🤖 Generated with Claude Code
Supersedes #2600 (same commit): reopened from an in-repo branch so the AWS-credential CI checks (
Proto generate,Audit registry usage) get real secrets, which fork PRs are denied. Already reviewed by @r-vasquez there.