akashchamp opened a new pull request, #324:
URL: https://github.com/apache/calcite-avatica/pull/324

   ## What
   
   Documents the `keystore`, `keystore_password`, and `key_password` JDBC URL
   properties on the [client reference 
page](https://calcite.apache.org/avatica/docs/client_reference.html).
   
   ## Why
   
   [CALCITE-5896](https://issues.apache.org/jira/browse/CALCITE-5896): the
   client reference documents `truststore`, `truststore_password`, and
   `keystore_type` (used to verify the *server's* certificate), but never
   documented `keystore`, `keystore_password`, or `key_password` (used to
   supply the *client's* own certificate/private key for mutual TLS). These
   three properties have existed in `BuiltInConnectionProperty` since
   CALCITE-2285 and are consumed by
   `CommonsHttpClientPoolCache#loadKeyStore` via
   `SSLContextBuilder#loadKeyMaterial`, but a user reading the reference page
   has no way to discover them.
   
   ## Change
   
   Adds three definition-list entries to `site/_docs/client_reference.md`,
   placed right after the existing `keystore_type` entry (matching the
   declaration order in `BuiltInConnectionProperty`) and mirroring the
   wording/format of the adjacent `truststore` / `truststore_password`
   entries:
   
   - `keystore`
   - `keystore_password`
   - `key_password`
   
   No code changes; this is a pure documentation addition (1 file changed,
   31 insertions, 0 deletions).
   
   ## Verification
   
   - Confirmed the gap against the live published page and against
     `BuiltInConnectionProperty.java`, `ConnectionConfig(Impl).java`, and
     `CommonsHttpClientPoolCache.java` (where `keystore` / `keystore_password`
     / `key_password` are actually consumed).
   - Rendered the edited section with `kramdown` (the markdown engine this
     Jekyll site uses, per `site/_config.yml`) to confirm the new entries
     produce the same `<dt>`/`<dd>` structure as their siblings, and that the
     new anchors (`#keystore`, `#keystore_password`, `#key_password`) are
     unique and resolve correctly.
   - Checked the whole page for anchor-name collisions: none.
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)
   


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to