Skip to content

[Bug]: Data plane sample in TypeSpec Azure playground should have descriptions on security schemes #2532

Description

@mikekistler

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:

Image

Reproduction

Open the TypeSpec Azure playground and select the "Azure Core Data Plane Service" sample.

Checklist

  • Follow our Code of Conduct
  • Check that this issue is about the Azure libraries for typespec. For bug in the typespec language or core libraries file it in the TypeSpec repo
  • Check that there isn't already an issue that request the same bug to avoid creating a duplicate.
  • The provided reproduction is a minimal reproducible example of the bug.

Metadata

Metadata

Labels

bugSomething isn't workingdocsImprovements or additions to documentationneeds-areatriaged:core

Type

Fields

No fields configured for Bug.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions