fix: 2.7 and 3.0 metadata system (#1519)

* doc: new metadata

* State processors/providers

* bump

* fix links

* lint

* lint

* Apply suggestions from code review

Co-authored-by: Alan Poulain <[email protected]>

* review

Co-authored-by: Alan Poulain <[email protected]>

Author: soyuka

admin/handling-relations.md

@@ -170,9 +170,9 @@ class Review
 // api/src/Entity/Book.php
 namespace App\Entity;
 
-use ApiPlatform\Core\Annotation\ApiFilter;
+use ApiPlatform\Metadata\ApiFilter;
 use ApiPlatform\Metadata\ApiResource;
-use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
+use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;

admin/performance.md

@@ -19,8 +19,8 @@ you can make sure the authors are retrieved in one go by writing:
 // api/src/Entity/Author.php
 namespace App\Entity;
 
-use ApiPlatform\Core\Annotation\ApiFilter;
-use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
+use ApiPlatform\Metadata\ApiFilter;
+use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
 use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 

admin/validation.md

@@ -7,7 +7,7 @@ API Platform Admin manages automatically two types of validation: client-side va
 If the API documentation indicates that a field is mandatory,
 API Platform Admin will automatically add a [required client-side validation](https://marmelab.com/react-admin/CreateEdit.html#per-input-validation-built-in-field-validators).
 
-For instance, with API Platform Core as backend, if you write the following:
+For instance, with API Platform as backend, if you write the following:
 
 ```php
 <?php
@@ -37,7 +37,7 @@ API Platform Admin will automatically show the errors for the corresponding fiel
 To do so, it uses the [submission validation](https://marmelab.com/react-admin/CreateEdit.html#submission-validation) feature of React Admin,
 and the mapping between the response and the fields is done by the [schema analyzer](components.md#schemaanalyzer) with its method `getSubmissionErrors`.
 
-API Platform Core is supported by default, but if you use another backend, you will need to override the `getSubmissionErrors` method.
+API Platform is supported by default, but if you use another backend, you will need to override the `getSubmissionErrors` method.
 
 For example if you have this code:
 

core/content-negotiation.md

@@ -2,7 +2,7 @@
 
 The API system has built-in [content negotiation](https://en.wikipedia.org/wiki/Content_negotiation) capabilities.
 
-By default, only the [JSON-LD](https://json-ld.org) and JSON formats are enabled. However API Platform Core supports many more formats and can be extended.
+By default, only the [JSON-LD](https://json-ld.org) and JSON formats are enabled. However API Platform supports many more formats and can be extended.
 
 The framework natively supports JSON-LD (and Hydra), GraphQL, JSON:API, HAL, YAML, CSV, HTML (API docs), raw JSON and raw XML.
 Using the raw JSON or raw XML formats is discouraged, prefer using JSON-LD instead, which provides more feature and is as easy to use.
@@ -11,7 +11,7 @@ API Platform also supports [JSON Merge Patch (RFC 7396)](https://tools.ietf.org/
 
 <p align="center" class="symfonycasts"><a href="https://symfonycasts.com/screencast/api-platform/formats?cid=apip"><img src="../distribution/images/symfonycasts-player.png" alt="Formats screencast"><br>Watch the Formats screencast</a></p>
 
-API Platform Core will automatically detect the best resolving format depending on:
+API Platform will automatically detect the best resolving format depending on:
 
 * enabled formats (see below)
 * the requested format, specified in either [the `Accept` HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept) or as an extension appended to the URL
@@ -133,10 +133,11 @@ use ApiPlatform\Metadata\Patch;
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\Post;
 
-#[ApiResource(formats: ['jsonld', 'csv' => ['text/csv']])]
-#[Patch(inputFormats: ['json' => ['application/merge-patch+json']])]
-#[GetCollection]
-#[Post]
+#[ApiResource(formats: ['jsonld', 'csv' => ['text/csv']], operations: [
+    new Patch(inputFormats: ['json' => ['application/merge-patch+json']]),
+    new GetCollection(),
+    new Post(),
+])]
 class Book
 {
     // ...
@@ -195,7 +196,7 @@ api_platform:
         myformat: ['application/vnd.myformat']
 ```
 
-API Platform Core will automatically call the serializer with your defined format name as `format` parameter during the deserialization process (`myformat` in the example).
+API Platform will automatically call the serializer with your defined format name as `format` parameter during the deserialization process (`myformat` in the example).
 It will then return the result to the client with the requested MIME type using its built-in responder.
 For non-standard formats, [a vendor, vanity or unregistered MIME type should be used](https://en.wikipedia.org/wiki/Media_type#Vendor_tree).
 
@@ -297,4 +298,4 @@ class CustomItemNormalizer implements NormalizerInterface, DenormalizerInterface
 ### Contributing Support for New Formats
 
 Adding support for **standard** formats upstream is welcome!
-We'll be glad to merge new encoders and normalizers in API Platform Core.
+We'll be glad to merge new encoders and normalizers in API Platform.

core/controllers.md

@@ -64,8 +64,8 @@ controller classes (the default when using the API Platform distribution).
 This action will be automatically registered as a service (the service name is the same as the class name:
 `App\Controller\CreateBookPublication`).
 
-API Platform automatically retrieves the appropriate PHP entity using the data provider then deserializes user data in it,
-and for `POST`, `PUT` and `PATCH` requests updates the entity with data provided by the user.
+API Platform automatically retrieves the appropriate PHP entity using the state provider then deserializes user data in it,
+and for `POST`, `PUT` and `PATCH` requests updates the entity with state provided by the user.
 
 The entity is retrieved in the `__invoke` method thanks to a dedicated argument resolver.
 
@@ -97,13 +97,14 @@ use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\Post;
 use App\Controller\CreateBookPublication;
 
-#[ApiResource]
-#[Get]
-#[Post(
-    name: 'publication', 
-    uriTemplate: '/books/{id}/publication', 
-    controller: CreateBookPublication::class
-)]
+#[ApiResource(operations: [
+    new Get(),
+    new Post(
+        name: 'publication', 
+        uriTemplate: '/books/{id}/publication', 
+        controller: CreateBookPublication::class
+    )
+])]
 class Book
 {
     // ...
@@ -163,14 +164,15 @@ use ApiPlatform\Metadata\Post;
 use App\Controller\CreateBookPublication;
 use Symfony\Component\Serializer\Annotation\Groups;
 
-#[ApiResource]
-#[Get]
-#[Post(
-    name: 'publication', 
-    uriTemplate: '/books/{id}/publication', 
-    controller: CreateBookPublication::class, 
-    normalizationContext: ['groups' => 'publication']
-)]
+#[ApiResource(operations: [
+    new Get(),
+    new Post(
+        name: 'publication', 
+        uriTemplate: '/books/{id}/publication', 
+        controller: CreateBookPublication::class, 
+        normalizationContext: ['groups' => 'publication']
+    )
+])]
 class Book
 {
     // ...
@@ -238,14 +240,15 @@ use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\Post;
 use App\Controller\CreateBookPublication;
 
-#[ApiResource]
-#[Get]
-#[Post(
-    name: 'publication', 
-    uriTemplate: '/books/{id}/publication', 
-    controller: CreateBookPublication::class, 
-    read: false
-)]
+#[ApiResource(operations: [
+    new Get(),
+    new Post(
+        name: 'publication', 
+        uriTemplate: '/books/{id}/publication', 
+        controller: CreateBookPublication::class, 
+        read: false
+    )
+])]
 class Book
 {
     // ...
@@ -313,10 +316,11 @@ use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\Post;
 
-#[ApiResource]
-#[Get]
-#[Post(name: 'publication', routeName: 'book_post_publication')]
-#[Post(name: 'book_post_discontinuation')]
+#[ApiResource(operations: [
+    new Get(),
+    new Post(name: 'publication', routeName: 'book_post_publication'),
+    new Post(name: 'book_post_discontinuation')
+])]
 class Book
 {
     // ...