Updated API from documentation release

commercetools · Oct 11, 2023 · 2e8dccc · 2e8dccc
1 parent 0db46bc
commit 2e8dccc
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 40 deletions.
diff --git a/api-specs/ml/resources/missing-data.raml b/api-specs/ml/resources/missing-data.raml
@@ -1,12 +1,12 @@
 #%RAML 1.0 Library
 (annotations.deprecated): true
-(beta): true
+(annotations.beta): true
 /attributes:
   (annotations.deprecated): true
-  (beta): true
+  (annotations.beta): true
   post:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     body:
       application/json:
         type: missing-data.MissingAttributesSearchRequest
@@ -18,17 +18,17 @@
             example: !include ../examples/missing-data-token.json
   /status:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     /{taskId}:
       (annotations.deprecated): true
-      (beta): true
+      (annotations.beta): true
       (annotations.methodName): withTaskId
       uriParameters:
         taskId:
         type: string
       get:
         (annotations.deprecated): true
-        (beta): true
+        (annotations.beta): true
         responses:
           200:
             body:
@@ -37,10 +37,10 @@
                 example: !include ../examples/missing-data-response.json
 /images:
   (annotations.deprecated): true
-  (beta): true
+  (annotations.beta): true
   post:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     body:
       application/json:
         type: missing-data.MissingImagesSearchRequest
@@ -52,17 +52,17 @@
             example: !include ../examples/missing-data-token.json
   /status:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     /{taskId}:
       (annotations.deprecated): true
-      (beta): true
+      (annotations.beta): true
       (annotations.methodName): withTaskId
       uriParameters:
         taskId:
         type: string
       get:
         (annotations.deprecated): true
-        (beta): true
+        (annotations.beta): true
         responses:
           200:
             body:
@@ -71,10 +71,10 @@
                 example: !include ../examples/missing-images-response.json
 /prices:
   (annotations.deprecated): true
-  (beta): true
+  (annotations.beta): true
   post:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     body:
       application/json:
         type: missing-data.MissingPricesSearchRequest
@@ -86,17 +86,17 @@
             example: !include ../examples/missing-data-token.json
   /status:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     /{taskId}:
       (annotations.deprecated): true
-      (beta): true
+      (annotations.beta): true
       (annotations.methodName): withTaskId
       uriParameters:
         taskId:
         type: string
       get:
         (annotations.deprecated): true
-        (beta): true
+        (annotations.beta): true
         responses:
           200:
             body:

diff --git a/api-specs/ml/types/annotations.raml b/api-specs/ml/types/annotations.raml
@@ -51,3 +51,5 @@ annotationTypes:
     type: array
     items:
       type: string
+  beta:
+    type: boolean
diff --git a/api-specs/ml/types/missing-data.raml b/api-specs/ml/types/missing-data.raml
@@ -9,7 +9,7 @@ uses:
 types:
   AttributeCount:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       productTypeAttributes:
         description: Number of attributes defined in the product type.
@@ -26,7 +26,7 @@ types:
 
   AttributeCoverage:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       names:
         description:
@@ -44,7 +44,7 @@ types:
 
   MissingAttributesDetails:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       total:
         description: Number of products scanned.
@@ -61,7 +61,7 @@ types:
 
   MissingAttributes:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       product:
         type: common.ProductReference
@@ -88,7 +88,7 @@ types:
 
   MissingAttributesMeta:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       productLevel:
         type: MissingAttributesDetails
@@ -100,7 +100,7 @@ types:
 
   MissingAttributesSearchRequest:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       limit?:
         type: number
@@ -165,7 +165,7 @@ types:
         type: string
   MissingAttributesPagedQueryResult:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       count:
         type: number
@@ -185,7 +185,7 @@ types:
 
   MissingDataTaskStatus:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     description:
       Represents a URL path to poll to get the results of an Asynchronous
       Request.
@@ -203,7 +203,7 @@ types:
   ## Missing image section
   MissingImages:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       product: common.ProductReference
       variantId:
@@ -217,7 +217,7 @@ types:
 
   MissingImagesCount:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       missingImages:
         type: number
@@ -229,7 +229,7 @@ types:
 
   MissingImagesProductLevel:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     type: MissingImagesCount
     properties:
       missingImages:
@@ -243,7 +243,7 @@ types:
 
   MissingImagesVariantLevel:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     type: MissingImagesCount
     properties:
       missingImages:
@@ -257,7 +257,7 @@ types:
 
   MissingImagesMeta:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       productLevel: MissingImagesProductLevel
       variantLevel: MissingImagesVariantLevel
@@ -270,7 +270,7 @@ types:
 
   MissingImagesSearchRequest:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       limit?:
         type: number
@@ -322,7 +322,7 @@ types:
         type: string[]
   MissingImagesPagedQueryResult:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       count:
         type: number
@@ -341,7 +341,7 @@ types:
         type: MissingImagesMeta
   MissingImagesTaskStatus:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     description:
       Represents a URL path to poll to get the results of an Asynchronous
       Request.
@@ -360,7 +360,7 @@ types:
   # Missing prices section
   MissingPrices:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       product: common.ProductReference
       variantId:
@@ -369,7 +369,7 @@ types:
         format: int64
   MissingPricesProductCount:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       total:
         type: number
@@ -379,7 +379,7 @@ types:
         format: int64
   MissingPricesProductLevel:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     type: MissingPricesProductCount
     properties:
       total:
@@ -393,7 +393,7 @@ types:
 
   MissingPricesVariantLevel:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     type: MissingPricesProductCount
     properties:
       total:
@@ -406,14 +406,14 @@ types:
         format: int64
   MissingPricesMeta:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       productLevel: MissingPricesProductLevel
       variantLevel: MissingPricesVariantLevel
 
   MissingPricesSearchRequest:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       limit?:
         type: number
@@ -476,7 +476,7 @@ types:
 
   MissingPricesPagedQueryResult:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     properties:
       count:
         type: number
@@ -495,7 +495,7 @@ types:
         type: MissingPricesMeta
   MissingPricesTaskStatus:
     (annotations.deprecated): true
-    (beta): true
+    (annotations.beta): true
     description:
       Represents a URL path to poll to get the results of an Asynchronous
       Request.