Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API documentation debt - Microsoft.Extensions.Http #43916

Closed
Tracked by #43849
carlossanlop opened this issue Oct 27, 2020 · 3 comments
Closed
Tracked by #43849

API documentation debt - Microsoft.Extensions.Http #43916

carlossanlop opened this issue Oct 27, 2020 · 3 comments
Assignees
Labels
area-Extensions-HttpClientFactory documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Milestone

Comments

@carlossanlop
Copy link
Member

carlossanlop commented Oct 27, 2020

Area owners: @dotnet/ncl

The APIs in the list below are missing some or all of their documentation. Please add the missing documentation directly in triple slash comments in source. We will make sure it gets ported to dotnet-api-docs after it's merged.

Make sure to follow the documentation guidelines defined in the dotnet-api-docs wiki:
https://github.com/dotnet/dotnet-api-docs/wiki

Also please add me as a PR reviewer.

Community contributions are welcome.

Microsoft.Extensions.Http
PR DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
PR dotnet/dotnet-api-docs#7110 Microsoft.Extensions.Http namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Http.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http?branch=master
PR dotnet/dotnet-api-docs#7110 M:Microsoft.Extensions.Http.HttpClientFactoryOptions.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http/HttpClientFactoryOptions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.HttpClientFactoryOptions.-ctor?branch=master
PR dotnet/dotnet-api-docs#7110 M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.HttpMessageHandlerBuilder.-ctor?branch=master
PR #57719 M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.CreateHandlerPipeline
(System.Net.Http.HttpMessageHandler,System.Collections.Generic.IEnumerable{System.Net.Http.DelegatingHandler})
Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.HttpMessageHandlerBuilder.CreateHandlerPipeline?branch=master
PR #57719 M:Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter.Configure
(System.Action{Microsoft.Extensions.Http.HttpMessageHandlerBuilder})
Present Present NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter.Configure?branch=master
PR dotnet/dotnet-api-docs#7110 M:Microsoft.Extensions.Http.PolicyHttpMessageHandler.SendAsync
(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)
Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.PolicyHttpMessageHandler.SendAsync?branch=master
Microsoft.Extensions.Http.Logging
PR DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
PR dotnet/dotnet-api-docs#7110 Microsoft.Extensions.Http.Logging namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Http.Logging.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.Logging?branch=master
PR #57719 M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger) Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.-ctor?branch=master
PR #57719 M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.#ctor
(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Http.HttpClientFactoryOptions)
Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.-ctor?branch=master
PR #57719 M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.SendAsync
(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)
Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.SendAsync?branch=master
PR #57719 M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger) Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.-ctor?branch=master
PR #57719 M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.#ctor
(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Http.HttpClientFactoryOptions)
Missing Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.-ctor?branch=master
PR #57719 M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.SendAsync
(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)
Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.SendAsync?branch=master
PR #57719 T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler?branch=master
PR #57719 T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler?branch=master

Notes:

  • The namespaces need to be documented directly in dotnet-api-docs.
  • Some of the APIs may be obsolete, so I'll let area owners decide if they want to still document them or skip them. If you opt for documenting them, please do it directly in dotnet-api-docs.
@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors untriaged New issue has not been triaged by the area owner area-Microsoft.Extensions labels Oct 27, 2020
@carlossanlop carlossanlop added this to the 6.0.0 milestone Oct 27, 2020
@ghost
Copy link

ghost commented Nov 5, 2020

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

@CarnaViire CarnaViire removed the untriaged New issue has not been triaged by the area owner label Jun 2, 2021
resistr added a commit to resistr/runtime that referenced this issue Aug 19, 2021
- M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.CreateHandlerPipeline
    (System.Net.Http.HttpMessageHandler,System.Collections.Generic.IEnumerable{System.Net.Http.DelegatingHandler})
- M:Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter.Configure
    (System.Action{Microsoft.Extensions.Http.HttpMessageHandlerBuilder})
- M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger)
- M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.#ctor
    (Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Http.HttpClientFactoryOptions)
- M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.SendAsync
    (System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)
- M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger)
- M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.#ctor
    (Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Http.HttpClientFactoryOptions)
- M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.SendAsync
    (System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)
- T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler
- T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler

Fix dotnet#43916
@ghost ghost added in-pr There is an active PR which will close this issue when it is merged and removed in-pr There is an active PR which will close this issue when it is merged labels Aug 19, 2021
@karelz
Copy link
Member

karelz commented Aug 19, 2021

Items not addressed by PR #57719:

Item Notes
Microsoft.Extensions.Http namespace This has to be documented directly in dotnet-api-docs.
M:Microsoft.Extensions.Http.HttpClientFactoryOptions.#ctor ctor is inferred; does not exist in code; also document directly in dotnet-api-docs? Uncertain.
M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.#ctor ctor is inferred; does not exist in code; also document directly in dotnet-api-docs? Uncertain.
M:Microsoft.Extensions.Http.PolicyHttpMessageHandler.SendAsync
(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)
Could not find class/method to add documentation to? Possibly removed?
Microsoft.Extensions.Http.Logging namespace This has to be documented directly in dotnet-api-docs.

resistr added a commit to resistr/runtime that referenced this issue Aug 19, 2021
Reworded the cstor documentation on HttpMessageHandlerBuilder based on feedback from active PR.

Contributes to dotnet#43916
resistr added a commit to resistr/runtime that referenced this issue Aug 20, 2021
Augment documentation for SendAsync in LoggingScopeHttpMessageHandler and LoggingHttpMessageHandler

Contributes to dotnet#43916
CarnaViire pushed a commit that referenced this issue Aug 31, 2021
Items Addressed: 

- M:Microsoft.Extensions.Http.HttpMessageHandlerBuilder.CreateHandlerPipeline
    (System.Net.Http.HttpMessageHandler,System.Collections.Generic.IEnumerable{System.Net.Http.DelegatingHandler})
- M:Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter.Configure
    (System.Action{Microsoft.Extensions.Http.HttpMessageHandlerBuilder})

Microsoft.Extensions.Http.Logging:
- M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger)
- M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.#ctor
    (Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Http.HttpClientFactoryOptions)
- M:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.SendAsync
    (System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)
- M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.#ctor(Microsoft.Extensions.Logging.ILogger)
- M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.#ctor
    (Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Http.HttpClientFactoryOptions)
- M:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.SendAsync
    (System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)
- T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler
- T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler

Contributes to #43916
@CarnaViire
Copy link
Member

CarnaViire commented Sep 7, 2021

Fixed by dotnet/dotnet-api-docs#7103 and dotnet/dotnet-api-docs#7110 in net6-rc1 (for .NET 6.0)

@ghost ghost locked as resolved and limited conversation to collaborators Oct 9, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Extensions-HttpClientFactory documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
None yet
Development

No branches or pull requests

5 participants