From 028a624812b07c3b85b0b5ad153a02a81a2783c4 Mon Sep 17 00:00:00 2001
From: Thibaudeau Pierre <pierre.thibaudeau@les-tilleuls.coop>
Date: Tue, 7 Sep 2021 15:16:59 +0200
Subject: [PATCH] fix: text_inconsistencies

_api_operation_name
snake to camel case
operations
---
 core/content-negotiation.md |  6 +--
 core/controllers.md         | 13 +++---
 core/errors.md              |  2 +-
 core/fosuser-bundle.md      |  4 +-
 core/graphql.md             |  2 +-
 core/openapi.md             |  4 +-
 core/operations.md          | 83 ++++---------------------------------
 core/pagination.md          |  2 +-
 core/performance.md         |  2 +-
 core/security.md            |  4 +-
 core/serialization.md       |  2 +-
 11 files changed, 29 insertions(+), 95 deletions(-)

diff --git a/core/content-negotiation.md b/core/content-negotiation.md
index dbfcdaebda5..c24709e6914 100644
--- a/core/content-negotiation.md
+++ b/core/content-negotiation.md
@@ -94,10 +94,10 @@ api_platform:
 
 ## Configuring Formats For a Specific Resource or Operation
 
-Support for specific formats can also be configured at resource and operation level using the `input_formats` and `output_formats` attributes.
-`input_formats` controls the formats accepted in request bodies while `output_formats` controls formats available for responses.
+Support for specific formats can also be configured at resource and operation level using the `inputFormats` and `outputFormats` attributes.
+`inputFormats` controls the formats accepted in request bodies while `outputFormats` controls formats available for responses.
 
-The `format` attribute can be used as a shortcut, it sets both the `input_formats` and `output_formats` in one time.
+The `format` attribute can be used as a shortcut, it sets both the `inputFormats` and `outputFormats` in one time.
 
 ```php
 <?php
diff --git a/core/controllers.md b/core/controllers.md
index c31220625eb..5a728d48a39 100644
--- a/core/controllers.md
+++ b/core/controllers.md
@@ -21,7 +21,7 @@ automatically instantiated and injected, without having to declare it explicitly
 
 In the following examples, the built-in `GET` operation is registered as well as a custom operation called `post_publication`.
 
-By default, API Platform uses the first `GET` operation defined in `itemOperations` to generate the IRI of an item and the first `GET` operation defined in `collectionOperations` to generate the IRI of a collection.
+By default, API Platform uses the first `Get` operation defined to generate the IRI of an item and the first `GetCollection` operation to generate the IRI of a collection.
 
 If you create a custom operation, you will probably want to properly document it.
 See the [OpenAPI](swagger.md) part of the documentation to do so.
@@ -149,7 +149,7 @@ the associated controller respectively.
 
 ## Using Serialization Groups
 
-You may want different serialization groups for your custom operations. Just configure the proper `normalization_context` and/or `denormalization_context` in your operation:
+You may want different serialization groups for your custom operations. Just configure the proper `normalizationContext` and/or `denormalizationContext` in your operation:
 
 [codeSelector]
 
@@ -226,7 +226,7 @@ App\Entity\Book:
 
 ## Retrieving the Entity
 
-If you want to bypass the automatic retrieval of the entity in your custom operation, you can set `"read"=false` in the
+If you want to bypass the automatic retrieval of the entity in your custom operation, you can set `read: false` in the
 operation attribute:
 
 [codeSelector]
@@ -305,7 +305,7 @@ the configuration at the same time in the routing and the resource configuration
 The `post_publication` operation references the Symfony route named `book_post_publication`.
 
 Since version 2.3, you can also use the route name as operation name by convention, as shown in the following example
-for `book_post_discontinuation` when neither `method` nor `route_name` attributes are specified.
+for `book_post_discontinuation` when neither `method` nor `routeName` attributes are specified.
 
 First, let's create your resource configuration:
 
@@ -391,7 +391,7 @@ class CreateBookPublication extends AbstractController
         methods: ['POST'],
         defaults: [
             '_api_resource_class' => Book::class,
-            '_api_item_operation_name' => 'post_publication',
+            '_api_operation_name' => '_api_/books/{id}/publication_post',
         ],
     )]
     public function __invoke(Book $book): Book
@@ -403,8 +403,7 @@ class CreateBookPublication extends AbstractController
 }
 ```
 
-It is mandatory to set `_api_resource_class` and `_api_item_operation_name` (or `_api_collection_operation_name` for a collection
-operation) in the parameters of the route (`defaults` key). It allows API Platform to work with the Symfony routing system.
+It is mandatory to set `_api_resource_class` and `_api_operation_name` in the parameters of the route (`defaults` key). It allows API Platform to work with the Symfony routing system.
 
 Alternatively, you can also use a traditional Symfony controller and YAML or XML route declarations. The following example does
 the same thing as the previous example:
diff --git a/core/errors.md b/core/errors.md
index a02033e9561..043d583e124 100644
--- a/core/errors.md
+++ b/core/errors.md
@@ -110,7 +110,7 @@ In any other cases, your exception message will be sent to end users.
 
 ## Fine-grained Configuration
 
-The `exception_to_status` configuration can be set on resources and operations:
+The `exceptionToStatus` configuration can be set on resources and operations:
 
 ```php
 <?php
diff --git a/core/fosuser-bundle.md b/core/fosuser-bundle.md
index f2ce636fe52..1c9ae3dfc4a 100644
--- a/core/fosuser-bundle.md
+++ b/core/fosuser-bundle.md
@@ -46,8 +46,8 @@ api_platform:
 Here's an example of declaration of a [Doctrine ORM User class](https://github.com/FriendsOfSymfony/FOSUserBundle/blob/master/Resources/doc/index.rst#a-doctrine-orm-user-class).
 There's also an example for a [Doctrine MongoDB ODM](https://github.com/FriendsOfSymfony/FOSUserBundle/blob/master/Resources/doc/index.rst#b-mongodb-user-class).
 You need to use serialization groups to hide some properties like `plainPassword` (only in read) and `password`. The properties
-shown are handled with [`normalization_context`](serialization.md#normalization), while the properties
-you can modify are handled with [`denormalization_context`](serialization.md#denormalization).
+shown are handled with [`normalizationContext`](serialization.md#normalization), while the properties
+you can modify are handled with [`denormalizationContext`](serialization.md#denormalization).
 
 Create your User entity with serialization groups:
 
diff --git a/core/graphql.md b/core/graphql.md
index 360ee56320e..741c099988a 100644
--- a/core/graphql.md
+++ b/core/graphql.md
@@ -1218,7 +1218,7 @@ You may want to restrict some resource's attributes to your GraphQL clients.
 
 As described in the [serialization process](serialization.md) documentation, you can use serialization groups to expose only the attributes you want in queries or in mutations.
 
-If the (de)normalization context between GraphQL and REST is different, use the `graphql` key to change it.
+If the (de)normalization context between GraphQL and REST is different, use the `(de)normalizationContext` key to change it in each query and mutations.
 
 Note that:
 
diff --git a/core/openapi.md b/core/openapi.md
index 5992297b2c1..df35c494702 100644
--- a/core/openapi.md
+++ b/core/openapi.md
@@ -254,12 +254,12 @@ This will produce the following Swagger documentation:
 }
 ```
 
-To pass a context to the OpenAPI **v2** generator, use the `swagger_context` attribute (notice the prefix: `swagger_` instead of `openapi_`).
+To pass a context to the OpenAPI **v2** generator, use the `swaggerContext` attribute (notice the prefix: `swagger` instead of `openapi`).
 
 ## Changing the Name of a Definition
 
 API Platform generates a definition name based on the serializer `groups` defined
-in the (`de`)`normalization_context`. It's possible to override the name
+in the (`de`)`normalizationContext`. It's possible to override the name
 thanks to the `swagger_definition_name` option:
 
 ```php
diff --git a/core/operations.md b/core/operations.md
index 0dfc6fd2064..4f6056f8262 100644
--- a/core/operations.md
+++ b/core/operations.md
@@ -52,20 +52,17 @@ Existing properties not included in the payload are **not** removed, their curre
 If no operation is specified, all default CRUD operations are automatically registered. It is also possible - and recommended
 for large projects - to define operations explicitly.
 
-Keep in mind that `collectionOperations` and `itemOperations` behave independently. For instance, if you don't explicitly
-configure operations for `collectionOperations`, `GET` and `POST` operations will be automatically registered, even if you
-explicitly configure `itemOperations`. The reverse is also true.
+Keep in mind that once you explicitly set up an operation, the automatically registered CRUD will no longer be.
+If you declare even one operation manually, such as `#[GET]`, you must declare the others manually as well if you need them.
 
 Operations can be configured using annotations, XML or YAML. In the following examples, we enable only the built-in operation
-for the `GET` method for both `collectionOperations` and `itemOperations` to create a readonly endpoint.
-
-`itemOperations` and `collectionOperations` are arrays containing a list of operations. Each operation is defined by a key
-corresponding to the name of the operation that can be anything you want and an array of properties as value. If an
-empty list of operations is provided, all operations are disabled.
+for the `GET` method for both `collection` and `item` to create a readonly endpoint.
 
 If the operation's name matches a supported HTTP methods (`GET`, `POST`, `PUT`, `PATCH` or `DELETE`), the corresponding `method` property
 will be automatically added.
 
+Note: The `#[GetCollection]` attribute is an alias for `#[Get(collection: true)]`
+
 [codeSelector]
 
 ```php
@@ -116,62 +113,6 @@ App\Entity\Book:
 
 [/codeSelector]
 
-The previous example can also be written with an explicit method definition:
-
-[codeSelector]
-
-```php
-<?php
-// api/src/Entity/Book.php
-namespace App\Entity;
-
-use ApiPlatform\Metadata\ApiResource;
-use ApiPlatform\Metadata\Get;
-use ApiPlatform\Metadata\GetCollection;
-
-#[ApiResource]
-#[Get]
-#[GetCollection]
-class Book
-{
-    // ...
-}
-```
-
-```yaml
-# api/config/api_platform/resources.yaml
-App\Entity\Book:
-    collectionOperations:
-        get:
-            method: GET
-    itemOperations:
-        get:
-            method: GET
-```
-
-```xml
-<?xml version="1.0" encoding="UTF-8" ?>
-<!-- api/config/api_platform/resources.xml -->
-
-<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\Book">
-        <collectionOperations>
-            <collectionOperation name="get" />
-        </collectionOperations>
-        <itemOperations>
-            <itemOperation name="get">
-                <attribute name="method">GET</attribute>
-            </itemOperation>
-        </itemOperations>
-    </resource>
-</resources>
-```
-
-[/codeSelector]
-
 API Platform Core is smart enough to automatically register the applicable Symfony route referencing a built-in CRUD action
 just by specifying the method name as key, or by checking the explicitly configured HTTP method.
 
@@ -195,7 +136,7 @@ use ApiPlatform\Metadata\ApiResource;
     read: false, 
     output: false
 )]
-#[GetCollection]
+#[GetCollection] 
 class Book
 {
     // ...
@@ -336,13 +277,11 @@ App\Entity\Book:
 
 [/codeSelector]
 
-In all these examples, the `method` attribute is omitted because it matches the operation name.
-
 ## Prefixing All Routes of All Operations
 
 Sometimes it's also useful to put a whole resource into its own "namespace" regarding the URI. Let's say you want to
 put everything that's related to a `Book` into the `library` so that URIs become `library/book/{id}`. In that case
-you don't need to override all the operations to set the path but configure the `route_prefix` attribute for the whole entity instead:
+you don't need to override all the operations to set the path but configure the `routePrefix` attribute for the whole entity instead:
 
 [codeSelector]
 
@@ -394,8 +333,6 @@ App\Entity\Book:
 
 [/codeSelector]
 
-Alternatively, the more verbose attribute syntax can be used: `#[ApiResource(routePrefix: "/library")]`.
-
 API Platform will automatically map this `post_publication` operation to the route `book_post_publication`. Let's create a custom action
 and its related route using annotations:
 
@@ -422,7 +359,7 @@ class CreateBookPublication extends AbstractController
         name: 'book_post_publication',
         defaults: [
             '_api_resource_class' => Book::class,
-            '_api_item_operation_name' => 'post_publication',
+            '_api_operation_name' => '_api_/books/{id}/publication_post',
         ],
         methods: ['POST'],
     )]
@@ -435,8 +372,7 @@ class CreateBookPublication extends AbstractController
 }
 ```
 
-It is mandatory to set `_api_resource_class` and `_api_item_operation_name` (or `_api_collection_operation_name` for a collection
-operation) in the parameters of the route (`defaults` key). It allows API Platform to work with the Symfony routing system.
+It is mandatory to set `_api_resource_class` and `_api_operation_name`in the parameters of the route (`defaults` key). It allows API Platform to work with the Symfony routing system.
 
 Alternatively, you can also use a traditional Symfony controller and YAML or XML route declarations. The following example does
 the exact same thing as the previous example:
@@ -609,7 +545,6 @@ Then, remove the route from the decorator:
 ```php
 <?php
 // src/OpenApi/OpenApiFactory.php
-
 namespace App\OpenApi;
 
 use ApiPlatform\Core\OpenApi\Factory\OpenApiFactoryInterface;
diff --git a/core/pagination.md b/core/pagination.md
index 310a9233686..1417c1dc745 100644
--- a/core/pagination.md
+++ b/core/pagination.md
@@ -309,7 +309,7 @@ class Book
 
 ## Cursor-Based Pagination
 
-To configure your resource to use the cursor-based pagination, select your unique sorted field as well as the direction you’ll like the pagination to go via filters and enable the `pagination_via_cursor` option.
+To configure your resource to use the cursor-based pagination, select your unique sorted field as well as the direction you’ll like the pagination to go via filters and enable the `paginationViaCursor` option.
 Note that for now you have to declare a `RangeFilter` and an `OrderFilter` on the property used for the cursor-based pagination.
 
 The following configuration also works on a specific operation:
diff --git a/core/performance.md b/core/performance.md
index e3624efd80b..5939c694e5e 100644
--- a/core/performance.md
+++ b/core/performance.md
@@ -88,7 +88,7 @@ final class UserResourcesSubscriber implements EventSubscriberInterface
 
 ## Setting Custom HTTP Cache Headers
 
-The `cache_headers` attribute can be used to set custom HTTP cache headers:
+The `cacheHeaders` attribute can be used to set custom HTTP cache headers:
 
 ```php
 use ApiPlatform\Metadata\ApiResource;
diff --git a/core/security.md b/core/security.md
index 8b5f2c8252f..cdd04a28909 100644
--- a/core/security.md
+++ b/core/security.md
@@ -287,14 +287,14 @@ class BookVoter extends Voter
 }
 ```
 
-*Note 1: When using Voters on POST methods: The voter needs an `$attribute` and `$subject` as input parameter, so you have to use the `security_post_denormalize` (i.e. `"post" = { "security_post_denormalize" = "is_granted('BOOK_CREATE', object)" }` ) because the object does not exist before denormalization (it is not created, yet.)*
+*Note 1: When using Voters on POST methods: The voter needs an `$attribute` and `$subject` as input parameter, so you have to use the `securityPostDenormalize` (i.e. `"post" = { "securityPostDenormalize" = "is_granted('BOOK_CREATE', object)" }` ) because the object does not exist before denormalization (it is not created, yet.)*
 
 *Note 2: You can't use Voters on the collection GET method, use [Collection Filters](https://api-platform.com/docs/core/security/#filtering-collection-according-to-the-current-user-permissions) instead.*
 
 ## Configuring the Access Control Error Message
 
 By default when API requests are denied, you will get the "Access Denied" message.
-You can change it by configuring the `security_message` attribute or the `security_post_denormalize_message` attribute.
+You can change it by configuring the `securityMessage` attribute or the `securityPostDenormalizeMessage` attribute.
 
 For example:
 
diff --git a/core/serialization.md b/core/serialization.md
index 5270d0ca926..c99968ce0f0 100644
--- a/core/serialization.md
+++ b/core/serialization.md
@@ -434,7 +434,7 @@ App\Entity\Person:
 
 The problem here is that the **$parent** property become automatically an embedded object. Besides, the property won't be shown on the OpenAPI view.
 
-To force the **$parent** property to be used as an IRI, add an **#[ApiProperty(readableLink: false, writableLink: false)]** annotation:
+To force the **$parent** property to be used as an IRI, add an `#[ApiProperty(readableLink: false, writableLink: false)]` annotation:
 
 [codeSelector]