ApiParameterDescription.IsRequired Property

Definition

Namespace:

Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

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

public:
 property bool IsRequired { bool get(); void set(bool value); };

public bool IsRequired { get; set; }

member this.IsRequired : bool with get, set

Public Property IsRequired As Boolean

Property Value

Boolean

Remarks

A parameter is considered required if

• it's bound from the request body (Body).
• it's a required route value.
• it has annotations (e.g. BindRequiredAttribute) that indicate it's required.