Skip to content

Commit ff62a16

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Updated API from documentation release
1 parent 761b815 commit ff62a16

File tree

9 files changed

+81
-5
lines changed

9 files changed

+81
-5
lines changed

‎api-specs/api/api.raml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ resourceTypes:
199199
(updateable): Project
200200
description: The Project endpoint is used to retrieve certain information from a project.
201201
get:
202-
displayName: Get project settings
202+
displayName: Get Project
203203
is:
204204
- errorable
205205
- deprecatable200
@@ -210,12 +210,13 @@ resourceTypes:
210210
example: !include examples/project.example.json
211211
type: Project
212212
head:
213+
displayName: Check if Project exists
213214
securedBy: [oauth_2_0: { scopes: ['view_project_settings:{projectKey}'] }]
214215
description: Checks if a Project exists for a given `projectKey`. Returns a `200 OK` status if the Project exists or a `404 Not Found` otherwise.
215216
responses:
216217
200:
217218
post:
218-
displayName: Update project settings
219+
displayName: Update Project
219220
is:
220221
- conflicting
221222
securedBy: [oauth_2_0: { scopes: ['manage_project_settings:{projectKey}'] }]

‎api-specs/api/resources/api-clients.raml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ type:
88
description: |
99
Manage your API Clients via an API. Useful for Infrastructure-as-Code tooling, and regularly rotating API secrets.
1010
get:
11+
displayName: Query ApiClients
1112
securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
1213
responses:
1314
200:
1415
body:
1516
application/json:
1617
example: !include ../examples/api-clients.example.json
1718
head:
19+
displayName: Check if ApiClient exists by Query Predicate
1820
securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
1921
description: Checks if an API Client exists for the provided query predicate. Returns a `200 OK` status if any API Clients match the query predicate, or a `404 Not Found` otherwise.
2022
queryParameters:
@@ -26,6 +28,7 @@ head:
2628
[Number](ctp:api:type:AttributeNumberType), [Date](ctp:api:type:AttributeDateType),
2729
[Time](ctp:api:type:AttributeTimeType), and [DateTime](ctp:api:type:AttributeDateTimeType) attribute types.
2830
post:
31+
displayName: Create ApiClient
2932
securedBy: [oauth_2_0: { scopes: ['manage_api_clients:{projectKey}'] }]
3033
body:
3134
application/json:
@@ -44,20 +47,21 @@ post:
4447
description: '`id` of the API Client.'
4548
type: base
4649
get:
47-
securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
4850
displayName: Get ApiClient by ID
51+
securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
4952
responses:
5053
200:
5154
body:
5255
application/json:
5356
example: !include ../examples/api-client.example.json
5457
type: ApiClient
5558
head:
59+
displayName: Check if ApiClient exists by ID
5660
securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
5761
description: Checks if an API Client exists with the provided `id`. Returns a `200 OK` status if the API Client exists or a `404 Not Found` otherwise.
5862
delete:
59-
securedBy: [oauth_2_0: { scopes: ['manage_api_clients:{projectKey}'] }]
6063
displayName: Delete ApiClient by ID
64+
securedBy: [oauth_2_0: { scopes: ['manage_api_clients:{projectKey}'] }]
6165
responses:
6266
200:
6367
body:

‎api-specs/api/resources/attribute-groups.raml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ type:
1010
(createable): AttributeGroupDraft
1111
description: Attribute groups ... TODO
1212
get:
13+
displayName: Query AttributeGroups
1314
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
1415
responses:
1516
200:
1617
body:
1718
application/json:
1819
example: !include ../examples/AttributeGroup/AttributeGroups.json
1920
head:
21+
displayName: Check if AttributeGroup exists by Query Predicate
2022
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
2123
description: Checks if one or more AttributeGroups exist for the provided query predicate. Returns `200 OK` status if any AttributeGroups match the query predicate, or a `404 Not Found` otherwise.
2224
queryParameters:
@@ -28,6 +30,7 @@ head:
2830
[Number](ctp:api:type:AttributeNumberType), [Date](ctp:api:type:AttributeDateType),
2931
[Time](ctp:api:type:AttributeTimeType), and [DateTime](ctp:api:type:AttributeDateTimeType) attribute types.
3032
post:
33+
displayName: Create AttributeGroup
3134
securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
3235
body:
3336
application/json:
@@ -45,16 +48,19 @@ post:
4548
resourceType: AttributeGroup
4649
resourceUpdateType: AttributeGroupUpdate
4750
get:
51+
displayName: Get AttributeGroup by Key
4852
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
4953
responses:
5054
200:
5155
body:
5256
application/json:
5357
example: !include ../examples/AttributeGroup/AttributeGroup.json
5458
head:
59+
displayName: Check if AttributeGroup exists by Key
5560
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
5661
description: Checks if an AttributeGroup exists with the provided `key`. Returns `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.
5762
post:
63+
displayName: Update AttributeGroup by Key
5864
securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
5965
body:
6066
application/json:
@@ -65,6 +71,7 @@ post:
6571
application/json:
6672
example: !include ../examples/AttributeGroup/AttributeGroup.json
6773
delete:
74+
displayName: Delete AttributeGroup by Key
6875
securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
6976
responses:
7077
200:
@@ -79,16 +86,19 @@ post:
7986
resourceType: AttributeGroup
8087
resourceUpdateType: AttributeGroupUpdate
8188
get:
89+
displayName: Get AttributeGroup by ID
8290
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
8391
responses:
8492
200:
8593
body:
8694
application/json:
8795
example: !include ../examples/AttributeGroup/AttributeGroup.json
8896
head:
97+
displayName: Check if AttributeGroup exists by ID
8998
securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
9099
description: Checks if an AttributeGroup exists with the provided `id`. Returns a `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.
91100
post:
101+
displayName: Update AttributeGroup by ID
92102
securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
93103
body:
94104
application/json:
@@ -99,6 +109,7 @@ post:
99109
application/json:
100110
example: !include ../examples/AttributeGroup/AttributeGroup.json
101111
delete:
112+
displayName: Delete AttributeGroup by ID
102113
securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
103114
responses:
104115
200:

‎api-specs/api/resources/channels.raml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ type:
1111
description: |
1212
Channels represent a source or destination of different entities. They can be used to model warehouses or stores.
1313
get:
14+
displayName: Query Channels
1415
securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
1516
responses:
1617
200:
1718
body:
1819
application/json:
1920
example: !include ../examples/channels.example.json
2021
head:
22+
displayName: Check if Channel exists by Query Predicate
2123
securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
2224
description: Checks if one or more Channels exist for the provided query predicate. Returns a `200 OK` status if any Channels match the query predicate, or a `404 Not Found` otherwise.
2325
queryParameters:
@@ -29,6 +31,7 @@ head:
2931
[Number](ctp:api:type:AttributeNumberType), [Date](ctp:api:type:AttributeDateType),
3032
[Time](ctp:api:type:AttributeTimeType), and [DateTime](ctp:api:type:AttributeDateTimeType) attribute types.
3133
post:
34+
displayName: Create Channel
3235
securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
3336
body:
3437
application/json:
@@ -46,16 +49,19 @@ post:
4649
resourceType: Channel
4750
resourceUpdateType: ChannelUpdate
4851
get:
52+
displayName: Get Channel by ID
4953
securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
5054
responses:
5155
200:
5256
body:
5357
application/json:
5458
example: !include ../examples/channel.example.json
5559
head:
60+
displayName: Check if Channel exists by ID
5661
securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
5762
description: Checks if a Channel exists with the provided `id`. Returns a `200 OK` status if the Channel exists or a `404 Not Found` otherwise.
5863
post:
64+
displayName: Update Channel by ID
5965
securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
6066
body:
6167
application/json:
@@ -66,6 +72,7 @@ post:
6672
application/json:
6773
example: !include ../examples/channel-updated.example.json
6874
delete:
75+
displayName: Delete Channel by ID
6976
securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
7077
description: |
7178
Returns a [ReferenceExists](ctp:api:type:ReferenceExistsError) error if other resources reference the Channel to be deleted.
@@ -83,16 +90,19 @@ post:
8390
resourceType: Channel
8491
resourceUpdateType: ChannelUpdate
8592
get:
93+
displayName: Get Channel by Key
8694
securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
8795
responses:
8896
200:
8997
body:
9098
application/json:
9199
example: !include ../examples/channel.example.json
92100
head:
101+
displayName: Check if Channel exists by Key
93102
securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
94103
description: Checks if a Channel exists with the provided `key`. Returns a `200 OK` status if the Channel exists or a `404 Not Found` otherwise.
95104
post:
105+
displayName: Update Channel by Key
96106
securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
97107
body:
98108
application/json:
@@ -103,6 +113,7 @@ post:
103113
application/json:
104114
example: !include ../examples/channel-updated.example.json
105115
delete:
116+
displayName: Delete Channel by Key
106117
securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
107118
description: |
108119
Returns a [ReferenceExists](ctp:api:type:ReferenceExistsError) error if other resources reference the Channel to be deleted.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2202,7 +2202,7 @@ uriParameters:
22022202
type: base
22032203
description: Get ShippingMethods for a cart in a store
22042204
get:
2205-
displayName: Get ShippingMethods for a cart in a store
2205+
displayName: Get matching ShippingMethods for a Cart in Store
22062206
description: |
22072207
Retrieves the active ShippingMethods that can ship to the shipping address of the given Cart in a given [Store](ctp:api:type:Store).
22082208
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
@@ -2231,6 +2231,7 @@ uriParameters:
22312231
type: ShippingMethodPagedQueryResponse
22322232
example: !include ../examples/shipping-methods.example.json
22332233
head:
2234+
displayName: Check if matching ShippingMethod exists for a Cart in Store
22342235
securedBy:
22352236
- oauth_2_0:
22362237
scopes:

‎api-specs/api/resources/shipping-methods.raml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ type:
1010
(createable): ShippingMethodDraft
1111
description: ShippingMethods define where orders can be shipped and what the costs are.
1212
get:
13+
displayName: Query ShippingMethods
1314
securedBy:
1415
[
1516
oauth_2_0:
@@ -28,6 +29,7 @@ get:
2829
application/json:
2930
example: !include ../examples/shipping-methods.example.json
3031
head:
32+
displayName: Check if ShippingMethod exists by Query Predicate
3133
securedBy:
3234
[
3335
oauth_2_0:
@@ -45,6 +47,7 @@ head:
4547
where?:
4648
type: QueryPredicate[]
4749
post:
50+
displayName: Create ShippingMethod
4851
securedBy:
4952
[
5053
oauth_2_0:
@@ -72,6 +75,7 @@ post:
7275
resourceType: ShippingMethod
7376
resourceUpdateType: ShippingMethodUpdate
7477
get:
78+
displayName: Get ShippingMethod by Key
7579
securedBy:
7680
[
7781
oauth_2_0:
@@ -90,6 +94,7 @@ post:
9094
application/json:
9195
example: !include ../examples/shipping-method.example.json
9296
head:
97+
displayName: Check if ShippingMethod exists by Key
9398
securedBy:
9499
[
95100
oauth_2_0:
@@ -104,6 +109,7 @@ post:
104109
]
105110
description: Checks if a ShippingMethod exists with the provided `key`. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.
106111
post:
112+
displayName: Update ShippingMethod by Key
107113
securedBy:
108114
[
109115
oauth_2_0:
@@ -124,6 +130,7 @@ post:
124130
application/json:
125131
example: !include ../examples/shipping-method.example.json
126132
delete:
133+
displayName: Delete ShippingMethod by Key
127134
securedBy:
128135
[
129136
oauth_2_0:
@@ -176,6 +183,7 @@ post:
176183
type: ShippingMethodPagedQueryResponse
177184
example: !include ../examples/shipping-methods.example.json
178185
head:
186+
displayName: Check if matching ShippingMethod exists for a Cart
179187
securedBy:
180188
[
181189
oauth_2_0:
@@ -239,6 +247,7 @@ post:
239247
type: ShippingMethodPagedQueryResponse
240248
example: !include ../examples/shipping-methods.example.json
241249
head:
250+
displayName: Check if matching ShippingMethod exists for a Cart and Location
242251
securedBy:
243252
[
244253
oauth_2_0:
@@ -304,6 +313,7 @@ post:
304313
type: ShippingMethodPagedQueryResponse
305314
example: !include ../examples/shipping-methods.example.json
306315
head:
316+
displayName: Check if matching ShippingMethod exists for an Order Edit
307317
securedBy:
308318
[
309319
oauth_2_0:
@@ -375,6 +385,7 @@ post:
375385
type: ShippingMethodPagedQueryResponse
376386
example: !include ../examples/shipping-methods.example.json
377387
head:
388+
displayName: Check if matching ShippingMethod exists for a Location
378389
securedBy:
379390
[
380391
oauth_2_0:
@@ -409,6 +420,7 @@ post:
409420
resourceType: ShippingMethod
410421
resourceUpdateType: ShippingMethodUpdate
411422
get:
423+
displayName: Get ShippingMethod by ID
412424
securedBy:
413425
[
414426
oauth_2_0:
@@ -427,6 +439,7 @@ post:
427439
application/json:
428440
example: !include ../examples/shipping-method.example.json
429441
head:
442+
displayName: Check if ShippingMethod exists by ID
430443
securedBy:
431444
[
432445
oauth_2_0:
@@ -441,6 +454,7 @@ post:
441454
]
442455
description: Checks if a ShippingMethod exists with the provided `id`. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.
443456
post:
457+
displayName: Update ShippingMethod by ID
444458
securedBy:
445459
[
446460
oauth_2_0:
@@ -461,6 +475,7 @@ post:
461475
application/json:
462476
example: !include ../examples/shipping-method.example.json
463477
delete:
478+
displayName: Delete ShippingMethod by ID
464479
securedBy:
465480
[
466481
oauth_2_0:

0 commit comments

Comments
 (0)