RestApiOperation Class

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Plugins.OpenApi

Assembly:: Microsoft.SemanticKernel.Plugins.OpenApi.dll

Package:: Microsoft.SemanticKernel.Plugins.OpenApi v1.20.0-alpha

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.

The REST API operation.

public sealed class RestApiOperation

type RestApiOperation = class

Public NotInheritable Class RestApiOperation

Inheritance: Object
RestApiOperation

Constructors

RestApiOperation(String, RestApiOperationServer, String, HttpMethod, String, IList<RestApiOperationParameter>, RestApiOperationPayload, IDictionary<String,RestApiOperationExpectedResponse>)

Creates an instance of a RestApiOperation class.

Properties

ContentTypeArgumentName	Gets the name of an artificial parameter to be used for indicate payload media-type if it's missing in payload metadata.
Description	The operation description.
Extensions	Additional unstructured metadata about the operation.
Id	The operation identifier.
Method	The operation method - GET, POST, PUT, DELETE.
Parameters	The operation parameters.
Path	The operation path.
Payload	The operation payload.
PayloadArgumentName	Gets the name of an artificial parameter to be used for operation having "text/plain" payload media type.
Responses	The list of possible operation responses.
Server	The server.

Methods

BuildHeaders(IDictionary<String,Object>)	Builds operation request headers.
BuildOperationUrl(IDictionary<String,Object>, Uri, Uri)	Builds operation Url.
BuildQueryString(IDictionary<String,Object>)	Builds the operation query string.

Applies to

Share via