Skip to content

debezium/dbz#1245 Add description field to connections API payload#309

Open
PDGGK wants to merge 1 commit intodebezium:mainfrom
PDGGK:fix/dbz-1245-connection-description
Open

debezium/dbz#1245 Add description field to connections API payload#309
PDGGK wants to merge 1 commit intodebezium:mainfrom
PDGGK:fix/dbz-1245-connection-description

Conversation

@PDGGK
Copy link
Copy Markdown

@PDGGK PDGGK commented Mar 21, 2026

Summary

Adds the description field to the connections API payload, consistent with all other resources (pipelines, sources, destinations, transforms, vaults) that already have this field.

Closes debezium/dbz#1245

Changes

Backend (Java/Quarkus):

  • ConnectionEntity.java: Added description field with getter/setter
  • Connection.java (Blaze-Persistence EntityView): Added getDescription()/setDescription()
  • New Flyway migration V3.5.0__add_connection_description.sql: Adds description varchar(255) column to connection table

Frontend (TypeScript/React):

  • apis.tsx: Added description?: string to Connection and ConnectionPayload types
  • Connections.json: Updated mock data with description field

Tests:

  • ConnectionResourceIT.java: Updated test payloads to include description, added assertions, added testCreateConnection_WithoutDescription to verify optionality

Design Decisions

  • Description is optional (nullable), consistent with all other entities
  • No REST endpoint changes needed — Blaze-Persistence and Jackson handle serialization automatically
  • Column type varchar(255) matches existing description columns in other tables

@github-actions
Copy link
Copy Markdown

Hi @PDGGK, thanks for your contribution. Please prefix the commit message(s) with the debezium/dbz#xxx GitHub issue key.

@mfvitale
Copy link
Copy Markdown
Member

mfvitale commented Mar 24, 2026

@PDGGK Thanks for you first PR! Could you please sign-off you commits and format with debezium/dbz#xxx GitHub?

@PDGGK PDGGK force-pushed the fix/dbz-1245-connection-description branch from 62dff95 to 0dfb2ff Compare March 24, 2026 11:24
@Naros
Copy link
Copy Markdown
Member

Naros commented Mar 26, 2026

Hi @PDGGK your email addresses do not match on the commit sign-offs with what is expected, see
https://github.com/debezium/debezium-platform/actions/runs/23486964273?pr=309#summary-68651795864

Signed-off-by: Zihan Dai <99155080+PDGGK@users.noreply.github.com>
@mfvitale
Copy link
Copy Markdown
Member

@PDGGK Overall it LGTM.

@indraraj could you take a look to the FE part?

Copy link
Copy Markdown
Member

@kmos kmos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add the Description field to the connections API payload [DBZ-9492]

4 participants