@salesforce/lds-adapters-commerce-search 0.1.0-dev1

package/src/raml/luvio.raml

@@ -0,0 +1,122 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'Commerce'
+(luvio.ttl): 2592000000
+
+types:
+  BoostBuryConditionInputRepresentation:
+    (luvio.opaque): true
+  BoostBuryConditionOutputRepresentation:
+    (luvio.opaque): true
+  BoostBuryQueryContextConditionInputRepresentation:
+    (luvio.opaque): true
+  BoostBuryQueryContextConditionOutputRepresentation:
+    (luvio.opaque): true
+  BoostBuryQueryContextInputRepresentation:
+    (luvio.opaque): true
+  BoostBuryQueryContextOutputRepresentation:
+    (luvio.opaque): true
+  BoostBuryTargetExpressionInputRepresentation:
+    (luvio.opaque): true
+  BoostBuryTargetExpressionOutputRepresentation:
+    (luvio.opaque): true
+  ProductSearchResultsRepresentation:
+    (luvio.opaque): true
+  ProductSearchSuggestionsResultsRepresentation:
+    (luvio.opaque): true
+    examples:
+      validResponse: !include ../mocks/types/ProductSearchSuggestionsResultsRepresentation/validResponse.json
+      validResponseEmpty: !include ../mocks/types/ProductSearchSuggestionsResultsRepresentation/validResponseEmpty.json
+  SearchBoostBuryRuleInputRepresentation:
+    (luvio.opaque): true
+  SearchBoostBuryRuleOutputRepresentation:
+    (luvio.key):
+      id: id
+  SearchBoostBuryRulesCollectionOutputRepresentation:
+    (luvio.opaque): true
+
+/commerce/management/webstores/{webstoreId}/search/boost-bury-rules:
+  get:
+    (luvio.adapter):
+      name: getSearchBoostBuryRules
+  post:
+    (luvio.adapter):
+      name: createSearchBoostBuryRule
+
+/commerce/management/webstores/{webstoreId}/search/boost-bury-rules/{ruleId}:
+  get:
+    (luvio.key):
+      id: urlParams.ruleId
+    (luvio.adapter):
+      name: getSearchBoostBuryRule
+  patch:
+    (luvio.adapter):
+      name: updateSearchBoostBuryRule
+  delete:
+    (luvio.key):
+      id: urlParams.ruleId
+    (luvio.adapter):
+      name: deleteSearchBoostBuryRule
+
+/commerce/webstores/{webstoreId}/search/product-search:
+  post:
+    (luvio.method): get
+    (luvio.adapter):
+      name: productSearch
+
+/commerce/webstores/{webstoreId}/search/suggestions:
+  get:
+    (luvio.adapter):
+      name: getSuggestions
+      tests:
+        expectedResponses:
+          - configInput: |
+              {
+                "webstoreId": "0ZExx0000000001",
+                "searchTerm": "coffee",
+                "effectiveAccountId": "001xx000003GYTfAAO"
+              }
+            mockPayloadId: validResponse
+          - configInput: |
+              {
+                "webstoreId": "0ZExx0000000002",
+                "searchTerm": "coffee",
+                "effectiveAccountId": "001xx000003GYTfAAO"
+              }
+            mockPayloadId: validResponseEmpty
+        validConfigs:
+          - |
+            {
+              "webstoreId": "0ZExx0000000001",
+              "searchTerm": "coffee",
+              "effectiveAccountId": "001xx000003GYTfAAO"
+            }
+          - |
+            {
+              "webstoreId": "0ZExx0000000001"
+            }
+        invalidConfigs:
+          - |
+            {}
+          - |
+            {
+              "webstoreId": 1234567890
+            }
+    queryParameters:
+      searchTerm:
+        examples:
+          validResponse: 'coffee'
+          validResponseEmpty: 'coffee'
+      effectiveAccountId:
+        examples:
+          validResponse: '001xx000003GYTfAAO'
+          validResponseEmpty: '001xx000003GYTfAAO'
+  uriParameters:
+    webstoreId:
+      examples:
+        validResponse: '0ZExx0000000001'
+        validResponseEmpty: '0ZExx0000000002'