chore: merge 3.1

.github/workflows/cd.yml

@@ -3,46 +3,46 @@ 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

.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') }}

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
     {
@@ -117,14 +114,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 +186,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 +257,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 +329,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 +402,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" ?>

core/extending-jsonld-context.md

@@ -88,10 +88,11 @@ class Book
 
 ```yaml
 # api/config/api_platform/resources.yaml
-App\Entity\Book:
-    operations:
-        ApiPlatform\Metadata\Get:
-            hydraContext: { foo: 'bar' }
+resources:
+    App\Entity\Book:
+        operations:
+            ApiPlatform\Metadata\Get:
+                hydraContext: { foo: 'bar' }
 ```
 
 ```xml

core/filters.md

@@ -71,11 +71,12 @@ to a Resource in two ways:
 
     ```yaml
     # api/config/api_platform/resources.yaml
-    App\Entity\Offer:
-        operations:
-            ApiPlatform\Metadata\GetCollection:
-                filters: ['offer.date_filter']
-        # ...
+    resources:
+        App\Entity\Offer:
+            operations:
+                ApiPlatform\Metadata\GetCollection:
+                    filters: ['offer.date_filter']
+            # ...
     ```
 
     ```xml
@@ -1461,7 +1462,7 @@ Start by creating a custom attribute to mark restricted entities:
 
 ```php
 <?php
-// api/Annotation/UserAware.php
+// api/src/Attribute/UserAware.php
 
 namespace App\Attribute;