Add flatten property tests for unknown type and read-only properties

[Copilot]

Plan for adding flatten property tests

• Explore repository structure and understand existing flatten-property tests
• Add test case 1: Flatten property with unknown type
  • Add model with properties?: unknown field
  • Apply @Azure.ClientGenerator.Core.Legacy.flattenProperty decorator
  • Add PUT operation with scenario
  • Add mock API definition in mockapi.ts
• Add test case 2: Flatten property with all read-only properties
  • Add SolutionProperties model with all @visibility(Lifecycle.Read) fields
  • Add Solution model with required and optional flattened properties
  • Add operation with body parameter
  • Add mock API definition in mockapi.ts
• Build and validate the changes
  • Run build to compile TypeScript
  • Run validate-scenarios to ensure spec is valid
  • Run validate-mock-apis to ensure mock APIs are correct
• Address review feedback
  • Remove unused @azure-tools/typespec-azure-core import and using global.Azure.Core
  • Add changeset for the changes
• Request code review

Summary

Successfully added two new test cases, addressed review feedback, and added a changeset documenting the feature addition.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>[Spector] Add more tests for flatten property</issue_title>
<issue_description>Add two tests under packages/azure-http-specs/specs/azure/client-generator-core/flatten-property:

1. Flatten property case for an non-model type like unknown, typespec like this:

model XXX {
  #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
  properties?: unknown;
}

@@Azure.ClientGenerator.Core.Legacy.flattenProperty(XXX.properties);

2. Flatten property case for all readOnly, typespec like this:

model SolutionProperties {
  @visibility(Lifecycle.Read)
  solutionId?: string;
  @visibility(Lifecycle.Read)
  title?: string;
  @visibility(Lifecycle.Read)
  content?: string;
}
model Solution{
  @Azure.ClientGenerator.Core.Legacy.flattenProperty
  properties: SolutionProperties;
  @Azure.ClientGenerator.Core.Legacy.flattenProperty
  propertiesOptional?: SolutionProperties;
}
op test(@body body:Solution):void;

/cc @MaryGao </issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes [Spector] Add more tests for flatten property #3711

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/Azure/typespec-azure/@azure-tools/azure-http-specs@3729

commit: 11ea991

[v-jiaodi]

@copilot add a changeset.

[Copilot]

@copilot add a changeset.

Done in commit 24ee7fd. Added changeset for the flatten property test feature.

[azure-sdk]

All changed packages have been documented.

• ✅ @azure-tools/azure-http-specs

Show changes

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

Add test cases for flatten property with unknown type and read-only properties.

[azure-sdk]

You can try these changes here

🛝 Playground	🌐 Website

[msyyc]

(1) the response body shall be wrapped with properties or propertiesOptional
(2) one little question: is there any real service use flatten pattern of this PR? If yes, pls show the link and python may need also take a look.

[v-jiaodi]

For the first point, I’ll open a PR to fix it.

properties unknown case:https://github.com/Azure/azure-rest-api-specs/blob/main/specification/eventhub/resource-manager/Microsoft.EventHub/Eventhub/models.tsp#L1608
properties readonly case: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/help/resource-manager/Microsoft.Help/Help/back-compatible.tsp#L58

[v-jiaodi]

@msyyc Please help review #4006