ApiParameterDescription Class

A metadata description of an input to an API.

Namespace
Microsoft.AspNetCore.Mvc.ApiExplorer
Assemblies
  • Microsoft.AspNetCore.Mvc.ApiExplorer

Syntax

public class ApiParameterDescription
class Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription

Properties

Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.ModelMetadata

Gets or sets the Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.ModelMetadata.

Return type:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata
public ModelMetadata ModelMetadata { get; set; }
Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.Name

Gets or sets the name.

Return type:System.String
public string Name { get; set; }
Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.RouteInfo

Gets or sets the Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo.

Return type:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterRouteInfo
public ApiParameterRouteInfo RouteInfo { get; set; }
Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.Source

Gets or sets the Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource.

Return type:Microsoft.AspNetCore.Mvc.ModelBinding.BindingSource
public BindingSource Source { get; set; }
Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription.Type

Gets or sets the parameter type.

Return type:System.Type
public Type Type { get; set; }