Share via


RestApiParameter Class

Definition

REST API parameter.

public sealed class RestApiParameter
type RestApiParameter = class
Public NotInheritable Class RestApiParameter
Inheritance
RestApiParameter

Properties

ArgumentName

The parameter argument name. If provided, the argument name will be used to search for the parameter value in function arguments. If no value is found using the argument name, the original name - Name will be used for the search instead.

DefaultValue

The default value.

Description

The parameter description.

Expand

Specifies whether arrays and objects should generate separate parameters for each array item or object property.

Format

The parameter type modifier that refines the generic parameter type to a more specific one. More details can be found at https://swagger.io/docs/specification/data-models/data-types

IsRequired

Flag specifying if the parameter is required or not.

Location

The parameter location.

Name

The parameter name.

Schema

The schema of the parameter.

Style

The parameter style - defines how multiple values are delimited.

Applies to