Skip to content

Document Org.Apache.Http.Client.Protocol - #586

Merged
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-document-http-client-protocol
Aug 18, 2026
Merged

Document Org.Apache.Http.Client.Protocol#586
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-document-http-client-protocol

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Replaced all 55 existing To be added. entries under Org.Apache.Http.Client.Protocol with API-specific documentation.
  • Documented HTTP context keys, client context configuration, authentication interceptors, and JNI peer metadata.

Closes#265

Sources

Validation

  • Parsed every docs/xml/Org.Apache.Http.Client.Protocol/*.xml file as XML.
  • Confirmed zero To be added. placeholders in the scoped XML files.
  • Confirmed CRLF line endings and ran git diff --check.

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

CopilotAI 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

This PR replaces placeholder XML documentation (“To be added.”) across Org.Apache.Http.Client.Protocol with API-specific docs covering HTTP context keys, context configuration helpers, request/response interceptors, and JNI peer metadata entries.

Changes:

  • Added namespace/type/member summaries and remarks for the Org.Apache.Http.Client.Protocol XML docs (removing placeholders).
  • Documented HTTP context attribute keys (IClientContext and ClientContextConfigurer.InterfaceConsts) and context configuration (ClientContextConfigurer).
  • Documented interceptor types and their purpose (e.g., target/proxy authentication interceptors) and filled in JNI-related member docs.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.

Show a summary per file
FileDescription
docs/xml/Org.Apache.Http.Client.Protocol/ResponseProcessCookies.xmlReplaces placeholder docs; updates JNI peer member documentation.
docs/xml/Org.Apache.Http.Client.Protocol/RequestTargetAuthentication.xmlAdds interceptor summary; updates JNI peer member documentation.
docs/xml/Org.Apache.Http.Client.Protocol/RequestProxyAuthentication.xmlAdds interceptor summary; updates JNI peer member documentation.
docs/xml/Org.Apache.Http.Client.Protocol/RequestDefaultHeaders.xmlUpdates JNI peer member documentation.
docs/xml/Org.Apache.Http.Client.Protocol/RequestAddCookies.xmlUpdates JNI peer member documentation.
docs/xml/Org.Apache.Http.Client.Protocol/IClientContext.xmlDocuments context attribute constants and adds obsolescence/remar ks content.
docs/xml/Org.Apache.Http.Client.Protocol/ClientContextConfigurer+InterfaceConsts.xmlDocuments inherited context attribute names (consts).
docs/xml/Org.Apache.Http.Client.Protocol/ClientContextConfigurer.xmlDocuments context configurer type and members; updates JNI peer member documentation.

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

Comment threaddocs/xml/Org.Apache.Http.Client.Protocol/ResponseProcessCookies.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Protocol/RequestTargetAuthentication.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Protocol/RequestProxyAuthentication.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Protocol/ClientContextConfigurer.xml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

1 similar comment
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

@dalexsotodalexsoto 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.

Two protocol documentation gaps remain:

  • ClientContextConfigurer has a nullable managed constructor parameter, but AOSP rejects null with Java.Lang.IllegalArgumentException; document the non-null requirement and exception.
  • The public compatibility ClientContext type still has blank summaries for all ten constants while equivalent IClientContext and InterfaceConsts members are documented.

Please add the constructor contract and keep the compatibility projection in parity.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 0794cefb-ece4-45f7-ac33-4b4cf05a5cad
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

Two protocol documentation gaps remain:

Addressed in 9ea4350: the configurer constructor now documents its non-null contract and Java.Lang.IllegalArgumentException, and all ten ClientContext compatibility constants now match the documented projections.

@dalexsotodalexsoto 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 configurer null contract and all ClientContext compatibility constants now match the Apache implementation and managed projections.

@jonathanpeppers
jonathanpeppers merged commit 2cf4ee0 into mainAug 18, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-http-client-protocol branch August 18, 2026 19:32
Sign up for freeto 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.

Add XML documentation for Org.Apache.Http.Client.Protocol

3 participants

@jonathanpeppers@dalexsoto