Skip to content

docs: clarify primitive schema byte order#1161

Open
singhvishalkr wants to merge 1 commit into
apache:mainfrom
singhvishalkr:docs/primitive-schema-byte-order
Open

docs: clarify primitive schema byte order#1161
singhvishalkr wants to merge 1 commit into
apache:mainfrom
singhvishalkr:docs/primitive-schema-byte-order

Conversation

@singhvishalkr

@singhvishalkr singhvishalkr commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Motivation

Primitive schema docs list the supported types, but they do not state how fixed-width numeric values are ordered on the wire. That leaves client implementers to infer byte order when producers and consumers are not using the same client library.

Modifications

  • Clarify that Java primitive schemas encode fixed-width numeric values in big-endian byte order.
  • Note that INT8 is a single byte, FLOAT and DOUBLE use IEEE 754 bit patterns, and BYTES payloads keep application-defined ordering.
  • Apply the same clarification to the current docs and supported versioned docs (4.0.x and 4.2.x).

Verifying this change

  • corepack yarn install --immutable
  • git diff --check
  • corepack yarn typecheck fails on existing non-doc TypeScript issues in matomoClientModule.ts and src/theme/Blog* files.
  • $env:NODE_OPTIONS='--max_old_space_size=16000'; corepack yarn docusaurus build passes; it emits existing site-wide broken-link and SSG warnings outside the changed schema docs.

Contribution Checklist

Fixes #1142

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.

Primitive types schema serialization is ambiguous

1 participant