Merge 3.3

Author: soyuka

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## v3.3.7
+
+### Bug fixes
+
+* [0ed1b637a](https://github.com/api-platform/core/commit/0ed1b637a84d0860c2e014e2473b52d17de9276b) fix(metadata): wrong schema generated if openapicontext set on array (#6431)
+* [57f930c65](https://github.com/api-platform/core/commit/57f930c65cb067b1727488ba6db6188c6c5a01c6) fix(openapi): parameters can disable openapi (#6440)
+* [69b4d35b9](https://github.com/api-platform/core/commit/69b4d35b9764e36dab0484e1a7332886e1de9b2c) fix(state): provider as ParameterProviderInterface (#6430)
+* [842091ddf](https://github.com/api-platform/core/commit/842091ddf5b41c7a0d76bfbcddccff2920a84c35) fix(jsonschema): make all required properties optional in PATCH operation with 'json' format (#6394)
+* [af34e72ed](https://github.com/api-platform/core/commit/af34e72ed6bb0d5f7235fcc9c2a6c7810ba4f9c2) fix(openapi): yaml openapi export should have numeric keys as string (#6436)
+* [b42e25f2d](https://github.com/api-platform/core/commit/b42e25f2dcb5e0c1759c9482c08c9929ef86dc90) fix(state): parameter decorates main chain (#6434)
+* [c922ba3f5](https://github.com/api-platform/core/commit/c922ba3f5cf6117e85548697a982fb1cbe3dde2e) fix(symfony): check method for readonly routes (#6437)
+
 ## v3.3.6
 
 ### Bug fixes
@@ -223,6 +235,12 @@ api_platform:
         form: ['multipart/form-data']
 ```
 
+## v3.2.25
+
+### Bug fixes
+
+* [0ed1b637a](https://github.com/api-platform/core/commit/0ed1b637a84d0860c2e014e2473b52d17de9276b) fix(metadata): wrong schema generated if openapicontext set on array (#6431)
+
 ## v3.2.24
 
 ### Bug fixes

features/graphql/query.feature

@@ -664,3 +664,16 @@ Feature: GraphQL query support
     And the header "Content-Type" should be equal to "application/json"
     And the JSON node "data.dummyDifferentGraphQlSerializationGroup.name" should be equal to "Name #1"
     And the JSON node "data.dummyDifferentGraphQlSerializationGroup.title" should be equal to "Title #1"
+
+  Scenario: Call security after resolver
+    When I send the following GraphQL request:
+    """
+    {
+      getSecurityAfterResolver(id: "/security_after_resolvers/1") {
+        name
+      }
+    }
+    """
+    Then the response status code should be 200
+    And the header "Content-Type" should be equal to "application/json"
+    And the JSON node "data.getSecurityAfterResolver.name" should be equal to "test"

features/jsonld/interface_as_resource.feature

@@ -15,15 +15,15 @@ Feature: JSON-LD using interface as resource
       "code": "WONDERFUL_TAXON"
     }
     """
-    When I send a "GET" request to "/taxa/WONDERFUL_TAXON"
+    When I send a "GET" request to "/taxons/WONDERFUL_TAXON"
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
     And the JSON should be equal to:
     """
     {
       "@context": "/contexts/Taxon",
-      "@id": "/taxa/WONDERFUL_TAXON",
+      "@id": "/taxons/WONDERFUL_TAXON",
       "@type": "Taxon",
       "code": "WONDERFUL_TAXON"
     }
@@ -49,7 +49,7 @@ Feature: JSON-LD using interface as resource
       "@type": "Product",
       "code": "GREAT_PRODUCT",
       "mainTaxon": {
-        "@id": "/taxa/WONDERFUL_TAXON",
+        "@id": "/taxons/WONDERFUL_TAXON",
         "@type": "Taxon",
         "code": "WONDERFUL_TAXON"
       }

src/JsonSchema/Metadata/Property/Factory/SchemaPropertyMetadataFactory.php

@@ -19,6 +19,7 @@
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\Util\ResourceClassInfoTrait;
+use Doctrine\Common\Collections\ArrayCollection;
 use Ramsey\Uuid\UuidInterface;
 use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Uid\Ulid;
@@ -100,15 +101,21 @@ public function create(string $resourceClass, string $property, array $options =
             $propertySchema['example'] = $propertySchema['default'];
         }
 
-        // never override the following keys if at least one is already set
+        // never override the following keys if at least one is already set or if there's a custom openapi context
         if ([] === $types
             || ($propertySchema['type'] ?? $propertySchema['$ref'] ?? $propertySchema['anyOf'] ?? $propertySchema['allOf'] ?? $propertySchema['oneOf'] ?? false)
+            || ($propertyMetadata->getOpenapiContext() ?? false)
         ) {
             return $propertyMetadata->withSchema($propertySchema);
         }
 
         $valueSchema = [];
         foreach ($types as $type) {
+            // Temp fix for https://github.com/symfony/symfony/pull/52699
+            if (ArrayCollection::class === $type->getClassName()) {
+                $type = new Type($type->getBuiltinType(), $type->isNullable(), $type->getClassName(), true, $type->getCollectionKeyTypes(), $type->getCollectionValueTypes());
+            }
+
             if ($isCollection = $type->isCollection()) {
                 $keyType = $type->getCollectionKeyTypes()[0] ?? null;
                 $valueType = $type->getCollectionValueTypes()[0] ?? null;

src/JsonSchema/SchemaFactory.php

@@ -18,6 +18,7 @@
 use ApiPlatform\Metadata\CollectionOperationInterface;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Patch;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
@@ -33,6 +34,9 @@
 final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareInterface
 {
     use ResourceMetadataTrait;
+
+    private const PATCH_SCHEMA_POSTFIX = '.patch';
+
     private ?TypeFactoryInterface $typeFactory = null;
     private ?SchemaFactoryInterface $schemaFactory = null;
     // Edge case where the related resource is not readable (for example: NotExposed) but we have groups to read the whole related object
@@ -88,6 +92,12 @@ public function buildSchema(string $className, string $format = 'json', string $
             return $schema;
         }
 
+        $isJsonMergePatch = 'json' === $format && $operation instanceof Patch && Schema::TYPE_INPUT === $type;
+
+        if ($isJsonMergePatch) {
+            $definitionName .= self::PATCH_SCHEMA_POSTFIX;
+        }
+
         if (!isset($schema['$ref']) && !isset($schema['type'])) {
             $ref = Schema::VERSION_OPENAPI === $version ? '#/components/schemas/'.$definitionName : '#/definitions/'.$definitionName;
             if ($forceCollection || ('POST' !== $method && $operation instanceof CollectionOperationInterface)) {
@@ -136,7 +146,7 @@ public function buildSchema(string $className, string $format = 'json', string $
             }
 
             $normalizedPropertyName = $this->nameConverter ? $this->nameConverter->normalize($propertyName, $inputOrOutputClass, $format, $serializerContext) : $propertyName;
-            if ($propertyMetadata->isRequired()) {
+            if ($propertyMetadata->isRequired() && !$isJsonMergePatch) {
                 $definition['required'][] = $normalizedPropertyName;
             }
 

src/JsonSchema/Tests/Fixtures/DummyWithCustomOpenApiContext.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\JsonSchema\Tests\Fixtures;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#[ApiResource]
+class DummyWithCustomOpenApiContext
+{
+    #[ApiProperty(openapiContext: ['type' => 'object', 'properties' => ['alpha' => ['type' => 'integer']]])]
+    public $acme;
+}

src/JsonSchema/Tests/Metadata/Property/Factory/SchemaPropertyMetadataFactoryTest.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\JsonSchema\Tests\Metadata\Property\Factory;
 
 use ApiPlatform\JsonSchema\Metadata\Property\Factory\SchemaPropertyMetadataFactory;
+use ApiPlatform\JsonSchema\Tests\Fixtures\DummyWithCustomOpenApiContext;
 use ApiPlatform\JsonSchema\Tests\Fixtures\DummyWithEnum;
 use ApiPlatform\JsonSchema\Tests\Fixtures\Enum\IntEnumAsIdentifier;
 use ApiPlatform\Metadata\ApiProperty;
@@ -34,4 +35,18 @@ public function testEnum(): void
         $apiProperty = $schemaPropertyMetadataFactory->create(DummyWithEnum::class, 'intEnumAsIdentifier');
         $this->assertEquals(['type' => ['integer', 'null'], 'enum' => [1, 2, null]], $apiProperty->getSchema());
     }
+
+    public function testWithCustomOpenApiContext(): void
+    {
+        $resourceClassResolver = $this->createMock(ResourceClassResolverInterface::class);
+        $apiProperty = new ApiProperty(
+            builtinTypes: [new Type(builtinType: 'object', nullable: true, class: IntEnumAsIdentifier::class)],
+            openapiContext: ['type' => 'object', 'properties' => ['alpha' => ['type' => 'integer']]],
+        );
+        $decorated = $this->createMock(PropertyMetadataFactoryInterface::class);
+        $decorated->expects($this->once())->method('create')->with(DummyWithCustomOpenApiContext::class, 'acme')->willReturn($apiProperty);
+        $schemaPropertyMetadataFactory = new SchemaPropertyMetadataFactory($resourceClassResolver, $decorated);
+        $apiProperty = $schemaPropertyMetadataFactory->create(DummyWithCustomOpenApiContext::class, 'acme');
+        $this->assertEquals([], $apiProperty->getSchema());
+    }
 }

src/Metadata/GraphQl/Operation.php

@@ -41,6 +41,8 @@ public function __construct(
         protected ?array $extraArgs = null,
         protected ?array $links = null,
         protected ?bool $validateAfterResolver = null,
+        protected ?string $securityAfterResolver = null,
+        protected ?string $securityMessageAfterResolver = null,
 
         ?string $shortName = null,
         ?string $class = null,
@@ -209,4 +211,30 @@ public function withValidateAfterResolver(bool $validateAfterResolver = true): s
 
         return $self;
     }
+
+    public function getSecurityAfterResolver(): ?string
+    {
+        return $this->securityAfterResolver;
+    }
+
+    public function withSecurityAfterResolver(string $securityAfterResolver): self
+    {
+        $self = clone $this;
+        $self->securityAfterResolver = $securityAfterResolver;
+
+        return $self;
+    }
+
+    public function getSecurityMessageAfterResolver(): ?string
+    {
+        return $this->securityMessageAfterResolver;
+    }
+
+    public function withSecurityMessageAfterResolver(string $securityMessageAfterResolver): self
+    {
+        $self = clone $this;
+        $self->securityMessageAfterResolver = $securityMessageAfterResolver;
+
+        return $self;
+    }
 }

src/Metadata/GraphQl/Query.php

@@ -24,6 +24,8 @@ public function __construct(
         ?array $args = null,
         ?array $extraArgs = null,
         ?array $links = null,
+        ?string $securityAfterResolver = null,
+        ?string $securityMessageAfterResolver = null,
 
         ?string $shortName = null,
         ?string $class = null,
@@ -79,6 +81,8 @@ public function __construct(
             args: $args,
             extraArgs: $extraArgs,
             links: $links,
+            securityAfterResolver: $securityAfterResolver,
+            securityMessageAfterResolver: $securityMessageAfterResolver,
             shortName: $shortName,
             class: $class,
             paginationEnabled: $paginationEnabled,

src/Metadata/GraphQl/QueryCollection.php

@@ -25,6 +25,8 @@ public function __construct(
         ?array $args = null,
         ?array $extraArgs = null,
         ?array $links = null,
+        ?string $securityAfterResolver = null,
+        ?string $securityMessageAfterResolver = null,
 
         ?string $shortName = null,
         ?string $class = null,
@@ -80,6 +82,8 @@ public function __construct(
             args: $args,
             extraArgs: $extraArgs,
             links: $links,
+            securityAfterResolver: $securityAfterResolver,
+            securityMessageAfterResolver: $securityMessageAfterResolver,
             shortName: $shortName,
             class: $class,
             paginationEnabled: $paginationEnabled,