2 instantiations of ApiDescription
Microsoft.AspNetCore.Mvc.ApiExplorer (2)
DefaultApiDescriptionProvider.cs (1)
102var apiDescription = new ApiDescription()
EndpointMetadataApiDescriptionProvider.cs (1)
100var apiDescription = new ApiDescription
49 references to ApiDescription
Microsoft.AspNetCore.Mvc.Abstractions (8)
ApiExplorer\ApiDescription.cs (1)
37/// Gets arbitrary metadata properties associated with the <see cref="ApiDescription"/>.
ApiExplorer\ApiDescriptionProviderContext.cs (4)
9/// A context object for <see cref="ApiDescription"/> providers. 23Results = new List<ApiDescription>(); 32/// The list of resulting <see cref="ApiDescription"/>. 34public IList<ApiDescription> Results { get; }
ApiExplorer\ApiResponseType.cs (1)
50/// If an <see cref="ApiDescription"/> has a default response, then the <see cref="StatusCode"/> property should be ignored. This response
ApiExplorer\IApiDescriptionProvider.cs (2)
9/// Defines a contract for specifying <see cref="ApiDescription"/> instances. 51/// Creates or modifies <see cref="ApiDescription"/>s.
Microsoft.AspNetCore.Mvc.ApiExplorer (18)
ApiDescriptionExtensions.cs (7)
7/// Extension methods for <see cref="ApiDescription"/>. 12/// Gets the value of a property from the <see cref="ApiDescription.Properties"/> collection 16/// <param name="apiDescription">The <see cref="ApiDescription"/>.</param> 18public static T? GetProperty<T>(this ApiDescription apiDescription) 33/// Sets the value of an property in the <see cref="ApiDescription.Properties"/> collection using 37/// <param name="apiDescription">The <see cref="ApiDescription"/>.</param> 39public static void SetProperty<T>(this ApiDescription apiDescription, T value)
ApiDescriptionGroup.cs (5)
10/// Endpoints are grouped by their <see cref="ApiDescription.GroupName"/>, which can be set 27/// <param name="items">A collection of <see cref="ApiDescription"/> items for this group.</param> 28public ApiDescriptionGroup(string? groupName, IReadOnlyList<ApiDescription> items) 40/// A collection of <see cref="ApiDescription"/> items for this group. 42public IReadOnlyList<ApiDescription> Items { get; }
DefaultApiDescriptionProvider.cs (3)
22/// Implements a provider of <see cref="ApiDescription"/> for actions represented 95private ApiDescription CreateApiDescription( 102var apiDescription = new ApiDescription()
EndpointMetadataApiDescriptionProvider.cs (2)
83private ApiDescription CreateApiDescription(RouteEndpoint routeEndpoint, string httpMethod, MethodInfo methodInfo, bool disableInferredBody) 100var apiDescription = new ApiDescription
Properties\AssemblyInfo.cs (1)
7[assembly: TypeForwardedTo(typeof(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription))]
Microsoft.AspNetCore.Mvc.NewtonsoftJson (2)
JsonPatchOperationsArrayProvider.cs (2)
13/// Implements a provider of <see cref="ApiDescription"/> to change parameters of 40foreach (var result in context.Results)
Microsoft.AspNetCore.OpenApi (21)
Extensions\ApiDescriptionExtensions.cs (4)
23public static HttpMethod? GetHttpMethod(this ApiDescription apiDescription) 68public static string MapRelativePathToItemPath(this ApiDescription apiDescription) 119public static bool TryGetFormParameters(this ApiDescription apiDescription, out IEnumerable<ApiParameterDescription> formParameters) 131public static bool TryGetBodyParameter(this ApiDescription apiDescription, [NotNullWhen(true)] out ApiParameterDescription? bodyParameter)
Extensions\TypeExtensions.cs (1)
41public static bool ShouldApplyNullableResponseSchema(this ApiResponseType apiResponseType, ApiDescription apiDescription)
Services\OpenApiDocumentService.cs (12)
273IGrouping<string?, ApiDescription> descriptions, 281foreach (var description in descriptions) 326ApiDescription description, 347private static string? GetSummary(ApiDescription description) 350private static string? GetDescription(ApiDescription description) 353private static string? GetOperationId(ApiDescription description) 357private static HashSet<OpenApiTagReference> GetTags(ApiDescription description, OpenApiDocument document) 380ApiDescription description, 417ApiDescription apiDescription, 578ApiDescription description, 658private async Task<OpenApiRequestBody?> GetRequestBodyAsync(OpenApiDocument document, ApiDescription description, IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, CancellationToken cancellationToken) 901private static Type GetTargetType(ApiDescription description, ApiParameterDescription parameter)
Services\OpenApiOptions.cs (2)
46/// A delegate to determine whether a given <see cref="ApiDescription"/> should be included in the given OpenAPI document. 48public Func<ApiDescription, bool> ShouldInclude { get; set; }
Transformers\OpenApiDocumentTransformerContext.cs (1)
28/// Each <see cref="ApiDescriptionGroup"/> contains a collection of <see cref="ApiDescription"/>
Transformers\OpenApiOperationTransformerContext.cs (1)
22public required ApiDescription Description { get; init; }