Repository navigation
docs(spec-api): Add JSDoc for public APIs [skip chg] - #12236
Merged
Timothee Guerin (timotheeguerin) merged 6 commits intoOct 16, 2026
Merged
Timothee Guerin (timotheeguerin) merged 6 commits into
Timothee Guerin (timotheeguerin) merged 6 commits into
Conversation
commit: |
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:44
Timothee Guerin (timotheeguerin)
requested review from
catalinaperalta,
iscai-msft,
Laurent Mazuel (lmazuel) and
Mark Cowlishaw (markcowl)
as code owners
October 16, 2026 13:44
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
These documentation-only changes leave behavior unchanged, with only a minor comparison-description correction remaining.
1 open finding
What changed in this PR
Expands public contract documentation in spec-api as part of issue #12228, without changing runtime behavior or API signatures.
Changes:
- Documents request expectations, custom handlers, and multipart inputs.
- Clarifies payload resolution, streaming responses, and scenario coverage.
| File | Description |
|---|---|
| packages/spec-api/src/types.ts | Adds JSDoc for mock, resolver, and scenario contracts. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+105
to
+106
| * Expected request payload. JSON and XML are compared structurally; Buffer payloads | ||
| * are compared byte-for-byte. Multipart validation requires a custom handler. |
Timothee Guerin (timotheeguerin)
changed the title
Timothee Guerin (timotheeguerin)
merged commit Oct 16, 2026
d1bc2a6
into
microsoft:main
31 of 33 checks passed
Timothee Guerin (timotheeguerin)
deleted the
docs/jsdoc-spec-api-contracts
branch
October 16, 2026 16:08
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.
Mock authors need to know how scenarios, request coverage, matching, validation, and response helpers interact, including what body representations helpers actually accept and return.
Document the public spec API together with its resolver, coverage, and format-specific limitations. No matching or mock-server behavior changes.
Consolidates 12246.
Tracked in #12228.