Skip to content

[Automated][azure-resource-manager] Fix @azureBaseType doc example to reference a real resource model #4744

Description

@github-actions

Caution

Protected files were modified in this change.
This pull request is in request_review mode and requires explicit human scrutiny before merge.

Protected files: .chronus/changes/arm-azurebasetype-doc-example-2026-06-29.md

Summary

Incremental documentation update for @azure-tools/typespec-azure-resource-manager. The only source change since the last run was the backmerge of the experimental Agent base type feature (@azureBaseType, the Agent/AgentConversation/AgentResponse templates, two new lint rules, and the agent sample). Its reference docs, rule docs, and sample were already merged with the feature, so this run corrects the one remaining inaccuracy and regenerates affected reference docs.

Changes

  • @azureBaseType doc comment (lib/base-types/base-types.tsp): the example referenced non-existent spreads (...AgentProperties is internal, ...AgentToolProperty does not exist). Replaced with a real, compilable resource-model example and clarified that the decorator targets the resource model and is applied automatically by templates like Agent.
  • reference/decorators.md: regenerated to reflect the corrected example.
  • Knowledge base updated with base-types lessons; metadata advanced to the checkout commit.

Verification

  • pnpm -r --filter "@azure-tools/typespec-azure-resource-manager..." build
  • pnpm regen-docs ✓ (no other reference drift)
  • pnpm format

The other two source commits in range were formatter-only reflows with no documentation impact.

Generated by Documentation Update Agent · 266.5 AIC · ⌖ 25 AIC · ⊞ 8K ·


Note

This was originally intended as a pull request, but the git push operation failed.

Workflow Run: View run details and download bundle artifact

The bundle file is available in the agent artifact in the workflow run linked above.

To create a pull request with the changes:

# Download the artifact from the workflow run
gh run download 28365947931 -n agent -D /tmp/agent-28365947931

# Fetch the bundle into a temporary ref, then update the local branch
git fetch /tmp/agent-28365947931/aw-docs-arm-azurebasetype-example-fix.bundle refs/heads/docs/arm-azurebasetype-example-fix:refs/bundles/create-pr-docs-arm-azurebasetype-example-fix-c0a3a0e273c0bae2-0ec65693
git update-ref refs/heads/docs/arm-azurebasetype-example-fix-c0a3a0e273c0bae2 refs/bundles/create-pr-docs-arm-azurebasetype-example-fix-c0a3a0e273c0bae2-0ec65693
git checkout docs/arm-azurebasetype-example-fix-c0a3a0e273c0bae2
# Ensure the working tree matches the updated branch
git reset --hard
# Remove the temporary bundle ref
git update-ref -d refs/bundles/create-pr-docs-arm-azurebasetype-example-fix-c0a3a0e273c0bae2-0ec65693

# Push the branch to origin
git push origin docs/arm-azurebasetype-example-fix-c0a3a0e273c0bae2

# Create the pull request
gh pr create --title '[Automated][azure-resource-manager] Fix `@azureBaseType` doc example to reference a real resource model' --base main --head docs/arm-azurebasetype-example-fix-c0a3a0e273c0bae2 --repo Azure/typespec-azure

Metadata

Metadata

Labels

agentic-workflowsIssues/PR created by github agentic workflowsdocsImprovements or additions to documentationlib:azure-resource-managerIssues for @azure-tools/typespec-azure-core librarytriaged:core

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions