You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by et...@apache.org on 2025/11/20 14:55:19 UTC

(iceberg) branch main updated: OpenAPI: Add storage-credentials to CompletedPlanningResult (#14563)

This is an automated email from the ASF dual-hosted git repository.

etudenhoefner pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg.git


The following commit(s) were added to refs/heads/main by this push:
     new 7fc886ad75 OpenAPI: Add storage-credentials to CompletedPlanningResult (#14563)
7fc886ad75 is described below

commit 7fc886ad751eaf4f53915ca0da69bdb8c2c1e72b
Author: ajreid21 <57...@users.noreply.github.com>
AuthorDate: Thu Nov 20 06:55:13 2025 -0800

    OpenAPI: Add storage-credentials to CompletedPlanningResult (#14563)
---
 open-api/rest-catalog-open-api.py   |  5 +++++
 open-api/rest-catalog-open-api.yaml | 10 ++++++++++
 2 files changed, 15 insertions(+)

diff --git a/open-api/rest-catalog-open-api.py b/open-api/rest-catalog-open-api.py
index c4846fc481..b7da166271 100644
--- a/open-api/rest-catalog-open-api.py
+++ b/open-api/rest-catalog-open-api.py
@@ -1499,6 +1499,11 @@ class CompletedPlanningResult(ScanTasks):
     """
 
     status: Literal['completed'] = Field(..., const=True)
+    storage_credentials: Optional[List[StorageCredential]] = Field(
+        None,
+        alias='storage-credentials',
+        description='Storage credentials for accessing the files returned in the scan result.\nIf the server returns storage credentials as part of the completed scan planning response, the expectation is for the client to use these credentials to read the files returned in the FileScanTasks as part of the scan result.',
+    )
 
 
 class FetchScanTasksResult(ScanTasks):
diff --git a/open-api/rest-catalog-open-api.yaml b/open-api/rest-catalog-open-api.yaml
index dc6ae04db7..184d785bca 100644
--- a/open-api/rest-catalog-open-api.yaml
+++ b/open-api/rest-catalog-open-api.yaml
@@ -3444,6 +3444,16 @@ components:
             status:
               $ref: '#/components/schemas/PlanStatus'
               const: "completed"
+            storage-credentials:
+              type: array
+              description:
+                Storage credentials for accessing the files returned in the scan result.
+              
+                If the server returns storage credentials as part of the completed scan
+                planning response, the expectation is for the client to use these credentials
+                to read the files returned in the FileScanTasks as part of the scan result.
+              items:
+                $ref: '#/components/schemas/StorageCredential'
 
     CompletedPlanningWithIDResult:
       type: object