Skip to content

OpenAPI, Core: Disambiguate the intent of REFS snapshot mode #16252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kevinjqliu merged 2 commits into from
May 8, 2026
Merged

OpenAPI, Core: Disambiguate the intent of REFS snapshot mode #16252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
681d9b2
Spec, Core: Disambiguate the intent of REFS snapshot mode
gaborkaszab May 6, 2026
6f548c3
Update core/src/test/java/org/apache/iceberg/rest/TestRESTCatalog.java
gaborkaszab May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions core/src/test/java/org/apache/iceberg/rest/TestRESTCatalog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
import org.apache.iceberg.DataFile;
import org.apache.iceberg.DataFiles;
import org.apache.iceberg.HasTableOperations;
import org.apache.iceberg.HistoryEntry;
import org.apache.iceberg.MetadataUpdate;
import org.apache.iceberg.PartitionSpec;
import org.apache.iceberg.Schema;
Expand Down Expand Up @@ -1086,6 +1087,14 @@ public void testTableSnapshotLoading() {
.asInstanceOf(InstanceOfAssertFactories.list(Snapshot.class))
.hasSize(1);

// snapshot log is complete regardless REFS mode
assertThat(((BaseTable) refsTable).operations().current())
.extracting("snapshotLog")
.asInstanceOf(InstanceOfAssertFactories.list(HistoryEntry.class))
.hasSize(2)
.containsExactlyInAnyOrderElementsOf(
((BaseTable) table).operations().current().snapshotLog());

assertThat(refsTable.currentSnapshot()).isEqualTo(table.currentSnapshot());

// verify that the table was loaded with the refs argument
Expand Down Expand Up @@ -1180,6 +1189,14 @@ public void testTableSnapshotLoadingWithDivergedBranches(String formatVersion) {
.asInstanceOf(InstanceOfAssertFactories.list(Snapshot.class))
.hasSize(2);

// snapshot log is complete regardless REFS mode
assertThat(((BaseTable) refsTable).operations().current())
.extracting("snapshotLog")
.asInstanceOf(InstanceOfAssertFactories.list(HistoryEntry.class))
.hasSize(1) // main branch has a single snapshot
.containsExactlyInAnyOrderElementsOf(
((BaseTable) table).operations().current().snapshotLog());

assertThat(refsTable.currentSnapshot()).isEqualTo(table.currentSnapshot());

// verify that the table was loaded with the refs argument
Expand Down Expand Up @@ -1265,6 +1282,14 @@ public void lazySnapshotLoadingWithDivergedHistory() {
.asInstanceOf(InstanceOfAssertFactories.list(Snapshot.class))
.hasSize(1);

// snapshot log is complete regardless REFS mode
assertThat(((BaseTable) refsTable).operations().current())
.extracting("snapshotLog")
.asInstanceOf(InstanceOfAssertFactories.list(HistoryEntry.class))
.hasSize(numSnapshots)
.containsExactlyInAnyOrderElementsOf(
((BaseTable) table).operations().current().snapshotLog());

assertThat(refsTable.currentSnapshot()).isEqualTo(table.currentSnapshot());
assertThat(refsTable.snapshots()).hasSize(numSnapshots);
assertThat(refsTable.history()).hasSize(numSnapshots);
Expand Down
6 changes: 3 additions & 3 deletions open-api/rest-catalog-open-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -983,9 +983,9 @@ paths:
- in: query
name: snapshots
description:
The snapshots to return in the body of the metadata. Setting the value to `all` would
return the full set of snapshots currently valid for the table. Setting the value to
`refs` would load all snapshots referenced by branches or tags.
The snapshots to return in the body of the metadata via the `snapshots` field. Setting
the value to `all` would return the full set of snapshots currently valid for the table.
Setting the value to `refs` would load all snapshots referenced by branches or tags.

Default if no param is provided is `all`.
required: false
Expand Down
Loading