Describe the bug
The OpenAPI for Azure services should have security schemes that include a description field, as this description is shown in the generated REST API documentation. Many service teams struggle to figure out how to add a description on the security scheme. The Data plane service example in the TypeSpec Azure playground currently does not illustrate how to do this:
Reproduction
Open the TypeSpec Azure playground and select the "Azure Core Data Plane Service" sample.
Checklist
Describe the bug
The OpenAPI for Azure services should have security schemes that include a
descriptionfield, as this description is shown in the generated REST API documentation. Many service teams struggle to figure out how to add a description on the security scheme. The Data plane service example in the TypeSpec Azure playground currently does not illustrate how to do this:Reproduction
Open the TypeSpec Azure playground and select the "Azure Core Data Plane Service" sample.
Checklist