Skip to content

Commit 38f1853

Browse files
committed
Updated API from documentation release
1 parent e45c960 commit 38f1853

File tree

48 files changed

+270
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+270
-4
lines changed

api-specs/api/resources/in-store.raml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2572,16 +2572,20 @@ uriParameters:
25722572
limit:
25732573
type: number
25742574
format: int32
2575-
maximum: 500
25762575
required: false
25772576
description: |
25782577
Number of [results requested](/../api/general-concepts#limit).
2578+
default: 20
2579+
minimum: 0
2580+
maximum: 500
25792581
offset:
25802582
type: number
25812583
format: int32
25822584
required: false
25832585
description: |
25842586
Number of [elements skipped](/../api/general-concepts#offset).
2587+
default: 0
2588+
maximum: 10000
25852589
withTotal:
25862590
type: boolean
25872591
default: true
@@ -2873,16 +2877,20 @@ uriParameters:
28732877
limit:
28742878
type: number
28752879
format: int32
2876-
maximum: 500
28772880
required: false
28782881
description: |
28792882
Number of [results requested](/../api/general-concepts#limit).
2883+
default: 20
2884+
minimum: 0
2885+
maximum: 500
28802886
offset:
28812887
type: number
28822888
format: int32
28832889
required: false
28842890
description: |
28852891
Number of [elements skipped](/../api/general-concepts#offset).
2892+
default: 0
2893+
maximum: 10000
28862894
withTotal:
28872895
type: boolean
28882896
default: true

api-specs/api/traits/paging.raml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,20 @@ queryParameters:
44
limit:
55
type: number
66
format: int32
7-
maximum: 500
87
required: false
98
description: |
109
Number of [results requested](/../api/general-concepts#limit).
10+
default: 20
11+
minimum: 0
12+
maximum: 500
1113
offset:
1214
type: number
1315
format: int32
1416
required: false
1517
description: |
1618
Number of [elements skipped](/../api/general-concepts#offset).
19+
default: 0
20+
maximum: 10000
1721
withTotal:
1822
type: boolean
1923
default: true

api-specs/api/types/PagedQueryResponse.raml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,16 @@ properties:
99
format: int64
1010
description: |
1111
Number of [results requested](/../api/general-concepts#limit).
12+
default: 20
13+
minimum: 0
14+
maximum: 500
1215
offset:
1316
type: number
1417
format: int64
1518
description: |
1619
Number of [elements skipped](/../api/general-concepts#offset).
20+
default: 0
21+
maximum: 10000
1722
count:
1823
type: number
1924
format: int64

api-specs/api/types/api-client/ApiClientPagedQueryResponse.raml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@ properties:
1010
format: int64
1111
description: |
1212
Number of [results requested](/../api/general-concepts#limit).
13+
default: 20
14+
minimum: 0
15+
maximum: 500
1316
offset:
1417
type: number
1518
format: int64
1619
description: |
1720
Number of [elements skipped](/../api/general-concepts#offset).
21+
default: 0
22+
maximum: 10000
1823
count:
1924
type: number
2025
format: int64

api-specs/api/types/approval-flow/ApprovalFlowPagedQueryResponse.raml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@ properties:
1010
format: int64
1111
description: |
1212
Number of [results requested](/../api/general-concepts#limit).
13+
default: 20
14+
minimum: 0
15+
maximum: 500
1316
offset:
1417
type: number
1518
format: int64
1619
description: |
1720
Number of [elements skipped](/../api/general-concepts#offset).
21+
default: 0
22+
maximum: 10000
1823
count:
1924
type: number
2025
format: int64

api-specs/api/types/approval-rule/ApprovalRulePagedQueryResponse.raml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@ properties:
1010
format: int64
1111
description: |
1212
Number of [results requested](/../api/general-concepts#limit).
13+
default: 20
14+
minimum: 0
15+
maximum: 500
1316
offset:
1417
type: number
1518
format: int64
1619
description: |
1720
Number of [elements skipped](/../api/general-concepts#offset).
21+
default: 0
22+
maximum: 10000
1823
count:
1924
type: number
2025
format: int64

api-specs/api/types/cart-discount/CartDiscountPagedQueryResponse.raml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@ properties:
1010
format: int64
1111
description: |
1212
Number of [results requested](/../api/general-concepts#limit).
13+
default: 20
14+
minimum: 0
15+
maximum: 500
1316
offset:
1417
type: number
1518
format: int64
1619
description: |
1720
Number of [elements skipped](/../api/general-concepts#offset).
21+
default: 0
22+
maximum: 10000
1823
count:
1924
type: number
2025
format: int64

api-specs/api/types/cart/CartPagedQueryResponse.raml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@ properties:
1010
format: int64
1111
description: |
1212
Number of [results requested](/../api/general-concepts#limit).
13+
default: 20
14+
minimum: 0
15+
maximum: 500
1316
offset:
1417
type: number
1518
format: int64
1619
description: |
1720
Number of [elements skipped](/../api/general-concepts#offset).
21+
default: 0
22+
maximum: 10000
1823
count:
1924
type: number
2025
format: int64

api-specs/api/types/category/CategoryPagedQueryResponse.raml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@ properties:
1010
format: int64
1111
description: |
1212
Number of [results requested](/../api/general-concepts#limit).
13+
default: 20
14+
minimum: 0
15+
maximum: 500
1316
offset:
1417
type: number
1518
format: int64
1619
description: |
1720
Number of [elements skipped](/../api/general-concepts#offset).
21+
default: 0
22+
maximum: 10000
1823
count:
1924
type: number
2025
format: int64

api-specs/api/types/channel/ChannelPagedQueryResponse.raml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@ properties:
1010
format: int64
1111
description: |
1212
Number of [results requested](/../api/general-concepts#limit).
13+
default: 20
14+
minimum: 0
15+
maximum: 500
1316
offset:
1417
type: number
1518
format: int64
1619
description: |
1720
Number of [elements skipped](/../api/general-concepts#offset).
21+
default: 0
22+
maximum: 10000
1823
count:
1924
type: number
2025
format: int64

0 commit comments

Comments
 (0)