AWS ApiGateway compatibility

[MLDMoritz]

API Platform version(s) affected:
"api-platform/core": "^2.5",

Description
When I try to import the schema from http://localhost/api/docs.json?api_gateway=true to ApiGateway it errors.

How to reproduce
Create an Entity which has a normalizationGroup, get the api_gateway "compatible" json spec and try to import it.

Possible Solution
Entity name has colon in it, which API Gateway doesn't allow.

Additional Context

Error Message from APIGateway importer:

Your API was not imported due to errors in the Swagger file.
Unable to create model for 'ConfirmEmailconfirmEmail:write': Model name must be alphanumeric: ConfirmEmailconfirmEmail:write
Unable to create model for 'EmailCheck:b7add851abebff79e75557aab315cdc2emailCheck:read': Model name must be alphanumeric: EmailCheck:b7add851abebff79e75557aab315cdc2emailCheck:read
Unable to create model for 'EmailCheckemailCheck:write': Model name must be alphanumeric: EmailCheckemailCheck:write
Unable to create model for 'GenerateTokengenerateToken:write': Model name must be alphanumeric: GenerateTokengenerateToken:write
Unable to create model for 'RefreshTokenrefreshToken:write': Model name must be alphanumeric: RefreshTokenrefreshToken:write
Unable to create model for 'Register:5b4fa5b4800265236a947e59c5cd3661register:read': Model name must be alphanumeric: Register:5b4fa5b4800265236a947e59c5cd3661register:read
Unable to create model for 'Registerregister:write': Model name must be alphanumeric: Registerregister:write
Unable to create model for 'Userregister:read': Model name must be alphanumeric: Userregister:read
Unable to create model for 'Useruser:read': Model name must be alphanumeric: Useruser:read
Unable to put method 'POST' on resource at path '/api/confirm_email': Invalid model identifier specified: null
Unable to put method 'POST' on resource at path '/api/email_check': Invalid model identifier specified: null
Unable to put method 'POST' on resource at path '/api/register': Invalid model identifier specified: null
Unable to put method 'PUT' on resource at path '/api/users/{id}/change_email': Invalid model identifier specified: null
Unable to put method 'PUT' on resource at path '/api/users/{id}/change_password': Invalid model identifier specified: null
Unable to put method 'POST' on resource at path '/token/generate': Invalid model identifier specified: null
Unable to put method 'POST' on resource at path '/token/refresh': Invalid model identifier specified: null
Additionally, these warnings were found:
API Key security definition 'apiKey' has unexpected name or location. Ignoring.
Unknown or invalid reference specified by '#/definitions/ConfirmEmailconfirmEmail:write'. Ignoring.
Unknown or invalid reference specified by '#/definitions/EmailCheckemailCheck:write'. Ignoring.
Unknown or invalid reference specified by '#/definitions/Registerregister:write'. Ignoring.
Unknown or invalid reference specified by '#/definitions/RequestPasswordReset:7f546cb601bbd9e0eb1a7cfa305ea7fb'. Ignoring.
Invalid format for model application/json for method POST
Unknown or invalid reference specified by '#/definitions/Useruser:read'. Ignoring.
Unable to create model for 200 response to method 'GET /api/users': Invalid model specified: Validation Result: warnings : [], errors : [Invalid model specified: Useruser:read]
Unknown or invalid reference specified by '#/definitions/Useruser:read'. Ignoring.
Invalid format for model application/json for method GET
Unknown or invalid reference specified by '#/definitions/ChangeEmail:5bab9375ca064bc028c7d4f29f2eaf2f'. Ignoring.
Unknown or invalid reference specified by '#/definitions/ChangePassword:b12382e7dd54bc0f641b9ded532416fc'. Ignoring.
Unknown or invalid reference specified by '#/definitions/GenerateTokengenerateToken:write'. Ignoring.
Unknown or invalid reference specified by '#/definitions/RefreshTokenrefreshToken:write'. Ignoring.

[MLDMoritz]

I attached a Normalizer that somewhat works. However, it strips out security information and colons from Model names.

This probably needs a rework, it looks kind of hacky to me.

<?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\Core\Swagger\Serializer;

use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Removes features unsupported by Amazon API Gateway.
 *
 * @see https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html
 *
 * @internal
 *
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
 */
final class ApiGatewayNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
{
    public const API_GATEWAY = 'api_gateway';

    private $documentationNormalizer;
    private $defaultContext = [self::API_GATEWAY => false];

    public function __construct(NormalizerInterface $documentationNormalizer, $defaultContext = [])
    {
        $this->documentationNormalizer = $documentationNormalizer;
        $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
    }

    /**
     * {@inheritdoc}
     *
     * @throws UnexpectedValueException
     */
    public function normalize($object, $format = null, array $context = [])
    {
        $data = $this->documentationNormalizer->normalize($object, $format, $context);
        if (!\is_array($data)) {
            throw new UnexpectedValueException('Expected data to be an array');
        }

        if (!($context[self::API_GATEWAY] ?? $this->defaultContext[self::API_GATEWAY])) {
            return $data;
        }

        if (empty($data['basePath'])) {
            $data['basePath'] = '/';
        }

        unset($data['security']);
        unset($data['securityDefinitions']);

        foreach ($data['paths'] as $path => $operations) {
            foreach ($operations as $operation => $options) {
                if (isset($options['parameters'])) {
                    foreach ($options['parameters'] as $key => $parameter) {
                        if (!preg_match('/^[a-zA-Z0-9._$-]+$/', $parameter['name'])) {
                            unset($data['paths'][$path][$operation]['parameters'][$key]);
                        }
                        if (isset($parameter['schema']['$ref']) && !preg_match('/^#\/definitions\/[A-z]+$/', $parameter['schema']['$ref'])) {
                            $data['paths'][$path][$operation]['parameters'][$key]['schema']['$ref'] = str_replace(['-', ':', '_'], '', $parameter['schema']['$ref']);
                        }
                    }
                    $data['paths'][$path][$operation]['parameters'] = array_values($data['paths'][$path][$operation]['parameters']);
                }
                if (isset($options['responses'])) {
                    foreach ($options['responses'] as $statusCode => $response) {
                        if (isset($response['schema']['items']['$ref']) && !preg_match('/^#\/definitions\/[A-z]+$/', $response['schema']['items']['$ref'])) {
                            $data['paths'][$path][$operation]['responses'][$statusCode]['schema']['items']['$ref'] = str_replace(['-', ':', '_'], '', $response['schema']['items']['$ref']);
                        }
                        if (isset($response['schema']['$ref']) && !preg_match('/^#\/definitions\/[A-z]+$/', $response['schema']['$ref'])) {
                            $data['paths'][$path][$operation]['responses'][$statusCode]['schema']['$ref'] = str_replace(['-', ':', '_'], '', $response['schema']['$ref']);
                        }
                    }
                }
            }
        }

        foreach ($data['definitions'] as $definition => $options) {
            if (!isset($options['properties'])) {
                continue;
            }
            foreach ($options['properties'] as $property => $propertyOptions) {
                if (isset($propertyOptions['readOnly'])) {
                    unset($data['definitions'][$definition]['properties'][$property]['readOnly']);
                }
                if (isset($propertyOptions['$ref']) && !preg_match('/^#\/definitions\/[A-z]+$/', $propertyOptions['$ref'])) {
                    $data['definitions'][$definition]['properties'][$property]['$ref'] = str_replace(['-', ':', '_'], '', $propertyOptions['$ref']);
                }
                if (isset($propertyOptions['items']['$ref']) && !preg_match('/^#\/definitions\/[A-z]+$/', $propertyOptions['items']['$ref'])) {
                    $data['definitions'][$definition]['properties'][$property]['items']['$ref'] = str_replace(['-', ':', '_'], '', $propertyOptions['items']['$ref']);
                }
            }
        }

        // $data['definitions'] is an instance of \ArrayObject
        foreach (array_keys($data['definitions']->getArrayCopy()) as $definition) {
            if (!preg_match('/^[A-z]+$/', (string) $definition)) {
                $data['definitions'][str_replace(['-', ':', '_'], '', (string) $definition)] = $data['definitions'][$definition];
                unset($data['definitions'][$definition]);
            }
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function supportsNormalization($data, $format = null)
    {
        return $this->documentationNormalizer->supportsNormalization($data, $format);
    }

    /**
     * {@inheritdoc}
     */
    public function hasCacheableSupportsMethod(): bool
    {
        return $this->documentationNormalizer instanceof CacheableSupportsMethodInterface && $this->documentationNormalizer->hasCacheableSupportsMethod();
    }
}