lisancao opened a new pull request, #18587: URL: https://github.com/apache/iceberg/pull/18587
The File Format API shipped in 1.11.0 but the only documentation is the announcement blog post; the `org.apache.iceberg.formats` package has no page under the versioned docs. This adds `docs/docs/file-format-api.md` under API, next to FileIO: what a `FormatModel` and the `FormatModelRegistry` are, the read and write builders, engine schemas, the built-in object models, how an engine registers its own model, and what adding a new file format currently involves. The examples are taken from `GenericReader`, `RegistryBasedFileWriterFactory` and `GenericFormatModels` so they match the code. Related: #12225. Test plan: `make lint` passes; built the dev site with `mkdocs serve -f mkdocs-dev.yml` and reviewed the rendered page and its nav entry. --- **AI Disclosure** - Model: Claude Fable 5.1 - Platform/Tool: Claude Code - Human Oversight: Reviewed the rendered page on a local docs build and checked the examples against the 1.12.0 source. - Prompt Summary: Draft a docs page for the File Format API from the Javadoc, the format model sources and the announcement post; the structure, prose and examples were generated, then checked against the 1.12.0 source and a local site build. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
