References ExternalDocumentation
Reference
C
Class

ApiPlatform\OpenApi\Model\ExternalDocumentation

class ApiPlatform\OpenApi\Model\ExternalDocumentation
{
    public __construct(string $description, string $url)
    public getDescription(): string
    public getUrl(): string
    public withDescription(string $description): ApiPlatform\OpenApi\Model\ExternalDocumentation
    public withUrl(string $url): ApiPlatform\OpenApi\Model\ExternalDocumentation
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

public __construct(string $description, string $url)

Parameters

descriptionstring
urlstring

getDescription

public getDescription(): string

Returns

string

getUrl

public getUrl(): string

Returns

string

withDescription

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

Parameters

descriptionstring

Returns

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

withUrl

Parameters

urlstring

Returns

<a href="/docs/main/references/OpenApi/Model/ExternalDocumentation">ApiPlatform\OpenApi\Model\ExternalDocumentation</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