Repository navigation
docs(openapi3): Add JSDoc for public APIs [skip chg] - #12229
Merged
Timothee Guerin (timotheeguerin) merged 7 commits intoOct 16, 2026
Merged
Timothee Guerin (timotheeguerin) merged 7 commits into
Timothee Guerin (timotheeguerin) merged 7 commits into
Conversation
microsoft-github-policy-service
Bot
added
the
emitter:openapi3
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: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 clarify existing contracts, with no unresolved findings.
0 open findings
What changed in this PR
Improves public OpenAPI type documentation as part of #12228, without changing runtime behavior or API signatures.
Changes:
- Clarifies API versions versus OpenAPI specification versions.
- Documents reusable components, operations, responses, and examples.
- Explains reference siblings, security overrides, and server substitutions.
| File | Description |
|---|---|
| packages/openapi3/src/types.ts | Adds and corrects JSDoc for public OpenAPI types and members. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
microsoft-github-policy-service
Bot
added
the
openapi3:converter
Timothee Guerin (timotheeguerin)
changed the title
This was referenced Oct 16, 2026
Timothee Guerin (timotheeguerin)
merged commit Oct 16, 2026
4a69775
into
microsoft:main
31 of 33 checks passed
Timothee Guerin (timotheeguerin)
deleted the
docs/jsdoc-openapi3-documents
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.
OpenAPI tooling consumers need to distinguish component keys from wire names and understand references, schema constraints, version-specific overlays, and emission/conversion results.
Document the public OpenAPI 3 APIs together, including document/component contracts and the 3.1/3.2 additions. This improves the reference without changing schemas, emitted documents, or public signatures.
Consolidates 12237, 12241, 12253.
Tracked in #12228.