Reference
C
Class

ApiPlatform\OpenApi\Model\Link

class ApiPlatform\OpenApi\Model\Link
{
    public __construct(string $operationId, null|ArrayObject $parameters, $requestBody, string $description, null|ApiPlatform\OpenApi\Model\Server $server)
    public getOperationId(): string
    public getParameters(): ArrayObject
    public getRequestBody()
    public getDescription(): string
    public getServer(): ApiPlatform\OpenApi\Model\Server
    public withOperationId(string $operationId): ApiPlatform\OpenApi\Model\Link
    public withParameters(ArrayObject $parameters): ApiPlatform\OpenApi\Model\Link
    public withRequestBody($requestBody): ApiPlatform\OpenApi\Model\Link
    public withDescription(string $description): ApiPlatform\OpenApi\Model\Link
    public withServer($server): `<a href="/docs/main/references/OpenApi/Model/Link">ApiPlatform\OpenApi\Model\Link
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

public __construct(string $operationId, null|ArrayObject $parameters, $requestBody, string $description, null|ApiPlatform\OpenApi\Model\Server $server)

Parameters

operationIdstring
parametersArrayObject
requestBody
descriptionstring
server`ApiPlatform\OpenApi\Model\Server`

getOperationId

public getOperationId(): string

Returns

string

getParameters

public getParameters(): ArrayObject

Returns

ArrayObject

getRequestBody

public getRequestBody()

getDescription

public getDescription(): string

Returns

string

getServer

Returns

<a href="/docs/main/references/OpenApi/Model/Server">ApiPlatform\OpenApi\Model\Server</a>

withOperationId

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

Parameters

operationIdstring

Returns

<a href="/docs/main/references/OpenApi/Model/Link">ApiPlatform\OpenApi\Model\Link</a>

withParameters

public withParameters(ArrayObject $parameters): ApiPlatform\OpenApi\Model\Link

Parameters

parametersArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/Link">ApiPlatform\OpenApi\Model\Link</a>

withRequestBody

public withRequestBody($requestBody): ApiPlatform\OpenApi\Model\Link

Parameters

requestBody

Returns

<a href="/docs/main/references/OpenApi/Model/Link">ApiPlatform\OpenApi\Model\Link</a>

withDescription

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

Parameters

descriptionstring

Returns

<a href="/docs/main/references/OpenApi/Model/Link">ApiPlatform\OpenApi\Model\Link</a>

withServer

Parameters

server`ApiPlatform\OpenApi\Model\Server`

Returns

<a href="/docs/main/references/OpenApi/Model/Link">ApiPlatform\OpenApi\Model\Link</a>

withExtensionProperty

public withExtensionProperty(string $key, $value)

Parameters

keystring
value

Returns

getExtensionProperties

public getExtensionProperties(): array

Returns

array

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

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop