ApiPlatform\OpenApi\Model\Operation

class ApiPlatform\OpenApi\Model\Operation
{
    public __construct(null|string $operationId, null|array $tags, null|array $responses, null|string $summary, null|string $description, null|ApiPlatform\OpenApi\Model\ExternalDocumentation $externalDocs, null|array $parameters, null|ApiPlatform\OpenApi\Model\RequestBody $requestBody, null|ArrayObject $callbacks, null|bool $deprecated, null|array $security, null|array $servers, array $extensionProperties)
    public addResponse(ApiPlatform\OpenApi\Model\Response $response, $status): ApiPlatform\OpenApi\Model\Operation
    public getOperationId(): string
    public getTags(): array
    public getResponses(): array
    public getSummary(): string
    public getDescription(): string
    public getExternalDocs(): ApiPlatform\OpenApi\Model\ExternalDocumentation
    public getParameters(): array
    public getRequestBody(): ApiPlatform\OpenApi\Model\RequestBody
    public getCallbacks(): ArrayObject
    public getDeprecated(): bool
    public getSecurity(): array
    public getServers(): array
    public withOperationId(string $operationId): ApiPlatform\OpenApi\Model\Operation
    public withTags(array $tags): ApiPlatform\OpenApi\Model\Operation
    public withResponses(array $responses): ApiPlatform\OpenApi\Model\Operation
    public withResponse(string|int $status, ApiPlatform\OpenApi\Model\Response $response): ApiPlatform\OpenApi\Model\Operation
    public withSummary(string $summary): ApiPlatform\OpenApi\Model\Operation
    public withDescription(string $description): ApiPlatform\OpenApi\Model\Operation
    public withExternalDocs(ApiPlatform\OpenApi\Model\ExternalDocumentation $externalDocs): ApiPlatform\OpenApi\Model\Operation
    public withParameters(array $parameters): ApiPlatform\OpenApi\Model\Operation
    public withParameter(ApiPlatform\OpenApi\Model\Parameter $parameter): ApiPlatform\OpenApi\Model\Operation
    public withRequestBody(null|ApiPlatform\OpenApi\Model\RequestBody $requestBody): ApiPlatform\OpenApi\Model\Operation
    public withCallbacks(ArrayObject $callbacks): ApiPlatform\OpenApi\Model\Operation
    public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Operation
    public withSecurity(null|array $security): ApiPlatform\OpenApi\Model\Operation
    public withServers(null|array $servers): ApiPlatform\OpenApi\Model\Operation
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

class ApiPlatform\OpenApi\Model\Operation
{
    public __construct(null|string $operationId, null|array $tags, null|array $responses, null|string $summary, null|string $description, null|ApiPlatform\OpenApi\Model\ExternalDocumentation $externalDocs, null|array $parameters, null|ApiPlatform\OpenApi\Model\RequestBody $requestBody, null|ArrayObject $callbacks, null|bool $deprecated, null|array $security, null|array $servers, array $extensionProperties)
    public addResponse(ApiPlatform\OpenApi\Model\Response $response, $status): ApiPlatform\OpenApi\Model\Operation
    public getOperationId(): string
    public getTags(): array
    public getResponses(): array
    public getSummary(): string
    public getDescription(): string
    public getExternalDocs(): ApiPlatform\OpenApi\Model\ExternalDocumentation
    public getParameters(): array
    public getRequestBody(): ApiPlatform\OpenApi\Model\RequestBody
    public getCallbacks(): ArrayObject
    public getDeprecated(): bool
    public getSecurity(): array
    public getServers(): array
    public withOperationId(string $operationId): ApiPlatform\OpenApi\Model\Operation
    public withTags(array $tags): ApiPlatform\OpenApi\Model\Operation
    public withResponses(array $responses): ApiPlatform\OpenApi\Model\Operation
    public withResponse(string|int $status, ApiPlatform\OpenApi\Model\Response $response): ApiPlatform\OpenApi\Model\Operation
    public withSummary(string $summary): ApiPlatform\OpenApi\Model\Operation
    public withDescription(string $description): ApiPlatform\OpenApi\Model\Operation
    public withExternalDocs(ApiPlatform\OpenApi\Model\ExternalDocumentation $externalDocs): ApiPlatform\OpenApi\Model\Operation
    public withParameters(array $parameters): ApiPlatform\OpenApi\Model\Operation
    public withParameter(ApiPlatform\OpenApi\Model\Parameter $parameter): ApiPlatform\OpenApi\Model\Operation
    public withRequestBody(null|ApiPlatform\OpenApi\Model\RequestBody $requestBody): ApiPlatform\OpenApi\Model\Operation
    public withCallbacks(ArrayObject $callbacks): ApiPlatform\OpenApi\Model\Operation
    public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Operation
    public withSecurity(null|array $security): ApiPlatform\OpenApi\Model\Operation
    public withServers(null|array $servers): ApiPlatform\OpenApi\Model\Operation
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

public __construct(null|string $operationId, null|array $tags, null|array $responses, null|string $summary, null|string $description, null|ApiPlatform\OpenApi\Model\ExternalDocumentation $externalDocs, null|array $parameters, null|ApiPlatform\OpenApi\Model\RequestBody $requestBody, null|ArrayObject $callbacks, null|bool $deprecated, null|array $security, null|array $servers, array $extensionProperties)

public __construct(null|string $operationId, null|array $tags, null|array $responses, null|string $summary, null|string $description, null|ApiPlatform\OpenApi\Model\ExternalDocumentation $externalDocs, null|array $parameters, null|ApiPlatform\OpenApi\Model\RequestBody $requestBody, null|ArrayObject $callbacks, null|bool $deprecated, null|array $security, null|array $servers, array $extensionProperties)

Parameters

operationId	string
tags	array
responses	array
summary	string
description	string
externalDocs	ApiPlatform\OpenApi\Model\ExternalDocumentation
parameters	array
requestBody	ApiPlatform\OpenApi\Model\RequestBody
callbacks	ArrayObject
deprecated	bool
security	array
servers	array
extensionProperties	array

addResponse

public addResponse(ApiPlatform\OpenApi\Model\Response $response, $status): ApiPlatform\OpenApi\Model\Operation

public addResponse(ApiPlatform\OpenApi\Model\Response $response, $status): ApiPlatform\OpenApi\Model\Operation

Parameters

response	ApiPlatform\OpenApi\Model\Response
status

Returns

ApiPlatform\OpenApi\Model\Operation

getOperationId

public getOperationId(): string

public getOperationId(): string

Returns

string

getTags

public getTags(): array

public getTags(): array

Returns

array

getResponses

public getResponses(): array

public getResponses(): array

Returns

array

getSummary

public getSummary(): string

public getSummary(): string

Returns

string

getDescription

public getDescription(): string

public getDescription(): string

Returns

string

getExternalDocs

public getExternalDocs(): ApiPlatform\OpenApi\Model\ExternalDocumentation

public getExternalDocs(): ApiPlatform\OpenApi\Model\ExternalDocumentation

Returns

ApiPlatform\OpenApi\Model\ExternalDocumentation

getParameters

public getParameters(): array

public getParameters(): array

Returns

array

getRequestBody

public getRequestBody(): ApiPlatform\OpenApi\Model\RequestBody

public getRequestBody(): ApiPlatform\OpenApi\Model\RequestBody

Returns

ApiPlatform\OpenApi\Model\RequestBody

getCallbacks

public getCallbacks(): ArrayObject

public getCallbacks(): ArrayObject

Returns

ArrayObject

getDeprecated

public getDeprecated(): bool

public getDeprecated(): bool

Returns

bool

getSecurity

public getSecurity(): array

public getSecurity(): array

Returns

array

getServers

public getServers(): array

public getServers(): array

Returns

array

withOperationId

public withOperationId(string $operationId): ApiPlatform\OpenApi\Model\Operation

public withOperationId(string $operationId): ApiPlatform\OpenApi\Model\Operation

Parameters

operationId

string

Returns

ApiPlatform\OpenApi\Model\Operation

withTags

public withTags(array $tags): ApiPlatform\OpenApi\Model\Operation

public withTags(array $tags): ApiPlatform\OpenApi\Model\Operation

Parameters

Returns

ApiPlatform\OpenApi\Model\Operation

withResponses

public withResponses(array $responses): ApiPlatform\OpenApi\Model\Operation

public withResponses(array $responses): ApiPlatform\OpenApi\Model\Operation

Parameters

responses

array

Returns

ApiPlatform\OpenApi\Model\Operation

withResponse

public withResponse(string|int $status, ApiPlatform\OpenApi\Model\Response $response): ApiPlatform\OpenApi\Model\Operation

public withResponse(string|int $status, ApiPlatform\OpenApi\Model\Response $response): ApiPlatform\OpenApi\Model\Operation

Parameters

status	string int
response	ApiPlatform\OpenApi\Model\Response

Returns

ApiPlatform\OpenApi\Model\Operation

withSummary

public withSummary(string $summary): ApiPlatform\OpenApi\Model\Operation

public withSummary(string $summary): ApiPlatform\OpenApi\Model\Operation

Parameters

summary

string

Returns

ApiPlatform\OpenApi\Model\Operation

withDescription

public withDescription(string $description): ApiPlatform\OpenApi\Model\Operation

public withDescription(string $description): ApiPlatform\OpenApi\Model\Operation

Parameters

description

string

Returns

ApiPlatform\OpenApi\Model\Operation

withExternalDocs

public withExternalDocs(ApiPlatform\OpenApi\Model\ExternalDocumentation $externalDocs): ApiPlatform\OpenApi\Model\Operation

public withExternalDocs(ApiPlatform\OpenApi\Model\ExternalDocumentation $externalDocs): ApiPlatform\OpenApi\Model\Operation

Parameters

externalDocs

ApiPlatform\OpenApi\Model\ExternalDocumentation

Returns

ApiPlatform\OpenApi\Model\Operation

withParameters

public withParameters(array $parameters): ApiPlatform\OpenApi\Model\Operation

public withParameters(array $parameters): ApiPlatform\OpenApi\Model\Operation

Parameters

parameters

array

Returns

ApiPlatform\OpenApi\Model\Operation

withParameter

public withParameter(ApiPlatform\OpenApi\Model\Parameter $parameter): ApiPlatform\OpenApi\Model\Operation

public withParameter(ApiPlatform\OpenApi\Model\Parameter $parameter): ApiPlatform\OpenApi\Model\Operation

Parameters

parameter

ApiPlatform\OpenApi\Model\Parameter

Returns

ApiPlatform\OpenApi\Model\Operation

withRequestBody

public withRequestBody(null|ApiPlatform\OpenApi\Model\RequestBody $requestBody): ApiPlatform\OpenApi\Model\Operation

public withRequestBody(null|ApiPlatform\OpenApi\Model\RequestBody $requestBody): ApiPlatform\OpenApi\Model\Operation

Parameters

requestBody

ApiPlatform\OpenApi\Model\RequestBody

Returns

ApiPlatform\OpenApi\Model\Operation

withCallbacks

public withCallbacks(ArrayObject $callbacks): ApiPlatform\OpenApi\Model\Operation

public withCallbacks(ArrayObject $callbacks): ApiPlatform\OpenApi\Model\Operation

Parameters

callbacks

ArrayObject

Returns

ApiPlatform\OpenApi\Model\Operation

withDeprecated

public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Operation

public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Operation

Parameters

deprecated

bool

Returns

ApiPlatform\OpenApi\Model\Operation

withSecurity

public withSecurity(null|array $security): ApiPlatform\OpenApi\Model\Operation

public withSecurity(null|array $security): ApiPlatform\OpenApi\Model\Operation

Parameters

security

array

Returns

ApiPlatform\OpenApi\Model\Operation

withServers

public withServers(null|array $servers): ApiPlatform\OpenApi\Model\Operation

public withServers(null|array $servers): ApiPlatform\OpenApi\Model\Operation

Parameters

servers

array

Returns

ApiPlatform\OpenApi\Model\Operation

withExtensionProperty

public withExtensionProperty(string $key, $value)

public withExtensionProperty(string $key, $value)

Parameters

key	string
value

Returns

getExtensionProperties

public getExtensionProperties(): array

public getExtensionProperties(): array

Returns

array