Skip to content

[docs-sync] Update documentation for recent code changes - #15

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs-sync/update-2026-08-19-f7c5a84f0bce726e
Draft

github-actions[bot] wants to merge 1 commit into
mainfrom
docs-sync/update-2026-08-19-f7c5a84f0bce726e

Conversation

@github-actions

Copy link
Copy Markdown

Summary

Updates documentation to reflect code changes merged in the last 7 days on Azure/typespec-azure main.

Changes

@convenientAPI and @protocolAPI decorator docs (Azure/typespec-azure#5119)

Commit 6aa25543 added a new decorator-requires-scope validation that warns when @convenientAPI or @protocolAPI is used without a java/csharp scope. These decorators are only meaningful for the Java and C# emitters — other emitters ignore them.

Updated website/src/content/docs/docs/libraries/typespec-client-generator-core/reference/decorators.md:

  • Added notes to @convenientAPI and @protocolAPI sections clarifying they require a "java" and/or "csharp" scope
  • Updated code examples to show correct scoped usage (@convenientAPI(false, "java") instead of @convenientAPI(false))

Related commits

Generated by Documentation Sync · 103.7 AIC · ⌖ 9.79 AIC · ⊞ 5.5K · ◷

…ement

These decorators are only meaningful for the java and csharp emitters.
The decorator-requires-scope validation (added in Azure#5119)
warns when they are used without a java/csharp scope. Update docs to
reflect this requirement and fix code examples to use proper scopes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants