Skip to content

Commit d1eb9d4

Browse files
Release 20201014
1 parent 2448e70 commit d1eb9d4

Some content is hidden

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

50 files changed

+2073
-1285
lines changed

apis/cdn/cdn-api-process-apis/.metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cdn-api-process-apis/1.0.8",
2+
"id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cdn-api-process-apis/1.0.9",
33
"name": "CDN Zones",
44
"description": "Extend your eCDN beyond Business Manager configuration.",
55
"groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
66
"assetId": "cdn-api-process-apis",
7-
"version": "1.0.8",
7+
"version": "1.0.9",
88
"categories": {
99
"API layer": [
1010
"Process"

apis/cdn/cdn-api-process-apis/cdnapi-process-api.raml

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ baseUri: https://{shortCode}.api.commercecloud.salesforce.com/cdn/zones/{version
88
baseUriParameters:
99
shortCode:
1010
description: Region-specific merchant identifier.
11-
example: fd4gt82k
11+
example: 0dnz6oep
1212

1313
mediaType: application/json
1414

@@ -25,6 +25,7 @@ types:
2525
ErrorResponse: ApiStandards.ErrorResponse
2626
CollectionResponseEnvelope: !include dataTypes/CollectionResponseEnvelope.raml
2727
ItemResponseEnvelope: !include dataTypes/ItemResponseEnvelope.raml
28+
SpeedSetting: !include dataTypes/SpeedSetting.raml
2829

2930
ZonesEnvelope:
3031
type: CollectionResponseEnvelope
@@ -66,6 +67,11 @@ types:
6667
properties:
6768
data:
6869
type: WafRule[]
70+
SpeedSettingsEnvelope:
71+
type: ItemResponseEnvelope
72+
properties:
73+
data:
74+
type: SpeedSetting
6975

7076
traits:
7177
hasUnauthorizedResponse: !include traits/HasUnauthorizedResponse.raml
@@ -245,4 +251,35 @@ securedBy:
245251
description: Delete a specific firewall rule.
246252
responses:
247253
'204':
248-
description: Successfully deleted the firewall rule specified by the caller.
254+
description: Successfully deleted the firewall rule specified by the caller.
255+
256+
/zones/{zoneId}/speed-settings:
257+
is: [hasResourceNotFoundResponse, hasUnauthorizedResponse, hasForbiddenAccessResponse, hasInternalServerErrorResponse]
258+
get:
259+
displayName: getSpeedSettings
260+
description: Retrieve speed settings for a zone.
261+
responses:
262+
'200':
263+
description: Successfully returned back speed settings requested by the caller.
264+
body:
265+
application/json:
266+
type: SpeedSettingsEnvelope
267+
example: !include /examples/zone/speed-settings-response.raml
268+
patch:
269+
is: [hasBadRequestResponse]
270+
displayName: updateSpeedSettings
271+
description: Update speed settings for a zone.
272+
273+
body:
274+
application/json:
275+
type: SpeedSetting
276+
examples: !include /examples/zone/speed-settings-patch-request.raml
277+
278+
responses:
279+
'200':
280+
description: Successfully updated speed settings requested by the caller.
281+
body:
282+
application/json:
283+
type: SpeedSettingsEnvelope
284+
examples:
285+
response : !include /examples/zone/speed-settings-response.raml
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#%RAML 1.0 DataType
2+
properties:
3+
brotliCompression:
4+
type: string
5+
description: Brotli compression setting of a zone, valid values are "on" and "off".
6+
required: false
7+
default: off
8+
enum: ["on", "off"]
9+
http2Prioritization:
10+
type: string
11+
description: Http2 prioritization setting for a zone, valid values are "on" and "off".
12+
required: false
13+
default: off
14+
enum: ["on", "off"]
15+
example: off
16+
17+
examples:
18+
brotliCompressionExample:
19+
brotliCompression: on
20+
http2PrioritizationExample:
21+
http2Prioritization: off
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#%RAML 1.0 NamedExample
2+
3+
Request Body Example:
4+
{
5+
"brotliCompression": "off",
6+
"http2Prioritization": "off"
7+
}
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#%RAML 1.0 NamedExample
2+
3+
data:
4+
brotliCompression: on
5+
http2Prioritization: on
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"main":"cdnapi-process-api.raml","name":"CDN API - Process APIs","classifier":"raml","tags":[],"dependencies":[{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"api-standards","version":"1.1.6"},{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"commerce-cloud-standards","version":"1.0.12"}],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"cdn-api-process-apis","version":"1.0.8","apiVersion":"v1","originalFormatVersion":"1.0"}
1+
{"main":"cdnapi-process-api.raml","name":"CDN API - Process APIs","classifier":"raml","tags":[],"dependencies":[{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"api-standards","version":"1.1.6"},{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"commerce-cloud-standards","version":"1.0.12"}],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"cdn-api-process-apis","version":"1.0.9","apiVersion":"v1","originalFormatVersion":"1.0"}

apis/checkout/shopper-baskets/.metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-baskets/0.1.2",
2+
"id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-baskets/0.2.1",
33
"name": "Shopper Baskets",
44
"description": "Build a checkout experience.",
55
"groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
66
"assetId": "shopper-baskets",
7-
"version": "0.1.2",
7+
"version": "0.2.1",
88
"categories": {
99
"API layer": [
1010
"Process"
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#%RAML 1.0 NamedExample
2+
value:
3+
["price-book-id1", "price-book-id2"]
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"main":"shopper-baskets.raml","name":"Shopper Baskets","classifier":"raml","tags":[],"dependencies":[{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"api-standards","version":"1.1.8"},{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"commerce-cloud-standards","version":"1.0.15"},{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"checkout-data-types","version":"1.0.53"}],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"shopper-baskets","version":"0.1.2","apiVersion":"v1","originalFormatVersion":"1.0"}
1+
{"main":"shopper-baskets.raml","name":"Shopper Baskets","classifier":"raml","tags":[],"dependencies":[{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"api-standards","version":"1.1.8"},{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"commerce-cloud-standards","version":"1.0.15"},{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"checkout-data-types","version":"1.0.53"}],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"shopper-baskets","version":"0.2.1","apiVersion":"v1","originalFormatVersion":"1.0"}

apis/checkout/shopper-baskets/shopper-baskets.raml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -907,6 +907,59 @@ types:
907907
dataTypes.ErrorResponse: !include exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/1.0.53/examples/error/basket-not-found.raml
908908
securedBy:
909909
- CommerceCloudStandards.ShopperToken: { scopes: [ "sfcc.shopper-baskets-orders", "sfcc.shopper-baskets-orders.rw" ] }
910+
/price-books:
911+
type: CommerceCloudStandards.Organization
912+
get:
913+
is:
914+
- CommerceCloudStandards.SiteSpecific:
915+
- ApiStandards.RateLimited2:
916+
responseStatus: 200
917+
responseStatus2: 404
918+
description: Gets applicable price books for an existing basket.
919+
displayName: getPriceBooksForBasket
920+
responses:
921+
'200':
922+
description: Success, the response body contains the priceBookIds for the basket.
923+
body:
924+
type: dataTypes.PriceBookIds
925+
examples:
926+
dataTypes.PriceBookIds: !include examples/basket/price-books.raml
927+
'404':
928+
description: |-
929+
The basket with the given basket ID is unknown.
930+
body:
931+
application/problem+json:
932+
type: ErrorResponse
933+
examples:
934+
dataTypes.ErrorResponse: !include exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/1.0.53/examples/error/basket-not-found.raml
935+
securedBy:
936+
- CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.shopper-baskets-orders", "sfcc.shopper-baskets-orders.rw" ] }
937+
- CommerceCloudStandards.AmOAuth2
938+
put:
939+
is:
940+
- CommerceCloudStandards.SiteSpecific:
941+
- ApiStandards.RateLimited2:
942+
responseStatus: 204
943+
responseStatus2: 404
944+
description: This method allows you to put an array of priceBookIds to an existing basket, which will be used for basket calculation.
945+
displayName: addPriceBooksToBasket
946+
responses:
947+
'204':
948+
description: Success, without body.
949+
'404':
950+
description: The basket with the given basket ID is unknown or contains a price book ID that does not correspond to an existing price book.
951+
body:
952+
application/problem+json:
953+
type: ErrorResponse
954+
examples:
955+
dataTypes.ErrorResponse: !include exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/1.0.53/examples/error/basket-not-found.raml
956+
body:
957+
type: dataTypes.PriceBookIds
958+
examples:
959+
dataTypes.PriceBookIds: !include examples/basket/price-books.raml
960+
securedBy:
961+
- CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.shopper-baskets-orders.rw" ] }
962+
- CommerceCloudStandards.AmOAuth2
910963
/shipments:
911964
type: CommerceCloudStandards.Organization
912965
post:

0 commit comments

Comments
 (0)