ApiParameterDescription.IsRequired Property

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:: Microsoft.AspNetCore.Mvc.Abstractions.dll

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.0-preview.5.22303.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Applies to