class ApiPlatform\OpenApi\Model\Operation
{
public __construct(null|string $operationId, null|array $tags, null|array $responses, null|string $summary, null|string $description, null|$externalDocs, null|array $parameters, null|`<a href="/docs/main/references/OpenApi/Model/RequestBody">ApiPlatform\OpenApi\Model\RequestBody $requestBody, null|ArrayObject $callbacks, null|bool $deprecated, null|array $security, null|array $servers, array $extensionProperties)
public addResponse($response, $status): `<a href="/docs/main/references/OpenApi/Model/Operation">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, $response): `<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation
public withSummary(string $summary): ApiPlatform\OpenApi\Model\Operation
public withDescription(string $description): ApiPlatform\OpenApi\Model\Operation
public withExternalDocs($externalDocs): `<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation
public withParameters(array $parameters): ApiPlatform\OpenApi\Model\Operation
public withParameter($parameter): `<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation
public withRequestBody(null|$requestBody): `<a href="/docs/main/references/OpenApi/Model/Operation">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
}public __construct(null|string $operationId, null|array $tags, null|array $responses, null|string $summary, null|string $description, null|$externalDocs, null|array $parameters, null|`<a href="/docs/main/references/OpenApi/Model/RequestBody">ApiPlatform\OpenApi\Model\RequestBody $requestBody, null|ArrayObject $callbacks, null|bool $deprecated, null|array $security, null|array $servers, array $extensionProperties)| 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 |
public addResponse($response, $status): `<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation| response | `ApiPlatform\OpenApi\Model\Response` | |
| status |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public getOperationId(): stringstring
public getTags(): arrayarray
public getResponses(): arrayarray
public getSummary(): stringstring
public getDescription(): stringstring
public getExternalDocs(): ApiPlatform\OpenApi\Model\ExternalDocumentation<a href="/docs/main/references/OpenApi/Model/ExternalDocumentation">ApiPlatform\OpenApi\Model\ExternalDocumentation</a>
public getParameters(): arrayarray
public getRequestBody(): ApiPlatform\OpenApi\Model\RequestBody<a href="/docs/main/references/OpenApi/Model/RequestBody">ApiPlatform\OpenApi\Model\RequestBody</a>
public getCallbacks(): ArrayObjectArrayObject
public getDeprecated(): boolbool
public getSecurity(): arrayarray
public getServers(): arrayarray
public withOperationId(string $operationId): ApiPlatform\OpenApi\Model\Operation| operationId | string |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withTags(array $tags): ApiPlatform\OpenApi\Model\Operation| tags | array |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withResponses(array $responses): ApiPlatform\OpenApi\Model\Operation| responses | array |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withResponse(string|int $status, $response): `<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation| status | string int | |
| response | `ApiPlatform\OpenApi\Model\Response` |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withSummary(string $summary): ApiPlatform\OpenApi\Model\Operation| summary | string |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withDescription(string $description): ApiPlatform\OpenApi\Model\Operation| description | string |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withExternalDocs($externalDocs): `<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation| externalDocs | `ApiPlatform\OpenApi\Model\ExternalDocumentation` |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withParameters(array $parameters): ApiPlatform\OpenApi\Model\Operation| parameters | array |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withParameter($parameter): `<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation| parameter | `ApiPlatform\OpenApi\Model\Parameter` |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withRequestBody(null|$requestBody): `<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation| requestBody | `ApiPlatform\OpenApi\Model\RequestBody` |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withCallbacks(ArrayObject $callbacks): ApiPlatform\OpenApi\Model\Operation| callbacks | ArrayObject |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withDeprecated(bool $deprecated): ApiPlatform\OpenApi\Model\Operation| deprecated | bool |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withSecurity(null|array $security): ApiPlatform\OpenApi\Model\Operation| security | array |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withServers(null|array $servers): ApiPlatform\OpenApi\Model\Operation| servers | array |
<a href="/docs/main/references/OpenApi/Model/Operation">ApiPlatform\OpenApi\Model\Operation</a>
public withExtensionProperty(string $key, $value)| key | string | |
| value |
public getExtensionProperties(): arrayarray
Made with love by
Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.
Learn more