RestApiOperationPayloadProperty 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 RestApiOperationPayloadProperty class.
public RestApiOperationPayloadProperty (string name, string type, bool isRequired, System.Collections.Generic.IList<Microsoft.SemanticKernel.Plugins.OpenApi.RestApiOperationPayloadProperty> properties, string? description = default, string? format = default, Microsoft.SemanticKernel.KernelJsonSchema? schema = default, object? defaultValue = default);new Microsoft.SemanticKernel.Plugins.OpenApi.RestApiOperationPayloadProperty : string * string * bool * System.Collections.Generic.IList<Microsoft.SemanticKernel.Plugins.OpenApi.RestApiOperationPayloadProperty> * string * string * Microsoft.SemanticKernel.KernelJsonSchema * obj -> Microsoft.SemanticKernel.Plugins.OpenApi.RestApiOperationPayloadPropertyPublic Sub New (name As String, type As String, isRequired As Boolean, properties As IList(Of RestApiOperationPayloadProperty), Optional description As String = Nothing, Optional format As String = Nothing, Optional schema As KernelJsonSchema = Nothing, Optional defaultValue As Object = Nothing)Parameters
- name
- String
The name of the property.
- type
- String
The type of the property.
- isRequired
- Boolean
A flag specifying if the property is required or not.
- properties
- IList<RestApiOperationPayloadProperty>
A list of properties for the payload property.
- description
- String
A description of the property.
- 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 schema of the payload property.
- defaultValue
- Object
The default value of the property.