Documentation

ApiMcpControllerApi
in package

ApiMcpControllerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['post' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
post()  : string
Operation post
postAsync()  : PromiseInterface
Operation postAsync
postAsyncWithHttpInfo()  : PromiseInterface
Operation postAsyncWithHttpInfo
postRequest()  : Request
Create request for operation 'post'
postWithHttpInfo()  : array<string|int, mixed>
Operation postWithHttpInfo
setHostIndex()  : void
Set the host index
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['post' => ['application/json']]

Properties

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values
mixed —

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int —

Host index

post()

Operation post

public post(string $body[, string $contentType = self::contentTypes['post'][0] ]) : string
Parameters
$body : string

body (required)

$contentType : string = self::contentTypes['post'][0]

The value for the Content-Type header. Check self::contentTypes['post'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
string —

postAsync()

Operation postAsync

public postAsync(string $body[, string $contentType = self::contentTypes['post'][0] ]) : PromiseInterface
Parameters
$body : string

(required)

$contentType : string = self::contentTypes['post'][0]

The value for the Content-Type header. Check self::contentTypes['post'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

postAsyncWithHttpInfo()

Operation postAsyncWithHttpInfo

public postAsyncWithHttpInfo(string $body[, string $contentType = self::contentTypes['post'][0] ]) : PromiseInterface
Parameters
$body : string

(required)

$contentType : string = self::contentTypes['post'][0]

The value for the Content-Type header. Check self::contentTypes['post'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

postRequest()

Create request for operation 'post'

public postRequest(string $body[, string $contentType = self::contentTypes['post'][0] ]) : Request
Parameters
$body : string

(required)

$contentType : string = self::contentTypes['post'][0]

The value for the Content-Type header. Check self::contentTypes['post'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

postWithHttpInfo()

Operation postWithHttpInfo

public postWithHttpInfo(string $body[, string $contentType = self::contentTypes['post'][0] ]) : array<string|int, mixed>
Parameters
$body : string

(required)

$contentType : string = self::contentTypes['post'][0]

The value for the Content-Type header. Check self::contentTypes['post'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of string, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

Return values
void —

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

Search results