Skip to content

Commit b1fc7df

Browse files
committed
Updated API from documentation release
1 parent d28ee28 commit b1fc7df

File tree

6 files changed

+15
-6
lines changed

6 files changed

+15
-6
lines changed

api-specs/api/types/me/MyShoppingListDraft.raml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ properties:
3333
deleteDaysAfterLastModification?:
3434
type: number
3535
format: int64
36+
minimum: 1
3637
description: |
37-
Number of days after which the ShoppingList will be automatically deleted if it has not been modified. If not set, the [default value](ctp:api:type:ShoppingListsConfiguration) configured in the [Project](ctp:api:type:Project) is used.
38+
Number of days after the last modification before a ShoppingList is deleted. If not set, the [default value](ctp:api:type:ShoppingListsConfiguration) configured in the [Project](ctp:api:type:Project) is used.
3839
store?:
3940
type: StoreResourceIdentifier
4041
description: |

api-specs/api/types/me/updates/MyShoppingListSetDeleteDaysAfterLastModificationAction.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ type: MyShoppingListUpdateAction
44
displayName: MyShoppingListSetDeleteDaysAfterLastModificationAction
55
discriminatorValue: setDeleteDaysAfterLastModification
66
example: !include ../../../examples/ShoppingList/ShoppingListSetDeleteDaysAfterLastModificationAction.json
7+
description: |
8+
Number of days after the last modification before a Shopping List is deleted.
79
properties:
810
deleteDaysAfterLastModification?:
911
type: number
1012
format: int64
1113
minimum: 1
1214
description: |
13-
Value to set. If empty, any existing value will be removed.
15+
Value to set. If not provided, the default value for this field configured in [Project settings](ctp:api:type:ShoppingListsConfiguration) is assigned.

api-specs/api/types/project/ShoppingListsConfiguration.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ type: object
44
displayName: ShoppingListsConfiguration
55
properties:
66
deleteDaysAfterLastModification?:
7+
default: 360
8+
minimum: 1
79
type: number
810
format: int64
911
description: |

api-specs/api/types/shopping-list/ShoppingList.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ properties:
4848
deleteDaysAfterLastModification?:
4949
type: number
5050
format: int64
51-
description: Number of days after which the ShoppingList will be automatically deleted if it has not been modified.
51+
default: 360
52+
description: |
53+
Number of days after the last modification before a ShoppingList is deleted. If not set, the [default value](ctp:api:type:ShoppingListsConfiguration) configured in the [Project](ctp:api:type:Project) is used.
5254
anonymousId?:
5355
type: string
5456
description: Identifies ShoppingLists belonging to an [anonymous session](ctp:api:type:AnonymousSession).

api-specs/api/types/shopping-list/ShoppingListDraft.raml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ properties:
3535
deleteDaysAfterLastModification?:
3636
type: number
3737
format: int64
38-
description: |
39-
Number of days after which the ShoppingList will be automatically deleted if it has not been modified. If not set, the [default value](ctp:api:type:ShoppingListsConfiguration) configured in the [Project](ctp:api:type:Project) is used.
4038
minimum: 1
39+
description: |
40+
Number of days after the last modification before a ShoppingList is deleted. If not set, the [default value](ctp:api:type:ShoppingListsConfiguration) configured in the [Project](ctp:api:type:Project) is used.
4141
lineItems?:
4242
type: ShoppingListLineItemDraft[]
4343
description: |

api-specs/api/types/shopping-list/updates/ShoppingListSetDeleteDaysAfterLastModificationAction.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ type: ShoppingListUpdateAction
44
displayName: ShoppingListSetDeleteDaysAfterLastModificationAction
55
discriminatorValue: setDeleteDaysAfterLastModification
66
example: !include ../../../examples/ShoppingList/ShoppingListSetDeleteDaysAfterLastModificationAction.json
7+
description: |
8+
Number of days after the last modification before a Shopping List is deleted.
79
properties:
810
deleteDaysAfterLastModification?:
911
type: number
1012
format: int64
1113
minimum: 1
1214
description: |
13-
Value to set. If empty, any existing value will be removed.
15+
Value to set. If not provided, the default value for this field configured in [Project settings](ctp:api:type:ShoppingListsConfiguration) is assigned.

0 commit comments

Comments
 (0)