Document Apache HTTP client APIs - #428
Open
jonathanpeppers wants to merge 2 commits into
Open
Conversation
Refs #270 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and
a lite review from Copilot
August 14, 2026 09:07
jonathanpeppers
enabled auto-merge (squash)
August 14, 2026 09:07
There was a problem hiding this comment.
Pull request overview
This PR fills in previously placeholder XML documentation for the Org.Apache.Http.Client namespace, using source-supported descriptions where available, and adds a namespace-level summary to improve generated API docs.
Changes:
- Replace multiple
To be added.placeholders with concrete<summary>,<param>,<returns>, and<value>documentation across keyOrg.Apache.Http.Clienttypes. - Add a meaningful namespace summary in
ns-Org.Apache.Http.Client.xml. - Improve documentation for async extension methods on
IHttpClient.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/xml/Org.Apache.Http.Client/RedirectException.xml | Documents constructor parameters for RedirectException. |
| docs/xml/Org.Apache.Http.Client/NonRepeatableRequestException.xml | Documents constructor parameter for NonRepeatableRequestException. |
| docs/xml/Org.Apache.Http.Client/IUserTokenHandler.xml | Replaces placeholder return docs with a meaningful description. |
| docs/xml/Org.Apache.Http.Client/IResponseHandler.xml | Documents return value semantics for response handler processing. |
| docs/xml/Org.Apache.Http.Client/IRequestDirector.xml | Documents return value semantics for request execution. |
| docs/xml/Org.Apache.Http.Client/IRedirectHandler.xml | Documents return values for redirect determination methods. |
| docs/xml/Org.Apache.Http.Client/IHttpRequestRetryHandler.xml | Documents boolean return value for retry decisions. |
| docs/xml/Org.Apache.Http.Client/IHttpClientExtensions.xml | Adds docs for async IHttpClient extension methods (params/summaries/returns). |
| docs/xml/Org.Apache.Http.Client/IHttpClient.xml | Adds missing <returns>/<value> docs for core client members. |
| docs/xml/Org.Apache.Http.Client/ICredentialsProvider.xml | Documents credentials lookup return value. |
| docs/xml/Org.Apache.Http.Client/ICookieStore.xml | Documents cookie store parameter/return/value semantics. |
| docs/xml/Org.Apache.Http.Client/CircularRedirectException.xml | Documents constructor parameters for CircularRedirectException. |
| docs/xml/ns-Org.Apache.Http.Client.xml | Adds namespace-level summary text. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and removed request for
dalexsoto
August 14, 2026 09:18
Member
Author
|
@dalexsoto review |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Org.Apache.Http.Client.Refs #270
Sources
package.html,CircularRedirectException.java,CookieStore.java,CredentialsProvider.java,HttpClient.java,HttpRequestRetryHandler.java,RedirectHandler.java,RequestDirector.java,ResponseHandler.java,UserTokenHandler.java,NonRepeatableRequestException.java, andRedirectException.java.Validation
[xml].git diff --checkand verified the diff is limited todocs/xml/Org.Apache.Http.Client/anddocs/xml/ns-Org.Apache.Http.Client.xml.To be added.placeholders: 117 before, 30 after.