Merge pull request PrestaShop#46 from jolelievre/api-doc

Modifications for API auto doc improvement

Author: jolelievre

src/ApiPlatform/Resources/ApiClient/ApiClient.php

@@ -91,7 +91,7 @@ class ApiClient
 
     public ?string $externalIssuer;
 
-    #[Assert\NotBlank(groups: ['Create'])]
+    #[Assert\NotNull(groups: ['Create'])]
     public bool $enabled;
 
     #[Assert\NotBlank(groups: ['Create'])]

src/ApiPlatform/Resources/Module/UploadModule.php

@@ -47,7 +47,7 @@
                 'module_write',
             ],
             CQRSCommandMapping: [
-                '[archive][pathName]' => '[source]',
+                '[archive].pathName' => '[source]',
             ],
         ),
     ],

…c/ApiPlatform/Resources/FoundProduct.php …tform/Resources/Product/FoundProduct.phpsrc/ApiPlatform/Resources/FoundProduct.php renamed to src/ApiPlatform/Resources/Product/FoundProduct.php src/ApiPlatform/Resources/FoundProduct.php renamed to src/ApiPlatform/Resources/Product/FoundProduct.php

@@ -20,7 +20,7 @@
 
 declare(strict_types=1);
 
-namespace PrestaShop\Module\APIResources\ApiPlatform\Resources;
+namespace PrestaShop\Module\APIResources\ApiPlatform\Resources\Product;
 
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\ApiResource;

src/ApiPlatform/Resources/Product/NewProductImage.php

@@ -43,7 +43,7 @@
             CQRSQueryMapping: NewProductImage::QUERY_MAPPING,
             CQRSCommandMapping: [
                 '[_context][shopConstraint]' => '[shopConstraint]',
-                '[image][pathName]' => '[pathName]',
+                '[image].pathName' => '[pathName]',
             ],
         ),
     ],

src/ApiPlatform/Resources/Product/Product.php

@@ -102,7 +102,7 @@ class Product
     #[LocalizedValue]
     public array $descriptions;
 
-    #[ApiProperty(openapiContext: ['type' => 'array', 'items' => ['type' => 'integer']])]
+    #[ApiProperty(openapiContext: ['type' => 'array', 'items' => ['type' => 'integer'], 'example' => [1, 3]])]
     public array $shopIds;
 
     public const QUERY_MAPPING = [

src/ApiPlatform/Resources/Product/ProductImage.php

@@ -58,7 +58,7 @@
             CQRSQueryMapping: ProductImage::QUERY_MAPPING,
             CQRSCommandMapping: [
                 '[_context][shopConstraint]' => '[shopConstraint]',
-                '[image][pathName]' => '[filePath]',
+                '[image].pathName' => '[filePath]',
                 '[legends]' => '[localizedLegends]',
                 '[cover]' => '[isCover]',
             ]

tests/Integration/ApiPlatform/ApiClientEndpointTest.php

@@ -71,7 +71,8 @@ public function testAddApiClient(): int
                 'clientId' => 'client_id_test',
                 'clientName' => 'Client name test',
                 'description' => 'Client description test',
-                'enabled' => true,
+                // Check that false can be used (previously bug because of a NotBlank constraint)
+                'enabled' => false,
                 'lifetime' => 3600,
                 'scopes' => [
                     'api_client_read',
@@ -121,7 +122,7 @@ public function testGetApiClient(int $apiClientId): int
                 'clientName' => 'Client name test',
                 'description' => 'Client description test',
                 'externalIssuer' => null,
-                'enabled' => true,
+                'enabled' => false,
                 'lifetime' => 3600,
                 'scopes' => [
                     'api_client_read',
@@ -152,7 +153,7 @@ public function testUpdateApiClient(int $apiClientId): int
                 'clientId' => 'client_id_test_updated',
                 'clientName' => 'Client name test updated',
                 'description' => 'Client description test updated',
-                'enabled' => false,
+                'enabled' => true,
                 'lifetime' => 1800,
                 'scopes' => [
                     'api_client_write',
@@ -172,7 +173,7 @@ public function testUpdateApiClient(int $apiClientId): int
                 'clientName' => 'Client name test updated',
                 'description' => 'Client description test updated',
                 'externalIssuer' => null,
-                'enabled' => false,
+                'enabled' => true,
                 'lifetime' => 1800,
                 'scopes' => [
                     'api_client_write',
@@ -203,7 +204,7 @@ public function testUpdateApiClient(int $apiClientId): int
                 'clientName' => 'Client name test updated',
                 'description' => 'Client description test partially updated',
                 'externalIssuer' => null,
-                'enabled' => false,
+                'enabled' => true,
                 'lifetime' => 900,
                 'scopes' => [
                     'api_client_write',
@@ -240,7 +241,7 @@ public function testGetUpdatedApiClient(int $apiClientId): int
                 'clientName' => 'Client name test updated',
                 'description' => 'Client description test partially updated',
                 'externalIssuer' => null,
-                'enabled' => false,
+                'enabled' => true,
                 'lifetime' => 900,
                 'scopes' => [
                     'api_client_write',
@@ -274,7 +275,7 @@ public function testListApiClients(int $apiClientId): int
                 'clientName' => 'Client name test updated',
                 'description' => 'Client description test partially updated',
                 'externalIssuer' => null,
-                'enabled' => false,
+                'enabled' => true,
                 'lifetime' => 900,
             ],
             $apiClients['items'][1],
@@ -368,7 +369,7 @@ public function testCreateInvalidApiClient(): void
             ],
             [
                 'propertyPath' => 'enabled',
-                'message' => 'This value should not be blank.',
+                'message' => 'This value should not be null.',
             ],
             [
                 'propertyPath' => 'description',