Share via


RestApiPayloadProperty Class

Definition

REST API payload property.

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

Properties

ArgumentName

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

DefaultValue

The default value.

Description

The property description.

Format

The property 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 property is required or not.

Name

The property name.

Properties

The properties.

Schema

The schema of the parameter.

Applies to