[iceberg] branch master updated: Spec: Add S3 configuration to REST table load (#7401)

[bl...@apache.org]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 1168312e01 Spec: Add S3 configuration to REST table load (#7401)
1168312e01 is described below

commit 1168312e01e8cf2115fc0e44e2303be882dc5bff
Author: Daniel Weeks <dw...@apache.org>
AuthorDate: Sat Apr 22 12:19:57 2023 -0700

    Spec: Add S3 configuration to REST table load (#7401)
---
 open-api/rest-catalog-open-api.yaml | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/open-api/rest-catalog-open-api.yaml b/open-api/rest-catalog-open-api.yaml
index 19b5ae9f3d..a2473488e9 100644
--- a/open-api/rest-catalog-open-api.yaml
+++ b/open-api/rest-catalog-open-api.yaml
@@ -1702,7 +1702,7 @@ components:
           type: integer
 
     LoadTableResult:
-      description:
+      description: |
         Result used when a table is successfully loaded.
 
 
@@ -1711,6 +1711,22 @@ components:
 
 
         The `config` map returns table-specific configuration for the table's resources, including its HTTP client and FileIO. For example, config may contain a specific FileIO implementation class for the table depending on its underlying storage.
+      
+      
+        The following configurations should be respected by clients:
+        
+        ## General Configurations
+        
+        - `token`: Authorization bearer token to use for table requests if OAuth2 security is enabled 
+        
+        ## AWS Configurations
+        
+        The following configurations should be respected when working with tables stored in AWS S3
+         - `client.region`: region to configure client for making requests to AWS
+         - `s3.access-key-id`: id for for credentials that provide access to the data in S3
+         - `s3.secret-access-key`: secret for credentials that provide access to data in S3 
+         - `s3.session-token`: if present, this value should be used for as the session token 
+         - `s3.remote-signing-enabled`: if `true` remote signing should be performed as described in the `s3-signer-open-api.yaml` specification
       type: object
       required:
         - metadata