kevinjqliu commented on code in PR #2175: URL: https://github.com/apache/iceberg-python/pull/2175#discussion_r2192706106
########## mkdocs/docs/configuration.md: ########## @@ -339,40 +339,107 @@ catalog: | Key | Example | Description | | ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- | -| uri | <https://rest-catalog/ws> | URI identifying the REST Server | -| ugi | t-1234:secret | Hadoop UGI for Hive client. | -| credential | t-1234:secret | Credential to use for OAuth2 credential flow when initializing the catalog | +| uri | <https://rest-catalog/ws> | URI identifying the REST Server | +| warehouse | myWarehouse | Warehouse location or identifier to request from the catalog service. May be used to determine server-side overrides, such as the warehouse location. | +| snapshot-loading-mode | refs | 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. | +| `header.X-Iceberg-Access-Delegation` | `vended-credentials` | Signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms. When using `vended-credentials`, the server provides temporary credentials to the client. When using `remote-signing`, the server signs requests on behalf of the client. (default: `vended-credentials`) | + + +#### Headers in RESTCatalog + +To configure custom headers in RESTCatalog, include them in the catalog properties with `header.<Header-Name>`. This Review Comment: ```suggestion #### Headers in REST Catalog To configure custom headers in REST Catalog, include them in the catalog properties with `header.<Header-Name>`. This ``` ########## mkdocs/docs/configuration.md: ########## @@ -339,40 +339,107 @@ catalog: | Key | Example | Description | | ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- | -| uri | <https://rest-catalog/ws> | URI identifying the REST Server | -| ugi | t-1234:secret | Hadoop UGI for Hive client. | -| credential | t-1234:secret | Credential to use for OAuth2 credential flow when initializing the catalog | +| uri | <https://rest-catalog/ws> | URI identifying the REST Server | +| warehouse | myWarehouse | Warehouse location or identifier to request from the catalog service. May be used to determine server-side overrides, such as the warehouse location. | +| snapshot-loading-mode | refs | 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. | +| `header.X-Iceberg-Access-Delegation` | `vended-credentials` | Signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms. When using `vended-credentials`, the server provides temporary credentials to the client. When using `remote-signing`, the server signs requests on behalf of the client. (default: `vended-credentials`) | + + +#### Headers in RESTCatalog + +To configure custom headers in RESTCatalog, include them in the catalog properties with `header.<Header-Name>`. This +ensures that all HTTP requests to the REST service include the specified headers. + +```yaml +catalog: + default: + uri: http://rest-catalog/ws/ + credential: t-1234:secret + header.content-type: application/vnd.api+json +``` + + +#### Authentication Options + +##### OAuth2 +| Key | Example | Description | +| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------- | | token | FEW23.DFSDF.FSDF | Bearer token value to use for `Authorization` header | +| oauth2-server-uri | <https://auth-service/cc> | Authentication URL to use for client credentials authentication (default: uri + 'v1/oauth/tokens') | Review Comment: ```suggestion | oauth2-server-uri | <https://auth-service/cc> | Authentication URL to use for client credentials authentication (default: uri + 'v1/oauth/tokens') | | | token | FEW23.DFSDF.FSDF | Bearer token value to use for `Authorization` header ``` -- 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: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org