Updated api-reference from documentation release

commercetools · Sep 5, 2024 · 3e4215d · 3e4215d
1 parent a832b56
commit 3e4215d
Show file tree

Hide file tree

Showing 111 changed files with 1,639 additions and 452 deletions.
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/extension-update-response.example.json b/api-specs/api/examples/extension-update-response.example.json
@@ -0,0 +1,21 @@
+{
+  "id": "8062243c-46fc-40b5-88a4-75e2216aef75",
+  "version": 2,
+  "createdAt": "2017-01-25T14:14:22.417Z",
+  "lastModifiedAt": "2024-08-06T13:49:48.511Z",
+  "destination": {
+    "type": "HTTP",
+    "url": "https://example.azurewebsites.net/api/extension",
+    "authentication": {
+      "type": "AzureFunctions",
+      "key": "****code"
+    }
+  },
+  "triggers": [
+    {
+      "resourceTypeId": "cart",
+      "actions": ["Create", "Update"]
+    }
+  ],
+  "key": "my-new-extension-key"
+}
diff --git a/api-specs/api/examples/extension-update.example.json b/api-specs/api/examples/extension-update.example.json
@@ -1,7 +1,9 @@
 {
   "version": 1,
-  "actions": [{
-    "action": "setKey",
-    "key": "my-new-extension-key"
-  }]
+  "actions": [
+    {
+      "action": "setKey",
+      "key": "my-new-extension-key"
+    }
+  ]
 }
diff --git a/api-specs/api/examples/extension.example.json b/api-specs/api/examples/extension.example.json
@@ -8,12 +8,14 @@
     "url": "https://example.azurewebsites.net/api/extension",
     "authentication": {
       "type": "AzureFunctions",
-      "key": "some-azure-function-code"
+      "key": "****code"
     }
   },
-  "triggers": [{
-    "resourceTypeId": "cart",
-    "actions": ["Create", "Update"]
-  }],
+  "triggers": [
+    {
+      "resourceTypeId": "cart",
+      "actions": ["Create", "Update"]
+    }
+  ],
   "key": "my-extension"
 }
diff --git a/api-specs/api/examples/state-create.example.json b/api-specs/api/examples/state-create.example.json
@@ -1,6 +1,12 @@
 {
-  "key": "test-state",
-  "type": "ProductState",
+  "key": "Initial",
+  "type": "LineItemState",
   "roles": [],
+  "name": {
+    "en": "Initial"
+  },
+  "description": {
+    "en": "Initial is the first State that a (custom) Line Item gets after its creation."
+  },
   "initial": true
 }
diff --git a/api-specs/api/examples/state-update-response.example.json b/api-specs/api/examples/state-update-response.example.json
@@ -0,0 +1,17 @@
+{
+  "id": "7c2e2694-aefe-43d7-888e-6a99514caaca",
+  "version": 2,
+  "key": "Initial",
+  "type": "LineItemState",
+  "roles": [],
+  "name": {
+    "en": "New Name"
+  },
+  "description": {
+    "en": "Initial is the first State that a (custom) Line Item gets after its creation."
+  },
+  "builtIn": true,
+  "initial": true,
+  "createdAt": "2015-01-21T09:22:03.906Z",
+  "lastModifiedAt": "2024-08-06T13:49:48.511Z"
+}
diff --git a/api-specs/api/examples/state-update.example.json b/api-specs/api/examples/state-update.example.json
@@ -1,9 +1,11 @@
 {
   "version": 1,
-  "actions": [{
-    "action": "setName",
-    "name": {
-      "en": "New Name"
+  "actions": [
+    {
+      "action": "setName",
+      "name": {
+        "en": "New Name"
+      }
     }
-  }]
+  ]
 }
diff --git a/api-specs/api/examples/state.example.json b/api-specs/api/examples/state.example.json
@@ -8,7 +8,7 @@
     "en": "Initial"
   },
   "description": {
-    "en": "Initial is the first that (custom) line item gets after its creation"
+    "en": "Initial is the first State that a (custom) Line Item gets after its creation."
   },
   "builtIn": true,
   "initial": true,

diff --git a/api-specs/api/examples/states.example.json b/api-specs/api/examples/states.example.json
@@ -14,7 +14,7 @@
         "en": "Initial"
       },
       "description": {
-        "en": "Initial is the first that (custom) line item gets after it's creation"
+        "en": "Initial is the first State that a (custom) Line Item gets after its creation."
       },
       "builtIn": true,
       "initial": true,

diff --git a/api-specs/api/examples/subscription-create.example.json b/api-specs/api/examples/subscription-create.example.json
@@ -1,9 +1,9 @@
 {
   "destination": {
     "type": "SQS",
-    "queueUrl": "<url-to-my-queue>",
+    "queueUrl": "https://sqs.my-region.amazonaws.com/my-aws-account-number/my-queue",
     "authenticationMode": "IAM",
-    "region": "<my-region>"
+    "region": "my-region"
   },
   "messages": [
     {

diff --git a/api-specs/api/examples/subscription-update-response.example.json b/api-specs/api/examples/subscription-update-response.example.json
@@ -0,0 +1,24 @@
+{
+  "id": "bf79c5d2-2813-4229-9a88-e7c76be50986",
+  "version": 2,
+  "destination": {
+    "type": "SQS",
+    "queueUrl": "https://sqs.my-region.amazonaws.com/my-aws-account-number/my-queue",
+    "authenticationMode": "IAM",
+    "region": "my-region"
+  },
+  "messages": [
+    {
+      "resourceTypeId": "product",
+      "types": []
+    }
+  ],
+  "changes": [],
+  "createdAt": "2017-01-25T14:14:22.417Z",
+  "key": "new-key",
+  "format": {
+    "type": "Platform"
+  },
+  "lastModifiedAt": "2024-08-06T13:49:48.511Z",
+  "status": "Healthy"
+}
diff --git a/api-specs/api/examples/subscription-update.example.json b/api-specs/api/examples/subscription-update.example.json
@@ -1,7 +1,9 @@
 {
   "version": 1,
-  "actions": [{
-    "action": "setKey",
-    "key": "queue-key"
-  }]
+  "actions": [
+    {
+      "action": "setKey",
+      "key": "new-key"
+    }
+  ]
 }
diff --git a/api-specs/api/examples/subscription.example.json b/api-specs/api/examples/subscription.example.json
@@ -1,11 +1,11 @@
 {
-  "id": "8062243c-46fc-40b5-88a4-75e2216aef75",
+  "id": "bf79c5d2-2813-4229-9a88-e7c76be50986",
   "version": 1,
   "destination": {
     "type": "SQS",
-    "queueUrl": "<url-to-my-queue>",
+    "queueUrl": "https://sqs.my-region.amazonaws.com/my-aws-account-number/my-queue",
     "authenticationMode": "IAM",
-    "region": "<my-region>"
+    "region": "my-region"
   },
   "messages": [
     {

diff --git a/api-specs/api/examples/subscriptions.example.json b/api-specs/api/examples/subscriptions.example.json
@@ -5,7 +5,7 @@
   "total": 1,
   "results": [
     {
-      "id": "8062243c-46fc-40b5-88a4-75e2216aef75",
+      "id": "bf79c5d2-2813-4229-9a88-e7c76be50986",
       "version": 1,
       "destination": {
         "type": "SQS",

diff --git a/api-specs/api/examples/type-update-response.example.json b/api-specs/api/examples/type-update-response.example.json
@@ -0,0 +1,27 @@
+{
+  "id": "3ae9bcca-df23-443e-bd22-0c592f9694fa",
+  "version": 2,
+  "key": "lineitemtype",
+  "name": {
+    "en": "New Name"
+  },
+  "description": {
+    "en": "description"
+  },
+  "resourceTypeIds": ["line-item"],
+  "fieldDefinitions": [
+    {
+      "name": "offer_name",
+      "label": {
+        "en": "offer_name"
+      },
+      "required": false,
+      "type": {
+        "name": "String"
+      },
+      "inputHint": "SingleLine"
+    }
+  ],
+  "createdAt": "2015-10-07T06:56:19.217Z",
+  "lastModifiedAt": "2024-08-06T13:49:48.511Z"
+}
diff --git a/api-specs/api/examples/type-update.example.json b/api-specs/api/examples/type-update.example.json
@@ -1,9 +1,11 @@
 {
   "version": 1,
-  "actions": [{
-    "action": "changeName",
-    "name": {
-      "en": "New Name"
+  "actions": [
+    {
+      "action": "changeName",
+      "name": {
+        "en": "New Name"
+      }
     }
-  }]
+  ]
 }
diff --git a/api-specs/api/resources/discount-codes.raml b/api-specs/api/resources/discount-codes.raml
@@ -12,7 +12,7 @@ description:
   Discount Codes can be added to a discount-code to enable certain discount-code
   discounts.
 get:
-  description: 'Deprecated scope: `view_orders:{projectKey}`'
+  description: 'Deprecated OAuth 2.0 Scope: `view_orders:{projectKey}`'
   securedBy: [oauth_2_0: { scopes: ['view_discount_codes:{projectKey}'] }]
   responses:
     200:
@@ -29,7 +29,7 @@ post:
   description: |
     Creating a Discount Code produces the [DiscountCodeCreated](ctp:api:type:DiscountCodeCreatedMessage) Message.
 
-    Deprecated scope: `manage_orders:{projectKey}`
+    Deprecated OAuth 2.0 Scope: `manage_orders:{projectKey}`
   securedBy: [oauth_2_0: { scopes: ['manage_discount_codes:{projectKey}'] }]
   body:
     application/json:
@@ -47,7 +47,7 @@ post:
       resourceType: DiscountCode
       resourceUpdateType: DiscountCodeUpdate
   get:
-    description: 'Deprecated scope: `view_orders:{projectKey}`'
+    description: 'Deprecated OAuth 2.0 Scope: `view_orders:{projectKey}`'
     securedBy: [oauth_2_0: { scopes: [' view_discount_codes:{projectKey}'] }]
     responses:
       200:
@@ -58,7 +58,7 @@ post:
     securedBy: [oauth_2_0: { scopes: ['view_discount_codes:{projectKey}'] }]
     description: Checks if a DiscountCode exists for a given `id`. Returns a `200 OK` status if the DiscountCode exists or a `404 Not Found` otherwise.
   post:
-    description: 'Deprecated scope: `manage_orders:{projectKey}`'
+    description: 'Deprecated OAuth 2.0 Scope: `manage_orders:{projectKey}`'
     securedBy: [oauth_2_0: { scopes: ['manage_discount_codes:{projectKey}'] }]
     body:
       application/json:
@@ -74,7 +74,7 @@ post:
     description: |
       Deleting a Discount Code produces the [DiscountCodeDeleted](ctp:api:type:DiscountCodeDeletedMessage) Message.
 
-      Deprecated scope: `manage_orders:{projectKey}`
+      Deprecated OAuth 2.0 Scope: `manage_orders:{projectKey}`
     securedBy: [oauth_2_0: { scopes: ['manage_discount_codes:{projectKey}'] }]
     responses:
       200:
@@ -89,7 +89,7 @@ post:
       resourceType: DiscountCode
       resourceUpdateType: DiscountCodeUpdate
   get:
-    description: 'Deprecated scope: `view_orders:{projectKey}`'
+    description: 'Deprecated OAuth 2.0 Scope: `view_orders:{projectKey}`'
     securedBy: [oauth_2_0: { scopes: [' view_discount_codes:{projectKey}'] }]
     responses:
       200:
@@ -100,7 +100,7 @@ post:
     securedBy: [oauth_2_0: { scopes: ['view_discount_codes:{projectKey}'] }]
     description: Checks if a DiscountCode exists for a given `key`. Returns a `200 OK` status if the DiscountCode exists or a `404 Not Found` otherwise.
   post:
-    description: 'Deprecated scope: `manage_orders:{projectKey}`'
+    description: 'Deprecated OAuth 2.0 Scope: `manage_orders:{projectKey}`'
     securedBy: [oauth_2_0: { scopes: ['manage_discount_codes:{projectKey}'] }]
     body:
       application/json:
@@ -116,7 +116,7 @@ post:
     description: |
       Deleting a Discount Code produces the [DiscountCodeDeleted](ctp:api:type:DiscountCodeDeletedMessage) Message.
 
-      Deprecated scope: `manage_orders:{projectKey}`
+      Deprecated OAuth 2.0 Scope: `manage_orders:{projectKey}`
     securedBy: [oauth_2_0: { scopes: ['manage_discount_codes:{projectKey}'] }]
     responses:
       200:

diff --git a/api-specs/api/resources/extensions.raml b/api-specs/api/resources/extensions.raml
@@ -75,7 +75,7 @@ post:
         body:
           application/json:
             type: Extension
-            example: !include ../examples/extension.example.json
+            example: !include ../examples/extension-update-response.example.json
   delete:
     displayName: Delete Extension by key
     securedBy: [oauth_2_0: { scopes: ['manage_extensions:{projectKey}'] }]
@@ -122,7 +122,7 @@ post:
         body:
           application/json:
             type: Extension
-            example: !include ../examples/extension.example.json
+            example: !include ../examples/extension-update-response.example.json
   delete:
     displayName: Delete Extension by ID
     securedBy: [oauth_2_0: { scopes: ['manage_extensions:{projectKey}'] }]