ApiPlatform\JsonSchema\Schema

See also

• https://json-schema.org/latest/json-schema-core.html

• https://github.com/OAI/OpenAPI-Specification

Methods

__construct

public __construct(string $version)

Parameters

getVersion

The flavor used for this document: JSON Schema, OpenAPI v2 or OpenAPI v3.

public getVersion(): string

Returns

string

getArrayCopy

public getArrayCopy(bool $includeDefinitions): array

Parameters

Returns

array

getDefinitions

Retrieves the definitions used by this schema.

public getDefinitions(): ArrayObject

Returns

ArrayObject

setDefinitions

Associates existing definitions to this schema.

public setDefinitions(ArrayObject $definitions): null

Parameters

Returns

null

getRootDefinitionKey

Returns the name of the root definition, if defined.

public getRootDefinitionKey(): string

Returns

string

getItemsDefinitionKey

Returns the name of the items definition, if defined.

public getItemsDefinitionKey(): string

Returns

string

isDefined

Checks if this schema is initialized.

public isDefined(): bool

Returns

bool