7 instantiations of ApiDescription
Microsoft.AspNetCore.Grpc.Swagger (1)
Internal\GrpcJsonTranscodingDescriptionProvider.cs (1)
64var apiDescription = new ApiDescription();
Microsoft.AspNetCore.Grpc.Swagger.Tests (1)
XmlComments\XmlCommentsDocumentFilterTests.cs (1)
48return new ApiDescription
Microsoft.AspNetCore.Mvc.ApiExplorer (2)
DefaultApiDescriptionProvider.cs (1)
101var apiDescription = new ApiDescription()
EndpointMetadataApiDescriptionProvider.cs (1)
100var apiDescription = new ApiDescription
Microsoft.AspNetCore.Mvc.NewtonsoftJson.Test (1)
JsonPatchOperationsArrayProviderTests.cs (1)
30var apiDescription = new ApiDescription();
Microsoft.AspNetCore.OpenApi.Tests (2)
Extensions\ApiDescriptionExtensionsTests.cs (2)
22var apiDescription = new ApiDescription 55var apiDescription = new ApiDescription
199 references to ApiDescription
ApiExplorerWebSite (2)
ApiExplorerDataFilter.cs (2)
37foreach (var description in group.Items) 53private ApiExplorerData CreateSerializableData(ApiDescription description)
Microsoft.AspNetCore.Grpc.Swagger (3)
Internal\GrpcJsonTranscodingDescriptionProvider.cs (3)
52var apiDescription = CreateApiDescription(routeEndpoint, httpRule, methodDescriptor, pattern, verb); 62private static ApiDescription CreateApiDescription(RouteEndpoint routeEndpoint, HttpRule httpRule, MethodDescriptor methodDescriptor, string pattern, string verb) 64var apiDescription = new ApiDescription();
Microsoft.AspNetCore.Grpc.Swagger.Tests (1)
XmlComments\XmlCommentsDocumentFilterTests.cs (1)
46static ApiDescription CreateApiDescription(Type serviceType)
Microsoft.AspNetCore.Mvc.Abstractions (8)
ApiExplorer\ApiDescription.cs (1)
36/// 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 (17)
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 (4)
15/// <param name="items">A collection of <see cref="ApiDescription"/> items for this group.</param> 16public ApiDescriptionGroup(string? groupName, IReadOnlyList<ApiDescription> items) 28/// A collection of <see cref="ApiDescription"/> items for this group. 30public IReadOnlyList<ApiDescription> Items { get; }
DefaultApiDescriptionProvider.cs (3)
21/// Implements a provider of <see cref="ApiDescription"/> for actions represented 94private ApiDescription CreateApiDescription( 101var 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.ApiExplorer.Test (138)
DefaultApiDescriptionProviderTest.cs (76)
48var description = Assert.Single(descriptions); 101var description = Assert.Single(descriptions); 116var description = Assert.Single(descriptions); 131var description = Assert.Single(descriptions); 147var description = Assert.Single(descriptions); 161var description = Assert.Single(descriptions); 211var description = Assert.Single(descriptions); 257var description = Assert.Single(descriptions); 295var description = Assert.Single(descriptions); 324var description = Assert.Single(descriptions); 340var description = Assert.Single(descriptions); 366var description = Assert.Single(descriptions); 397var description = Assert.Single(descriptions); 420var description = Assert.Single(descriptions); 447var description = Assert.Single(descriptions); 465var description = Assert.Single(descriptions); 489var description = Assert.Single(descriptions); 513var description = Assert.Single(descriptions); 527var description = Assert.Single(descriptions); 545var description = Assert.Single(descriptions); 564var description = Assert.Single(descriptions); 586var description = Assert.Single(descriptions); 604var description = Assert.Single(descriptions); 620var description = Assert.Single(descriptions); 636var description = Assert.Single(descriptions); 661var description = Assert.Single(descriptions); 727var description = Assert.Single(descriptions); 837var description = Assert.Single(descriptions); 900var description = Assert.Single(descriptions); 970var description = Assert.Single(descriptions); 1040var description = Assert.Single(descriptions); 1088var description = Assert.Single(descriptions); 1113var description = Assert.Single(descriptions); 1152var description = Assert.Single(descriptions); 1176var description = Assert.Single(descriptions); 1196var description = Assert.Single(descriptions); 1228var description = Assert.Single(descriptions); 1247var description = Assert.Single(descriptions); 1261var description = Assert.Single(descriptions); 1285var description = Assert.Single(descriptions); 1303var description = Assert.Single(descriptions); 1333var description = Assert.Single(descriptions); 1350var description = Assert.Single(descriptions); 1378var description = Assert.Single(descriptions); 1397var description = Assert.Single(descriptions); 1414var description = Assert.Single(descriptions); 1431var description = Assert.Single(descriptions); 1448var description = Assert.Single(descriptions); 1480var description = Assert.Single(descriptions); 1501var description = Assert.Single(descriptions); 1519var description = Assert.Single(descriptions); 1533var description = Assert.Single(descriptions); 1547var description = Assert.Single(descriptions); 1564var description = Assert.Single(descriptions); 1593var description = Assert.Single(descriptions); 1624var description = Assert.Single(descriptions); 1643var description = Assert.Single(descriptions); 1662var description = Assert.Single(descriptions); 1681var description = Assert.Single(descriptions); 1700var description = Assert.Single(descriptions); 1719var description = Assert.Single(descriptions); 1738var description = Assert.Single(descriptions); 1757var description = Assert.Single(descriptions); 1781var description = Assert.Single(descriptions); 1812var description = Assert.Single(descriptions); 1844var description = Assert.Single(descriptions); 1875var description = Assert.Single(descriptions); 1903var description = Assert.Single(descriptions); 1934var description = Assert.Single(descriptions); 1952var description = Assert.Single(descriptions); 1971var description = Assert.Single(descriptions); 1990var description = Assert.Single(descriptions); 2015var description = Assert.Single(descriptions); 2037var description = Assert.Single(descriptions); 2262private IReadOnlyList<ApiDescription> GetApiDescriptions( 2299return new ReadOnlyCollection<ApiDescription>(context.Results);
EndpointMetadataApiDescriptionProviderTest.cs (62)
48var apiDescription = GetApiDescription(TestAction); 57var apiDescription = GetApiDescription(() => { }); 65static void AssertCustomRequestFormat(ApiDescription apiDescription) 86var apiDescription = GetApiDescription( 105var apiDescription = GetApiDescription( 120var apiDescription = GetApiDescription( 135static void AssertJsonResponse(ApiDescription apiDescription, Type expectedType) 154var apiDescription = GetApiDescription(() => "foo"); 169static void AssertVoid(ApiDescription apiDescription) 187var apiDescription = GetApiDescription( 214var apiDescription = GetApiDescription( 252var apiDescription = GetApiDescription( 280var apiDescription = GetApiDescription(Results<Created<InferredJsonClass>, BadRequest> () => 309var apiDescription = GetApiDescription( 339var apiDescription = GetApiDescription([ProducesResponseType<GenericClass<TimeSpan>>(StatusCodes.Status200OK, Description = expectedOkDescription)] 358var apiDescription = GetApiDescription([ProducesResponseType<GenericClass<TimeSpan>>(StatusCodes.Status200OK, Description = expectedOkDescription)] 377var apiDescription = GetApiDescription([ProducesResponseType<IEnumerable<TimeSpan>>(StatusCodes.Status200OK, Description = expectedOkDescription)] 396var apiDescription = GetApiDescription([ProducesResponseType<IEnumerable<TimeSpan>>(StatusCodes.Status200OK, Description = expectedOkDescription)] 425var apiDescription = GetApiDescription([ProducesResponseType<string>(StatusCodes.Status200OK, Description = "Only returned with a string")] 442var apiDescription = GetApiDescription( 490var apiDescription = GetApiDescription( 521var apiDescription = GetApiDescription(() => TypedResults.Created("https://example.com", new InferredJsonClass())); 539var apiDescription = GetApiDescription(() => TypedResults.Problem()); 553var apiDescription = GetApiDescription(() => 572var apiDescription = GetApiDescription( 600var apiDescription = GetApiDescription( 634var apiDescription = GetApiDescription( 660static void AssertPathParameter(ApiDescription apiDescription) 675static void AssertPathParameter(ApiDescription apiDescription) 689static void AssertPathParameter(ApiDescription apiDescription) 703static void AssertPathParameter(ApiDescription apiDescription, Type expectedTYpe) 724static void AssertPathParameter(ApiDescription apiDescription, Type expectedTYpe) 745static void AssertPathParameter(ApiDescription apiDescription) 759static void AssertPathParameter(ApiDescription apiDescription) 773static void AssertQueryParameter<T>(ApiDescription apiDescription) 795static void AssertBody<T>(ApiDescription apiDescription) 811var apiDescription = GetApiDescription(([FromHeader] int foo) => { }); 838static void AssertBodyParameter(ApiDescription apiDescription, string expectedName, Type expectedType) 854var apiDescription = GetApiDescription(TestActionWithDefaultValue); 863var apiDescription = GetApiDescription(([FromRoute] int foo, int bar, InferredJsonClass fromBody) => { }, httpMethods: ["POST"]); 892static void AssertParameters(ApiDescription apiDescription, string capturedName = "Foo") 943var apiDescription = GetApiDescription(([AsParameters] AsParametersWithRequiredMembers foo) => { }); 956var apiDescription = GetApiDescription(([AsParameters] AsParametersWithRequiredMembers foo) => { }); 973var apiDescription = GetApiDescription(([AsParameters] AsParametersWithRequiredMembersObliviousContext foo) => { }); 985var apiDescription = GetApiDescription(([FromRoute] int foo, int? bar) => { }); 1004var apiDescription = GetApiDescription(() => "foo", displayName: "FOO"); 1012var apiDescription = GetApiDescription([ApiExplorerSettings(IgnoreApi = true)] () => { }); 1030var apiDescription = GetApiDescription((string foo, int bar) => { }); 1049var apiDescription = GetApiDescription(([Description("The name.")] string name) => { }); 1092var apiDescription = Assert.Single(context.Results); 1117var apiDescription = Assert.Single(context.Results); 1515var apiDescription = GetApiDescription( 1532var apiDescription0 = GetApiDescription((IFormFile fromFile) => { }); 1533var apiDescription1 = GetApiDescription((IFormFile? fromFile) => { }); 1553static void AssertFormFileParameter(ApiDescription apiDescription, Type expectedType, string expectedName) 1623var apiDescription = Assert.Single(context.Results); 1659var apiDescription = Assert.Single(context.Results); 1688var apiDescription = Assert.Single(context.Results); 1719var apiDescription = Assert.Single(context.Results); 1753var apiDescription = Assert.Single(context.Results); 1766private static IList<ApiDescription> GetApiDescriptions( 1818private static ApiDescription GetApiDescription(Delegate action, string? pattern = null, string? displayName = null, IEnumerable<string>? httpMethods = null, RequestDelegateFactoryOptions? options = null) =>
Microsoft.AspNetCore.Mvc.FunctionalTests (2)
ApiExplorerTest.cs (2)
1580var apiDescription = Assert.Single<ApiDescription>(group.Items);
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.Mvc.NewtonsoftJson.Test (1)
JsonPatchOperationsArrayProviderTests.cs (1)
30var apiDescription = new ApiDescription();
Microsoft.AspNetCore.OpenApi (20)
Extensions\ApiDescriptionExtensions.cs (4)
20public static HttpMethod? GetHttpMethod(this ApiDescription apiDescription) => 43public static string MapRelativePathToItemPath(this ApiDescription apiDescription) 94public static bool TryGetFormParameters(this ApiDescription apiDescription, out IEnumerable<ApiParameterDescription> formParameters) 106public 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)
264IGrouping<string?, ApiDescription> descriptions, 272foreach (var description in descriptions) 317ApiDescription description, 337private static string? GetSummary(ApiDescription description) 340private static string? GetDescription(ApiDescription description) 343private static string? GetOperationId(ApiDescription description) 347private static HashSet<OpenApiTagReference> GetTags(ApiDescription description, OpenApiDocument document) 372ApiDescription description, 405ApiDescription apiDescription, 453ApiDescription description, 533private async Task<OpenApiRequestBody?> GetRequestBodyAsync(OpenApiDocument document, ApiDescription description, IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, CancellationToken cancellationToken) 776private 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\OpenApiOperationTransformerContext.cs (1)
22public required ApiDescription Description { get; init; }
Microsoft.AspNetCore.OpenApi.Tests (5)
Extensions\ApiDescriptionExtensionsTests.cs (2)
22var apiDescription = new ApiDescription 55var apiDescription = new ApiDescription
Services\OpenApiDocumentServiceTestsBase.cs (2)
145public static IApiDescriptionGroupCollectionProvider CreateApiDescriptionGroupCollectionProvider(IList<ApiDescription> apiDescriptions = null) 147var apiDescriptionGroup = new ApiDescriptionGroup("testGroupName", (apiDescriptions ?? Array.Empty<ApiDescription>()).AsReadOnly());
Transformers\OperationTransformerTests.cs (1)
22var apiDescription = context.Description;