Release 20210106

Author: bredmond-sf

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

@@ -1,10 +1,10 @@
 {
-  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cdn-api-process-apis/1.0.9",
+  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cdn-api-process-apis/1.0.10",
   "name": "CDN Zones",
   "description": "Extend your eCDN beyond Business Manager configuration.",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "cdn-api-process-apis",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "categories": {
     "API layer": [
       "Process"

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

@@ -13,8 +13,8 @@ baseUriParameters:
 mediaType: application/json
 
 uses:
-  ApiStandards: /exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.6/api-standards.raml
-  CommerceCloudStandards: /exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.12/commerce-cloud-standards.raml
+  ApiStandards: /exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.12/api-standards.raml
+  CommerceCloudStandards: /exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.17/commerce-cloud-standards.raml
 
 types:
 
@@ -80,10 +80,6 @@ traits:
   hasResourceNotFoundResponse: !include traits/HasResourceNotFoundResponse.raml
   hasBadRequestResponse: !include traits/HasBadRequestResponse.raml
   hasConflictResponse: !include traits/HasConflictResponse.raml
-  
-securedBy: 
-  - CommerceCloudStandards.BearerToken
-  - CommerceCloudStandards.AmOAuth2
 
 /organizations/{organizationId}:
   type: CommerceCloudStandards.Organization
@@ -102,6 +98,9 @@ securedBy:
               application/json:
                 type: ZonesEnvelope
                 example: !include /examples/zone/zones-get-response.raml
+        securedBy: 
+          - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones, sfcc.cdn-zones.rw ] }
+          - CommerceCloudStandards.AmOAuth2
 
   /zones/{zoneId}/waf/groups:
     is: [hasUnauthorizedResponse, hasForbiddenAccessResponse, hasInternalServerErrorResponse]
@@ -117,6 +116,9 @@ securedBy:
             application/json:
               type: WafGroupsEnvelope
               example: !include /examples/waf/wafgroups-get-response.raml
+      securedBy: 
+        - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones, sfcc.cdn-zones.rw ] }
+        - CommerceCloudStandards.AmOAuth2
 
     /{groupId}:
       put:
@@ -134,6 +136,9 @@ securedBy:
               application/json:
                 type: WafGroupEnvelope
                 example: !include /examples/waf/wafgroup-put-response.raml
+        securedBy: 
+          - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones.rw ] }
+          - CommerceCloudStandards.AmOAuth2
 
   /zones/{zoneId}/waf/rules:
     is: [hasUnauthorizedResponse, hasForbiddenAccessResponse, hasInternalServerErrorResponse]
@@ -155,6 +160,9 @@ securedBy:
             application/json:
               type: WafRulesEnvelope
               example: !include /examples/waf/wafrules-get-response.raml
+      securedBy: 
+        - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones, sfcc.cdn-zones.rw ] }
+        - CommerceCloudStandards.AmOAuth2
     /{ruleId}:
       is: [hasUnauthorizedResponse, hasForbiddenAccessResponse, hasInternalServerErrorResponse]
       get:
@@ -168,6 +176,9 @@ securedBy:
               application/json:
                 type: WafRuleEnvelope
                 example: !include /examples/waf/wafrule-get-response.raml
+        securedBy: 
+          - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones, sfcc.cdn-zones.rw ] }
+          - CommerceCloudStandards.AmOAuth2
       put:
         is: [hasBadRequestResponse]
         displayName: updateWafRule
@@ -183,6 +194,9 @@ securedBy:
               application/json:
                 type: WafRuleEnvelope
                 example: !include /examples/waf/wafrule-put-response.raml
+        securedBy: 
+          - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones.rw ] }
+          - CommerceCloudStandards.AmOAuth2
 
   /zones/{zoneId}/firewall/rules:
     is: [hasUnauthorizedResponse, hasForbiddenAccessResponse, hasInternalServerErrorResponse]
@@ -197,6 +211,9 @@ securedBy:
             application/json:
               type: FirewallRulesEnvelope
               example: !include /examples/firewall/firewall-rules-get-response.raml
+      securedBy: 
+        - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones, sfcc.cdn-zones.rw ] }
+        - CommerceCloudStandards.AmOAuth2
 
     post:
       is: [hasBadRequestResponse, hasConflictResponse]
@@ -214,6 +231,9 @@ securedBy:
             application/json:
               type: FirewallRuleEnvelope
               example: !include /examples/firewall/firewall-rules-post-response.raml
+      securedBy: 
+        - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones.rw ] }
+        - CommerceCloudStandards.AmOAuth2
 
     /{firewallRuleId}:
       is: [hasUnauthorizedResponse, hasForbiddenAccessResponse, hasInternalServerErrorResponse]
@@ -228,6 +248,9 @@ securedBy:
               application/json:
                 type: FirewallRuleEnvelope
                 example: !include /examples/firewall/firewall-rule-get-response.raml
+        securedBy: 
+          - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones, sfcc.cdn-zones.rw ] }
+          - CommerceCloudStandards.AmOAuth2
       put:
         is: [hasBadRequestResponse]
         displayName: updateFirewallRule
@@ -244,6 +267,9 @@ securedBy:
               application/json:
                 type: FirewallRuleEnvelope
                 example: !include /examples/firewall/firewall-rules-put-response.raml
+        securedBy: 
+          - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones.rw ] }
+          - CommerceCloudStandards.AmOAuth2
 
       delete:
         is: [hasResourceNotFoundResponse]
@@ -252,6 +278,9 @@ securedBy:
         responses:
           '204':
             description: Successfully deleted the firewall rule specified by the caller.
+        securedBy: 
+          - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones.rw ] }
+          - CommerceCloudStandards.AmOAuth2
 
   /zones/{zoneId}/speed-settings:
     is: [hasResourceNotFoundResponse, hasUnauthorizedResponse, hasForbiddenAccessResponse, hasInternalServerErrorResponse]
@@ -265,6 +294,9 @@ securedBy:
             application/json:
               type: SpeedSettingsEnvelope
               example: !include /examples/zone/speed-settings-response.raml
+      securedBy: 
+        - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones, sfcc.cdn-zones.rw ] }
+        - CommerceCloudStandards.AmOAuth2
     patch:
       is: [hasBadRequestResponse]
       displayName: updateSpeedSettings
@@ -282,4 +314,7 @@ securedBy:
             application/json:
               type: SpeedSettingsEnvelope
               examples:
-                response : !include /examples/zone/speed-settings-response.raml
+                response : !include /examples/zone/speed-settings-response.raml
+      securedBy: 
+        - CommerceCloudStandards.BearerToken: { scopes: [ sfcc.cdn-zones.rw ] }
+        - CommerceCloudStandards.AmOAuth2

apis/cdn/cdn-api-process-apis/dataTypes/SpeedSetting.raml

@@ -18,4 +18,4 @@ examples:
   brotliCompressionExample:
     brotliCompression: on
   http2PrioritizationExample:
-    http2Prioritization: off
+    http2Prioritization: off

apis/cdn/cdn-api-process-apis/examples/zone/speed-settings-response.raml

@@ -2,4 +2,4 @@
 
 data:
   brotliCompression: on
-  http2Prioritization: on
+  http2Prioritization: on

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

@@ -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.9","apiVersion":"v1","originalFormatVersion":"1.0"}
+{"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.12"},{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"commerce-cloud-standards","version":"1.0.17"}],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"cdn-api-process-apis","version":"1.0.10","apiVersion":"v1","originalFormatVersion":"1.0"}

…8/api-standards/1.1.6/api-standards.raml …/api-standards/1.1.12/api-standards.ramlapis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.6/api-standards.raml renamed to apis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.12/api-standards.raml apis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.6/api-standards.raml renamed to apis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.12/api-standards.raml

@@ -16,9 +16,14 @@ types:
   ErrorResponse: !include dataTypes/error-response.raml
   Offset: Pagination.offset
   Limit: Pagination.limit
+  Total: Pagination.total
+  Uuid: Identifiers.UniversallyUniqueIdentifier
+  AbsoluteUrl: Uri.absoluteUrl
 
 uses:
   Pagination: dataTypes/pagination-types.raml
+  Identifiers: dataTypes/identifers.raml
+  Uri: dataTypes/uri.raml
 
 traits: 
   RateLimited: !include traits/rate-limited.raml

…ards/1.1.6/dataTypes/error-response.raml …rds/1.1.12/dataTypes/error-response.ramlapis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.6/dataTypes/error-response.raml renamed to apis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.12/dataTypes/error-response.raml apis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.6/dataTypes/error-response.raml renamed to apis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.12/dataTypes/error-response.raml

@@ -0,0 +1,12 @@
+#%RAML 1.0 Library
+usage: Library for types that can act as well described identifers.
+
+types:
+  UniversallyUniqueIdentifier:
+    displayName: Uuid
+    description: A universally unique identifier (UUID) for the purpose of uniquely identifying an object in the system. It is defined as a 128-bit hex encoded string of 32 characters separated into 5 groups in a pattern of `{8-4-4-4-12}` (36 characters total, with the `-` separator).
+    type: string
+    pattern: "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"
+    example: 5cb34ffb-2543-4052-aea6-226749e4e478
+    maxLength: 36
+    minLength: 36

apis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.12/dataTypes/identifers.raml

@@ -8,9 +8,18 @@ types:
   offset: 
     description: Used to retrieve the results based on a particular resource offset.
     type: integer
+    format: int64
     default: 0
     minimum: 0
   limit: 
-    description: Maximum records to retrieve per request, not to exceed the maximum defined.
+    description: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
     type: integer
-    default: 10
+    format: int32
+    default: 10
+    minimum: 1
+  total:
+    description: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
+    type: integer
+    format: int64
+    default: 0
+    minimum: 0

…ds/1.1.6/dataTypes/pagination-types.raml …s/1.1.12/dataTypes/pagination-types.ramlapis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.6/dataTypes/pagination-types.raml renamed to apis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.12/dataTypes/pagination-types.raml apis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.6/dataTypes/pagination-types.raml renamed to apis/cdn/cdn-api-process-apis/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.12/dataTypes/pagination-types.raml

@@ -0,0 +1,16 @@
+#%RAML 1.0 Library
+usage:
+  URL types with regexes to validate them
+types:
+  absoluteUrl:
+    description: An absolute URL, beginning with a protocol
+    type: string
+    pattern: ^(https?|ftp):\/\/([-\.\w])+(:[\d]+)?(\/[-\w]*)*([-\w\&#\/\?=])*$
+    examples:
+      BasicUrl: https://www.salesforce.com
+      UrlWithParametersAndPort: https://www.salesforce.com:8080/api?detailed=true&lang=en
+#To be determined if we will support relative URL
+#  relativeUrl:
+#    description: A relative URL, without a protocol or domain. It may or may not begin with a leading `/`
+#    type: string
+#    pattern: ^/?(\/[-\w]*)*([-\w&#\/\?=])*$