CPM-724: Fix JS

pierallard · pierallard · commit eb0db851956d · 2022-09-29T10:29:45.000+02:00
diff --git a/content/concepts/products.md b/content/concepts/products.md
@@ -138,7 +138,7 @@ Note that the `quality_scores` field is only available since the 5.0 and when th
 Note that the `completenesses` field is only available on SaaS platforms, and when the `with_completenesses` query parameter is set to `true`.
 :::
 
-::: panel-link Want more details about the product resource? [Check its endpoints here!](/api-reference.html#Product)
+::: panel-link Want more details about the product resource? [Check its endpoints here!](/api-reference.html#Productuuid)
 :::
 
 ### Convert a variant product to a simple product
diff --git a/content/img/illustrations/illus--Productidentifier.svg b/content/img/illustrations/illus--Productidentifier.svg
diff --git a/content/img/illustrations/illus--Productuuid.svg b/content/img/illustrations/illus--Productuuid.svg
diff --git a/content/swagger/akeneo-web-api.json b/content/swagger/akeneo-web-api.json
diff --git a/content/swagger/resources/products/routes/products.yaml b/content/swagger/resources/products/routes/products.yaml
@@ -2,7 +2,7 @@ get:
   summary: Get list of products
   operationId: "get_products"
   tags:
-    - Product
+    - Product [identifier]
   x-versions:
     - "1.7"
     - "2.x"
@@ -85,7 +85,7 @@ post:
   summary: Create a new product
   operationId: "post_products"
   tags:
-    - Product
+    - Product [identifier]
   x-versions:
     - "1.7"
     - "2.x"
@@ -117,7 +117,7 @@ patch:
   summary: Update/create several products
   operationId: "patch_products"
   tags:
-    - Product
+    - Product [identifier]
   x-versions:
     - "1.7"
     - "2.x"
diff --git a/content/swagger/resources/products/routes/products_code.yaml b/content/swagger/resources/products/routes/products_code.yaml
@@ -2,7 +2,7 @@ get:
   summary: Get a product
   operationId: "get_products__code_"
   tags:
-    - Product
+    - Product [identifier]
   x-versions:
     - "1.7"
     - "2.x"
@@ -35,7 +35,7 @@ patch:
   summary: Update/create a product
   operationId: "patch_products__code_"
   tags:
-    - Product
+    - Product [identifier]
   x-versions:
     - "1.7"
     - "2.x"
@@ -69,7 +69,7 @@ delete:
   summary: Delete a product
   operationId: "delete_products__code_"
   tags:
-    - Product
+    - Product [identifier]
   x-versions:
     - "1.7"
     - "2.x"
diff --git a/content/swagger/resources/products/routes/products_code_draft.yaml b/content/swagger/resources/products/routes/products_code_draft.yaml
@@ -2,7 +2,7 @@ get:
   summary: Get a draft
   operationId: "get_draft__code_"
   tags:
-    - Product
+    - Product [identifier]
   x-versions:
     - "2.x"
     - "3.x"
diff --git a/content/swagger/resources/products/routes/products_code_proposal.yaml b/content/swagger/resources/products/routes/products_code_proposal.yaml
@@ -2,7 +2,7 @@ post:
   summary: Submit a draft for approval
   operationId: "post_proposal"
   tags:
-    - Product
+    - Product [identifier]
   x-versions:
     - "2.x"
     - "3.x"
diff --git a/content/swagger/resources/products_uuid/routes/products_uuid.yaml b/content/swagger/resources/products_uuid/routes/products_uuid.yaml
@@ -2,7 +2,7 @@ get:
   summary: Get list of products
   operationId: "get_products_uuid"
   tags:
-    - Product uuid
+    - Product [uuid]
   x-versions:
     - "SaaS"
   description: This endpoint allows you to get a list of products. Products are paginated and they can be filtered. In the Enterprise Edition, since the 2.0, permissions based on your user groups are applied to the set of products you request.
@@ -67,7 +67,7 @@ post:
   summary: Create a new product
   operationId: "post_products_uuid"
   tags:
-    - Product uuid
+    - Product [uuid]
   x-versions:
     - "SaaS"
   description: This endpoint allows you to create a new product. In the Enterprise Edition, since the v2.0, permissions based on your user groups are applied to the product you try to create.
@@ -93,7 +93,7 @@ patch:
   summary: Update/create several products
   operationId: "patch_products_uuid"
   tags:
-    - Product uuid
+    - Product [uuid]
   x-versions:
     - "SaaS"
   description: This endpoint allows you to update and/or create several products at once. Learn more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no product exists for the given uuid, it creates it. In the Enterprise Edition, since the v2.0, permissions based on your user groups are applied to the products you try to update. It may result in the creation of drafts if you only have edit rights through the product's categories.
diff --git a/content/swagger/resources/products_uuid/routes/products_uuid_uuid.yaml b/content/swagger/resources/products_uuid/routes/products_uuid_uuid.yaml
@@ -2,7 +2,7 @@ get:
   summary: Get a product
   operationId: "get_products_uuid__uuid_"
   tags:
-    - Product uuid
+    - Product [uuid]
   x-versions:
     - "SaaS"
   description: This endpoint allows you to get the information about a given product. In the Entreprise Edition, since the v2.0, permissions based on your user groups are applied to the product you request.
@@ -29,7 +29,7 @@ patch:
   summary: Update/create a product
   operationId: "patch_products_uuid__uuid_"
   tags:
-    - Product uuid
+    - Product [uuid]
   x-versions:
     - "SaaS"
   description: This endpoint allows you to update a given product. Learn more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no product exists for the given uuid, it creates it. In the Entreprise Edition, since the v2.0, permissions based on your user groups are applied to the product you try to update. It may result in the creation of a draft if you only have edit rights through the product's categories.
@@ -57,7 +57,7 @@ delete:
   summary: Delete a product
   operationId: "delete_products_uuid__uuid_"
   tags:
-    - Product uuid
+    - Product [uuid]
   x-versions:
     - "SaaS"
   description: This endpoint allows you to delete a given product. In the Enterprise Edition, since the 2.0, permissions based on your user groups are applied to the product you try to delete.
diff --git a/content/swagger/resources/products_uuid/routes/products_uuid_uuid_draft.yaml b/content/swagger/resources/products_uuid/routes/products_uuid_uuid_draft.yaml
@@ -2,7 +2,7 @@ get:
   summary: Get a draft
   operationId: "get_draft_uuid__code_"
   tags:
-    - Product uuid
+    - Product [uuid]
   x-versions:
     - "SaaS"
   x-ee: true
diff --git a/content/swagger/resources/products_uuid/routes/products_uuid_uuid_proposal.yaml b/content/swagger/resources/products_uuid/routes/products_uuid_uuid_proposal.yaml
@@ -2,7 +2,7 @@ post:
   summary: Submit a draft for approval
   operationId: "post_proposal_uuid"
   tags:
-    - Product uuid
+    - Product [uuid]
   x-versions:
     - "SaaS"
   x-ee: true
diff --git a/src/api-reference/reference.handlebars b/src/api-reference/reference.handlebars
@@ -450,7 +450,7 @@
                                                                                 <em> ({{{type}}} {{#if items}} [{{{items.type}}}] {{/if}}) </em>
                                                                                 {{#if properties}}: { <br>
                                                                                     {{#each properties}}
-                                                                                        &nbsp; &nbsp; 
+                                                                                        &nbsp; &nbsp;
                                                                                         <code>{{{@key}}}</code>
                                                                                         <em>
                                                                                             ({{{type}}}
diff --git a/tasks/reference.js b/tasks/reference.js
@@ -36,8 +36,8 @@ const ignoreVersionImcompatibleProperties = async (data, version) => {
 
 function determineCategory(tag){
     switch(tag){
-        case 'Product':
-        case 'Product uuid':
+        case 'Product [identifier]':
+        case 'Product [uuid]':
         case 'Product model':
         case 'Product media file':
             return 'Products';
@@ -125,9 +125,9 @@ gulp.task('reference', ['clean-dist', 'less'], function() {
                     _.forEach(path, function(operation, verb) {
                         // This is where we filter the endpoints depending on their availability in the PIM versions
                         if (_.find(operation['x-versions'], function(o) { return (o === version) || o.startsWith(version.split('.')[0]) && o.endsWith('x'); })) {
-                            var escapeTag = operation.tags[0].replace(/\s/g, '');
+                            var escapeTag = operation.tags[0].replace(/[^\w]/g, '');
                             var category = determineCategory(operation.tags[0]);
-                            escapeCategory = category.replace(/\s/g, '');
+                            escapeCategory = category.replace(/[^\w]/g, '');
                             if (!data.categories[escapeCategory]){
                                 data.categories[escapeCategory] = { categoryName: category, resources: {}};
                                 if(escapeCategory === 'PAM') {
@@ -170,9 +170,9 @@ gulp.task('reference', ['clean-dist', 'less'], function() {
                         // This is where we filter the endpoints depending on their availability in the PIM versions
                         if (_.find(operation['x-versions'], function(o) { return o === version || o.startsWith(version.split('.')[0]) && o.endsWith('x'); })) {
                             var operationId = operation.operationId;
-                            var escapeTag = operation.tags[0].replace(/\s/g, '');
+                            var escapeTag = operation.tags[0].replace(/[^\w]/g, '');
                             var category = determineCategory(operation.tags[0]);
-                            escapeCategory = category.replace(/\s/g, '');
+                            escapeCategory = category.replace(/[^\w]/g, '');
                             if (!data.categories[escapeCategory]){
                                 data.categories[escapeCategory] = { categoryName: category, resources: {}};
                                 if(escapeCategory === 'PAM') {
