20822307873

Committed 08 Jan 2026 03:35PM UTC coverage: 21.258% (-7.6%) from 28.879%

Build # 20822307873

Build Type

Pull #7658

github

Committed by

web-flow

Commit Message

Merge 7e9d13d39 into 550b7621d

Pull Request Pull Request #7658: fix(openapi): properly document list parameters

Run Details

0 of 2 new or added lines in 1 file covered. (0.0%)

14467 existing lines in 472 files now uncovered.

12215 of 57461 relevant lines covered (21.26%)

49.28 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.0

/src/JsonLd/Serializer/ErrorNormalizer.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\JsonLd\Serializer;

use ApiPlatform\State\ApiResource\Error;
use ApiPlatform\Validator\Exception\ValidationException;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

final class ErrorNormalizer implements NormalizerInterface
{
    use HydraPrefixTrait;

    public function __construct(private readonly NormalizerInterface $inner, private readonly array $defaultContext = [])
    {
    }

    public function normalize(mixed $object, ?string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
    {
        $context += $this->defaultContext;
        $normalized = $this->inner->normalize($object, $format, $context);
        $hydraPrefix = $this->getHydraPrefix($context);
        if (!$hydraPrefix) {
            return $normalized;
        }

        if ('Error' === $normalized['@type']) {
            $normalized['@type'] = 'hydra:Error';
        }

        if (isset($normalized['description'])) {
            $normalized['hydra:description'] = $normalized['description'];
            unset($normalized['description']);
        }

        if (isset($normalized['title'])) {
            $normalized['hydra:title'] = $normalized['title'];
            // this is confusing as the field is also available in the Problem Detail Json representation
            // but we don't want to repeat the title in the response, tldr: use hydra without prefix
            unset($normalized['title']);
        }

        return $normalized;
    }

    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
    {
        return $this->inner->supportsNormalization($data, $format, $context)
            && (is_a($data, Error::class) || is_a($data, ValidationException::class));
    }

    public function getSupportedTypes(?string $format): array
    {
        if (method_exists($this->inner, 'getSupportedTypes')) {
            return $this->inner->getSupportedTypes($format);
        }

        return [];
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\JsonLd\Serializer;
15
16	use ApiPlatform\State\ApiResource\Error;
17	use ApiPlatform\Validator\Exception\ValidationException;
18	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
19
20	final class ErrorNormalizer implements NormalizerInterface
21	{
22	use HydraPrefixTrait;
23
24	public function __construct(private readonly NormalizerInterface $inner, private readonly array $defaultContext = [])
25	{
UNCOV 26	}	1,529✔
27
28	public function normalize(mixed $object, ?string $format = null, array $context = []): array\|string\|int\|float\|bool\|\ArrayObject\|null
29	{
UNCOV 30	$context += $this->defaultContext;	113✔
UNCOV 31	$normalized = $this->inner->normalize($object, $format, $context);	113✔
UNCOV 32	$hydraPrefix = $this->getHydraPrefix($context);	113✔
UNCOV 33	if (!$hydraPrefix) {	113✔
34	return $normalized;	×
35	}
36
UNCOV 37	if ('Error' === $normalized['@type']) {	113✔
UNCOV 38	$normalized['@type'] = 'hydra:Error';	98✔
39	}
40
UNCOV 41	if (isset($normalized['description'])) {	113✔
UNCOV 42	$normalized['hydra:description'] = $normalized['description'];	113✔
UNCOV 43	unset($normalized['description']);	113✔
44	}
45
UNCOV 46	if (isset($normalized['title'])) {	113✔
UNCOV 47	$normalized['hydra:title'] = $normalized['title'];	113✔
48	// this is confusing as the field is also available in the Problem Detail Json representation
49	// but we don't want to repeat the title in the response, tldr: use hydra without prefix
UNCOV 50	unset($normalized['title']);	113✔
51	}
52
UNCOV 53	return $normalized;	113✔
54	}
55
56	public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
57	{
UNCOV 58	return $this->inner->supportsNormalization($data, $format, $context)	912✔
UNCOV 59	&& (is_a($data, Error::class) \|\| is_a($data, ValidationException::class));	912✔
60	}
61
62	public function getSupportedTypes(?string $format): array
63	{
UNCOV 64	if (method_exists($this->inner, 'getSupportedTypes')) {	1,424✔
UNCOV 65	return $this->inner->getSupportedTypes($format);	1,424✔
66	}
67
68	return [];	×
69	}
70	}

api-platform / core / 20822307873

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous