RestApiOperationParameter Constructor
Definition
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.
Creates an instance of a RestApiOperationParameter class.
public RestApiOperationParameter (string name, string type, bool isRequired, bool expand, Microsoft.SemanticKernel.Plugins.OpenApi.RestApiOperationParameterLocation location, Microsoft.SemanticKernel.Plugins.OpenApi.RestApiOperationParameterStyle? style = default, string? arrayItemType = default, object? defaultValue = default, string? description = default, string? format = default, Microsoft.SemanticKernel.KernelJsonSchema? schema = default);new Microsoft.SemanticKernel.Plugins.OpenApi.RestApiOperationParameter : string * string * bool * bool * Microsoft.SemanticKernel.Plugins.OpenApi.RestApiOperationParameterLocation * Nullable<Microsoft.SemanticKernel.Plugins.OpenApi.RestApiOperationParameterStyle> * string * obj * string * string * Microsoft.SemanticKernel.KernelJsonSchema -> Microsoft.SemanticKernel.Plugins.OpenApi.RestApiOperationParameterPublic Sub New (name As String, type As String, isRequired As Boolean, expand As Boolean, location As RestApiOperationParameterLocation, Optional style As Nullable(Of RestApiOperationParameterStyle) = Nothing, Optional arrayItemType As String = Nothing, Optional defaultValue As Object = Nothing, Optional description As String = Nothing, Optional format As String = Nothing, Optional schema As KernelJsonSchema = Nothing)Parameters
- name
- String
The parameter name.
- type
- String
The parameter type.
- isRequired
- Boolean
Flag specifying if the parameter is required or not.
- expand
- Boolean
Specifies whether arrays and objects should generate separate parameters for each array item or object property.
- location
- RestApiOperationParameterLocation
The parameter location.
The parameter style - defines how multiple values are delimited.
- arrayItemType
- String
Type of array item for parameters of "array" type.
- defaultValue
- Object
The parameter default value.
- description
- String
The parameter description.
- format
- String
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
- schema
- KernelJsonSchema
The parameter schema.