ApiParameterDescription Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Mvc.ApiExplorer
Assembly:
Microsoft.AspNetCore.Mvc.ApiExplorer.dll
Assembly:
Microsoft.AspNetCore.Mvc.Abstractions.dll
Package:
Microsoft.AspNetCore.Mvc.ApiExplorer v1.0.0
Package:
Microsoft.AspNetCore.Mvc.ApiExplorer v1.1.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
ApiParameterDescription.cs
Source:
ApiParameterDescription.cs
Source:
ApiParameterDescription.cs

A metadata description of an input to an API.

public ref class ApiParameterDescription
public class ApiParameterDescription
type ApiParameterDescription = class
Public Class ApiParameterDescription
Inheritance
Object
ApiParameterDescription

Constructors

ApiParameterDescription()

Properties

BindingInfo

Gets or sets the BindingInfo.
DefaultValue

Gets or sets the default value for a parameter.
IsRequired

Gets or sets a value that determines if the parameter is required.
ModelMetadata

Gets or sets the ModelMetadata.
Name

Gets or sets the name.
ParameterDescriptor

Gets or sets the parameter descriptor.
RouteInfo

Gets or sets the ApiParameterRouteInfo.
Source

Gets or sets the BindingSource.
Type

Gets or sets the parameter type.

Applies to