Skip to content

[Automated][tcgc] Fix TCGC doc comments, add missing howto sections, and add Spector specs#4203

Open
tadelesh wants to merge 1 commit intomainfrom
copilot/tcgc-docs-update-20260407-6fbd3da58aa6a2ae
Open

[Automated][tcgc] Fix TCGC doc comments, add missing howto sections, and add Spector specs#4203
tadelesh wants to merge 1 commit intomainfrom
copilot/tcgc-docs-update-20260407-6fbd3da58aa6a2ae

Conversation

@tadelesh
Copy link
Copy Markdown
Member

@tadelesh tadelesh commented Apr 7, 2026

  • Fix @clientApiVersions param doc (was copied from @apiversion, described boolean instead of Enum)
  • Fix @deserializeEmptyStringAsNull example (scalar was inside model, invalid syntax)
  • Fix @markAsLro typo ('operatio' -> 'operation')
  • Remove empty @example tag from @client decorator
  • Fix @OverRide malformed comment
  • Fix @access usage in docs to use Access.internal enum instead of string
  • Add language scoping (@scope) documentation to setup guide
  • Add @responseAsBool documentation to methods guide
  • Add @clientDoc documentation to methods guide
  • Add @nextLinkVerb, @markAsPageable, @disablePageable to paging guide
  • Add @markAsLro to LRO guide
  • Add @clientApiVersions to versioning guide
  • Add @deserializeEmptyStringAsNull to types guide
  • Add Spector specs for @convenientAPI/@protocolAPI, @scope, @responseAsBool, @clientDoc
  • Create TCGC documentation knowledge base

Resolve: #4202

@github-actions
docs(tcgc): fix doc comments, add missing howto sections, add Spector…
f334842 
… specs

- Fix @clientApiVersions param doc (was copied from @apiversion, described boolean instead of Enum)
- Fix @deserializeEmptyStringAsNull example (scalar was inside model, invalid syntax)
- Fix @markAsLro typo ('operatio' -> 'operation')
- Remove empty @example tag from @client decorator
- Fix @OverRide malformed comment
- Fix @access usage in docs to use Access.internal enum instead of string
- Add language scoping (@scope) documentation to setup guide
- Add @responseAsBool documentation to methods guide
- Add @clientDoc documentation to methods guide
- Add @nextLinkVerb, @markAsPageable, @disablePageable to paging guide
- Add @markAsLro to LRO guide
- Add @clientApiVersions to versioning guide
- Add @deserializeEmptyStringAsNull to types guide
- Add Spector specs for @convenientAPI/@protocolAPI, @scope, @responseAsBool, @clientDoc
- Create TCGC documentation knowledge base

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@microsoft-github-policy-service microsoft-github-policy-service bot added eng lib:tcgc Issues for @azure-tools/typespec-client-generator-core library lib:azure-http-specs For issues/prs related to the @azure-tools/typespec-azure-http-specs package meta:website TypeSpec.io updates labels Apr 7, 2026
@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Apr 7, 2026

Open in StackBlitz

npm i https://pkg.pr.new/@azure-tools/azure-http-specs@4203

npm i https://pkg.pr.new/@azure-tools/typespec-client-generator-core@4203

commit: f334842

@azure-sdk
Copy link
Copy Markdown
Collaborator

azure-sdk commented Apr 7, 2026

All changed packages have been documented.

  • ✅ @azure-tools/azure-http-specs
  • ✅ @azure-tools/typespec-client-generator-core
Show changes

@azure-tools/typespec-client-generator-core - fix ✏️

Fix inaccurate doc comments: @clientApiVersions param description, @deserializeEmptyStringAsNull example, @markAsLro typo, @client empty example, @OverRide malformed comment.

@azure-tools/azure-http-specs - feature ✏️

Add Spector test specs for @convenientAPI/@protocolAPI, @scope, @responseAsBool, and @clientDoc decorators.

@azure-sdk
Copy link
Copy Markdown
Collaborator

azure-sdk commented Apr 7, 2026

You can try these changes here

🛝 Playground 🌐 Website

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iscai-msft iscai-msft Awaiting requested review from iscai-msft iscai-msft is a code owner

@lmazuel lmazuel Awaiting requested review from lmazuel lmazuel is a code owner

@m-nash m-nash Awaiting requested review from m-nash m-nash is a code owner

@joheredi joheredi Awaiting requested review from joheredi joheredi is a code owner

@srnagar srnagar Awaiting requested review from srnagar srnagar is a code owner

@weidongxu-microsoft weidongxu-microsoft Awaiting requested review from weidongxu-microsoft weidongxu-microsoft is a code owner

@jhendrixMSFT jhendrixMSFT Awaiting requested review from jhendrixMSFT jhendrixMSFT is a code owner

@bterlson bterlson Awaiting requested review from bterlson bterlson is a code owner

@markcowl markcowl Awaiting requested review from markcowl markcowl is a code owner

@timotheeguerin timotheeguerin Awaiting requested review from timotheeguerin timotheeguerin is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

eng lib:azure-http-specs For issues/prs related to the @azure-tools/typespec-azure-http-specs package lib:tcgc Issues for @azure-tools/typespec-client-generator-core library meta:website TypeSpec.io updates

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Automated][tcgc] Fix TCGC doc comments, add missing howto sections, and add Spector specs

2 participants

@tadelesh @azure-sdk