Updated API from documentation release

commercetools · Apr 3, 2024 · 9194bac · 9194bac
1 parent c4849fa
commit 9194bac
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 0 deletions.
diff --git a/api-specs/api/types/product/ProductDraft.raml b/api-specs/api/types/product/ProductDraft.raml
@@ -22,6 +22,8 @@ properties:
     type: string
     description: |
       User-defined unique identifier for the Product.
+
+      To update a Product using the [Import API](/../import-export/product), the Product `key` must match the pattern `^[A-Za-z0-9_-]{2,256}$`.
   description?:
     type: LocalizedString
     description: |

diff --git a/api-specs/api/types/product/updates/ProductSetKeyAction.raml b/api-specs/api/types/product/updates/ProductSetKeyAction.raml
@@ -9,3 +9,5 @@ properties:
     type: string
     description: |
       Value to set. If empty, any existing value will be removed.
+
+      To update a Product using the [Import API](/../import-export/product), the Product `key` must match the pattern `^[A-Za-z0-9_-]{2,256}$`.
diff --git a/api-specs/importapi/types/category-import.raml b/api-specs/importapi/types/category-import.raml
@@ -16,6 +16,9 @@ types:
       key:
         type: string
         description: User-defined unique identifier. If a [Category](/../api/projects/categories#category) with this `key` exists, it will be updated with the imported data.
+        pattern: ^[A-Za-z0-9_-]+$
+        minLength: 2
+        maxLength: 256
       name:
         description: |
           Maps to `Category.name`.

diff --git a/api-specs/importapi/types/customer-import.raml b/api-specs/importapi/types/customer-import.raml
@@ -60,6 +60,9 @@ types:
       key:
         type: string
         description: User-defined unique identifier. If a [Customer](/../api/projects/customers#customer) with this `key` exists, it will be updated with the imported data.
+        pattern: ^[A-Za-z0-9_-]+$
+        minLength: 2
+        maxLength: 256
       customerNumber?:
         description: |
           Maps to `Customer.customerNumber`.

diff --git a/api-specs/importapi/types/inventory-import.raml b/api-specs/importapi/types/inventory-import.raml
@@ -16,6 +16,9 @@ types:
       key:
         type: string
         description: User-defined unique identifier. If an [InventoryEntry](/../api/projects/inventory#inventoryentry) with this `key` exists, it will be updated with the imported data.
+        pattern: ^[A-Za-z0-9_-]+$
+        minLength: 2
+        maxLength: 256
       sku:
         type: string
         description: |

diff --git a/api-specs/importapi/types/product-draft-import.raml b/api-specs/importapi/types/product-draft-import.raml
@@ -18,6 +18,9 @@ types:
       key:
         type: string
         description: User-defined unique identifier. If a [Product](/../api/projects/products#product) with this `key` exists, it will be updated with the imported data.
+        pattern: ^[A-Za-z0-9_-]+$
+        minLength: 2
+        maxLength: 256
       productType:
         description: |
           The `productType` of a [Product](/../api/projects/products#product).

diff --git a/api-specs/importapi/types/product-import.raml b/api-specs/importapi/types/product-import.raml
@@ -65,6 +65,9 @@ types:
       key:
         type: string
         description: User-defined unique identifier. If a [Product](/../api/projects/products#product) with this `key` exists, it will be updated with the imported data.
+        pattern: ^[A-Za-z0-9_-]+$
+        minLength: 2
+        maxLength: 256
       name:
         description: |
           Maps to `Product.name`.

diff --git a/api-specs/importapi/types/product-type-import.raml b/api-specs/importapi/types/product-type-import.raml
@@ -117,6 +117,9 @@ types:
     properties:
       key:
         type: string
+        pattern: ^[A-Za-z0-9_-]+$
+        minLength: 2
+        maxLength: 256
         description: User-defined unique identifier. If a [ProductType](/../api/projects/productTypes#producttype) with this `key` exists, it will be updated with the imported data.
       name:
         description: |