Skip to content

Commit 1c132d4

Browse files
committed
Updated API from documentation release
1 parent 86a80fe commit 1c132d4

File tree

3 files changed

+18
-13
lines changed

3 files changed

+18
-13
lines changed

api-specs/api/types/extension/Extension.raml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,11 @@ properties:
4949
Describes what triggers the Extension.
5050
timeoutInMs?:
5151
type: integer
52+
default: 2000
53+
maximum: 10000
5254
description: |
5355
Maximum time (in milliseconds) that the Extension can respond within.
54-
If no timeout is provided, the [default value](#time-limits) is used for all types of Extensions, including `payment` Extensions.
55-
The maximum value is 10000 ms (10 seconds) for `payment` Extensions and 2000 ms (2 seconds) for all other Extensions.
56-
default: 2000
56+
If no timeout is provided, the default value is used for all [types of Extensions](ctp:api:type:ExtensionResourceTypeId).
57+
58+
The limit of 10000 ms (10 seconds) can be increased per Project after we review the performance impact.
59+
Please contact the [Composable Commerce support team](https://support.commercetools.com) and provide the Region, Project key, and use case.

api-specs/api/types/extension/ExtensionDraft.raml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ properties:
2020
Describes what triggers the Extension.
2121
timeoutInMs?:
2222
type: integer
23+
default: 2000
24+
maximum: 10000
2325
description: |
2426
Maximum time (in milliseconds) the Extension can respond within.
25-
If no timeout is provided, the [default value](/#time-limits) is used for all types of Extensions, including `payment` Extensions.
26-
The maximum value is 10000 ms (10 seconds) for `payment` Extensions and 2000 ms (2 seconds) for all other Extensions.
27+
If no timeout is provided, the default value is used for all [types of Extensions](ctp:api:type:ExtensionResourceTypeId).
28+
We recommend keeping the timeout as low as possible to avoid performance issues.
2729
28-
This limit can be increased per Project after we review the performance impact.
30+
The limit of 10000 ms (10 seconds) can be increased per Project after we review the performance impact.
2931
Please contact the [Composable Commerce support team](https://support.commercetools.com) and provide the Region, Project key, and use case.
30-
default: 2000

api-specs/api/types/extension/updates/ExtensionSetTimeoutInMsAction.raml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ discriminatorValue: setTimeoutInMs
66
properties:
77
timeoutInMs?:
88
type: integer
9+
default: 2000
10+
maximum: 10000
911
description: |
10-
Value to set. If not defined, the maximum value is used.
11-
If no timeout is provided, the [default value](#time-limits) is used for all types of Extensions, including `payment` Extensions.
12-
The maximum value is 10000 ms (10 seconds) for `payment` Extensions and 2000 ms (2 seconds) for all other Extensions.
12+
Value to set.
13+
If no timeout is provided, the default value is used for all [types of Extensions](ctp:api:type:ExtensionResourceTypeId).
14+
We recommend keeping the timeout as low as possible to avoid performance issues.
1315
14-
This limit can be increased per Project after we review the performance impact.
15-
Please contact the [Composable Commerce support team](https://support.commercetools.com/) and provide the Region, Project key, and use case.
16-
default: 2000
16+
The limit of 10000 ms (10 seconds) can be increased per Project after we review the performance impact.
17+
Please contact the [Composable Commerce support team](https://support.commercetools.com) and provide the Region, Project key, and use case.

0 commit comments

Comments
 (0)