Docs: Add dedicated page for REST Catalog documentation - #17940
Open
talatuyarer wants to merge 1 commit into
Open
Docs: Add dedicated page for REST Catalog documentation#17940talatuyarer wants to merge 1 commit into
talatuyarer wants to merge 1 commit into
Conversation
talatuyarer
force-pushed
the
docs-rest-catalog-page
branch
from
September 4, 2026 02:50
3a40c16 to
2f80e80
Compare
Contributor
Author
|
@RussellSpitzer I believe i adressed your comments. How it looks like now ? |
talatuyarer
force-pushed
the
docs-rest-catalog-page
branch
from
September 4, 2026 03:24
2f80e80 to
bbc4cfd
Compare
Contributor
Author
|
@kevinjqliu When you have a time Could you review this ? |
RussellSpitzer
approved these changes
Sep 4, 2026
RussellSpitzer
left a comment
RussellSpitzer
left a comment
Member
There was a problem hiding this comment.
This is I think a really good cleanup and explanation of some core Iceberg REST Catalogs that previously just lived in the impl or Spec
talatuyarer
force-pushed
the
docs-rest-catalog-page
branch
from
September 4, 2026 18:11
bbc4cfd to
ba10165
Compare
uros-b
approved these changes
Sep 5, 2026
Member
|
Seems like there are some conflicts here, but otherwise looks good! Thank you @talatuyarer and @RussellSpitzer! |
talatuyarer
force-pushed
the
docs-rest-catalog-page
branch
from
September 5, 2026 16:06
ba10165 to
2e483bc
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I know We have the REST Catalog Spec page and the OpenAPI definition, but those target server implementers, and the Catalogs section documents JDBC, Nessie, Hive, and Glue while saying nothing about how to actually use a REST catalog.
I thought it could be good to add
docs/docs/rest-catalog.mdwith general configuration examples for Java, Spark, and Flink and short prose sections on the protocol features that have no other home in the docs: endpoint discovery, multi-table transactions, credential vending and remote signing, server-side scan planning, ETag-based freshness and lazy snapshot loading, idempotent commit retries, pagination, and metrics reporting.