You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@polaris.apache.org by "MonkeyCanCode (via GitHub)" <gi...@apache.org> on 2026/07/11 18:29:12 UTC

[PR] CLI add supports for non-http scheme [polaris]

MonkeyCanCode opened a new pull request, #5043:
URL: https://github.com/apache/polaris/pull/5043

   <!--
   📝 Describe what changes you're proposing, especially breaking or user-facing changes. 
   📖 See https://github.com/apache/polaris/blob/main/CONTRIBUTING.md for more.
   -->
   
   _**Please don't merge this one as I am not able to update `CHANGELOG.md` due to https://github.com/apache/polaris/pull/5042**_
   
   
   This PR fixes https://github.com/apache/polaris/issues/4993 where we default to `http` for scheme when creating profile. Also, the CLI itself lacks scheme support unless using `base_url` (so this was not possible earlier when using `--host` and `--port` option. 
   
   Here is sample output for this change:
   
   Add profiles with http and https scheme:
   ```
   # https scheme
   ➜  polaris git:(main) ✗ ./polaris profiles create dev_https
   ┌─[DEPRECATED]────────────────────────────────┐
   │ This script is deprecated. Use pip instead: │
   │                                             │
   │   pip install apache-polaris                │
   └─────────────────────────────────────────────┘
   Polaris Client ID: abc
   Polaris Client Secret: abc
   Polaris Host [localhost]:
   Polaris Port [8181]:
   Polaris URL Scheme [http]: https
   Polaris Context Realm:
   Polaris Context Header Name [Polaris-Realm]:
   Polaris profile dev_https created successfully.
   
   # http scheme
   ➜  polaris git:(main) ✗ ./polaris profiles create dev_http
   ┌─[DEPRECATED]────────────────────────────────┐
   │ This script is deprecated. Use pip instead: │
   │                                             │
   │   pip install apache-polaris                │
   └─────────────────────────────────────────────┘
   Polaris Client ID: abc
   Polaris Client Secret: abc
   Polaris Host [localhost]:
   Polaris Port [8181]:
   Polaris URL Scheme [http]:
   Polaris Context Realm:
   Polaris Context Header Name [Polaris-Realm]:
   Polaris profile dev_http created successfully.
   ```
   
   Ensure scheme got persisted:
   ```
   # display for https scheme
   ➜  polaris git:(main) ✗ ./polaris profiles get dev_https
   ┌─[DEPRECATED]────────────────────────────────┐
   │ This script is deprecated. Use pip instead: │
   │                                             │
   │   pip install apache-polaris                │
   └─────────────────────────────────────────────┘
   Polaris profile dev_https: {'client_id': 'abc', 'client_secret': '********', 'host': 'localhost', 'port': 8181, 'scheme': 'https', 'realm': '', 'header': 'Polaris-Realm'}
   
   # display for http scheme
   ➜  polaris git:(main) ✗ ./polaris profiles get dev_http
   ┌─[DEPRECATED]────────────────────────────────┐
   │ This script is deprecated. Use pip instead: │
   │                                             │
   │   pip install apache-polaris                │
   └─────────────────────────────────────────────┘
   Polaris profile dev_http: {'client_id': 'abc', 'client_secret': '********', 'host': 'localhost', 'port': 8181, 'scheme': 'http', 'realm': '', 'header': 'Polaris-Realm'}
   ```
   
   Validation to ensure scheme got honored during api requests:
   ```
   # https scheme
   ➜  polaris git:(main) ✗ ./polaris --profile dev_https catalogs list --debug
   ┌─[DEPRECATED]────────────────────────────────┐
   │ This script is deprecated. Use pip instead: │
   │                                             │
   │   pip install apache-polaris                │
   └─────────────────────────────────────────────┘
   Request: POST https://localhost:8181/api/catalog/v1/oauth/tokens
   Headers: {'Content-Type': 'application/x-www-form-urlencoded'}
   Body: <redacted sensitive authentication payload>
   ...
   
   # http scheme
   ➜  polaris git:(main) ✗ ./polaris --profile dev_http catalogs list --debug
   ┌─[DEPRECATED]────────────────────────────────┐
   │ This script is deprecated. Use pip instead: │
   │                                             │
   │   pip install apache-polaris                │
   └─────────────────────────────────────────────┘
   Request: POST http://localhost:8181/api/catalog/v1/oauth/tokens
   Headers: {'Content-Type': 'application/x-www-form-urlencoded'}
   Body: <redacted sensitive authentication payload>
   ...
   ```
   
   Ensure change is backward compatible:
   ```
   # older profile without those extra files in the schema (fall-back to default)
   ➜  polaris git:(cli_add_scheme_support) ./polaris profiles get dev
   ┌─[DEPRECATED]────────────────────────────────┐
   │ This script is deprecated. Use pip instead: │
   │                                             │
   │   pip install apache-polaris                │
   └─────────────────────────────────────────────┘
   Polaris profile dev: {'client_id': 'root', 'client_secret': '********', 'host': 'localhost', 'port': 8181}
   
   # Sample request to ensure it still works
   ➜  polaris git:(cli_add_scheme_support) ./polaris --profile dev catalogs list --debug
   ┌─[DEPRECATED]────────────────────────────────┐
   │ This script is deprecated. Use pip instead: │
   │                                             │
   │   pip install apache-polaris                │
   └─────────────────────────────────────────────┘
   Request: POST http://localhost:8181/api/catalog/v1/oauth/tokens
   Headers: {'Content-Type': 'application/x-www-form-urlencoded'}
   Body: <redacted sensitive authentication payload>
   Response: 200
   Response Headers: {'Content-Type': 'application/json;charset=UTF-8', 'content-length': '757', 'X-Request-ID': 'c74784fa-9391-4178-b959-4bbee98d68eb_0000000000000000007'}
   Response Body: <redacted sensitive authentication payload>
   
   Request: GET http://localhost:8181/api/management/v1/catalogs
   Headers: {'Accept': 'application/json', 'User-Agent': 'OpenAPI-Generator/1.0.0/python', 'Authorization': '***REDACTED***'}
   Response: 200
   Response Headers: {'Content-Type': 'application/json;charset=UTF-8', 'content-length': '15', 'X-Request-ID': 'c74784fa-9391-4178-b959-4bbee98d68eb_0000000000000000008'}
   Response Body: {"catalogs": []}
   ```
   
   ## Checklist
   - [x] 🛡️ Don't disclose security issues! (contact security@apache.org)
   - [x] 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
   - [x] 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
   - [x] 💡 Added comments for complex logic
   - [ ] 🧾 Updated `CHANGELOG.md` (if needed)
   - [x] 📚 Updated documentation in `site/content/in-dev/unreleased` (if needed)
   


-- 
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-unsubscribe@polaris.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org