References Example
Reference
C
Class

ApiPlatform\OpenApi\Model\Example

class ApiPlatform\OpenApi\Model\Example
{
    public __construct(null|string $summary, null|string $description, $value, null|string $externalValue)
    public getSummary(): string
    public withSummary(string $summary): ApiPlatform\OpenApi\Model\Example
    public getDescription(): string
    public withDescription(string $description): ApiPlatform\OpenApi\Model\Example
    public getValue()
    public withValue($value): ApiPlatform\OpenApi\Model\Example
    public getExternalValue(): string
    public withExternalValue(string $externalValue): ApiPlatform\OpenApi\Model\Example
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

public __construct(null|string $summary, null|string $description, $value, null|string $externalValue)

Parameters

summarystring
descriptionstring
value
externalValuestring

getSummary

public getSummary(): string

Returns

string

withSummary

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

Parameters

summarystring

Returns

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

getDescription

public getDescription(): string

Returns

string

withDescription

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

Parameters

descriptionstring

Returns

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

getValue

public getValue()

Returns

withValue

public withValue($value): ApiPlatform\OpenApi\Model\Example

Parameters

value

Returns

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

getExternalValue

public getExternalValue(): string

Returns

string

withExternalValue

public withExternalValue(string $externalValue): ApiPlatform\OpenApi\Model\Example

Parameters

externalValuestring

Returns

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