Repository navigation
docs(http): Add JSDoc for routing and metadata helpers [skip chg] - #12224
Closed
Timothee Guerin (timotheeguerin) wants to merge 4 commits into
Closed
Timothee Guerin (timotheeguerin) wants to merge 4 commits into
Timothee Guerin (timotheeguerin) wants to merge 4 commits into
Conversation
commit: |
Timothee Guerin (timotheeguerin)
changed the title
Contributor
|
All changed packages have been documented.
Show changes
|
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 preserve behavior and signatures, with no unresolved blocking issues identified.
0 open findings
What changed in this PR
Documents public HTTP helper contracts for extension authors as part of #12228, without changing runtime behavior or public signatures.
Changes:
- Clarifies explicit decorator state, inferred metadata, routing defaults, and absent values.
- Documents payload visibility, property roles, and file/part inspection contracts.
- Adds an internal changelog entry.
| File | Description |
|---|---|
| packages/http/src/route.ts | Documents route composition and URI-template helpers. |
| packages/http/src/private.decorators.ts | Documents public file and part inspection contracts. |
| packages/http/src/parameters.ts | Clarifies request resolution and method inference. |
| packages/http/src/operations.ts | Documents service resolution and endpoint comparison. |
| packages/http/src/metadata.ts | Clarifies visibility and payload transformation contracts. |
| packages/http/src/linter.ts | Describes the HTTP linter definition. |
| packages/http/src/lib.ts | Describes the HTTP library definition. |
| packages/http/src/http-property.ts | Documents metadata and body property classifications. |
| packages/http/src/decorators/shared-route.ts | Clarifies shared-route state helpers. |
| packages/http/src/decorators/route.ts | Documents route assignment and conflict handling. |
| packages/http/src/decorators.ts | Documents decorator helpers, defaults, and absent values. |
| .chronus/changes/docs-jsdoc-http-helpers-2026-9-15-12-4-20.md | Records the documentation update. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
Author
Timothee Guerin (timotheeguerin)
added a commit
that referenced
this pull request
Oct 16, 2026
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](#12218), [12224](#12224), [12232](#12232). Tracked in #12228.
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 extension authors need to know when a helper reads explicit decorator state rather than inferred operation metadata, how route fragments compose, and which source properties belong to wire metadata versus the body.
Document those boundaries, defaults and absent values, along with payload visibility and the publicly exported file/part inspection contracts. Decorator implementations inherit their existing TypeSpec reference documentation; private decorator implementations remain undocumented and unchanged. Public signatures and emitted JavaScript are unchanged.
Tracked in #12228.