Share via

RestApiOperationParameter 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 parameter.

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

Constructors

RestApiOperationParameter(String, String, Boolean, Boolean, RestApiOperationParameterLocation, Nullable<RestApiOperationParameterStyle>, String, Object, String, String, KernelJsonSchema)

Creates an instance of a RestApiOperationParameter class.

Properties

AlternativeName

The property alternative name. It can be used as an alternative name in contexts where the original name can't be used.
ArrayItemType

Type of array item for parameters of "array" type.
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.
Type

The parameter type - string, integer, number, boolean, array and object.

Applies to