Description

The API definition endpoint provides metadata about available endpoints, DTOs, and types, but lacks any description or documentation information. Users who need summaries, remarks, display names or descriptions currently have to fall back to the OpenAPI specification. This change brings that information directly into the ABP API definition model, making it available to dynamic proxy generators, code generators, and API explorers without requiring an OpenAPI dependency.

Checklist

• [x ] I fully tested it as developer / designer and created unit / integration tests
• I documented it (or no need to document or I will create a separate documentation issue)

How to test it?

Usage

Default — no descriptions (backward compatible, dont overbloat if not documentation not required.)

GET /api/abp/api-definition

With descriptions

GET /api/abp/api-definition?includeDescriptions=true

With descriptions and type information

GET /api/abp/api-definition?includeDescriptions=true&includeTypes=true

• 13 new tests in AbpApiDefinitionController_Description_Tests cover:
  • Default request returns null for all description properties
  • IncludeDescriptions=true populates controller Summary, Remarks, Description, DisplayName
  • IncludeDescriptions=true populates action descriptions and return value summary
  • IncludeDescriptions=true populates parameter summaries (both ParametersOnMethod and Parameters)
  • IncludeDescriptions=true + IncludeTypes=true populates type and property descriptions
  • IncludeTypes=true without IncludeDescriptions does not populate type descriptions
  • Actions/controllers without XML docs or attributes correctly return null