ApiPlatform\JsonSchema\SchemaFactoryInterface

Factory for creating the JSON Schema document corresponding to a PHP class.

interface ApiPlatform\JsonSchema\SchemaFactoryInterface
{
    public buildSchema(string $className, string $format, string $type, null|ApiPlatform\Metadata\Operation $operation, null|ApiPlatform\JsonSchema\Schema $schema, null|array $serializerContext, bool $forceCollection): ApiPlatform\JsonSchema\Schema
}

interface ApiPlatform\JsonSchema\SchemaFactoryInterface
{
    public buildSchema(string $className, string $format, string $type, null|ApiPlatform\Metadata\Operation $operation, null|ApiPlatform\JsonSchema\Schema $schema, null|array $serializerContext, bool $forceCollection): ApiPlatform\JsonSchema\Schema
}

Methods

buildSchema

Builds the JSON Schema document corresponding to the given PHP class.

public buildSchema(string $className, string $format, string $type, null|ApiPlatform\Metadata\Operation $operation, null|ApiPlatform\JsonSchema\Schema $schema, null|array $serializerContext, bool $forceCollection): ApiPlatform\JsonSchema\Schema

public buildSchema(string $className, string $format, string $type, null|ApiPlatform\Metadata\Operation $operation, null|ApiPlatform\JsonSchema\Schema $schema, null|array $serializerContext, bool $forceCollection): ApiPlatform\JsonSchema\Schema

Parameters

className	string
format	string
type	string
operation	ApiPlatform\Metadata\Operation
schema	ApiPlatform\JsonSchema\Schema
serializerContext	array
forceCollection	bool

Returns

ApiPlatform\JsonSchema\Schema