Skip to content

Commit 19e723f

Browse files
committed
feat(API-1864): Change compatibility annotation for API Client routes.
API-1863
1 parent 9733597 commit 19e723f

35 files changed

+129
-129
lines changed

content/php-client/resources/PAM/asset-categories.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Also, did you know that since the PIM 3.2 (or the 5.0 of the client), you can ha
1313
:::
1414

1515
#### Get an asset category
16-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
16+
::: php-client-availability versions=2.0 editions=EE
1717

1818
```php
1919
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -33,7 +33,7 @@ $assetCategory = $client->getAssetCategoryApi()->get('face');
3333
```
3434

3535
#### Get a list of asset categories
36-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
36+
::: php-client-availability versions=2.0 editions=EE
3737

3838
There are two ways of getting asset categories.
3939

@@ -63,7 +63,7 @@ $assetCategories = $client->getAssetCategoryApi()->all(50);
6363
You can get more information about this method [here](/php-client/list-resources.html#with-a-cursor).
6464

6565
#### Upsert an asset category
66-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
66+
::: php-client-availability versions=2.0 editions=EE
6767

6868
If the asset category does not exist yet, this method creates it, otherwise it updates it.
6969

@@ -80,7 +80,7 @@ $client->getAssetCategoryApi()->upsert('dos', [
8080
```
8181

8282
#### Upsert a list of asset categories
83-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
83+
::: php-client-availability versions=2.0 editions=EE
8484

8585
This method allows to create or update a list of asset categories.
8686
It has the same behavior as the `upsert` method for a single asset category, except that the code must be specified in the data of each asset category.

content/php-client/resources/PAM/asset-reference-files.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Also, did you know that since the PIM 3.2 (or the 5.0 of the client), you can ha
77
:::
88

99
#### Get a reference file of a localizable asset
10-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
10+
::: php-client-availability versions=2.0 editions=EE
1111

1212
```php
1313
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -28,7 +28,7 @@ $product = $client->getAssetReferenceFileApi()->getFromLocalizableAsset('chicago
2828
```
2929

3030
#### Get a reference file of a not localizable asset
31-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
31+
::: php-client-availability versions=2.0 editions=EE
3232

3333
```php
3434
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -49,7 +49,7 @@ $product = $client->getAssetReferenceFileApi()->getFromNotLocalizableAsset('brid
4949
```
5050

5151
#### Download a reference file of a localizable asset
52-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
52+
::: php-client-availability versions=2.0 editions=EE
5353

5454
```php
5555
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -67,7 +67,7 @@ file_put_contents('/tmp/chicagoskyline.jpg', $product->getBody()->getContents())
6767
```
6868

6969
#### Download a reference file of a not localizable asset
70-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
70+
::: php-client-availability versions=2.0 editions=EE
7171

7272
```php
7373
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -85,7 +85,7 @@ file_put_contents('/tmp/bridge.jpg', $product->getBody()->getContents());
8585
```
8686

8787
#### Upload an asset reference file for a localizable asset
88-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
88+
::: php-client-availability versions=2.0 editions=EE
8989

9090
```php
9191
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -126,7 +126,7 @@ try {
126126
```
127127

128128
#### Upload an asset reference file for a not localizable asset
129-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
129+
::: php-client-availability versions=2.0 editions=EE
130130

131131
```php
132132
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');

content/php-client/resources/PAM/asset-tags.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Also, did you know that since the PIM 3.2 (or the 5.0 of the client), you can ha
77
:::
88

99
#### Get an asset tag
10-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
10+
::: php-client-availability versions=2.0 editions=EE
1111

1212
```php
1313
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -22,7 +22,7 @@ $assetTag = $client->getAssetTagApi()->get('water');
2222
```
2323

2424
#### Get a list of asset tags
25-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
25+
::: php-client-availability versions=2.0 editions=EE
2626

2727
There are two ways of getting asset tags.
2828

@@ -51,7 +51,7 @@ $assetTags = $client->getAssetTagApi()->all(50);
5151
You can get more information about this method [here](/php-client/list-resources.html#with-a-cursor).
5252

5353
#### Upsert an asset tag
54-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
54+
::: php-client-availability versions=2.0 editions=EE
5555

5656
If the asset tag does not exist yet, this method creates it, otherwise it updates it.
5757

content/php-client/resources/PAM/asset-variation-files.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Also, did you know that since the PIM 3.2 (or the 5.0 of the client), you can ha
77
:::
88

99
#### Get a variation file of a localizable asset
10-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
10+
::: php-client-availability versions=2.0
1111

1212
```php
1313
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -29,7 +29,7 @@ $product = $client->getAssetVariationFileApi()->getFromLocalizableAsset('chicago
2929
```
3030

3131
#### Get a variation file of a not localizable asset
32-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
32+
::: php-client-availability versions=2.0
3333

3434
```php
3535
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -51,7 +51,7 @@ $product = $client->getAssetVariationFileApi()->getFromNotLocalizableAsset('brid
5151
```
5252

5353
#### Download a variation file of a localizable asset
54-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
54+
::: php-client-availability versions=2.0
5555

5656
```php
5757
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -69,7 +69,7 @@ file_put_contents('/tmp/chicagoskyline-mobile.jpg', $product->getBody()->getCont
6969
```
7070

7171
#### Download a variation file of a not localizable asset
72-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
72+
::: php-client-availability versions=2.0
7373

7474
```php
7575
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -87,7 +87,7 @@ file_put_contents('/tmp/bridge-mobile.jpg', $product->getBody()->getContents());
8787
```
8888

8989
#### Upload an asset variation file for a localizable asset
90-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
90+
::: php-client-availability versions=2.0
9191

9292
```php
9393
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -96,7 +96,7 @@ $client->getAssetVariationFileApi()->uploadForLocalizableAsset('/tmp/chicagoskyl
9696
```
9797

9898
#### Upload an asset variation file for a not localizable asset
99-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
99+
::: php-client-availability versions=2.0
100100

101101
```php
102102
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');

content/php-client/resources/PAM/assets.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Also, did you know that since the PIM 3.2 (or the 5.0 of the client), you can ha
77
:::
88

99
#### Get an asset
10-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
10+
::: php-client-availability versions=2.0 editions=EE
1111

1212
```php
1313
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -74,7 +74,7 @@ $asset = $client->getAssetApi()->get('bridge');
7474
```
7575

7676
#### Get a list of assets
77-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
77+
::: php-client-availability versions=2.0 editions=EE
7878

7979
There are two ways of getting assets.
8080

@@ -104,7 +104,7 @@ $assets = $client->getAssetApi()->all(50);
104104
You can get more information about this method [here](/php-client/list-resources.html#with-a-cursor).
105105

106106
#### Create an asset
107-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
107+
::: php-client-availability versions=2.0 editions=EE
108108

109109
If the asset does not exist yet, this method creates it, otherwise it throws an exception.
110110

@@ -121,7 +121,7 @@ $client->getAssetApi()->create('unicorn', [
121121
```
122122

123123
#### Upsert an asset
124-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
124+
::: php-client-availability versions=2.0 editions=EE
125125

126126
If the asset does not exist yet, this method creates it, otherwise it updates it.
127127

@@ -138,7 +138,7 @@ $client->getAssetApi()->upsert('bridge', [
138138
```
139139

140140
#### Upsert a list of assets
141-
::: php-client-availability versions=2.0,3.0,4.0,5.0,6.0 editions=EE
141+
::: php-client-availability versions=2.0 editions=EE
142142

143143
This method allows to create or update a list of assets.
144144
It has the same behavior as the `upsert` method for a single asset, except that the code must be specified in the data of each asset.

content/php-client/resources/app-catalog/app-catalog-product.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44
#### Get the list of product uuids
5-
::: php-client-availability versions=9.1 editions=CE,EE
5+
::: php-client-availability versions=9.1
66

77
```php
88
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('https://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');

content/php-client/resources/app-catalog/app-catalog.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44
#### Get the list of owned catalogs
5-
::: php-client-availability versions=9.1 editions=CE,EE
5+
::: php-client-availability versions=9.1
66

77
```php
88
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('https://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -27,7 +27,7 @@ $catalogs = $client->getAppCatalogApi()->all();
2727

2828

2929
#### Get a catalog
30-
::: php-client-availability versions=9.1 editions=CE,EE
30+
::: php-client-availability versions=9.1
3131

3232
```php
3333
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('https://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -44,7 +44,7 @@ $catalogs = $client->getAppCatalogApi()->get('12351d98-200e-4bbc-aa19-7fdda1bd14
4444
```
4545

4646
#### Create a new catalog
47-
::: php-client-availability versions=9.1 editions=CE,EE
47+
::: php-client-availability versions=9.1
4848

4949
If the catalog does not exist yet, this method creates it, otherwise it throws an exception.
5050

@@ -56,7 +56,7 @@ $client->getAppCatalogApi()->create(['name' => 'A catalog name']);
5656

5757

5858
#### Update a catalog
59-
::: php-client-availability versions=9.1 editions=CE,EE
59+
::: php-client-availability versions=9.1
6060

6161
```php
6262
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -66,7 +66,7 @@ $client->getAppCatalogApi()->upsert(['name' => 'A catalog name']);
6666

6767

6868
#### Delete a catalog
69-
::: php-client-availability versions=9.1 editions=CE,EE
69+
::: php-client-availability versions=9.1
7070

7171
```php
7272
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');

content/php-client/resources/asset-manager/asset-attribute-options.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
We refer here to the asset attribute option of the [Asset Manager](/concepts/asset-manager.html#asset-attribute-option).
44

55
#### Get an attribute option for a given attribute of a given asset
6-
::: php-client-availability versions=5.0,6.0 editions=EE
6+
::: php-client-availability versions=5.0 editions=EE
77

88
```php
99
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -23,7 +23,7 @@ $client->getAssetAttributeOptionApi()->get('packshot', 'main_colors', 'blue);
2323
```
2424

2525
#### Get the list of attribute options of a given attribute for a given asset
26-
::: php-client-availability versions=5.0,6.0 editions=EE
26+
::: php-client-availability versions=5.0 editions=EE
2727

2828
```php
2929
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -32,7 +32,7 @@ $client->getAssetAttributeOptionApi()->all('packshot', 'main_colors');
3232
```
3333

3434
#### Upsert an attribute option for a given attribute of a given asset
35-
::: php-client-availability versions=5.0,6.0 editions=EE
35+
::: php-client-availability versions=5.0 editions=EE
3636

3737
If the attribute option does not exist yet, this method creates it, otherwise it updates it.
3838

content/php-client/resources/asset-manager/asset-attributes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
We refer here to the asset attribute option of the [Asset Manager](/concepts/asset-manager.html#asset-attribute).
33

44
#### Get an attribute of a given asset family
5-
::: php-client-availability versions=5.0,6.0 editions=EE
5+
::: php-client-availability versions=5.0 editions=EE
66

77
```php
88
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -27,7 +27,7 @@ $client->getAssetAttributeApi()->get('user_instructions', 'label');
2727
```
2828

2929
#### Get the list of attributes of a given asset
30-
::: php-client-availability versions=5.0,6.0 editions=EE
30+
::: php-client-availability versions=5.0 editions=EE
3131

3232
```php
3333
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -36,7 +36,7 @@ $client->getAssetAttributeApi()->all('user_instructions');
3636
```
3737

3838
#### Upsert an attribute of a given asset family
39-
::: php-client-availability versions=5.0,6.0 editions=EE
39+
::: php-client-availability versions=5.0 editions=EE
4040

4141
If the attribute does not exist yet, this method creates it, otherwise it updates it.
4242

content/php-client/resources/asset-manager/asset-families.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
We refer here to the asset family of the [Asset Manager](/concepts/asset-manager.html#asset-family).
44

55
#### Get an asset family
6-
::: php-client-availability versions=5.0,6.0 editions=EE
6+
::: php-client-availability versions=5.0 editions=EE
77

88
```php
99
$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
@@ -23,7 +23,7 @@ $client->getAssetFamilyApi()->get('user_instructions');
2323
```
2424

2525
#### Get the list of the asset families
26-
::: php-client-availability versions=5.0,6.0 editions=EE
26+
::: php-client-availability versions=5.0 editions=EE
2727

2828
You can get more information about the available query parameters [here](/api-reference.html#get_asset_families).
2929

@@ -34,7 +34,7 @@ $client->getAssetFamilyApi()->all();
3434
```
3535

3636
#### Upsert an asset family
37-
::: php-client-availability versions=5.0,6.0 editions=EE
37+
::: php-client-availability versions=5.0 editions=EE
3838

3939
If the asset family does not exist yet, this method creates it, otherwise it updates it.
4040

0 commit comments

Comments
 (0)