Fix @azureBaseType doc example to reference a real resource model#4755
Merged
Conversation
The example previously referenced non-existent spreads (AgentProperties is internal, AgentToolProperty does not exist). Replace with a compilable resource-model example that shows the decorator applied to a TrackedResource, matching actual usage in the codebase. Regenerate reference docs. Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix
Fix Jun 30, 2026
@azureBaseType doc example to reference a real resource model@azureBaseType doc example to reference a real resource model
markcowl
requested changes
Jun 30, 2026
…etype-doc-example Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
…ample spec Use ContosoApplianceDefinition, ContosoApplianceProperties, and ContosoApplianceAgent from the agent sample spec for a realistic example. Merge latest main, rebuild, regenerate docs, and format. Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
markcowl
approved these changes
Jun 30, 2026
markcowl
marked this pull request as ready for review
June 30, 2026 21:11
Contributor
|
All changed packages have been documented.
Show changes
|
commit: |
Contributor
|
You can try these changes here
|
timotheeguerin
approved these changes
Jun 30, 2026
github-actions Bot
added a commit
to XiaofeiCao/typespec-azure
that referenced
this pull request
Jul 11, 2026
Sync documentation from Azure/typespec-azure upstream main branch. Key changes included: - Add docs for new ARM linter rule `no-reserved-resource-property` (PR Azure#4842) - Add docs for new TCGC linter rule `csharp-no-url-suffix` (PR Azure#4541) - Add ARM agent base type rules docs: `arm-agent-base-type-child-resources`, `arm-agent-base-type-lifecycle-operations`, `no-override-props` - Update ARM `data-types.md`: align Agent ResponseStatus enum to PascalCase and `createdAt` to utcDateTime per ARM guidelines (PR Azure#4855) - Fix `@azureBaseType` decorator doc example (PR Azure#4755) - Improve ARM library decorators, interfaces, and models docs (PR Azure#4494) - Add TCGC `@override` path-param and `@clientLocation` type-conflict caution admonitions to howto (PR Azure#4844) - Regen Java emitter docs with default values and improved type info (PR Azure#4863) - Update Python emitter docs with new `typeddict` models mode (upstream) - Update TypeScript emitter reference docs - Update autorest and autorest-canonical emitter docs - Update azure-rulesets linter reference - Update azure-core, azure-portal-core, TCGC reference docs - Update howtos for ARM and Generate client libraries - Add release notes for 2026-06-09 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
The
@azureBaseTypedoc example referenced...AgentProperties(which isinternal) and...AgentToolProperty(which does not exist), making it non-compilable.Replaced with a valid example showing the decorator applied to a
TrackedResourcemodel, matching actual usage:lib/base-types/base-types.tsp— corrected the@exampleblockgenerated-defs/Azure.ResourceManager.BaseTypes.ts,README.md,reference/decorators.md— regenerated viapnpm regen-docs