Skip to content

Commit a3e4080

Browse files
committed
Updated API from documentation release
1 parent 8e8730a commit a3e4080

12 files changed

+31
-15
lines changed

api-specs/api/examples/Product/ProductLegacySetSkuAction.json

Lines changed: 0 additions & 5 deletions
This file was deleted.

api-specs/api/resources/custom-objects.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ get:
1818
- 'view_key_value_documents:{projectKey}'
1919
description: |
2020
For performance reasons, it is highly advisable to query for Custom Objects in a container by using the `container` field in the `where` predicate.
21+
22+
This endpoint is deprecated and replaced by the [Query CustomObjects in Container](/../apis/ctp:api:endpoint:/{projectKey}/custom-objects/{container}:GET) endpoint.
2123
responses:
2224
200:
2325
body:

api-specs/api/types/product/updates/ProductLegacySetSkuAction.raml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
#%RAML 1.0 DataType
22
(package): Product
3+
(deprecated): true
34
type: ProductUpdateAction
45
displayName: ProductLegacySetSkuAction
5-
discriminatorValue: legacySetSku
6+
discriminatorValue: setSKU
67
properties:
78
sku?:
89
type: string

api-specs/history/types/change/AddAssociateChange.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
(markDeprecated): true
44
type: Change
55
displayName: AddAssociateChange
6-
description: Change triggered by the [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action.
6+
description: |
7+
This Change is no longer triggered by the [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action.
8+
It has been deprecated and replaced by the [SetAssociatesChange](ctp:history:type:SetAssociatesChange).
79
discriminatorValue: AddAssociateChange
810
properties:
911
change:

api-specs/history/types/change/AddPriceChange.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
type: Change
55
displayName: AddPriceChange
66
discriminatorValue: AddPriceChange
7-
description: Change triggered by the [Add Price](ctp:api:type:ProductAddPriceAction) update action.
7+
description: |
8+
This Change is no longer triggered by the [Add Price](ctp:api:type:ProductAddPriceAction) update action.
9+
It has been deprecated and replaced by the [SetPricesChange](ctp:history:type:SetPricesChange).
810
properties:
911
type:
1012
type: string

api-specs/history/types/change/AddProductSelectionChange.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
(markDeprecated): true
44
type: Change
55
displayName: AddProductSelectionChange
6-
description: Change triggered by the [Add Product Selection](ctp:api:type:StoreAddProductSelectionAction) update action.
6+
description: |
7+
This Change is no longer triggered by the [Add Product Selection](ctp:api:type:StoreAddProductSelectionAction) update action.
8+
It has been deprecated and replaced by the [SetProductSelectionsChange](ctp:history:type:SetProductSelectionsChange).
79
discriminatorValue: AddProductSelectionChange
810
properties:
911
type:

api-specs/history/types/change/AddStateRolesChange.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
type: Change
55
displayName: AddStateRolesChange
66
discriminatorValue: AddStateRolesChange
7-
description: Change triggered by the [Add State roles](ctp:api:type:StateAddRolesAction) update action.
7+
description: |
8+
This Change is no longer triggered by the [Add State roles](ctp:api:type:StateAddRolesAction) update action.
9+
It has been deprecated and replaced by the [SetStateRolesChange](ctp:history:type:SetStateRolesChange).
810
properties:
911
type:
1012
type: string

api-specs/history/types/change/ChangeAmountAuthorizedChange.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
type: Change
55
displayName: ChangeAmountAuthorizedChange
66
discriminatorValue: ChangeAmountAuthorizedChange
7-
description: This change is initiated by background processes after the [Change AmountPlanned](ctp:api:type:PaymentChangeAmountPlannedAction) update action is performed.
7+
description: |
8+
This change is no longer initiated by background processes after the [Change AmountPlanned](ctp:api:type:PaymentChangeAmountPlannedAction) update action is performed.
9+
It has been deprecated since the corresponding field on the Payment does not exist anymore.
810
properties:
911
type:
1012
type: string

api-specs/history/types/change/RemoveAssociateChange.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
(markDeprecated): true
44
type: Change
55
displayName: RemoveAssociateChange
6-
description: Change triggered by the [Remove Associate](ctp:api:type:BusinessUnitRemoveAssociateAction) update action.
6+
description: |
7+
This Change is no longer triggered by the [Remove Associate](ctp:api:type:BusinessUnitRemoveAssociateAction) update action.
8+
It has been deprecated and replaced by the [SetAssociatesChange](ctp:history:type:SetAssociatesChange).
79
discriminatorValue: RemoveAssociateChange
810
properties:
911
change:

api-specs/history/types/change/RemovePriceChange.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
type: Change
55
displayName: RemovePriceChange
66
discriminatorValue: RemovePriceChange
7-
description: Change triggered by the [Remove Embedded Price](ctp:api:type:ProductRemovePriceAction) update action.
7+
description: |
8+
This Change is no longer triggered by the [Remove Embedded Price](ctp:api:type:ProductRemovePriceAction) update action.
9+
It has been deprecated and replaced by the [SetPricesChange](ctp:history:type:SetPricesChange).
810
properties:
911
type:
1012
type: string

0 commit comments

Comments
 (0)