8 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 (3)
Extensions\ApiDescriptionExtensionsTests.cs (3)
22var apiDescription = new ApiDescription 47var apiDescription = new ApiDescription 65var apiDescription = new ApiDescription
191 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 (131)
DefaultApiDescriptionProviderTest.cs (75)
49var description = Assert.Single(descriptions); 102var description = Assert.Single(descriptions); 117var description = Assert.Single(descriptions); 132var description = Assert.Single(descriptions); 148var description = Assert.Single(descriptions); 162var description = Assert.Single(descriptions); 212var description = Assert.Single(descriptions); 258var description = Assert.Single(descriptions); 296var description = Assert.Single(descriptions); 325var description = Assert.Single(descriptions); 341var description = Assert.Single(descriptions); 367var description = Assert.Single(descriptions); 398var description = Assert.Single(descriptions); 421var description = Assert.Single(descriptions); 448var description = Assert.Single(descriptions); 466var description = Assert.Single(descriptions); 490var description = Assert.Single(descriptions); 514var description = Assert.Single(descriptions); 528var description = Assert.Single(descriptions); 546var description = Assert.Single(descriptions); 565var description = Assert.Single(descriptions); 587var description = Assert.Single(descriptions); 605var description = Assert.Single(descriptions); 621var description = Assert.Single(descriptions); 637var description = Assert.Single(descriptions); 662var description = Assert.Single(descriptions); 728var description = Assert.Single(descriptions); 838var description = Assert.Single(descriptions); 901var description = Assert.Single(descriptions); 971var description = Assert.Single(descriptions); 1041var description = Assert.Single(descriptions); 1089var description = Assert.Single(descriptions); 1114var description = Assert.Single(descriptions); 1153var description = Assert.Single(descriptions); 1177var description = Assert.Single(descriptions); 1197var description = Assert.Single(descriptions); 1229var description = Assert.Single(descriptions); 1248var description = Assert.Single(descriptions); 1262var description = Assert.Single(descriptions); 1286var description = Assert.Single(descriptions); 1304var description = Assert.Single(descriptions); 1334var description = Assert.Single(descriptions); 1351var description = Assert.Single(descriptions); 1379var description = Assert.Single(descriptions); 1398var description = Assert.Single(descriptions); 1415var description = Assert.Single(descriptions); 1432var description = Assert.Single(descriptions); 1449var description = Assert.Single(descriptions); 1481var description = Assert.Single(descriptions); 1502var description = Assert.Single(descriptions); 1520var description = Assert.Single(descriptions); 1534var description = Assert.Single(descriptions); 1551var description = Assert.Single(descriptions); 1580var description = Assert.Single(descriptions); 1611var description = Assert.Single(descriptions); 1630var description = Assert.Single(descriptions); 1649var description = Assert.Single(descriptions); 1668var description = Assert.Single(descriptions); 1687var description = Assert.Single(descriptions); 1706var description = Assert.Single(descriptions); 1725var description = Assert.Single(descriptions); 1744var description = Assert.Single(descriptions); 1768var description = Assert.Single(descriptions); 1799var description = Assert.Single(descriptions); 1831var description = Assert.Single(descriptions); 1862var description = Assert.Single(descriptions); 1890var description = Assert.Single(descriptions); 1921var description = Assert.Single(descriptions); 1939var description = Assert.Single(descriptions); 1958var description = Assert.Single(descriptions); 1977var description = Assert.Single(descriptions); 2002var description = Assert.Single(descriptions); 2024var description = Assert.Single(descriptions); 2249private IReadOnlyList<ApiDescription> GetApiDescriptions( 2286return new ReadOnlyCollection<ApiDescription>(context.Results);
EndpointMetadataApiDescriptionProviderTest.cs (56)
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( 340var apiDescription = GetApiDescription( 388var apiDescription = GetApiDescription( 419var apiDescription = GetApiDescription(() => TypedResults.Created("https://example.com", new InferredJsonClass())); 437var apiDescription = GetApiDescription(() => TypedResults.Problem()); 451var apiDescription = GetApiDescription(() => 470var apiDescription = GetApiDescription( 498var apiDescription = GetApiDescription( 532static void AssertPathParameter(ApiDescription apiDescription) 547static void AssertPathParameter(ApiDescription apiDescription) 561static void AssertPathParameter(ApiDescription apiDescription) 575static void AssertPathParameter(ApiDescription apiDescription, Type expectedTYpe) 596static void AssertPathParameter(ApiDescription apiDescription, Type expectedTYpe) 617static void AssertPathParameter(ApiDescription apiDescription) 631static void AssertPathParameter(ApiDescription apiDescription) 645static void AssertQueryParameter<T>(ApiDescription apiDescription) 667static void AssertBody<T>(ApiDescription apiDescription) 683var apiDescription = GetApiDescription(([FromHeader] int foo) => { }); 708static void AssertBodyParameter(ApiDescription apiDescription, string expectedName, Type expectedType) 724var apiDescription = GetApiDescription(TestActionWithDefaultValue); 733var apiDescription = GetApiDescription(([FromRoute] int foo, int bar, InferredJsonClass fromBody) => { }, httpMethods: ["POST"]); 762static void AssertParameters(ApiDescription apiDescription, string capturedName = "Foo") 813var apiDescription = GetApiDescription(([AsParameters] AsParametersWithRequiredMembers foo) => { }); 826var apiDescription = GetApiDescription(([AsParameters] AsParametersWithRequiredMembers foo) => { }); 843var apiDescription = GetApiDescription(([AsParameters] AsParametersWithRequiredMembersObliviousContext foo) => { }); 855var apiDescription = GetApiDescription(([FromRoute] int foo, int? bar) => { }); 874var apiDescription = GetApiDescription(() => "foo", displayName: "FOO"); 882var apiDescription = GetApiDescription([ApiExplorerSettings(IgnoreApi = true)] () => { }); 900var apiDescription = GetApiDescription((string foo, int bar) => { }); 919var apiDescription = GetApiDescription(([Description("The name.")] string name) => { }); 962var apiDescription = Assert.Single(context.Results); 987var apiDescription = Assert.Single(context.Results); 1385var apiDescription = GetApiDescription( 1402var apiDescription0 = GetApiDescription((IFormFile fromFile) => { }); 1403var apiDescription1 = GetApiDescription((IFormFile? fromFile) => { }); 1423static void AssertFormFileParameter(ApiDescription apiDescription, Type expectedType, string expectedName) 1493var apiDescription = Assert.Single(context.Results); 1529var apiDescription = Assert.Single(context.Results); 1558var apiDescription = Assert.Single(context.Results); 1589var apiDescription = Assert.Single(context.Results); 1623var apiDescription = Assert.Single(context.Results); 1636private static IList<ApiDescription> GetApiDescriptions( 1688private 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 (18)
Extensions\ApiDescriptionExtensions.cs (4)
20public static OperationType GetOperationType(this ApiDescription apiDescription) => 42public static string MapRelativePathToItemPath(this ApiDescription apiDescription) 93public static bool TryGetFormParameters(this ApiDescription apiDescription, out IEnumerable<ApiParameterDescription> formParameters) 105public static bool TryGetBodyParameter(this ApiDescription apiDescription, [NotNullWhen(true)] out ApiParameterDescription? bodyParameter)
Services\OpenApiDocumentService.cs (12)
257IGrouping<string?, ApiDescription> descriptions, 265foreach (var description in descriptions) 303ApiDescription description, 323private static string? GetSummary(ApiDescription description) 326private static string? GetDescription(ApiDescription description) 329private static string? GetOperationId(ApiDescription description) 333private static HashSet<OpenApiTagReference> GetTags(ApiDescription description, OpenApiDocument document) 358ApiDescription description, 391ApiDescription apiDescription, 432ApiDescription description, 501private async Task<OpenApiRequestBody?> GetRequestBodyAsync(OpenApiDocument document, ApiDescription description, IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, CancellationToken cancellationToken) 723private static Type GetTargetType(ApiDescription description, ApiParameterDescription parameter)
Services\OpenApiOptions.cs (2)
48/// A delegate to determine whether a given <see cref="ApiDescription"/> should be included in the given OpenAPI document. 50public Func<ApiDescription, bool> ShouldInclude { get; set; }
Microsoft.AspNetCore.OpenApi.Tests (6)
Extensions\ApiDescriptionExtensionsTests.cs (3)
22var apiDescription = new ApiDescription 47var apiDescription = new ApiDescription 65var 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)
23var apiDescription = context.Description;