Skip to content

Commit f4bff29

Browse files
Copilotmarkcowl
andauthored
Fix outdated @flattenProperty link in no-openapi documentation (#3579)
The `@flattenProperty` decorator link in the no-openapi rule documentation points to a non-existent anchor. The decorator was moved to the `Azure.ClientGenerator.Core.Legacy` namespace but the link was not updated. - Updated anchor from `#@Azure.ClientGenerator.Core.flattenProperty` to `#@Azure.ClientGenerator.Core.Legacy.flattenProperty` <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>[doc] no-openapi document is out of date</issue_title> > <issue_description>The link of @flattenProperty is outdated in this document: https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-openapi/.</issue_description> > > <agent_instructions>Change the link to @flattenProperty to the actual jsdoc link in Azure.Core.Legacy namespace</agent_instructions> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > </comments> > </details> - Fixes #3575 <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/Azure/typespec-azure/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: markcowl <[email protected]>
1 parent f3d42ae commit f4bff29

File tree

1 file changed

+1
-1
lines changed
  • website/src/content/docs/docs/libraries/azure-core/rules

1 file changed

+1
-1
lines changed

website/src/content/docs/docs/libraries/azure-core/rules/no-openapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Those decorators are only meant to be read by the openapi emitters which means t
1717
| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1818
| `@example` | [See examples doc](../../../migrate-swagger/faq/x-ms-examples.mdx) |
1919
| `@extension("x-ms-examples", ` | [See examples doc](../../../migrate-swagger/faq/x-ms-examples.mdx) |
20-
| `@extension("x-ms-client-flatten", ` | Use [`@flattenProperty`](../../typespec-client-generator-core/reference/decorators.md#@Azure.ClientGenerator.Core.flattenProperty) |
20+
| `@extension("x-ms-client-flatten", ` | Use [`@flattenProperty`](../../typespec-client-generator-core/reference/decorators.md#@Azure.ClientGenerator.Core.Legacy.flattenProperty) |
2121
| `@extension("x-ms-mutability", ` | Use [`@visibility` decorator](https://typespec.io/docs/standard-library/built-in-decorators#@visibility) |
2222
| `@extension("x-ms-enum", ` | [Enum extensibility doc](../../../troubleshoot/enum-not-extensible.md) |
2323
| `@extension("x-ms-identifiers", ` | Use [`@identifiers`](../../azure-resource-manager/reference/decorators.md#@Azure.ResourceManager.identifiers) |

0 commit comments

Comments
 (0)