Share via

ApiParameterRouteInfo.IsOptional Property

  • 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:
ApiParameterRouteInfo.cs
Source:
ApiParameterRouteInfo.cs
Source:
ApiParameterRouteInfo.cs

Gets a value indicating whether not a parameter is considered optional by routing.

public:
 property bool IsOptional { bool get(); void set(bool value); };
public bool IsOptional { get; set; }
member this.IsOptional : bool with get, set
Public Property IsOptional As Boolean

Property Value

Boolean

Remarks

An optional parameter is considered optional by the routing system. This does not imply that the parameter is considered optional by the action.

If the parameter uses ModelBinding for the value of Source then the value may also come from the URL query string or form data.

Applies to