Share via

RestApiOperationPayloadProperty Class

  • Reference

Definition

Namespace:
Microsoft.SemanticKernel.Plugins.OpenApi
Assembly:
Microsoft.SemanticKernel.Plugins.OpenApi.dll
Package:
Microsoft.SemanticKernel.Plugins.OpenApi v1.20.0-alpha

The REST API operation payload property.

public sealed class RestApiOperationPayloadProperty
type RestApiOperationPayloadProperty = class
Public NotInheritable Class RestApiOperationPayloadProperty
Inheritance
Object
RestApiOperationPayloadProperty

Constructors

RestApiOperationPayloadProperty(String, String, Boolean, IList<RestApiOperationPayloadProperty>, String, String, KernelJsonSchema, Object)

Creates an instance of a RestApiOperationPayloadProperty class.

Properties

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.
Type

The property type.

Applies to