Merge branch '2.2'

Author: dunglas

admin/authentication-support.md

@@ -7,8 +7,8 @@ process is similar for other authentication mechanisms. The `login_uri` is the f
 The first step is to create a client to handle the authentication process:
 
 ```javascript
-// src/authClient.js
-import { AUTH_LOGIN, AUTH_LOGOUT, AUTH_ERROR, AUTH_CHECK } from 'admin-on-rest';
+// src/authProvider.js
+import { AUTH_LOGIN, AUTH_LOGOUT, AUTH_ERROR, AUTH_CHECK } from 'react-admin';
 
 // Change this to be your own login check route.
 const login_uri = 'https://demo.api-platform.com/login_check';
@@ -61,7 +61,7 @@ Then, configure the `Admin` component to use the authentication client we just c
 import React from 'react';
 import parseHydraDocumentation from '@api-platform/api-doc-parser/lib/hydra/parseHydraDocumentation';
 import { HydraAdmin, hydraClient, fetchHydra as baseFetchHydra } from '@api-platform/admin';
-import authClient from './authClient';
+import authProvider from './authProvider';
 import { Redirect } from 'react-router-dom';
 
 const entrypoint = 'https://demo.api-platform.com'; // Change this by your own entrypoint
@@ -70,7 +70,7 @@ const fetchHydra = (url, options = {}) => baseFetchHydra(url, {
     ...options,
     headers: new Headers(fetchHeaders),
 });
-const restClient = api => hydraClient(api, fetchHydra);
+const hydraClient = api => hydraClient(api, fetchHydra);
 const apiDocumentationParser = entrypoint => parseHydraDocumentation(entrypoint, { headers: new Headers(fetchHeaders) })
     .then(
         ({ api }) => ({ api }),
@@ -96,12 +96,12 @@ const apiDocumentationParser = entrypoint => parseHydraDocumentation(entrypoint,
 export default props => (
     <HydraAdmin
         apiDocumentationParser={apiDocumentationParser}
-        authClient={authClient}
+        authProvider={authProvider}
         entrypoint={entrypoint}
-        restClient={restClient}
+        dataProvider={hydraClient}
     />
 );
 ```
 
-Refer to [the chapter dedicated to authentication in the Admin On Rest documentation](https://marmelab.com/admin-on-rest/Authentication.html)
+Refer to [the chapter dedicated to authentication in the React Admin documentation](https://marmelab.com/react-admin/Authentication.html)
 for more information.

admin/getting-started.md

@@ -35,6 +35,23 @@ the admin's domain to access it.
 To do so, update the value of the `CORS_ALLOW_ORIGIN` parameter in `api/.env` (it will be set to `^https?://localhost:?[0-9]*$`
 by default).
 
+If you're not using the API Platform distribution, you will need to adjust the NelmioCorsBundle configuration to expose the `Link` HTTP header and to send proper CORS headers on the route under which the API will be served (`/api` by default).
+Here is a sample configuration (if you use the API Platform distribution, you can skip this step):
+
+```yaml
+# config/packages/nelmio-cors.yaml
+
+nelmio_cors:
+    paths:
+        '^/api/':
+            origin_regex: true
+            allow_origin: ['^http://localhost:[0-9]+'] # You probably want to change this regex to match your real domain
+            allow_methods: ['GET', 'OPTIONS', 'POST', 'PUT', 'PATCH', 'DELETE']
+            allow_headers: ['Content-Type', 'Authorization']
+            expose_headers: ['Link']
+            max_age: 3600
+```
+
 Clear the cache to apply this change:
 
     $ docker-compose exec php bin/console cache:clear --env=prod
@@ -50,12 +67,12 @@ The API Platform's admin parses the Hydra documentation exposed by the API and t
 ### Using Custom Components
 
 In the following example, we change components used for the `description` property of the `books` resource to ones accepting HTML (respectively `RichTextField` that renders HTML markup and `RichTextInput`, a WYSWYG editor).
-(To use the `RichTextInput`, the `aor-rich-text-input` package is must be installed: `yarn add aor-rich-text-input`).
+(To use the `RichTextInput`, the `ra-input-rich-text` package is must be installed: `yarn add ra-input-rich-text`).
 
 ```javascript
 import React from 'react';
-import { RichTextField } from 'admin-on-rest';
-import RichTextInput from 'aor-rich-text-input';
+import { RichTextField } from 'react-admin';
+import RichTextInput from 'ra-input-rich-text';
 import { HydraAdmin } from '@api-platform/admin';
 import parseHydraDocumentation from '@api-platform/api-doc-parser/lib/hydra/parseHydraDocumentation';
 
@@ -85,22 +102,21 @@ export default (props) => <HydraAdmin apiDocumentationParser={myApiDocumentation
 The `field` property of the `Field` class allows to set the component used to render a property in list and show screens.
 The `input` property allows to set the component to use to render the input used in create and edit screens.
 
-Any [field](https://marmelab.com/admin-on-rest/Fields.html) or [input](https://marmelab.com/admin-on-rest/Inputs.html) provided by the Admin On Rest library can be used.
+Any [field](https://marmelab.com/react-admin/Fields.html) or [input](https://marmelab.com/react-admin/Inputs.html) provided by the React Admin library can be used.
 
-To go further, take a look to the "[Including admin-on-rest on another React app](https://marmelab.com/admin-on-rest/CustomApp.html)" documentation page of Admin On Rest to learn how to use directly redux, react-router, and redux-saga along with components provided by this library.
+To go further, take a look to the "[Including react-admin on another React app](https://marmelab.com/react-admin/CustomApp.html)" documentation page of React Admin to learn how to use directly redux, react-router, and redux-saga along with components provided by this library.
 
 ### Managing Files and Images
 
 In the following example, we will:
-* find every [ImageObject](http://schema.org/ImageObject) resources. For each [contentUrl](http://schema.org/contentUrl) fields, we will use [ImageField](https://marmelab.com/admin-on-rest/Fields.html#imagefield) as `field` and [ImageInput](https://marmelab.com/admin-on-rest/Inputs.html#imageinput) as `input`.
-* [ImageInput](https://marmelab.com/admin-on-rest/Inputs.html#imageinput) will return a [File](https://developer.mozilla.org/en/docs/Web/API/File) instance. In this example, we will send a multi-part form data to a special action (`https://demo.api-platform.com/images/upload`). The action will return the ID of the uploaded image. We will "replace" the [File](https://developer.mozilla.org/en/docs/Web/API/File) instance by the ID in `normalizeData`.
-* As `contentUrl` fields will return a string, we have to convert Hydra data to AOR data. This action will be done by `denormalizeData`.
+* find every [ImageObject](http://schema.org/ImageObject) resources. For each [contentUrl](http://schema.org/contentUrl) fields, we will use [ImageField](https://marmelab.com/react-admin/Fields.html#imagefield) as `field` and [ImageInput](https://marmelab.com/react-admin/Inputs.html#imageinput) as `input`.
+* [ImageInput](https://marmelab.com/react-admin/Inputs.html#imageinput) will return a [File](https://developer.mozilla.org/en/docs/Web/API/File) instance. In this example, we will send a multi-part form data to a special action (`https://demo.api-platform.com/images/upload`). The action will return the ID of the uploaded image. We will "replace" the [File](https://developer.mozilla.org/en/docs/Web/API/File) instance by the ID in `normalizeData`.
+* As `contentUrl` fields will return a string, we have to convert Hydra data to React Admin data. This action will be done by `denormalizeData`.
 
 ```javascript
-import { FunctionField, ImageField, ImageInput } from 'admin-on-rest/lib/mui';
 import React from 'react';
-import { RichTextField } from 'admin-on-rest';
-import RichTextInput from 'aor-rich-text-input';
+import { FunctionField, ImageField, ImageInput, RichTextField } from 'react-admin';
+import RichTextInput from 'ra-input-rich-text';
 import { HydraAdmin } from '@api-platform/admin';
 import parseHydraDocumentation from '@api-platform/api-doc-parser/lib/hydra/parseHydraDocumentation';
 
@@ -208,7 +224,7 @@ export default class extends Component {
   render() {
     if (null === this.state.api) return <div>Loading...</div>;
 
-    return <AdminBuilder api={this.state.api} restClient={hydraClient(entrypoint)}/>
+    return <AdminBuilder api={this.state.api} dataProvider={hydraClient(entrypoint)}/>
   }
 }
 ```

admin/handling-relations-to-collections.md

@@ -78,7 +78,7 @@ Let's customize the components used for the `authors` property:
 
 ```javascript
 import React, { Component } from 'react';
-import { ReferenceArrayField, SingleFieldList, ChipField, ReferenceArrayInput, SelectArrayInput } from 'admin-on-rest';
+import { ReferenceArrayField, SingleFieldList, ChipField, ReferenceArrayInput, SelectArrayInput } from 'react-admin';
 import { AdminBuilder, hydraClient } from '@api-platform/admin';
 import parseHydraDocumentation from 'api-doc-parser/lib/hydra/parseHydraDocumentation';
 
@@ -115,7 +115,7 @@ export default class extends Component {
   render() {
     if (null === this.state.api) return <div>Loading...</div>;
 
-    return <AdminBuilder api={this.state.api} restClient={hydraClient({entrypoint: entrypoint, resources: this.state.resources})}/>
+    return <AdminBuilder api={this.state.api} dataProvider={hydraClient({entrypoint: entrypoint, resources: this.state.resources})}/>
   }
 }
 ```

admin/index.md

@@ -7,11 +7,11 @@ using [the API Platform framework](https://api-platform.com).
 The generated administration is a 100% standalone Single-Page-Application with no coupling to the server part, according
 to the API-first paradigm.
 
-API Platform Admin parses the Hydra documentation then uses the awesome [Admin On Rest](https://marmelab.com/admin-on-rest/)
+API Platform Admin parses the Hydra documentation then uses the awesome [React Admin](https://marmelab.com/react-admin/)
 library (and [React](https://facebook.github.io/react/)) to expose a nice, responsive, management interface (Create-Retrieve-Update-Delete)
 for all available resources.
 
-You can also customize all screens by using Admin On Rest components and even raw JavaScript/React code.
+You can also customize all screens by using React Admin components and even raw JavaScript/React code.
 
 ## Features
 

core/content-negotiation.md

@@ -5,7 +5,7 @@ It leverages the [`willdurand/negotiation`](https://github.com/willdurand/Negoti
 
 By default, only the [JSON-LD](https://json-ld.org) format is enabled. However API Platform Core supports many more formats and can be extended.
 
-The framework natively supports JSON-LD, HAL, raw JSON, XML, YAML and CSV (YAML and CSV support is only available if you use Symfony 3.2+).
+The framework natively supports JSON-LD, GraphQL, JSONAPI, HAL, raw JSON, XML, YAML and CSV (YAML and CSV support is only available if you use Symfony 3.2+).
 
 Both XML and JSON formats are experimental and there are no assurance that we will not break them.
 
@@ -19,16 +19,19 @@ Available formats are:
 Format                                                          | Format name  | MIME types                    | Backward Compatibility guaranteed
 ----------------------------------------------------------------|--------------|-------------------------------|----------------------------------------
 [JSON-LD](https://json-ld.org)                                  | `jsonld`     | `application/ld+json`         | yes
+[GraphQL](graphql.md)                                           | n/a          | n/a                           | yes
+[JSONAPI](http://jsonapi.org/)                                  | `jsonapi`    | `application/vnd.api+json`    | yes
 [HAL](http://stateless.co/hal_specification.html)               | `jsonhal`    | `application/hal+json`        | yes
-JSON                                                            | `json`       |  `application/json`           | no
-XML                                                             | `xml`        | `application/xml`, `text/xml` | no
-HTML (API docs)                                                 | `html`       | `text/html`                   | no
+[JSON](https://www.json.org/)                                   | `json`       |  `application/json`           | no
+[XML](https://www.w3.org/XML/)                                  | `xml`        | `application/xml`, `text/xml` | no
+[YAML](http://yaml.org/)                                        | `yaml`       | `application/x-yaml`          | no
+[CSV](https://tools.ietf.org/html/rfc4180)                      | `csv`        | `text/csv`                    | no
+[HTML](https://whatwg.org/) (API docs)                          | `html`       | `text/html`                   | no
 
-If the client requested format is not specified (if it's not supported, it will throw an HTTP bad format error), the response format will be the first format defined in the `formats` configuration key (see below).
+If the client requested format is not specified (if it's not supported, it will throw an HTTP bad request error), the response format will be the first format defined in the `formats` configuration key (see below).
 An example using the built-in XML support is available in [Behat specs](https://github.com/api-platform/core/blob/master/features/main/content_negotiation.feature).
 
-The API Platform content negotiation system is extendable. Support for other formats (such as [JSONAPI](http://jsonapi.org/))
-can be added by [creating and registering appropriate encoders and, sometimes, normalizers](https://symfony.com/doc/current/serializer.html#adding-normalizers-and-encoders). Adding support for other
+The API Platform content negotiation system is extendable. Support for other formats can be added by [creating and registering appropriate encoders and, sometimes, normalizers](https://symfony.com/doc/current/serializer.html#adding-normalizers-and-encoders). Adding support for other
 standard hypermedia formats upstream is welcome. Don't hesitate to contribute by adding your encoders and normalizers
 to API Platform Core.
 
@@ -45,12 +48,17 @@ api_platform:
     formats:
         jsonld:   ['application/ld+json']
         jsonhal:  ['application/hal+json']
+        jsonapi:  ['application/vnd.api+json']
         json:     ['application/json']
         xml:      ['application/xml', 'text/xml']
+        yaml:     ['application/x-yaml']
+        csv:      ['text/csv']
         html:     ['text/html']
         myformat: ['application/vnd.myformat']
 ```
 
+To enable GraphQL support, [read the dedicated chapter](graphql.md).
+
 Because the Symfony Serializer component is able to serialize objects in XML, sending an `Accept` HTTP header with the
 `text/xml` string as value is enough to retrieve XML documents from our API. However API Platform knows nothing about the
 `myformat` format. We need to register an encoder and optionally a normalizer for this format.

core/events.md

@@ -80,7 +80,7 @@ Name                          | Event              | Pre & Post hooks
 `DeserializeListener`         | `kernel.request`   | `PRE_DESERIALIZE`, `POST_DESERIALIZE`| 2        | deserialize data into a PHP entity (`GET`, `POST`, `DELETE`); update the entity retrieved using the data provider (`PUT`)
 `ValidateListener`            | `kernel.view`      | `PRE_VALIDATE`, `POST_VALIDATE`      | 64       | [validate data](validation.md) (`POST`, `PUT`)
 `WriteListener`               | `kernel.view`      | `PRE_WRITE`, `POST_WRITE`            | 32       | if using the Doctrine ORM, persist data (`POST`, `PUT`, `DELETE`)
-`SerializeListener`           | `kernel.view`      | None                                 | 16       | serialize the PHP entity in string [according to the request format](content-negotiation.md)
+`SerializeListener`           | `kernel.view`      | `PRE_SERIALIZE`, `POST_SERIALIZE`    | 16       | serialize the PHP entity in string [according to the request format](content-negotiation.md)
 `RespondListener`             | `kernel.view`      | `PRE_RESPOND`, `POST_RESPOND`        | 8        | transform serialized to a `Symfony\Component\HttpFoundation\Response` instance
 `AddLinkHeaderListener`       | `kernel.response`  | None                                 | 0        | add a `Link` HTTP header pointing to the Hydra documentation
 `ValidationExceptionListener` | `kernel.exception` | None                                 | 0        | serialize validation exceptions in the Hydra format
@@ -101,6 +101,8 @@ Constant           | Event             | Priority |
 `POST_VALIDATE`    | `kernel.view`     | 63       |
 `PRE_WRITE`        | `kernel.view`     | 33       |
 `POST_WRITE`       | `kernel.view`     | 31       |
+`PRE_SERIALIZE`    | `kernel.request`  | 17       |
+`POST_SERIALIZE`   | `kernel.request`  | 15       |
 `PRE_RESPOND`      | `kernel.view`     | 9        |
 `POST_RESPOND`     | `kernel.response` | 0        |