Merge 3.2

Author: soyuka

core/bootstrap.md

@@ -57,6 +57,7 @@ use ApiPlatform\JsonLd\Serializer\ObjectNormalizer as JsonLdObjectNormalizer;
 use ApiPlatform\JsonLd\ContextBuilder as JsonLdContextBuilder;
 use ApiPlatform\JsonSchema\SchemaFactory;
 use ApiPlatform\JsonSchema\TypeFactory;
+use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\CollectionOperationInterface;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Operation;
@@ -257,7 +258,7 @@ $providerCollection = new class implements ContainerInterface {
     }
 
     public function has($id): bool {
-        return isset($this->providers['id']);
+        return isset($this->providers[$id]);
     }
 };
 $stateProviders = new CallableProvider($providerCollection);
@@ -289,6 +290,12 @@ class Validator implements ValidatorInterface {
 $validator = new Validator(Validation::createValidator());
 $validateListener = new ValidateListener($validator, $resourceMetadataFactory);
 
+#[ApiResource(provider: \BookProvider::class)]
+class Book
+{
+    public int $id;
+}
+
 class BookProvider implements ProviderInterface
 {
     public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null

core/content-negotiation.md

@@ -121,7 +121,7 @@ this configuration might disable the `json` or the `html` on this resource for e
 
 You can specify different accepted formats at operation level too, it's especially convenient to configure formats available for the `PATCH` method:
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -178,7 +178,7 @@ resources:
 </resources>
 ```
 
-[/codeSelector]
+</code-selector>
 
 ## Supporting Custom Formats
 
@@ -237,9 +237,9 @@ final class CustomItemNormalizer implements NormalizerInterface, DenormalizerInt
         $this->normalizer = $normalizer;
     }
 
-    public function denormalize($data, $class, $format = null, array $context = [])
+    public function denormalize($data, $type, $format = null, array $context = [])
     {
-        return $this->normalizer->denormalize($data, $class, $format, $context);
+        return $this->normalizer->denormalize($data, $type, $format, $context);
     }
 
     public function supportsDenormalization($data, $type, $format = null)

core/controllers.md

@@ -85,7 +85,7 @@ the client.
 
 The routing has not been configured yet because we will add it at the resource configuration level:
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -143,7 +143,7 @@ resources:
 </resources>
 ```
 
-[/codeSelector]
+</code-selector>
 
 It is mandatory to set the `method`, `uriTemplate` and `controller` attributes. They allow API Platform to configure the routing path and
 the associated controller respectively.
@@ -158,7 +158,7 @@ To avoid that, API Platform provides the `ApiPlatform\Action\PlaceholderAction`
 
 You just need to set the `controller` attribute with this class. Here, the previous example updated:
 
-[codeSelector]
+<code-selector>
 
 ```php
 // api/src/Entity/Book.php
@@ -215,13 +215,13 @@ resources:
 </resources>
 ```
 
-[/codeSelector]
+</code-selector>
 
 ## Using Serialization Groups
 
 You may want different serialization groups for your custom operations. Just configure the proper `normalizationContext` and/or `denormalizationContext` in your operation:
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -292,14 +292,14 @@ resources:
 </resources>
 ```
 
-[/codeSelector]
+</code-selector>
 
 ## Retrieving the Entity
 
 If you want to bypass the automatic retrieval of the entity in your custom operation, you can set `read: false` in the
 operation attribute:
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -357,7 +357,7 @@ resources:
 </resources>
 ```
 
-[/codeSelector]
+</code-selector>
 
 This way, it will skip the `ReadListener`. You can do the same for some other built-in listeners. See [Built-in Event Listeners](events.md#built-in-event-listeners)
 for more information.
@@ -377,7 +377,7 @@ for `book_post_discontinuation` when neither `method` nor `routeName` attributes
 
 First, let's create your resource configuration:
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -430,7 +430,7 @@ resources:
 </resources>
 ```
 
-[/codeSelector]
+</code-selector>
 
 API Platform will automatically map this `post_publication` operation to the route `book_post_publication`. Let's create a custom action
 and its related route using attributes:

core/default-order.md

@@ -5,7 +5,7 @@ API Platform provides an easy way to override the default order of items in your
 By default, items in the collection are ordered in ascending (ASC) order by their resource identifier(s). If you want to
 customize this order, you must add an `order` attribute on your ApiResource annotation:
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -35,12 +35,12 @@ App\Entity\Book:
         foo: ASC
 ```
 
-[/codeSelector]
+</code-selector>
 
 This `order` attribute is used as an array: the key defines the order field, the values defines the direction.
 If you only specify the key, `ASC` direction will be used as default. For example, to order by `foo` & `bar`:
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -74,11 +74,11 @@ App\Entity\Book:
     order: ['foo', 'bar']
 ```
 
-[/codeSelector]
+</code-selector>
 
 It's also possible to configure the default order on an association property:
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -107,11 +107,11 @@ App\Entity\Book:
     order: ['author.username']
 ```
 
-[/codeSelector]
+</code-selector>
 
 Another possibility is to apply the default order for a specific collection operation, which will override the global default order configuration.
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -155,4 +155,4 @@ App\Entity\Book:
             name: ASC
 ```
 
-[/codeSelector]
+</code-selector>

core/deprecations.md

@@ -67,7 +67,7 @@ class Parchment
 
 It's also possible to deprecate a single property:
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -99,7 +99,7 @@ properties:
             deprecationReason: 'Use the rating property instead'
 ```
 
-[/codeSelector]
+</code-selector>
 
 * With JSON-lD / Hydra, [an `owl:deprecated` annotation property](https://www.w3.org/TR/owl2-syntax/#Annotation_Properties) will be added to the appropriate data structure
 * With Swagger / OpenAPI, [a `deprecated` property](https://swagger.io/docs/specification/2-0/paths-and-operations/) will be added

core/dto.md

@@ -124,7 +124,7 @@ final class BookRepresentationProvider implements ProviderInterface
 
 For returning another representation of your data in a [State Processor](./state-processors.md), you should specify your processor class in the `processor` attribute and same for your `output`.
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -165,7 +165,7 @@ resources:
 </resources>
 ```
 
-[/codeSelector]
+</code-selector>
 
 Here the `$data` attribute represents an instance of your resource.
 

core/errors.md

@@ -6,19 +6,18 @@ API Platform automatically sends the appropriate HTTP status code to the client:
 unexpected ones. It also provides a description of the error in [the Hydra error format](https://www.hydra-cg.com/spec/latest/core/#description-of-http-status-codes-and-errors)
 or in the format described in the [RFC 7807](https://tools.ietf.org/html/rfc7807), depending of the format selected during the [content negotiation](content-negotiation.md).
 
-# Errors 
-
 ## Backward compatibility with < 3.1
 
-Use the following configuration: 
+Use the following configuration:
 
 ```yaml
 api_platform:
     defaults:
+        extra_properties:
             rfc_7807_compliant_errors: false
 ```
 
-This can also be configured on an `ApiResource` or in an `HttpOperation`, for example: 
+This can also be configured on an `ApiResource` or in an `HttpOperation`, for example:
 
 ```php
 #[ApiResource(extraProperties: ['rfc_7807_compliant_errors' => false])
@@ -31,10 +30,8 @@ There are many ways of configuring the exception status code we recommend readin
 1. we look at `exception_to_status` and take one if there's a match
 2. If your exception is a `Symfony\Component\HttpKernel\Exception\HttpExceptionInterface` we get its status.
 3. If the exception is a `ApiPlatform\Metadata\Exception\ProblemExceptionInterface` and there is a status we use it
-4. Same for `ApiPlatform\Metadata\Exception\HttpExceptionInterface` 
-5. We have some defaults: 
-  - `Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface` => 400
-  - `ApiPlatform\Validator\Exception\ValidationException` => 422
+4. Same for `ApiPlatform\Metadata\Exception\HttpExceptionInterface`
+5. We have some defaults `Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface` => 400 and `ApiPlatform\Validator\Exception\ValidationException` => 422
 6. the status defined on an `ErrorResource`
 7. 500 is the fallback
 
@@ -175,9 +172,9 @@ the global config.
 
 ## Control your exceptions
 
-With `rfc_7807_compliant_errors` a few things happen. First Hydra exception are compatible with the JSON Problem specification. Default exception that are handled by API Platform in JSON will be returned as `application/problem+json`. 
+With `rfc_7807_compliant_errors` a few things happen. First Hydra exception are compatible with the JSON Problem specification. Default exception that are handled by API Platform in JSON will be returned as `application/problem+json`.
 
-To customize the API Platform response, replace the `api_platform.state.error_provider` with your own provider: 
+To customize the API Platform response, replace the `api_platform.state.error_provider` with your own provider:
 
 ```php
 <?php
@@ -234,7 +231,7 @@ api_platform.validator.state.error_provider:
 
 ## Domain exceptions
 
-Another way of having full control over domain exceptions is to create your own Error resource: 
+Another way of having full control over domain exceptions is to create your own Error resource:
 
 ```php
 <?php

core/events.md

@@ -1,5 +1,7 @@
 # The Event System
 
+In API Platform 3.2 you may need `event_listeners_backward_compatibility_layer: true` to keep event listeners activated.
+
 Note: using Kernel event with API Platform should be mostly limited to tweaking the generated HTTP response. Also, GraphQL is **not supported**.
 [For most use cases, better extension points, working both with REST and GraphQL, are available](extending.md).
 

core/extending-jsonld-context.md

@@ -67,7 +67,7 @@ Note that you do not have to provide the `@id` attribute. If you do not provide
 
 It's also possible to replace the Hydra context used by the documentation generator:
 
-[codeSelector]
+<code-selector>
 
 ```php
 <?php
@@ -117,4 +117,4 @@ resources:
 </resources>
 ```
 
-[/codeSelector]
+</code-selector>