Merge branch '2.3'

Author: dunglas

admin/getting-started.md

@@ -321,7 +321,7 @@ in the `admin/src/Component/User` directory:
 // admin/src/Component/User/Create.js
 
 import React from 'react';
-import { Create, SimpleForm, TextInput, email, required } from 'react-admin';
+import { Create, SimpleForm, TextInput, email, required, ArrayInput, SimpleFormIterator } from 'react-admin';
 
 export const UserCreate = (props) => (
     <Create { ...props }>
@@ -330,6 +330,11 @@ export const UserCreate = (props) => (
             <TextInput source="plainPassword" label="Password" validate={ required() } />
             <TextInput source="name" label="Name"/>
             <TextInput source="phone" label="Phone"/>
+            <ArrayInput source="roles" label="Roles">
+                <SimpleFormIterator>
+                    <TextInput />
+                </SimpleFormIterator>
+            </ArrayInput>
         </SimpleForm>
     </Create>
 );
@@ -340,7 +345,7 @@ export const UserCreate = (props) => (
 // admin/src/Component/User/Edit.js
 
 import React from 'react';
-import { Edit, SimpleForm, DisabledInput, TextInput, DateInput, email } from 'react-admin';
+import { Edit, SimpleForm, DisabledInput, TextInput, email, ArrayInput, SimpleFormIterator, DateInput } from 'react-admin';
 
 export const UserEdit = (props) => (
     <Edit {...props}>
@@ -349,6 +354,11 @@ export const UserEdit = (props) => (
             <TextInput source="email" label="Email" validate={ email() } />
             <TextInput source="name" label="Name"/>
             <TextInput source="phone" label="Phone"/>
+            <ArrayInput source="roles" label="Roles">
+                <SimpleFormIterator>
+                    <TextInput />
+                </SimpleFormIterator>
+            </ArrayInput>
             <DateInput disabled source="createdAt" label="Date"/>
         </SimpleForm>
     </Edit>

admin/images/admin-demo.gif

@@ -1,5 +1,7 @@
 # The API Platform Admin
 
+![Screencast](images/admin-demo.gif)
+
 API Platform Admin is a tool to automatically create a fancy (Material Design) and fully featured administration interface
 for any API supporting [the Hydra Core Vocabulary](http://www.hydra-cg.com/), including but not limited to all APIs created
 using [the API Platform framework](https://api-platform.com).

admin/index.md

@@ -173,7 +173,7 @@ api_platform:
         Symfony\Component\Serializer\Exception\ExceptionInterface: 400
 
         # Or with a constant defined in the 'Symfony\Component\HttpFoundation\Response' class.
-        ApiPlatform\Core\Exception\InvalidArgumentException: !php/const:Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST
+        ApiPlatform\Core\Exception\InvalidArgumentException: !php/const Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST
 
         # ...
 

core/configuration.md

@@ -54,7 +54,7 @@ You can also use this new `deprecationReason` attribute to deprecate specific [o
 
 ```php
 <?php
-// api/src/Entity/Review.php
+// api/src/Entity/Parchment.php
 
 /**
  * @ApiResource(itemOperations={

core/deprecations.md

@@ -12,9 +12,9 @@ Once enabled, you have nothing to do: your schema describing your API is automat
 
 ## Enabling GraphQL
 
-To enable GraphQL and GraphiQL interface in your API, simply require the graphql-php package using Composer:
+To enable GraphQL and GraphiQL interface in your API, simply require the [graphql-php](https://webonyx.github.io/graphql-php/) package using Composer and clear the cache one more time:
 
-    $ composer require webonyx/graphql-php
+    $ composer require webonyx/graphql-php && bin/console cache:clear
 
 You can now use GraphQL at the endpoint: `http://localhost/graphql`.
 

core/graphql.md

@@ -304,7 +304,6 @@ class Answer
 
 namespace App\Entity;
 
-use ApiPlatform\Core\Annotation\ApiProperty;
 use ApiPlatform\Core\Annotation\ApiResource;
 use ApiPlatform\Core\Annotation\ApiSubresource;
 use Doctrine\ORM\Mapping as ORM;
@@ -422,7 +421,7 @@ Or in XML:
                 <attribute name="method">GET</attribute>
                 <attribute name="normalization_context">
                   <attribute name="groups">
-                    <group>foobar</group>
+                    <attribute>foobar</attribute>
                   </attribute>
                 </attribute>
             </collectionOperation>
@@ -479,6 +478,7 @@ The `subresourceOperations` attribute also allows you to add an access control o
  *          }
  *      }
  * )
+ */
  class Answer
  {
  }
@@ -517,7 +517,7 @@ class Question
 
 API Platform can leverage the Symfony routing system to register custom operations related to custom controllers. Such custom
 controllers can be any valid [Symfony controller](http://symfony.com/doc/current/book/controller.html), including standard
-Symfony controllers extending the [`Symfony\Bundle\FrameworkBundle\Controller\Controller`](http://api.symfony.com/3.1/Symfony/Bundle/FrameworkBundle/Controller/Controller.html)
+Symfony controllers extending the [`Symfony\Bundle\FrameworkBundle\Controller\AbstractController`](http://api.symfony.com/4.1/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.html)
 helper class.
 
 However, API Platform recommends to use **action classes** instead of typical Symfony controllers. Internally, API Platform
@@ -727,7 +727,7 @@ Or in XML:
                 <attribute name="controller">App\Controller\BookSpecial</attribute>
                 <attribute name="normalization_context">
                   <attribute name="groups">
-                    <group>special</group>
+                    <attribute>special</attribute>
                   </attribute>
                 </attribute>
             </itemOperation>
@@ -921,11 +921,11 @@ exactly the same thing than the previous example in a more Symfony-like fashion:
 namespace App\Controller;
 
 use App\Entity\Book;
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 
-class BookController extends Controller
+class BookController extends AbstractController
 {
-    public function specialAction(Book $data, MyService $service): Book
+    public function special(Book $data, MyService $service): Book
     {
         return $service->doSomething($data);
     }

core/operations.md

@@ -54,6 +54,16 @@ framework:
 If you use [Symfony Flex](https://github.com/symfony/flex), just execute `composer req doctrine/annotations` and you are
 all set!
 
+If you want to use YAML or XML, please add the mapping path in the serializer configuration:
+
+```yaml
+# api/config/packages/api_platform.yaml
+framework:
+    serializer:
+        mapping:
+            paths: ['%kernel.project_dir%/config/serialization']
+```
+
 ## Using Serialization Groups
 
 It is simple to specify what groups to use in the API system:

core/serialization.md

@@ -234,6 +234,8 @@ class User
 
 You also have full control over both built-in and custom operations documentation:
 
+In Yaml:
+
 ```yaml
 resources:
   App\Entity\Rabbit:
@@ -262,6 +264,54 @@ resources:
                    description: Pink rabbit
 ```
 
+or with XML:
+
+```xml
+<?xml version="1.0" encoding="UTF-8" ?>
+<resources xmlns="https://api-platform.com/schema/metadata"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="https://api-platform.com/schema/metadata
+           https://api-platform.com/schema/metadata/metadata-2.0.xsd">
+    <resource class="App\Entity\Rabbit">
+        <collectionOperations>
+            <collectionOperation name="create_user">
+                <attribute name="method">get</attribute>
+                <attribute name="path">/rabbit/rand</attribute>
+                <attribute name="controller">App\Controller\RandomRabbit</attribute>
+                <attribute name="swagger_context">
+                    <attribute name="summary">Random rabbit picture</attribute>
+                    <attribute name="description">
+                        # Pop a great rabbit picture by color!
+
+                        ![A great rabbit](https://rabbit.org/graphics/fun/netbunnies/jellybean1-brennan1.jpg)
+                    </attribute>
+                    <attribute name="parameters">
+                        <attribute>
+                            <attribute name="in">body</attribute>
+                            <attribute name="schema">
+                                <attribute name="type">object</attribute>
+                                <attribute name="properties">
+                                    <attribute name="name">
+                                        <attribute name="type">string</attribute>
+                                    </attribute>
+                                    <attribute name="description">
+                                        <attribute name="type">string</attribute>
+                                    </attribute>
+                                </attribute>
+                            </attribute>
+                            <attribute name="example">
+                                <attribute name="name">Rabbit</attribute>
+                                <attribute name="description">Pink rabbit</attribute>
+                            </attribute>
+                        </attribute>
+                    </attribute>
+                </attribute>
+            </collectionOperation>
+        </collectionOperations>
+    </resource>
+</resources>
+```
+
 ![Impact on swagger ui](../distribution/images/swagger-ui-2.png)
 
 ## Changing the Swagger UI Location

core/swagger.md

@@ -4,8 +4,8 @@ API Platform follows the [Semantic Versioning](https://semver.org) strategy.
 
 Only 3 versions are maintained at the same time:
 
-* **stable** (currently the **2.2** branch): regular bug fixes are integrated in this version
-* **old-stable** (currently **2.1** branch): security fixes are integrated in this version, regular bug fixes are **not** backported in it
+* **stable** (currently the **2.3** branch): regular bug fixes are integrated in this version
+* **old-stable** (currently **2.2** branch): security fixes are integrated in this version, regular bug fixes are **not** backported in it
 * **development** (**master** branch): new features target this branch
 
 Older versions (1.x, 2.0...) **are not maintained**. If you still use them, you must upgrade as soon as possible.

extra/releases.md

@@ -434,7 +434,7 @@ Example:
 
 ```yaml
 rdfa:
-    - https://raw.githubusercontent.com/rvguha/schemaorg/master/data/schema.rdfa # Experimental version of Schema.org
+    - https://raw.githubusercontent.com/schemaorg/schemaorg/master/data/schema.rdfa # Experimental version of Schema.org
     - http://example.com/data/myschema.rfa # Additional types
 ```