Skip to content

KAFKA-12570: Document compact arrays in flexible versions#22862

Open
gvdutra wants to merge 1 commit into
apache:trunkfrom
gvdutra:KAFKA-12570-document-flexible-compact-arrays
Open

KAFKA-12570: Document compact arrays in flexible versions#22862
gvdutra wants to merge 1 commit into
apache:trunkfrom
gvdutra:KAFKA-12570-document-flexible-compact-arrays

Conversation

@gvdutra

@gvdutra gvdutra commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

What changed

  • explain that flexible message versions use compact encodings for
    variable-length fields
  • explicitly document that arrays use COMPACT_ARRAY instead of ARRAY
  • mention the related compact string and byte-array encodings,
    variable-length length prefix, and tagged-fields section

Why

The protocol primitive-type table lists compact encodings but did not
explain when clients must use them. This left implementers to infer that
flexible message versions use COMPACT_ARRAY and the other COMPACT_*
types.

Impact

Client implementers can now determine the correct array encoding for
flexible message versions directly from the wire-protocol guide.

Validation

  • ./gradlew siteDocsTar
  • git diff --check

@github-actions github-actions Bot added triage PRs from the community docs small Small PRs labels Jul 18, 2026
@gvdutra
gvdutra force-pushed the KAFKA-12570-document-flexible-compact-arrays branch from 5231e11 to 9561c64 Compare July 18, 2026 03:16
@gvdutra
gvdutra marked this pull request as ready for review July 18, 2026 03:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs small Small PRs triage PRs from the community

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant