Merge branch 'master' into feature/BAP-21264_es8

Author: amauryvallier

backend/api/actions.rst

@@ -5,7 +5,7 @@ Batch API
 
 The Batch API provides a way to create or update a list of entities of the same type via one API request.
 
-For detailed information how this API works see :ref:`update_list <update-list-action>`,
+For detailed information how this API works, see the :ref:`update_list <update-list-action>`,
 :ref:`batch_update <batch-update-action>` and :ref:`batch_update_item <batch-update-item-action>` actions.
 
 .. _web-api--batch-api--enable:
@@ -15,7 +15,7 @@ Enable Batch API for Entity
 
 By default, Batch API is disabled for all API resources. To enable it for an API resource,
 the :ref:`update_list <update-list-action>` action should be enabled for this resource.
-This can be done via ``actions`` section for an entity in `Resources/config/oro/api.yml`.
+You can do this via ``actions`` section for an entity in `Resources/config/oro/api.yml`.
 
 Example:
 
@@ -32,7 +32,7 @@ Example:
 Batch API Configuration
 -----------------------
 
-All configuration options related to Batch API are grouped in ``batch_api`` section of ApiBundle configuration:
+All configuration options related to Batch API are grouped in the ``batch_api`` section of ApiBundle configuration:
 
 .. code-block:: yaml
 
@@ -56,9 +56,8 @@ All configuration options related to Batch API are grouped in ``batch_api`` sect
 Parameters ``chunk_size_per_entity`` and ``included_data_chunk_size_per_entity`` can be used to tuning of
 an API engine to have maximum performance.
 
-To get maximum performance in requests with included entities, the value of the ``included_data_chunk_size_per_entity``
-parameter can be changed to the medium number of related entities that will be set to one primary entity when processing
-the request.
+To get maximum performance in requests with included entities, you can change the value of the ``included_data_chunk_size_per_entity``
+parameter to the medium number of related entities that will be set to one primary entity when processing the request.
 
 .. _web-api--batch-api--async-operation-config:
 
@@ -89,8 +88,7 @@ The default configuration of this cron job is illustrated below:
 Storage Configuration
 ---------------------
 
-The |KnpGaufretteBundle| is used to configure storages for source data files of Batch API requests and
-all files that are created when processing asynchronous batch operations (e.g. chunk files, error files, etc.).
+The |KnpGaufretteBundle| is used to configure storages for source data files of Batch API requests and all files created when processing asynchronous batch operations (e.g., chunk files, error files, etc.).
 
 Here is the default configuration of these storages:
 
@@ -117,8 +115,7 @@ Here is the default configuration of these storages:
                 adapter: api
                 alias: api_filesystem
 
-To change the adapter configuration the `Resources/config/oro/app.yml` in any bundle or `config/config.yml`
-of your application can be used.
+To change the adapter configuration, use `Resources/config/oro/app.yml` in any application bundle or `config/config.yml`.
 The following example shows how to reconfigure this adapter to use a local filesystem:
 
 .. code-block:: yaml
@@ -129,8 +126,8 @@ The following example shows how to reconfigure this adapter to use a local files
                 local:
                     directory: '%kernel.project_dir%/var/api_files'
 
-More examples can be found in |KnpGaufretteBundle documentation|.
+You can find more examples in |KnpGaufretteBundle documentation|.
 
 
 .. include:: /include/include-links-dev.rst
-   :start-after: begin
+   :start-after: begin

backend/api/batch-api.rst

@@ -10,9 +10,9 @@ CLI Commands
 oro:api:cache:clear
 -------------------
 
-This command command clears the API cache.
+This command clears the API cache.
 
-Usually you need to run this command when you add a new entity to `Resources/config/oro/api.yml` or you add a new processor that changes a list of available via the API.
+Usually, you need to run this command when you add a new entity to `Resources/config/oro/api.yml` or a new processor that changes a list of available via the API.
 
 .. code-block:: none
 
@@ -29,7 +29,7 @@ The ``--no-warmup`` option can be used to skip warming up the cache after cleani
 oro:api:doc:cache:clear
 -----------------------
 
-This clears or warms up API documentation cache.
+This clears or warms up the API documentation cache.
 
 If this command is launched without parameters, it warm ups all API documentation caches:
 
@@ -43,7 +43,7 @@ To clear the cache without then warming it up, use the ``--no-warmup`` option:
 
     php bin/console oro:api:doc:cache:clear --no-warmup
 
-To work only with the specified |API documentation views| use ``--view`` option:
+To work only with the specified |API documentation views| use the ``--view`` option:
 
 .. code-block:: none
 
@@ -127,8 +127,8 @@ or
 
     php bin/console oro:api:debug --no-docs <action> <group>
 
-The --attribute option can be used to show the processors that will be executed only when the context has a given attribute with the specified value.
-The attribute name and value should be separated by a colon, e.g. --attribute=collection:true   for a scalar value, or --attribute=extra:[definition,filters] for an array value:
+You can use the ``--attribute`` option to show the processors that will be executed only when the context has a given attribute with the specified value.
+Separate the attribute name and value by a colon, e.g., ``--attribute=collection:true`` for a scalar value, or ``--attribute=extra:[definition,filters]`` for an array value:
 
 .. code-block:: none
 
@@ -140,7 +140,7 @@ or
 
     php bin/console oro:api:debug --attribute=extra:[definition,filters] <action>
 
-The --processors and --processors-without-description options can be used to display all processors and all processors without descriptions respectively:
+Use the ``--processors` and ``--processors-without-description`` options to display all processors and all processors without descriptions, respectively:
 
 .. code-block:: none
 
@@ -152,7 +152,7 @@ or
 
     php bin/console oro:api:debug --processors-without-description
 
-The --request-type option can limit the scope to the specified request type(s).  Omitting this option is equivalent to --request-type=rest --request-type=json_api. Available types: rest, json_api, batch, or use any to include all request types:
+The ``--request-type`` option can limit the scope to the specified request type(s). Omitting this option is equivalent to ``--request-type=rest --request-type=json_api``. The available types are ``rest``, ``json_api``, ``batch``, or use ``any`` to include all request types:
 
 .. code-block:: none
 
@@ -173,7 +173,7 @@ The --request-type option can limit the scope to the specified request type(s).
 oro:api:config:dump
 -------------------
 
-This command shows configuration for a particular entity.
+This command shows the configuration for a particular entity.
 
 Execute this command with an entity class or entity alias specified as an argument:
 
@@ -193,25 +193,25 @@ To display the configuration used for a particular action, use the ``--action op
 
     php bin/console oro:api:config:dump users --action=update
 
-To display the configuration for a particular request type you can use the ``request-type`` option:
+To display the configuration for a particular request type, use the ``request-type`` option:
 
 .. code-block:: none
 
     php bin/console oro:api:config:dump users --request-type=rest --request-type=json_api
 
-By default no extra configuration data are added into output, but they can be added with the ``--extra`` option. The value for ``extra`` option can be: actions, definition, filters, sorters, descriptions or the full name of a class implements |ConfigExtraInterface|, e.g.
+No extra configuration data are added to the output by default, but you can add them with the ``--extra`` option. The value for the ``extra`` option can be: actions, definition, filters, sorters, descriptions, or the full name of a class implements |ConfigExtraInterface|, e.g.
 
 .. code-block:: none
 
     php bin/console oro:api:config:dump users --extra=filters --extra=sorters
 
-To display the human-readable representation of an entity and its fields:
+To display the human-readable representation of an entity and its fields, use:
 
 .. code-block:: none
 
     php bin/console oro:api:config:dump users --extra=descriptions
 
-If a new extra section was added, pass the FQCN of a ConfigExtra:
+If you added a new extra section, pass the FQCN of a ConfigExtra:
 
 .. code-block:: none
 
@@ -267,7 +267,7 @@ This command shows the structure of `Resources/config/oro/api.yml`.
 
     php bin/console oro:api:config:dump-reference
 
-The --max-nesting-level option can be used to limit the depth of nesting target entities:
+You can use the ``--max-nesting-level`` option to limit the depth of nesting target entities:
 
 .. code-block:: none
 
@@ -290,6 +290,5 @@ To show the number of obsolete asynchronous operations without the deletion of t
 
     php bin/console oro:cron:api:async_operations:cleanup --dry-run
 
-
 .. include:: /include/include-links-dev.rst
-    :start-after: begin
+    :start-after: begin

backend/api/commands.rst

@@ -3,18 +3,14 @@
 Configuration Extensions
 ========================
 
-Configuration extensions help add:
-
--  new options to existing configuration sections
--  new configuration sections
+Configuration extensions help add new options to existing configuration sections and new configuration sections.
 
 .. _web-api--configuration-extensions-create:
 
 Creating a Configuration Extension
 ----------------------------------
 
-
-Each configuration extension must implement |ConfigExtensionInterface| (you can also use |AbstractConfigExtension| as a superclass). To register new configuration extension, add it to `Resources/config/oro/app.yml` in your bundle or use `config/config.yml` of your application. Here is an example:
+Each configuration extension must implement |ConfigExtensionInterface| (you can also use |AbstractConfigExtension| as a superclass). To register a new configuration extension, add it to `Resources/config/oro/app.yml` in your bundle or use `config/config.yml` of your application. Here is an example:
 
 .. code-block:: php
 
@@ -38,15 +34,14 @@ Each configuration extension must implement |ConfigExtensionInterface| (you can
         config_extensions:
             - acme.api.my_config_extension
 
-
 .. _web-api--configuration-extensions-add-options:
 
 Add Options to an Existing Configuration Section
 ------------------------------------------------
 
-To add options to an existing configuration section, implement the ``getConfigureCallbacks`` method of |ConfigExtensionInterface|. If you need to add logic before the normalization of during the validation of the configuration, implement the ``getPreProcessCallbacks`` and ``getPostProcessCallbacks`` methods.
+To add options to an existing configuration section, implement the ``getConfigureCallbacks`` method of |ConfigExtensionInterface|. If you need to add logic before the normalization during the configuration validation, implement the ``getPreProcessCallbacks`` and ``getPostProcessCallbacks`` methods.
 
-The following table describes existing sections for which new options can be added.
+The following table describes existing sections to which you can add new options.
 
 +-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
 | Section Name                            | When to use                                                                                                                                   |
@@ -134,9 +129,9 @@ Add New Configuration Section
 
 To add new configuration section,  create a class implements |ConfigurationSectionInterface| and return instance of it in the ``getEntityConfigurationSections`` method of your configuration extension.
 
-By default the configuration is returned as an array, but if you want to provide a class represents the configuration of your section, you can implement a configuration loader. The loader is a class that implements |ConfigLoaderInterface|. An instance of the loader should be returned by the ``getEntityConfigurationLoaders`` method of your configuration extension.
+By default, the configuration is returned as an array, but if you want to provide a class that represents the configuration of your section, you can implement a configuration loader. The loader is a class that implements |ConfigLoaderInterface|. An instance of the loader should be returned by the ``getEntityConfigurationLoaders`` method of your configuration extension.
 
-An example of simple configuration section:
+An example of a simple configuration section:
 
 .. code-block:: php
 
@@ -156,7 +151,7 @@ An example of simple configuration section:
         }
     }
 
-An example of a configuration section that can be extended by other bundles:
+An example of a configuration section that other bundles can extend:
 
 .. code-block:: php
 
@@ -261,4 +256,4 @@ To check that your configuration section is added correctly, run ``php bin/conso
                     my_option: ~
 
 .. include:: /include/include-links-dev.rst
-    :start-after: begin
+    :start-after: begin