Merge branch '3.1' into merge-3.0

Author: soyuka

.github/workflows/cd.yml

@@ -3,46 +3,57 @@ name: Deploy Website
 on:
   push:
     branches:
-    - main
-    - '*.*'
+      - main
+      - '*.*'
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-
-    - name: Checkout the website
-      uses: actions/checkout@v2
-      with:
-        repository: api-platform/website
-        ref: main
-
-    - name: Get yarn cache directory path
-      id: yarn-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-
-    - uses: actions/cache@v2
-      id: yarn-cache
-      with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-yarn-
-
-    - name: Install deps
-      run: yarn install
-
-    - name: Retrieve docs
-      run: bin/retrieve-documentation
-
-    - name: Build website
-      env:
-        GITHUB_KEY: ${{ secrets.CONTRIBUTORS_GITHUB_TOKEN }}
-      run: yarn gatsby build
-
-    - name: Deploy
-      uses: peaceiris/actions-gh-pages@v3
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./public
-        cname: api-platform.com
+      - name: Checkout the website
+        uses: actions/checkout@v3
+        with:
+          repository: api-platform/website
+          ref: main
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "dir=$(yarn cache dir)" >> "$GITHUB_OUTPUT"
+
+      - uses: actions/cache@v3
+        id: yarn-cache
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install deps
+        run: yarn install
+
+      - name: Retrieve docs
+        run: bin/retrieve-documentation
+
+      - name: Build website
+        env:
+          GITHUB_KEY: ${{ secrets.CONTRIBUTORS_GITHUB_TOKEN }}
+          NODE_OPTIONS: --openssl-legacy-provider
+        run: yarn gatsby build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./public
+          cname: api-platform.com
+
+      - name: Auth gcloud
+        uses: google-github-actions/auth@v1
+        with:
+          credentials_json: ${{ secrets.BUCKET_CREDS }}
+        
+      - name: 'Set up Cloud SDK'
+        uses: 'google-github-actions/setup-gcloud@v1'
+  
+      - name: Deploy on bucket
+        run: gsutil -m rsync -d -r ./public gs://api-platform-website-v3/

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
@@ -24,7 +24,7 @@ jobs:
           DEFAULT_BRANCH: main
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}

admin/customizing.md

@@ -182,4 +182,4 @@ For instance, using an autocomplete input is straightforward, [checkout the dedi
 API Platform is built on top of [React Admin](https://marmelab.com/react-admin/).
 You can use all the features provided by the underlying library with API Platform Admin, including support for [authentication](https://marmelab.com/react-admin/Authentication.html), [authorization](https://marmelab.com/react-admin/Authorization.html) and deeper customization.
 
-To learn more about these capabilities, refer to [the React Admin documentation](https://marmelab.com/react-admin/).
+To learn more about these capabilities, refer to [the React Admin documentation](https://marmelab.com/react-admin/documentation.html).

admin/index.md

@@ -17,6 +17,8 @@ library to expose a nice, responsive, management interface (Create-Retrieve-Upda
 
 You can **customize everything** by using provided React Admin and [MUI](https://mui.com/) components, or by writing your custom [React](https://reactjs.org/) components.
 
+<p align="center" class="symfonycasts"><a href="https://symfonycasts.com/screencast/api-platform/react-admin?cid=apip"><img src="../distribution/images/symfonycasts-player.png" alt="React Admin Screencast"><br>Watch the React Admin screencast</a></p>
+
 ## Features
 
 * Automatically generates an admin interface for all the resources of the API thanks to the hypermedia features of Hydra or to the OpenAPI documentation

core/configuration.md

@@ -64,7 +64,7 @@ api_platform:
 
     # Enable the docs.
     enable_docs: true
-    
+
     # Enable the data collector and the WebProfilerBundle integration.
     enable_profiler: true
 
@@ -157,7 +157,7 @@ api_platform:
     swagger:
         # The active versions of OpenAPI to be exported or used in the swagger_ui. The first value is the default.
         versions: [2, 3]
-                
+
         # The swagger API keys.
         api_keys: []
             # The name of the header or query parameter containing the API key.
@@ -192,7 +192,7 @@ api_platform:
             url:
 
         swagger_ui_extra_configuration:
-            # Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). 
+            # Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing).
             docExpansion: list
             # If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown.
             filter: false
@@ -322,7 +322,9 @@ api_platform:
                 xkey:
                     glue: ' '
 
-        normalization_context: ~
+        normalization_context:
+            # Default value to omit null values in conformance with the JSON Merge Patch RFC.
+            skip_null_values: true
         denormalization_context: ~
         swagger_context: ~
         openapi_context: ~
@@ -373,5 +375,8 @@ api_platform:
         # The URL generation strategy to use for IRIs
         url_generation_strategy: !php/const ApiPlatform\Api\UrlGeneratorInterface::ABS_PATH
 
+        # To enable collecting denormalization errors
+        collectDenormalizationErrors: false
+
         # ...
 ```

core/controllers.md

@@ -44,12 +44,9 @@ use Symfony\Component\HttpKernel\Attribute\AsController;
 #[AsController]
 class CreateBookPublication extends AbstractController
 {
-    private $bookPublishingHandler;
-
-    public function __construct(BookPublishingHandler $bookPublishingHandler)
-    {
-        $this->bookPublishingHandler = $bookPublishingHandler;
-    }
+    public function __construct(
+        private BookPublishingHandler $bookPublishingHandler
+    ) {}
 
     public function __invoke(Book $book): Book
     {
@@ -75,7 +72,6 @@ The entity is retrieved in the `__invoke` method thanks to a dedicated argument
 
 When using `GET`, the `__invoke()` method parameter will receive the identifier and should be called the same as the resource identifier.
 So for the path `/user/{uuid}/bookmarks`, you must use `__invoke(string $uuid)`.
-**Warning: the `__invoke()` method parameter [MUST be called `$data`](https://symfony.com/doc/current/components/http_kernel.html#4-getting-the-controller-arguments)**, otherwise, it will not be filled correctly!
 
 Services (`$bookPublishingHandler` here) are automatically injected thanks to the autowiring feature. You can type-hint any service
 you need and it will be autowired too.
@@ -117,14 +113,15 @@ class Book
 
 ```yaml
 # api/config/api_platform/resources.yaml
-App\Entity\Book:
-    operations:
-        ApiPlatform\Metadata\Get: ~
-        post_publication:
-            class: ApiPlatform\Metadata\Post
-            method: POST
-            uriTemplate: /books/{id}/publication
-            controller: App\Controller\CreateBookPublication
+resources:
+    App\Entity\Book:
+        operations:
+            ApiPlatform\Metadata\Get: ~
+            post_publication:
+                class: ApiPlatform\Metadata\Post
+                method: POST
+                uriTemplate: /books/{id}/publication
+                controller: App\Controller\CreateBookPublication
 ```
 
 ```xml
@@ -188,14 +185,15 @@ class Book
 
 ```yaml
 # api/config/api_platform/resources.yaml
-App\Entity\Book:
-    operations:
-        ApiPlatform\Metadata\Get: ~
-        post_publication:
-            class: ApiPlatform\Metadata\Post
-            method: POST
-            uriTemplate: /books/{id}/publication
-            controller: ApiPlatform\Action\PlaceholderAction
+resources:
+    App\Entity\Book:
+        operations:
+            ApiPlatform\Metadata\Get: ~
+            post_publication:
+                class: ApiPlatform\Metadata\Post
+                method: POST
+                uriTemplate: /books/{id}/publication
+                controller: ApiPlatform\Action\PlaceholderAction
 ```
 
 ```xml
@@ -258,15 +256,16 @@ class Book
 
 ```yaml
 # api/config/api_platform/resources.yaml
-App\Entity\Book:
-    operations:
-        ApiPlatform\Metadata\Get: ~
-        post_publication:
-            class: ApiPlatform\Metadata\Get
-            uriTemplate: /books/{id}/publication
-            controller: App\Controller\CreateBookPublication
-            normalizationContext:
-                groups: ['publication']
+resources:
+    App\Entity\Book:
+        operations:
+            ApiPlatform\Metadata\Get: ~
+            post_publication:
+                class: ApiPlatform\Metadata\Get
+                uriTemplate: /books/{id}/publication
+                controller: App\Controller\CreateBookPublication
+                normalizationContext:
+                    groups: ['publication']
 ```
 
 ```xml
@@ -329,14 +328,15 @@ class Book
 
 ```yaml
 # api/config/api_platform/resources.yaml
-App\Entity\Book:
-    operations:
-        ApiPlatform\Metadata\Get: ~
-        post_publication:
-            class: ApiPlatform\Metadata\Post
-            uriTemplate: /books/{id}/publication
-            controller: App\Controller\CreateBookPublication
-            read: false
+resources:
+    App\Entity\Book:
+        operations:
+            ApiPlatform\Metadata\Get: ~
+            post_publication:
+                class: ApiPlatform\Metadata\Post
+                uriTemplate: /books/{id}/publication
+                controller: App\Controller\CreateBookPublication
+                read: false
 ```
 
 ```xml
@@ -401,14 +401,15 @@ class Book
 
 ```yaml
 # api/config/api_platform/resources.yaml
-App\Entity\Book:
-    operations:
-        ApiPlatform\Metadata\Get: ~
-        post_publication:
-            class: ApiPlatform\Metadata\Post
-            routeName: book_post_publication
-        book_post_discontinuation:
-          class: ApiPlatform\Metadata\Post
+resources:
+    App\Entity\Book:
+        operations:
+            ApiPlatform\Metadata\Get: ~
+            post_publication:
+                class: ApiPlatform\Metadata\Post
+                routeName: book_post_publication
+            book_post_discontinuation:
+              class: ApiPlatform\Metadata\Post
 ```
 
 ```xml

core/dto.md

@@ -140,11 +140,12 @@ class Book {}
 ```
 ```yaml
 # api/config/api_platform/resources.yaml
-App\Entity\Book:
-    operations:
-        ApiPlatform\Metadata\Post:
-            output: App\Dto\AnotherRepresentation
-            processor: App\State\BookRepresentationProcessor
+resources:
+    App\Entity\Book:
+        operations:
+            ApiPlatform\Metadata\Post:
+                output: App\Dto\AnotherRepresentation
+                processor: App\State\BookRepresentationProcessor
 ```
 ```xml
 <?xml version="1.0" encoding="UTF-8" ?>