Skip to content

Add metadata to the endpoints created by the MapIdentityAPI extension method. #57803

@mikekistler

Description

@mikekistler

Is there an existing issue for this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe the problem.

The MapIdentityAPIs extension method added in .NET 8 gives users an easy way to add APIs for ASP.NET Identity to their app. However, these APIs lack certain metadata to describe their functionality and features in a generated OpenAPI document. In particular

  • endpoints do not have a summary or description
  • request body properties do not have descriptions or validation information (e.g. allowed characters, min/max length for strings, formats such as email)
  • response body properties do not have descriptions

Lack of this metadata makes the APIs hard to consume both for humans and tooling such as AI-powered test generation tooling or GPT plugins.

Describe the solution you'd like

IdentityAPI endpoints should include

  • summary or description on all endpoints
  • description on all request body properties
  • validation attributes on request body properties where appropriate
  • description on all response body properties

Additional context

Lack of API metadata is more important now that ASP.NET has added support for generation of OpenAPI documents in .NET 8.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area-identityIncludes: Identity and providersenhancementThis issue represents an ask for new feature or an enhancement to an existing onefeature-identity-apis

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions