Skip to content

Document Apache HTTP SSL APIs - #622

Merged
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-document-http-connection-ssl-apis
Aug 18, 2026
Merged

Document Apache HTTP SSL APIs#622
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-document-http-connection-ssl-apis

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Documented source-backed APIs in Org.Apache.Http.Conn.Ssl.
  • Corrected Apache HttpComponents attribution to the Apache Software Foundation and Apache License 2.0.
  • Left generated *Async binding wrappers undocumented because no authoritative Android or published binding source describes their behavior.

Refs #304

Sources

Validation

  • Parsed all six changed XML files.
  • Confirmed CRLF line endings are preserved.
  • Ran git diff --check.
  • Confirmed the diff is limited to docs/xml/Org.Apache.Http.Conn.Ssl.
  • Scoped To be added count: 73 before, 16 after; the remaining placeholders are the unsupported generated *Async wrappers.

Refs #304

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the generated XML documentation for the Org.Apache.Http.Conn.Ssl namespace to replace placeholder docs with source-backed descriptions and to align attribution with Apache HttpComponents / Apache License 2.0.

Changes:

  • Replaced To be added placeholders with summaries/params/returns for key SSL/hostname-verification APIs.
  • Updated attribution text to reference the Apache Software Foundation and Apache License 2.0.
  • Added brief documentation for several binding infrastructure members (e.g., JniPeerMembers).

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/xml/Org.Apache.Http.Conn.Ssl/StrictHostnameVerifier.xml Fills in missing member documentation and updates attribution text.
docs/xml/Org.Apache.Http.Conn.Ssl/SSLSocketFactory.xml Documents constructor parameters/returns, updates attribution text.
docs/xml/Org.Apache.Http.Conn.Ssl/IX509HostnameVerifier.xml Adds missing parameter/return documentation and updates attribution text.
docs/xml/Org.Apache.Http.Conn.Ssl/BrowserCompatHostnameVerifier.xml Adds missing method/return documentation and updates attribution text.
docs/xml/Org.Apache.Http.Conn.Ssl/AllowAllHostnameVerifier.xml Adds missing method/return documentation and updates attribution text.
docs/xml/Org.Apache.Http.Conn.Ssl/AbstractVerifier.xml Adds missing helper/method documentation and updates attribution text.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/xml/Org.Apache.Http.Conn.Ssl/SSLSocketFactory.xml Outdated
Refs #304

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ConnectSocketAsync is newly documented as returning an unconnected SSL socket, but it wraps ConnectSocket, which connects and verifies the socket before returning it. This also contradicts the accepted scope of leaving generated *Async wrappers undocumented. Please restore this wrapper's return documentation to To be added.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: ff589cbb-0c3b-4ee8-a6ab-d2e433dde117
@jonathanpeppers

Copy link
Copy Markdown
Member Author

Addressed the requested change in 6bf9e33: restored \ConnectSocketAsync's generated <returns>To be added.\ documentation without changing the documented synchronous API scope. The six changed XML files pass XML/ECMA structure validation, CRLF validation, and \git diff --check.

@dalexsoto dalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SSL contracts now match the Apache implementation, and the generated async-wrapper scope is consistently preserved.

@jonathanpeppers
jonathanpeppers merged commit 6c69806 into main Aug 18, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-http-connection-ssl-apis branch August 18, 2026 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants