Updated api-reference from documentation release

commercetools · Dec 23, 2024 · 58bdc3e · 58bdc3e
1 parent 1afc50a
commit 58bdc3e
Show file tree

Hide file tree

Showing 427 changed files with 3,620 additions and 1,003 deletions.
diff --git a/api-specs/api/api.raml b/api-specs/api/api.raml
@@ -15,8 +15,6 @@ baseUriParameters:
       - europe-west1.gcp
       - eu-central-1.aws
       - australia-southeast1.gcp
-      - api.cn-northwest-1.aws.commercetools.cn
-      - eastus.azure
     description: |
       [Region](/../api/general-concepts#hosts) in which the Project is hosted.
 version: v1
@@ -222,10 +220,11 @@ resourceTypes:
     body:
       application/json:
         type: ProjectUpdate
+        example: !include /examples/project-update.example.json
     responses:
       200:
         body:
-          example: !include examples/project.example.json
+          example: !include examples/project-update-response.example.json
           type: Project
   /as-associate: !include resources/as-associate.raml
   /associate-roles: !include resources/associate-roles.raml

diff --git a/api-specs/api/examples/ApprovalFlow/ApprovalFlowSetCustomFieldAction.json b/api-specs/api/examples/ApprovalFlow/ApprovalFlowSetCustomFieldAction.json
@@ -1,5 +1,5 @@
 {
   "action": "setCustomField",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString"
 }
diff --git a/api-specs/api/examples/ApprovalFlow/ApprovalFlowSetCustomTypeAction.json b/api-specs/api/examples/ApprovalFlow/ApprovalFlowSetCustomTypeAction.json
@@ -5,6 +5,6 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   }
 }
diff --git a/api-specs/api/examples/ApprovalRule/ApprovalRuleSetCustomFieldAction.json b/api-specs/api/examples/ApprovalRule/ApprovalRuleSetCustomFieldAction.json
@@ -0,0 +1,5 @@
+{
+  "action": "setCustomField",
+  "name": "exampleStringField",
+  "value": "TextString"
+}
diff --git a/api-specs/api/examples/ApprovalRule/ApprovalRuleSetCustomTypeAction.json b/api-specs/api/examples/ApprovalRule/ApprovalRuleSetCustomTypeAction.json
@@ -0,0 +1,10 @@
+{
+  "action": "setCustomType",
+  "type": {
+    "id": "{{type-id}}",
+    "typeId": "type"
+  },
+  "fields": {
+    "exampleStringField": "TextString"
+  }
+}
diff --git a/api-specs/api/examples/BusinessUnit/BusinessUnitSetAddressCustomFieldAction.json b/api-specs/api/examples/BusinessUnit/BusinessUnitSetAddressCustomFieldAction.json
@@ -1,6 +1,6 @@
 {
   "action": "setAddressCustomField",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString",
   "addressId": "{{address-id}}"
 }
diff --git a/api-specs/api/examples/BusinessUnit/BusinessUnitSetAddressCustomTypeAction.json b/api-specs/api/examples/BusinessUnit/BusinessUnitSetAddressCustomTypeAction.json
@@ -5,7 +5,7 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   },
   "addressId": "{{address-id}}"
 }
diff --git a/api-specs/api/examples/BusinessUnit/BusinessUnitSetCustomFieldAction.json b/api-specs/api/examples/BusinessUnit/BusinessUnitSetCustomFieldAction.json
@@ -1,5 +1,5 @@
 {
   "action": "setCustomField",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString"
 }
diff --git a/api-specs/api/examples/BusinessUnit/BusinessUnitSetCustomTypeAction.json b/api-specs/api/examples/BusinessUnit/BusinessUnitSetCustomTypeAction.json
@@ -5,6 +5,6 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   }
 }
diff --git a/api-specs/api/examples/BusinessUnitSearch/BusinessUnitPagedSearchResponse.json b/api-specs/api/examples/BusinessUnitSearch/BusinessUnitPagedSearchResponse.json
@@ -0,0 +1,19 @@
+{
+  "results": [
+    {
+      "id": "e41337a0-ea96-4ddc-a9a4-d267976f21e0",
+      "relevance": 0.9264881
+    },
+    {
+      "id": "05cd5998-015c-4232-8943-ff8a1880bcbc",
+      "relevance": 0.6989829
+    },
+    {
+      "id": "09c3c5a2-6569-49dd-b021-af5de4cf4b02",
+      "relevance": 0.6989829
+    }
+  ],
+  "limit": 100,
+  "offset": 0,
+  "total": 3
+}
diff --git a/api-specs/api/examples/BusinessUnitSearch/BusinessUnitSearchIndexingStatusResponse.json b/api-specs/api/examples/BusinessUnitSearch/BusinessUnitSearchIndexingStatusResponse.json
@@ -0,0 +1,11 @@
+{
+  "status": "Indexing",
+  "states": {
+    "indexed": 43242,
+    "failed": 0,
+    "estimatedTotal": 100000
+  },
+  "startedAt": "2023-08-15T12:56:07.89Z",
+  "retryCount": 2,
+  "lastModifiedAt": "2023-08-15T12:56:07.89Z"
+}
diff --git a/api-specs/api/examples/BusinessUnitSearch/BusinessUnitSearchRequest.json b/api-specs/api/examples/BusinessUnitSearch/BusinessUnitSearchRequest.json
@@ -0,0 +1,8 @@
+{
+  "query": {
+    "fullText": {
+      "field": "all",
+      "value": "plumbing"
+    }
+  }
+}
diff --git a/api-specs/api/examples/Cart/CartChangeCustomLineItemCustomTypeAction.json b/api-specs/api/examples/Cart/CartChangeCustomLineItemCustomTypeAction.json
@@ -6,6 +6,6 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   }
 }
diff --git a/api-specs/api/examples/Cart/CartSetBillingAddressCustomFieldAction.json b/api-specs/api/examples/Cart/CartSetBillingAddressCustomFieldAction.json
@@ -1,5 +1,5 @@
 {
-    "action": "setBillingAddressCustomField",
-    "name": "ExampleStringTypeField",
-    "value": "TextString"
-  }
+  "action": "setBillingAddressCustomField",
+  "name": "exampleStringField",
+  "value": "TextString"
+}
diff --git a/api-specs/api/examples/Cart/CartSetBillingAddressCustomTypeAction.json b/api-specs/api/examples/Cart/CartSetBillingAddressCustomTypeAction.json
@@ -1,10 +1,10 @@
 {
-    "action": "setBillingAddressCustomType",
-    "type": {
-      "id": "{{type-id}}",
-      "typeId": "type"
-    },
-    "fields": {
-      "exampleStringTypeField": "TextString"
-    }
+  "action": "setBillingAddressCustomType",
+  "type": {
+    "id": "{{type-id}}",
+    "typeId": "type"
+  },
+  "fields": {
+    "exampleStringField": "TextString"
   }
+}
diff --git a/api-specs/api/examples/Cart/CartSetCustomFieldAction.json b/api-specs/api/examples/Cart/CartSetCustomFieldAction.json
@@ -1,5 +1,5 @@
 {
   "action": "setCustomField",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString"
 }
diff --git a/api-specs/api/examples/Cart/CartSetCustomLineItemCustomFieldAction.json b/api-specs/api/examples/Cart/CartSetCustomLineItemCustomFieldAction.json
@@ -1,6 +1,6 @@
 {
   "action": "setCustomLineItemCustomField",
   "customLineItemId": "{{customLineItemId}}",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString"
 }
diff --git a/api-specs/api/examples/Cart/CartSetCustomLineItemCustomTypeAction.json b/api-specs/api/examples/Cart/CartSetCustomLineItemCustomTypeAction.json
@@ -5,7 +5,7 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   },
   "customLineItemId": "{{customLineItemId}}"
 }
diff --git a/api-specs/api/examples/Cart/CartSetCustomTypeAction.json b/api-specs/api/examples/Cart/CartSetCustomTypeAction.json
@@ -5,6 +5,6 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   }
 }
diff --git a/api-specs/api/examples/Cart/CartSetItemShippingAddressCustomFieldAction.json b/api-specs/api/examples/Cart/CartSetItemShippingAddressCustomFieldAction.json
@@ -1,6 +1,6 @@
 {
-    "action": "setItemShippingAddressCustomField",
-    "addressKey": "{{address-key}}",
-    "name": "ExampleStringTypeField",
-    "value": "TextString"
-  }
+  "action": "setItemShippingAddressCustomField",
+  "addressKey": "{{address-key}}",
+  "name": "exampleStringField",
+  "value": "TextString"
+}
diff --git a/api-specs/api/examples/Cart/CartSetItemShippingAddressCustomTypeAction.json b/api-specs/api/examples/Cart/CartSetItemShippingAddressCustomTypeAction.json
@@ -1,11 +1,11 @@
 {
-    "action": "setItemShippingAddressCustomType",
-    "addressKey": "{{address-key}}",
-    "type": {
-      "id": "{{type-id}}",
-      "typeId": "type"
-    },
-    "fields": {
-      "exampleStringTypeField": "TextString"
-    }
+  "action": "setItemShippingAddressCustomType",
+  "addressKey": "{{address-key}}",
+  "type": {
+    "id": "{{type-id}}",
+    "typeId": "type"
+  },
+  "fields": {
+    "exampleStringField": "TextString"
   }
+}
diff --git a/api-specs/api/examples/Cart/CartSetLineItemCustomFieldAction.json b/api-specs/api/examples/Cart/CartSetLineItemCustomFieldAction.json
@@ -1,6 +1,6 @@
 {
   "action": "setLineItemCustomField",
   "lineItemId": "{{lineItemId}}",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString"
 }
diff --git a/api-specs/api/examples/Cart/CartSetLineItemCustomTypeAction.json b/api-specs/api/examples/Cart/CartSetLineItemCustomTypeAction.json
@@ -6,6 +6,6 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   }
 }
diff --git a/api-specs/api/examples/Cart/CartSetShippingAddressCustomFieldAction.json b/api-specs/api/examples/Cart/CartSetShippingAddressCustomFieldAction.json
@@ -1,5 +1,5 @@
 {
-    "action": "setShippingAddressCustomField",
-    "name": "ExampleStringTypeField",
-    "value": "TextString"
-  }
+  "action": "setShippingAddressCustomField",
+  "name": "exampleStringField",
+  "value": "TextString"
+}
diff --git a/api-specs/api/examples/Cart/CartSetShippingAddressCustomTypeAction.json b/api-specs/api/examples/Cart/CartSetShippingAddressCustomTypeAction.json
@@ -1,10 +1,10 @@
 {
-    "action": "setShippingAddressCustomType",
-    "type": {
-      "id": "{{type-id}}",
-      "typeId": "type"
-    },
-    "fields": {
-      "exampleStringTypeField": "TextString"
-    }
+  "action": "setShippingAddressCustomType",
+  "type": {
+    "id": "{{type-id}}",
+    "typeId": "type"
+  },
+  "fields": {
+    "exampleStringField": "TextString"
   }
+}
diff --git a/api-specs/api/examples/Cart/CartSetShippingCustomFieldAction.json b/api-specs/api/examples/Cart/CartSetShippingCustomFieldAction.json
@@ -1,6 +1,6 @@
 {
   "action": "setShippingCustomField",
   "shippingKey": "shippingMethodKey1",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString"
 }
diff --git a/api-specs/api/examples/Cart/CartSetShippingCustomTypeAction.json b/api-specs/api/examples/Cart/CartSetShippingCustomTypeAction.json
@@ -6,6 +6,6 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   }
 }
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountChangeValueAction.json b/api-specs/api/examples/CartDiscount/CartDiscountChangeValueAction.json
@@ -7,6 +7,7 @@
         "currencyCode": "EUR",
         "centAmount": 40099
       }
-    ]
+    ],
+    "applicationMode": "IndividualApplication"
   }
-}
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountSetCustomFieldAction.json b/api-specs/api/examples/CartDiscount/CartDiscountSetCustomFieldAction.json
@@ -1,5 +1,5 @@
 {
   "action": "setCustomField",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString"
 }
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountSetCustomTypeAction.json b/api-specs/api/examples/CartDiscount/CartDiscountSetCustomTypeAction.json
@@ -5,6 +5,6 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   }
 }
diff --git a/api-specs/api/examples/Category/CategorySetAssetCustomFieldAction.json b/api-specs/api/examples/Category/CategorySetAssetCustomFieldAction.json
@@ -1,6 +1,6 @@
 {
   "action": "setAssetCustomField",
   "assetId": "{{assetId}}",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString"
 }
diff --git a/api-specs/api/examples/Category/CategorySetAssetCustomTypeAction.json b/api-specs/api/examples/Category/CategorySetAssetCustomTypeAction.json
@@ -6,6 +6,6 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   }
 }
diff --git a/api-specs/api/examples/Category/CategorySetCustomFieldAction.json b/api-specs/api/examples/Category/CategorySetCustomFieldAction.json
@@ -1,5 +1,5 @@
 {
   "action": "setCustomField",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString"
 }
diff --git a/api-specs/api/examples/Category/CategorySetCustomTypeAction.json b/api-specs/api/examples/Category/CategorySetCustomTypeAction.json
@@ -5,6 +5,6 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   }
 }
diff --git a/api-specs/api/examples/Channel/ChannelSetAddressCustomFieldAction.json b/api-specs/api/examples/Channel/ChannelSetAddressCustomFieldAction.json
@@ -1,5 +1,5 @@
 {
-    "action": "setAddressCustomField",
-    "name": "ExampleStringTypeField",
-    "value": "TextString"
-  }
+  "action": "setAddressCustomField",
+  "name": "exampleStringField",
+  "value": "TextString"
+}
diff --git a/api-specs/api/examples/Channel/ChannelSetAddressCustomTypeAction.json b/api-specs/api/examples/Channel/ChannelSetAddressCustomTypeAction.json
@@ -1,10 +1,10 @@
 {
-    "action": "setAddressCustomType",
-    "type": {
-      "id": "{{type-id}}",
-      "typeId": "type"
-    },
-    "fields": {
-      "exampleStringTypeField": "TextString"
-    }
+  "action": "setAddressCustomType",
+  "type": {
+    "id": "{{type-id}}",
+    "typeId": "type"
+  },
+  "fields": {
+    "exampleStringField": "TextString"
   }
+}
diff --git a/api-specs/api/examples/Channel/ChannelSetCustomFieldAction.json b/api-specs/api/examples/Channel/ChannelSetCustomFieldAction.json
@@ -1,5 +1,5 @@
 {
   "action": "setCustomField",
-  "name": "ExampleStringTypeField",
+  "name": "exampleStringField",
   "value": "TextString"
 }
diff --git a/api-specs/api/examples/Channel/ChannelSetCustomTypeAction.json b/api-specs/api/examples/Channel/ChannelSetCustomTypeAction.json
@@ -5,6 +5,6 @@
     "typeId": "type"
   },
   "fields": {
-    "exampleStringTypeField": "TextString"
+    "exampleStringField": "TextString"
   }
 }