Skip to content

docs: Avro schema docs shard from the doc attribute and idl2schemata (closes #9936) - #9972

Merged
TrapsterDK merged 1 commit into
mainfrom
avro-docs-shard
Nov 9, 2026
Merged

TrapsterDK merged 1 commit into
mainfrom
avro-docs-shard

Conversation

@TrapsterDK

Copy link
Copy Markdown
Collaborator

Closes #9936.

avro_doc_shard(avro, package) reads the doc attribute of each .avsc with a new Rust extractor (tools/docs/avro/extract, serde_json). .avdl files first go through the pinned avro-tools (//config:tool_avro, idl2schemata) into a tree artifact, then the same extractor. Record -> class, field -> field, enum -> enum, symbol -> variant, fixed -> type alias, protocol -> interface, message -> method; ids start with the namespace. Enum symbols have no doc in Avro, so they are marked incomplete.

Also: docs aspect branch on AvroInfo.direct_srcs, fixture with an .avsc and an .avdl, crate registered and locks repinned with Bazel, languages.bzl doc tool, docs.md row, generation README paragraph, regenerated support matrix.

Tested: //tools/docs/avro/... (extractor unit tests, shard test), //quality/testdata:real_docs_shards, support_matrix facts/generate tests. macro_rows_test fails with "BENCH is not a dict" (#9951). Nested-Bazel and consumer tests were not run.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Xut2hwESun1HL2eSVd1d5B

@TrapsterDK
TrapsterDK merged commit a7e3ec8 into main Nov 9, 2026
@TrapsterDK
TrapsterDK deleted the avro-docs-shard branch November 9, 2026 16:33
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.

docs: schema docs for Avro from the doc attribute and avro-tools idl2schemata

1 participant