Updated API from documentation release

commercetools · Oct 2, 2023 · d4256ab · d4256ab
1 parent 4bf8c87
commit d4256ab
Show file tree

Hide file tree

Showing 15 changed files with 73 additions and 23 deletions.
diff --git a/api-specs/api/api.raml b/api-specs/api/api.raml
@@ -1,6 +1,8 @@
 #%RAML 1.0
 ---
-title: commercetools Composable Commerce
+title: commercetools Composable Commerce API
+(products):
+  - Composable Commerce
 baseUri: https://api.{region}.commercetools.com
 (sdkBaseUri): https://api.europe-west1.gcp.commercetools.com
 baseUriParameters:

diff --git a/api-specs/api/types/annotations.raml b/api-specs/api/types/annotations.raml
@@ -71,6 +71,12 @@ sdkBaseUri:
   allowedTargets:
     - API
   type: string
+products:
+  allowedTargets:
+    - API
+  type: array
+  items:
+    type: string
 docsBaseUri:
   allowedTargets:
     - API

diff --git a/api-specs/checkout/api.raml b/api-specs/checkout/api.raml
@@ -1,6 +1,8 @@
 #%RAML 1.0
 ---
 title: commercetools Checkout API
+(annotations.products):
+  - Checkout
 version: v1
 mediaType: application/json
 baseUri: https://checkout.{region}.commercetools.com

diff --git a/api-specs/checkout/types/annotations.raml b/api-specs/checkout/types/annotations.raml
@@ -25,6 +25,12 @@ annotationTypes:
     allowedTargets:
       - API
     type: string
+  products:
+    allowedTargets:
+      - API
+    type: array
+    items:
+      type: string
   serviceRegions:
     allowedTargets:
       - API

diff --git a/api-specs/connect/api.raml b/api-specs/connect/api.raml
@@ -1,6 +1,8 @@
 #%RAML 1.0
 ---
 title: commercetools Connect API
+(annotations.products):
+  - Connect
 version: v1
 mediaType: application/json
 baseUri: https://connect.{region}.commercetools.com

diff --git a/api-specs/connect/types/annotations.raml b/api-specs/connect/types/annotations.raml
@@ -25,6 +25,12 @@ annotationTypes:
     allowedTargets:
       - API
     type: string
+  products:
+    allowedTargets:
+      - API
+    type: array
+    items:
+      type: string
   serviceRegions:
     allowedTargets:
       - API

diff --git a/api-specs/connect/types/connector/updates/connector-add-private-project-action.raml b/api-specs/connect/types/connector/updates/connector-add-private-project-action.raml
@@ -6,7 +6,7 @@ discriminatorValue: addPrivateProject
 example: !include ../../../examples/connector/updates/ConnectorAddPrivateProjectAction.json
 description: |
   Allow a Composable Commerce Project to access a private Connector.
-  
+
   Attempting to add a `privateProject` to a non-private ConnectorStaged returns the [ConnectorStagedNotPrivate](ctp:connect:type:ConnectorStagedNotPrivateError) error.
 properties:
   privateProject:

diff --git a/api-specs/frontend-api/api.raml b/api-specs/frontend-api/api.raml
@@ -1,10 +1,18 @@
 #%RAML 1.0
 ---
-title: Frontastic API hub
+title: commercetools Frontend API hub API
+(products):
+  - Frontend
 annotationTypes:
   package:
     type: string
     allowedTargets: TypeDeclaration
+  products:
+    allowedTargets:
+      - API
+    type: array
+    items:
+      type: string
 
 baseUri: https://{project}-{customer}.frontastic.io
 baseUriParameters:
@@ -67,7 +75,7 @@ traits:
           application/json:
             type: Error
             example: !include ./examples/action-error.json
-      
+
 /frontastic:
   /context: !include resources/FrontasticContext.raml
   /page: !include resources/FrontasticPage.raml

diff --git a/api-specs/frontend-api/types/DataSourceResponse.raml b/api-specs/frontend-api/types/DataSourceResponse.raml
@@ -5,5 +5,5 @@ type: object
 properties:
   dataSourcePayload:
     type: object
-  previewPayload: 
+  previewPayload:
     type: object
diff --git a/api-specs/frontend-api/types/PagePreviewContext.raml b/api-specs/frontend-api/types/PagePreviewContext.raml
@@ -4,4 +4,4 @@ displayName: PagePreviewContext
 type: object
 properties:
   customerName:
-    type: string
+    type: string
diff --git a/api-specs/frontend-api/types/RedirectResponse.raml b/api-specs/frontend-api/types/RedirectResponse.raml
@@ -3,19 +3,19 @@
 displayName: RedirectResponse
 type: object
 properties:
-    statusCode:
-        type: number
-    reason:
-        type: string
-        enum:
-            - locale mismatch
-            - redirect exists for path
-            - dynamic page redirect
-    targetType:
-        type: string
-        enum:
-            - page folder
-            - link
-            - unknown
-    target:
-        type: string
+  statusCode:
+    type: number
+  reason:
+    type: string
+    enum:
+      - locale mismatch
+      - redirect exists for path
+      - dynamic page redirect
+  targetType:
+    type: string
+    enum:
+      - page folder
+      - link
+      - unknown
+  target:
+    type: string
diff --git a/api-specs/history/api.raml b/api-specs/history/api.raml
@@ -1,6 +1,8 @@
 #%RAML 1.0
 ---
-title: Change History API
+title: commercetools Change History API
+(products):
+  - Composable Commerce
 description: Fetch all Records from all resource types that match queryParameters.
 version: 1
 baseUri: https://history.europe-west1.gcp.commercetools.com
@@ -61,6 +63,12 @@ annotationTypes:
     allowedTargets:
       - API
     type: object
+  products:
+    allowedTargets:
+      - API
+    type: array
+    items:
+      type: string
   serviceRegions:
     allowedTargets:
       - API

diff --git a/api-specs/importapi/annotationTypes/annotations.raml b/api-specs/importapi/annotationTypes/annotations.raml
@@ -49,6 +49,12 @@ annotationTypes:
     allowedTargets:
       - API
     type: object
+  products:
+    allowedTargets:
+      - API
+    type: array
+    items:
+      type: string
   serviceRegions:
     allowedTargets:
       - API

diff --git a/api-specs/importapi/api.raml b/api-specs/importapi/api.raml
@@ -1,6 +1,8 @@
 #%RAML 1.0
 ---
 title: commercetools Composable Commerce Import API
+(annotations.products):
+  - Composable Commerce
 version: v1
 mediaType: application/json
 baseUri: https://import.europe-west1.gcp.commercetools.com

diff --git a/api-specs/ml/api.raml b/api-specs/ml/api.raml
@@ -1,6 +1,8 @@
 #%RAML 1.0
 ---
 title: commercetools Composable Commerce Machine Learning API
+(annotations.products):
+  - Composable Commerce
 version: v1
 mediaType: application/json
 baseUri: https://ml-eu.europe-west1.gcp.commercetools.com