Updated API from documentation release

commercetools · Jan 23, 2024 · b290971 · b290971
1 parent 4771466
commit b290971
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 10 deletions.
diff --git a/api-specs/importapi/api.raml b/api-specs/importapi/api.raml
@@ -167,10 +167,12 @@ traits:
       queryParameters:
         limit?:
           type: number
+          format: int64
           description: |
             Number of [results requested](/../api/general-concepts#limit).
         offset?:
           type: number
+          format: int64
           description: |
             Number of [elements skipped](/../api/general-concepts#offset).
         sort?:
@@ -260,10 +262,12 @@ traits:
           queryParameters:
             limit?:
               type: number
+              format: int64
               description: |
                 Number of [results requested](/../api/general-concepts#limit).
             offset?:
               type: number
+              format: int64
               description: |
                 Number of [elements skipped](/../api/general-concepts#offset).
             sort?:

diff --git a/api-specs/importapi/types/common.raml b/api-specs/importapi/types/common.raml
@@ -32,11 +32,11 @@ types:
       w:
         description: The width of the asset source.
         type: number
-        format: int
+        format: int32
       h:
         description: The height of the asset source.
         type: number
-        format: int
+        format: int32
   AssetSource:
     description:
       An AssetSource is a representation of an Asset in a specific format, for

diff --git a/api-specs/importapi/types/import-summary.raml b/api-specs/importapi/types/import-summary.raml
@@ -21,9 +21,8 @@ types:
         type: integer
         format: long
   OperationStates:
+    description: The number of resources in each [Processing State](/processing-state#processingstate).
     properties:
-      #description: The number of resources in each [Processing State](/processing-state#processingstate).
-      #  type: number
       processing:
         type: integer
         format: int64

diff --git a/api-specs/importapi/types/order-import.raml b/api-specs/importapi/types/order-import.raml
@@ -16,6 +16,7 @@ types:
     properties:
       quantity:
         type: number
+        format: int64
       state:
         description: |
           Maps to `ItemState.state`.
@@ -32,6 +33,7 @@ types:
         description: |
           Maps to `ItemShippingTarget.quantity`.
         type: number
+        format: int64
   ItemShippingDetailsDraft:
     properties:
       targets:
@@ -123,6 +125,7 @@ types:
         description: |
           Maps to `LineItem.quantity`.
         type: number
+        format: int64
       state?:
         type: ItemState[]
       supplyChannel?:
@@ -181,10 +184,18 @@ types:
         type: ShippingRatePriceTier[]
   ParcelMeasurements:
     properties:
-      heightInMillimeter?: number
-      lengthInMillimeter?: number
-      widthInMillimeter?: number
-      weightInGram?: number
+      heightInMillimeter?:
+        type: number
+        format: int32
+      lengthInMillimeter?:
+        type: number
+        format: int32
+      widthInMillimeter?:
+        type: number
+        format: int32
+      weightInGram?:
+        type: number
+        format: int32
   TrackingData:
     properties:
       trackingId?: string
@@ -195,7 +206,9 @@ types:
   DeliveryItem:
     properties:
       id: string
-      quantity: number
+      quantity:
+        type: number
+        format: int64
   Parcel:
     properties:
       id:
@@ -264,7 +277,10 @@ types:
   ExternalTaxRateDraft:
     properties:
       name: string
-      amount?: number
+      amount?:
+        type: number
+        minimum: 0
+        maximum: 1
       country: string
       state?: string
       subRates?: price.SubRate[]
@@ -292,6 +308,7 @@ types:
       slug: string
       quantity:
         type: number
+        format: int64
       state?:
         type: ItemState[]
       taxCategory?:
@@ -438,6 +455,7 @@ types:
     properties:
       score:
         type: number
+        format: int64
   OrderImport:
     description: |
       The data representation for an Order to be imported that is persisted as an [Order](/../api/projects/orders#top) in the Project.

diff --git a/api-specs/importapi/types/order-patch-import.raml b/api-specs/importapi/types/order-patch-import.raml
@@ -23,6 +23,7 @@ types:
     properties:
       quantity:
         type: number
+        format: int64
       lineItemId?:
         type: string
       customLineItemId?: