19 instantiations of ApiParameterDescription
Microsoft.AspNetCore.Grpc.Swagger (3)
Internal\GrpcJsonTranscodingDescriptionProvider.cs (3)
115apiDescription.ParameterDescriptions.Add(new ApiParameterDescription 137apiDescription.ParameterDescriptions.Add(new ApiParameterDescription 157apiDescription.ParameterDescriptions.Add(new ApiParameterDescription
Microsoft.AspNetCore.Mvc.ApiExplorer (4)
DefaultApiDescriptionProvider.cs (2)
288context.Results.Add(new ApiParameterDescription() 670return new ApiParameterDescription()
EndpointMetadataApiDescriptionProvider.cs (2)
143var parameterDescription = new ApiParameterDescription 188return new ApiParameterDescription
Microsoft.AspNetCore.Mvc.ApiExplorer.Test (10)
DefaultApiDescriptionProviderTest.cs (10)
2065var description = new ApiParameterDescription { Source = BindingSource.Body, }; 2079var description = new ApiParameterDescription { Source = BindingSource.Body, }; 2093var description = new ApiParameterDescription 2114var description = new ApiParameterDescription 2136var description = new ApiParameterDescription 2154var description = new ApiParameterDescription(); 2168var description = new ApiParameterDescription(); 2191var description = new ApiParameterDescription 2215var description = new ApiParameterDescription 2238var description = new ApiParameterDescription
Microsoft.AspNetCore.Mvc.NewtonsoftJson.Test (2)
JsonPatchOperationsArrayProviderTests.cs (2)
20var jsonPatchParameterDescription = new ApiParameterDescription 25var stringParameterDescription = new ApiParameterDescription
168 references to ApiParameterDescription
ApiExplorerWebSite (1)
ApiExplorerDataFilter.cs (1)
62foreach (var parameter in description.ParameterDescriptions)
Microsoft.AspNetCore.Mvc.Abstractions (6)
ApiExplorer\ApiDescription.cs (3)
31/// Gets a list of <see cref="ApiParameterDescription"/> for this api. 33public IList<ApiParameterDescription> ParameterDescriptions { get; } = new List<ApiParameterDescription>();
ApiExplorer\ApiParameterRouteInfo.cs (3)
9/// A metadata description of routing information for an <see cref="ApiParameterDescription"/>. 18/// <see cref="ApiParameterDescription.Source"/> for the data source considered. 35/// <see cref="ApiParameterDescription.Source"/> then the value may also come from the
Microsoft.AspNetCore.Mvc.ApiExplorer (13)
ApiParameterContext.cs (2)
21Results = new List<ApiParameterDescription>(); 28public IList<ApiParameterDescription> Results { get; }
DefaultApiDescriptionProvider.cs (7)
113foreach (var parameter in GetParameters(parameterContext)) 133foreach (var parameter in apiDescription.ParameterDescriptions) 162private IList<ApiParameterDescription> GetParameters(ApiParameterContext context) 248var parameter = context.Results[i]; 299foreach (var parameter in context.Results) 339foreach (var parameter in context.Results) 665private ApiParameterDescription CreateResult(
EndpointMetadataApiDescriptionProvider.cs (3)
120var parameterDescription = CreateApiParameterDescription(parameter, routeEndpoint, disableInferredBody); 143var parameterDescription = new ApiParameterDescription 171private ApiParameterDescription? CreateApiParameterDescription(IParameterBindingMetadata parameter, RouteEndpoint routeEndpoint, bool disableInferredBody)
Properties\AssemblyInfo.cs (1)
9[assembly: TypeForwardedTo(typeof(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription))]
Microsoft.AspNetCore.Mvc.ApiExplorer.Test (109)
DefaultApiDescriptionProviderTest.cs (74)
49var categoryParameter = Assert.Single(description.ParameterDescriptions, 51var groupParameter = Assert.Single(description.ParameterDescriptions, 53var anyParameter = Assert.Single(description.ParameterDescriptions, 213var parameter = Assert.Single(description.ParameterDescriptions); 259var parameter = Assert.Single(description.ParameterDescriptions); 325var parameter = Assert.Single(description.ParameterDescriptions); 341var parameterDescription = Assert.Single(description.ParameterDescriptions); 369var id = Assert.Single(parameters, p => p.Source == expected); 400var id = Assert.Single(parameters, p => p.Source == expected); 421var parameter = Assert.Single(description.ParameterDescriptions); 466var id1 = Assert.Single(description.ParameterDescriptions, p => p.Name == "id1"); 470var id2 = Assert.Single(description.ParameterDescriptions, p => p.Name == "id2"); 1355var parameter = Assert.Single(parameters, p => p.Name == "ProductId"); 1379var parameter = Assert.Single(description.ParameterDescriptions); 1399var parameter = Assert.Single(description.ParameterDescriptions); 1416var parameter = Assert.Single(description.ParameterDescriptions); 1433var parameter = Assert.Single(description.ParameterDescriptions); 1453var parameter = Assert.Single(parameters, p => p.Name == "ProductId"); 1483var parameter = Assert.Single(parameters); 1503var parameter = Assert.Single(description.ParameterDescriptions); 1549var parameter = Assert.Single(description.ParameterDescriptions); 1569var parameter = Assert.Single(parameters, p => p.Name == "ProductId"); 1596var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "Id"); 1600var product = Assert.Single(description.ParameterDescriptions, p => p.Name == "Product"); 1604var userId = Assert.Single(description.ParameterDescriptions, p => p.Name == "UserId"); 1608var comments = Assert.Single(description.ParameterDescriptions, p => p.Name == "Comments"); 1627var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "Name"); 1646var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "id"); 1665var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "id"); 1684var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "employee"); 1703var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "employee"); 1722var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "employee"); 1741var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "employee"); 1760var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "managerid"); 1764var product = Assert.Single(description.ParameterDescriptions, p => p.Name == "name"); 1784var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "Id"); 1788var product = Assert.Single(description.ParameterDescriptions, p => p.Name == "Product"); 1792var userId = Assert.Single(description.ParameterDescriptions, p => p.Name == "UserId"); 1796var comments = Assert.Single(description.ParameterDescriptions, p => p.Name == "Comments"); 1815var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "Id"); 1819var quantity = Assert.Single(description.ParameterDescriptions, p => p.Name == "Quantity"); 1823var productId = Assert.Single(description.ParameterDescriptions, p => p.Name == "Product.Id"); 1827var price = Assert.Single(description.ParameterDescriptions, p => p.Name == "Product.Price"); 1847var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "Id"); 1851var quantity = Assert.Single(description.ParameterDescriptions, p => p.Name == "Quantity"); 1855var productId = Assert.Single(description.ParameterDescriptions, p => p.Name == "Product.Id"); 1859var productPrice = Assert.Single(description.ParameterDescriptions, p => p.Name == "Product.Price"); 1882var id = Assert.Single(description.ParameterDescriptions, p => p.Name == $"{parentName}.Child.Id"); 1886var name = Assert.Single(description.ParameterDescriptions, p => p.Name == $"{parentName}.Child.Name"); 1913var id = Assert.Single(description.ParameterDescriptions, p => p.Name == $"{groupName}.{parentName}.Child.Id"); 1917var name = Assert.Single(description.ParameterDescriptions, p => p.Name == $"{groupName}.{parentName}.Child.Name"); 1936var c = Assert.Single(description.ParameterDescriptions); 1954var products = Assert.Single(description.ParameterDescriptions); 1973var items = Assert.Single(description.ParameterDescriptions); 1995var id = Assert.Single(parameters, p => p.Name == "Id"); 1999var name = Assert.Single(parameters, p => p.Name == "Name"); 2017var name = Assert.Single(description.ParameterDescriptions, p => p.Name == "Name"); 2021var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "Id"); 2040var name = Assert.Single(description.ParameterDescriptions, p => p.Name == "name"); 2044var id = Assert.Single(description.ParameterDescriptions, p => p.Name == "Id"); 2048var product = Assert.Single(description.ParameterDescriptions, p => p.Name == "Product"); 2052var userId = Assert.Single(description.ParameterDescriptions, p => p.Name == "UserId"); 2056var comments = Assert.Single(description.ParameterDescriptions, p => p.Name == "Comments"); 2065var description = new ApiParameterDescription { Source = BindingSource.Body, }; 2079var description = new ApiParameterDescription { Source = BindingSource.Body, }; 2093var description = new ApiParameterDescription 2114var description = new ApiParameterDescription 2136var description = new ApiParameterDescription 2154var description = new ApiParameterDescription(); 2168var description = new ApiParameterDescription(); 2191var description = new ApiParameterDescription 2215var description = new ApiParameterDescription 2238var description = new ApiParameterDescription 2255private static ApiParameterContext GetApiParameterContext(ApiParameterDescription description)
EndpointMetadataApiDescriptionProviderTest.cs (35)
112var apiParameterDescription = apiDescription.ParameterDescriptions[0]; 127var apiParameterDescription = apiDescription.ParameterDescriptions[0]; 662var param = Assert.Single(apiDescription.ParameterDescriptions); 677var param = Assert.Single(apiDescription.ParameterDescriptions); 691var param = Assert.Single(apiDescription.ParameterDescriptions); 705var param = Assert.Single(apiDescription.ParameterDescriptions); 726var param = Assert.Single(apiDescription.ParameterDescriptions); 747var param = Assert.Single(apiDescription.ParameterDescriptions); 761var param = Assert.Single(apiDescription.ParameterDescriptions); 775var param = Assert.Single(apiDescription.ParameterDescriptions); 797var param = Assert.Single(apiDescription.ParameterDescriptions); 812var param = Assert.Single(apiDescription.ParameterDescriptions); 840var param = Assert.Single(apiDescription.ParameterDescriptions); 856var param = Assert.Single(apiDescription.ParameterDescriptions); 866var fooParam = apiDescription.ParameterDescriptions[0]; 873var barParam = apiDescription.ParameterDescriptions[1]; 880var fromBodyParam = apiDescription.ParameterDescriptions[2]; 988var fooParam = apiDescription.ParameterDescriptions[0]; 994var barParam = apiDescription.ParameterDescriptions[1]; 1033var fooParam = apiDescription.ParameterDescriptions[0]; 1039var barParam = apiDescription.ParameterDescriptions[1]; 1052var nameParam = apiDescription.ParameterDescriptions[0]; 1291var bodyParameterDescription = parameterDescriptions.Single(); 1350var bodyParameterDescription = parameterDescriptions.Single(); 1382var bodyParameterDescription = parameterDescriptions.Single(); 1414var bodyParameterDescription = parameterDescriptions.Single(); 1442var bodyParameterDescription = parameterDescriptions.Single(); 1471var bodyParameterDescription = parameterDescriptions.Single(); 1500var bodyParameterDescription = parameterDescriptions.Single(); 1537var fromFileParam0 = apiDescription0.ParameterDescriptions[0]; 1543var fromFileParam1 = apiDescription1.ParameterDescriptions[0]; 1555var param = Assert.Single(apiDescription.ParameterDescriptions); 1588var bodyParameterDescription = parameterDescriptions.Single(); 1660var parameter = Assert.Single(apiDescription.ParameterDescriptions); 1754var parameter = Assert.Single(apiDescription.ParameterDescriptions);
Microsoft.AspNetCore.Mvc.NewtonsoftJson (1)
JsonPatchOperationsArrayProvider.cs (1)
42foreach (var parameterDescription in result.ParameterDescriptions)
Microsoft.AspNetCore.Mvc.NewtonsoftJson.Test (2)
JsonPatchOperationsArrayProviderTests.cs (2)
20var jsonPatchParameterDescription = new ApiParameterDescription 25var stringParameterDescription = new ApiParameterDescription
Microsoft.AspNetCore.OpenApi (33)
Extensions\ApiDescriptionExtensions.cs (7)
79/// Determines if the given <see cref="ApiParameterDescription" /> is a request body parameter. 81/// <param name="apiParameterDescription">The <see cref="ApiParameterDescription"/> to check. </param> 83public static bool IsRequestBodyParameter(this ApiParameterDescription apiParameterDescription) => 92/// <param name="formParameters">A list of <see cref="ApiParameterDescription"/> associated with the form parameters.</param> 94public static bool TryGetFormParameters(this ApiDescription apiDescription, out IEnumerable<ApiParameterDescription> formParameters) 104/// <param name="bodyParameter">The <see cref="ApiParameterDescription"/> associated with the body parameter.</param> 106public static bool TryGetBodyParameter(this ApiDescription apiDescription, [NotNullWhen(true)] out ApiParameterDescription? bodyParameter)
Extensions\JsonNodeSchemaExtensions.cs (2)
299/// <param name="parameterDescription">The <see cref="ApiParameterDescription"/> associated with the <see paramref="schema"/>.</param> 301internal static void ApplyParameterInfo(this JsonNode schema, ApiParameterDescription parameterDescription, JsonTypeInfo? jsonTypeInfo)
Extensions\TypeExtensions.cs (1)
75public static bool ShouldApplyNullableRequestSchema(this ApiParameterDescription apiParameterDescription)
Services\OpenApiDocumentService.cs (12)
459foreach (var parameter in description.ParameterDescriptions) 487static bool ShouldIgnoreParameter(ApiParameterDescription parameter) 506private static bool IsRequired(ApiParameterDescription parameter) 516private static string? GetParameterDescriptionFromAttribute(ApiParameterDescription parameter) 536if (description.TryGetBodyParameter(out var bodyParameter)) 554IEnumerable<ApiParameterDescription> formParameters, 596var description = parameter.Single(); 684foreach (var description in parameter) 693foreach (var description in parameter) 717ApiParameterDescription bodyParameter, 772/// This method will also check if no target type was resolved from the <see cref="ApiParameterDescription"/> 776private static Type GetTargetType(ApiDescription description, ApiParameterDescription parameter)
Services\Schemas\OpenApiSchemaService.cs (3)
230internal async Task<OpenApiSchema> GetOrCreateUnresolvedSchemaAsync(OpenApiDocument? document, Type type, IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, ApiParameterDescription? parameterDescription = null, CancellationToken cancellationToken = default) 249internal async Task<IOpenApiSchema> GetOrCreateSchemaAsync(OpenApiDocument document, Type type, IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, ApiParameterDescription? parameterDescription = null, CancellationToken cancellationToken = default) 390internal async Task ApplySchemaTransformersAsync(OpenApiDocument? document, IOpenApiSchema schema, Type type, IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, ApiParameterDescription? parameterDescription = null, CancellationToken cancellationToken = default)
Transformers\OpenApiDocumentTransformerContext.cs (2)
40/// augmented with the <see cref="ApiParameterDescription"/> information. 46public Task<OpenApiSchema> GetOrCreateSchemaAsync(Type type, ApiParameterDescription? parameterDescription = null, CancellationToken cancellationToken = default)
Transformers\OpenApiOperationTransformerContext.cs (2)
40/// augmented with the <see cref="ApiParameterDescription"/> information. 46public Task<OpenApiSchema> GetOrCreateSchemaAsync(Type type, ApiParameterDescription? parameterDescription = null, CancellationToken cancellationToken = default)
Transformers\OpenApiSchemaTransformerContext.cs (4)
24/// Gets the <see cref="ApiParameterDescription"/> associated with the target schema. 27public required ApiParameterDescription? ParameterDescription { get; init; } 64/// augmented with the <see cref="ApiParameterDescription"/> information. 70public Task<OpenApiSchema> GetOrCreateSchemaAsync(Type type, ApiParameterDescription? parameterDescription = null, CancellationToken cancellationToken = default)
Microsoft.AspNetCore.OpenApi.Tests (2)
Transformers\CustomSchemaTransformerTests.cs (2)
191var idParam = context.Description.ParameterDescriptions.FirstOrDefault(p => p.Name == "id"); 192var limitParam = context.Description.ParameterDescriptions.FirstOrDefault(p => p.Name == "limit");
Sample (1)
artifacts\obj\Sample\Release\net10.0\generated\Microsoft.AspNetCore.OpenApi.SourceGenerators\Microsoft.AspNetCore.OpenApi.SourceGenerators.XmlCommentGenerator\OpenApiXmlCommentSupport.generated.cs (1)
485foreach (var parameterDescription in context.Description.ParameterDescriptions)