References Options
Reference
C
Class

ApiPlatform\OpenApi\Options

class ApiPlatform\OpenApi\Options
{
    public __construct(string $title, string $description, string $version, bool $oAuthEnabled, null|string $oAuthType, null|string $oAuthFlow, null|string $oAuthTokenUrl, null|string $oAuthAuthorizationUrl, null|string $oAuthRefreshUrl, array $oAuthScopes, array $apiKeys, null|string $contactName, null|string $contactUrl, null|string $contactEmail, null|string $termsOfService, null|string $licenseName, null|string $licenseUrl, bool $overrideResponses)
    public getTitle(): string
    public getDescription(): string
    public getVersion(): string
    public getOAuthEnabled(): bool
    public getOAuthType(): string
    public getOAuthFlow(): string
    public getOAuthTokenUrl(): string
    public getOAuthAuthorizationUrl(): string
    public getOAuthRefreshUrl(): string
    public getOAuthScopes(): array
    public getApiKeys(): array
    public getContactName(): string
    public getContactUrl(): string
    public getContactEmail(): string
    public getTermsOfService(): string
    public getLicenseName(): string
    public getLicenseUrl(): string
    public getOverrideResponses(): bool
}

Methods

__construct

public __construct(string $title, string $description, string $version, bool $oAuthEnabled, null|string $oAuthType, null|string $oAuthFlow, null|string $oAuthTokenUrl, null|string $oAuthAuthorizationUrl, null|string $oAuthRefreshUrl, array $oAuthScopes, array $apiKeys, null|string $contactName, null|string $contactUrl, null|string $contactEmail, null|string $termsOfService, null|string $licenseName, null|string $licenseUrl, bool $overrideResponses)

Parameters

titlestring
descriptionstring
versionstring
oAuthEnabledbool
oAuthTypestring
oAuthFlowstring
oAuthTokenUrlstring
oAuthAuthorizationUrlstring
oAuthRefreshUrlstring
oAuthScopesarray
apiKeysarray
contactNamestring
contactUrlstring
contactEmailstring
termsOfServicestring
licenseNamestring
licenseUrlstring
overrideResponsesbool

getTitle

public getTitle(): string

Returns

string

getDescription

public getDescription(): string

Returns

string

getVersion

public getVersion(): string

Returns

string

getOAuthEnabled

public getOAuthEnabled(): bool

Returns

bool

getOAuthType

public getOAuthType(): string

Returns

string

getOAuthFlow

public getOAuthFlow(): string

Returns

string

getOAuthTokenUrl

public getOAuthTokenUrl(): string

Returns

string

getOAuthAuthorizationUrl

public getOAuthAuthorizationUrl(): string

Returns

string

getOAuthRefreshUrl

public getOAuthRefreshUrl(): string

Returns

string

getOAuthScopes

public getOAuthScopes(): array

Returns

array

getApiKeys

public getApiKeys(): array

Returns

array

getContactName

public getContactName(): string

Returns

string

getContactUrl

public getContactUrl(): string

Returns

string

getContactEmail

public getContactEmail(): string

Returns

string

getTermsOfService

public getTermsOfService(): string

Returns

string

getLicenseName

public getLicenseName(): string

Returns

string

getLicenseUrl

public getLicenseUrl(): string

Returns

string

getOverrideResponses

public getOverrideResponses(): bool

Returns

bool

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