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)
    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
}

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)
    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
}

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)

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)

Parameters

title	string
description	string
version	string
oAuthEnabled	bool
oAuthType	string
oAuthFlow	string
oAuthTokenUrl	string
oAuthAuthorizationUrl	string
oAuthRefreshUrl	string
oAuthScopes	array
apiKeys	array
contactName	string
contactUrl	string
contactEmail	string
termsOfService	string
licenseName	string
licenseUrl	string

getTitle

public getTitle(): string

public getTitle(): string

Returns

string

getDescription

public getDescription(): string

public getDescription(): string

Returns

string

getVersion

public getVersion(): string

public getVersion(): string

Returns

string

getOAuthEnabled

public getOAuthEnabled(): bool

public getOAuthEnabled(): bool

Returns

bool

getOAuthType

public getOAuthType(): string

public getOAuthType(): string

Returns

string

getOAuthFlow

public getOAuthFlow(): string

public getOAuthFlow(): string

Returns

string

getOAuthTokenUrl

public getOAuthTokenUrl(): string

public getOAuthTokenUrl(): string

Returns

string

getOAuthAuthorizationUrl

public getOAuthAuthorizationUrl(): string

public getOAuthAuthorizationUrl(): string

Returns

string

getOAuthRefreshUrl

public getOAuthRefreshUrl(): string

public getOAuthRefreshUrl(): string

Returns

string

getOAuthScopes

public getOAuthScopes(): array

public getOAuthScopes(): array

Returns

array

getApiKeys

public getApiKeys(): array

public getApiKeys(): array

Returns

array

getContactName

public getContactName(): string

public getContactName(): string

Returns

string

getContactUrl

public getContactUrl(): string

public getContactUrl(): string

Returns

string

getContactEmail

public getContactEmail(): string

public getContactEmail(): string

Returns

string

getTermsOfService

public getTermsOfService(): string

public getTermsOfService(): string

Returns

string

getLicenseName

public getLicenseName(): string

public getLicenseName(): string

Returns

string

getLicenseUrl

public getLicenseUrl(): string

public getLicenseUrl(): string

Returns

string