Repository navigation
docs(http): Add JSDoc for public APIs [skip chg] - #12210
Merged
Timothee Guerin (timotheeguerin) merged 14 commits intoOct 16, 2026
Merged
Timothee Guerin (timotheeguerin) merged 14 commits into
Timothee Guerin (timotheeguerin) merged 14 commits into
Conversation
commit: |
Contributor
|
All changed packages have been documented.
Show changes
|
Timothee Guerin (timotheeguerin)
changed the title
29 of 30 tasks
|
You can try these changes here
|
Timothee Guerin (timotheeguerin)
marked this pull request as ready for review
October 16, 2026 13:45
Timothee Guerin (timotheeguerin)
requested review from
catalinaperalta,
iscai-msft,
Laurent Mazuel (lmazuel) and
Mark Cowlishaw (markcowl)
as code owners
October 16, 2026 13:45
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes have no identified blocking issues and preserve existing behavior and signatures.
0 open findings
What changed in this PR
Documents HTTP authentication contracts for API consumers as part of #12228, without changing public signatures or runtime behavior.
Changes:
- Clarifies authentication alternatives, combined requirements, and scheme configuration.
- Explains local scopes and normalized service-level references.
- Adds an internal changelog entry.
| File | Description |
|---|---|
packages/http/src/types.ts |
Adds JSDoc for authentication types and security requirements. |
.chronus/changes/docs-jsdoc-http-auth-2026-9-15-11-57-31.md |
Records the documentation update. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Timothee Guerin (timotheeguerin)
changed the title
This was referenced Oct 16, 2026
Timothee Guerin (timotheeguerin)
merged commit Oct 16, 2026
43581cd
into
microsoft:main
31 of 33 checks passed
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.
HTTP library consumers need consistent guidance across authentication, operation payloads, routing, metadata, and experimental helpers.
Document the public HTTP contracts together, including scheme identifiers, request/response body classification, parameter and response metadata, diagnostics, and typekit helpers. Existing HTTP semantics and API signatures are unchanged.
Consolidates 12218, 12224, 12232.
Tracked in #12228.