Skip to content

Commit ddec9cb

Browse files
amauryvallieramauryvallier
committed
Merge branch 'master' into feature/BAP-21264_es8
2 parents 204dc3e + 304a762 commit ddec9cb

File tree

516 files changed

+8137
-5593
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

516 files changed

+8137
-5593
lines changed

‎_themes/sphinx_rtd_theme/header.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
<li><a href="{{ pathto('/backend/index') }}">Backend Developer Guide</a></li>
3434
<li><a href="{{ pathto('/frontend/index') }}">Frontend Developer Guide</a></li>
3535
<li><a href="{{ pathto('/bundles/index') }}">Oro Bundles</a></li>
36+
<li><a href="{{ pathto('/components/index') }}">Oro Components</a></li>
3637
<li><a href="{{ pathto('/api/index') }}">Web Services API Guide</a></li>
3738
<li><a href="{{ pathto('/community/index') }}">Community Guide</a></li>
3839
</ul>

‎api/filters.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ Include the **roles** relation with the **fields** filter.
340340
"email": "[email protected]"
341341
},
342342
"relationships": {
343-
"roles": {
343+
"userRoles": {
344344
"data": [
345345
{
346346
"type": "userroles",
@@ -398,7 +398,7 @@ should be used.
398398
"email": "[email protected]"
399399
},
400400
"relationships": {
401-
"roles": {
401+
"userRoles": {
402402
"data": [
403403
{
404404
"type": "userroles",

‎backend/api/actions.rst

Lines changed: 278 additions & 278 deletions
Large diffs are not rendered by default.

‎backend/api/batch-api.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ The default configuration of this cron job is illustrated below:
8181
# The maximum number of seconds that the cron job can spend in one run.
8282
cleanup_process_timeout: 3600 # 1 hour
8383
84+
# The maximum number of seconds after which an operation will be removed regardless of status.
85+
operation_timeout: 3600 # 1 hour
86+
8487
.. _web-api--batch-api--storage-config:
8588

8689
Storage Configuration

‎backend/api/commands.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The ``--no-warmup`` option can be used to skip warming up the cache after cleani
2222

2323
.. code-block:: none
2424
25-
php bin/console oro:api:cache:clear --no-warmup
25+
php bin/console oro:api:cache:clear --no-warmup
2626
2727
.. _oroapidoccacheclear:
2828

@@ -215,13 +215,13 @@ If a new extra section was added, pass the FQCN of a ConfigExtra:
215215

216216
.. code-block:: none
217217
218-
php bin/console oro:api:config:dump users --extra="Acme\Bundle\AcmeBundle\Config\AcmeConfigExtra"
218+
php bin/console oro:api:config:dump users --extra="Acme\Bundle\DemoBundle\Config\AcmeConfigExtra"
219219
220220
You can pass multiple options:
221221

222222
.. code-block:: none
223223
224-
php bin/console oro:api:config:dump users --extra=sorters --extra=descriptions --extra=filters --extra="Acme\Bundle\AcmeBundle\Config\AcmeConfigExtra"
224+
php bin/console oro:api:config:dump users --extra=sorters --extra=descriptions --extra=filters --extra="Acme\Bundle\DemoBundle\Config\MyConfigExtra"
225225
226226
oro:api:metadata:dump
227227
---------------------
@@ -256,7 +256,7 @@ To include the HATEOAS links to the metadata, use the ``--hateoas`` option:
256256

257257
.. code-block:: none
258258
259-
php bin/console oro:api:metadata:dump --hateoas <entity>
259+
php bin/console oro:api:metadata:dump --hateoas <entity>
260260
261261
oro:api:config:dump-reference
262262
-----------------------------
@@ -271,7 +271,7 @@ The --max-nesting-level option can be used to limit the depth of nesting target
271271

272272
.. code-block:: none
273273
274-
php bin/console oro:api:config:dump-reference --max-nesting-level=<number>
274+
php bin/console oro:api:config:dump-reference --max-nesting-level=<number>
275275
276276
.. _web-api--commands--oro-cron-api-async_operations-cleanup:
277277

@@ -292,4 +292,4 @@ To show the number of obsolete asynchronous operations without the deletion of t
292292
293293
294294
.. include:: /include/include-links-dev.rst
295-
:start-after: begin
295+
:start-after: begin

‎backend/api/configuration-extensions.rst

Lines changed: 37 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Each configuration extension must implement |ConfigExtensionInterface| (you can
1818

1919
.. code-block:: php
2020
21-
namespace Acme\Bundle\AcmeBundle\Api;
21+
namespace Acme\Bundle\DemoBundle\Api;
2222
2323
use Oro\Bundle\ApiBundle\Config\Extension\AbstractConfigExtension;
2424
@@ -27,12 +27,12 @@ Each configuration extension must implement |ConfigExtensionInterface| (you can
2727
}
2828
2929
.. code-block:: yaml
30-
:caption: config/config.yml
30+
:caption: config/config.yml
3131
3232
services:
33-
acme.api.my_config_extension:
34-
class: Acme\Bundle\AcmeBundle\Api\MyConfigExtension
35-
public: false
33+
acme.api.my_config_extension:
34+
class: Acme\Bundle\DemoBundle\Api\MyConfigExtension
35+
public: false
3636
3737
oro_api:
3838
config_extensions:
@@ -80,17 +80,17 @@ Example:
8080

8181
.. code-block:: php
8282
83-
namespace Acme\Bundle\AcmeBundle\Api;
83+
namespace Acme\Bundle\DemoBundle\Api;
8484
8585
use Symfony\Component\Config\Definition\Builder\NodeBuilder;
8686
use Oro\Bundle\ApiBundle\Config\Extension\AbstractConfigExtension;
8787
8888
class MyConfigExtension extends AbstractConfigExtension
8989
{
9090
/**
91-
* {@inheritdoc}
91+
* @inheritDoc
9292
*/
93-
public function getConfigureCallbacks()
93+
public function getConfigureCallbacks(): array
9494
{
9595
return [
9696
'entities.entity' => function (NodeBuilder $node) {
@@ -100,9 +100,9 @@ Example:
100100
}
101101
102102
/**
103-
* {@inheritdoc}
103+
* @inheritDoc
104104
*/
105-
public function getPreProcessCallbacks()
105+
public function getPreProcessCallbacks(): array
106106
{
107107
return [
108108
'entities.entity' => function (array $config) {
@@ -113,9 +113,9 @@ Example:
113113
}
114114
115115
/**
116-
* {@inheritdoc}
116+
* @inheritDoc
117117
*/
118-
public function getPostProcessCallbacks()
118+
public function getPostProcessCallbacks(): array
119119
{
120120
return [
121121
'entities.entity' => function (array $config) {
@@ -140,14 +140,17 @@ An example of simple configuration section:
140140

141141
.. code-block:: php
142142
143-
namespace Acme\Bundle\AcmeBundle\Api;
143+
namespace Acme\Bundle\DemoBundle\Api\Config\Definition;
144144
145-
use Symfony\Component\Config\Definition\Builder\NodeBuilder;
146145
use Oro\Bundle\ApiBundle\Config\Definition\AbstractConfigurationSection;
146+
use Symfony\Component\Config\Definition\Builder\NodeBuilder;
147147
148148
class MyConfiguration extends AbstractConfigurationSection
149149
{
150-
public function configure(NodeBuilder $node)
150+
/**
151+
* @inheritDoc
152+
*/
153+
public function configure(NodeBuilder $node): void
151154
{
152155
$node->scalarNode('some_option');
153156
}
@@ -157,15 +160,18 @@ An example of a configuration section that can be extended by other bundles:
157160

158161
.. code-block:: php
159162
160-
namespace Acme\Bundle\AcmeBundle\Api;
163+
namespace Acme\Bundle\DemoBundle\Api\Config\Definition;
161164
165+
use Oro\Bundle\ApiBundle\Config\Definition\AbstractConfigurationSection;
162166
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
163167
use Symfony\Component\Config\Definition\Builder\NodeBuilder;
164-
use Oro\Bundle\ApiBundle\Config\Definition\AbstractConfigurationSection;
165168
166169
class MyConfiguration extends AbstractConfigurationSection
167170
{
168-
public function configure(NodeBuilder $node)
171+
/**
172+
* @inheritDoc
173+
*/
174+
public function configure(NodeBuilder $node): void
169175
{
170176
$sectionName = 'my_section';
171177
@@ -183,14 +189,15 @@ An example of a configuration section loader:
183189

184190
.. code-block:: php
185191
186-
namespace Acme\Bundle\AcmeBundle\Api;
192+
namespace Acme\Bundle\DemoBundle\Api\Config\Loader;
187193
194+
use Acme\Bundle\DemoBundle\Api\Config\MyConfigSection;
188195
use Oro\Bundle\ApiBundle\Config\Loader\AbstractConfigLoader;
189196
190197
class MyConfigLoader extends AbstractConfigLoader
191198
{
192199
/**
193-
* {@inheritdoc}
200+
* @inheritDoc
194201
*/
195202
public function load(array $config)
196203
{
@@ -207,24 +214,26 @@ An example of a configuration extension:
207214

208215
.. code-block:: php
209216
210-
namespace Acme\Bundle\AcmeBundle\Api;
217+
namespace Acme\Bundle\DemoBundle\Api\Config\Extension;
211218
219+
use Acme\Bundle\DemoBundle\Api\Config\Definition\MyConfiguration;
220+
use Acme\Bundle\DemoBundle\Api\Config\Loader\MyConfigLoader;
212221
use Oro\Bundle\ApiBundle\Config\Extension\AbstractConfigExtension;
213222
214223
class MyConfigExtension extends AbstractConfigExtension
215224
{
216225
/**
217-
* {@inheritdoc}
226+
* @inheritDoc
218227
*/
219-
public function getEntityConfigurationSections()
228+
public function getEntityConfigurationSections(): array
220229
{
221230
return ['my_section' => new MyConfiguration()];
222231
}
223232
224233
/**
225-
* {@inheritdoc}
234+
* @inheritDoc
226235
*/
227-
public function getEntityConfigurationLoaders()
236+
public function getEntityConfigurationLoaders(): array
228237
{
229238
return ['my_section' => new MyConfigLoader()];
230239
}
@@ -236,14 +245,14 @@ An example of how to use the created configuration section:
236245
237246
api:
238247
entities:
239-
Acme\Bundle\AcmeBundle\Entity\AcmeEntity:
248+
Acme\Bundle\DemoBundle\Entity\SomeEntity:
240249
my_section:
241250
my_option: value
242251
243252
To check that your configuration section is added correctly, run ``php bin/console oro:api:config:dump-reference``. The output should look similar to the following:
244253

245254
.. code-block:: yaml
246-
:caption: Resources/config/oro/api.yml
255+
:caption: Resources/config/oro/api.yml
247256
248257
api:
249258
entities:
@@ -252,4 +261,4 @@ To check that your configuration section is added correctly, run ``php bin/conso
252261
my_option: ~
253262
254263
.. include:: /include/include-links-dev.rst
255-
:start-after: begin
264+
:start-after: begin

0 commit comments

Comments
 (0)