@searchspring/snapi-oas 0.1.22 → 0.1.25

package/README.md

@@ -1,4 +1,4 @@
-# Snap API OpenAPI Specification v0.1.22
+# Snap API OpenAPI Specification v0.1.25
 
 https://searchspring.github.io/snapi-oas/  
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snapi-oas",
-	"version": "0.1.22",
+	"version": "0.1.25",
 	"description": "Snap OpenAPI Specification",
 	"author": "Searchspring",
 	"license": "MIT",

package/spec/v1/snapi.oas.v1.json

@@ -6,7 +6,7 @@
     },
     "description" : "Searchspring Snap Search API",
     "title" : "snAPI",
-    "version" : "0.1.22",
+    "version" : "0.1.25",
     "x-logo" : {
       "url" : "./images/searchspring_logo.svg",
       "altText" : "Searchspring Snap"
@@ -3698,6 +3698,9 @@
       },
       "SearchRequestModel_facets" : {
         "properties" : {
+          "autoDrillDown" : {
+            "type" : "boolean"
+          },
           "limit" : {
             "type" : "integer"
           },
@@ -3809,6 +3812,11 @@
           "originalQuery" : {
             "description" : "Original query if spell correction occured.",
             "type" : "string"
+          },
+          "matchType" : {
+            "description" : "Indicates the type of search matching that was required for this search. Will return \"expanded\" when an Expanded Search is applied after finding zero results for the initial strict search.",
+            "enum" : [ "expanded" ],
+            "type" : "string"
           }
         },
         "type" : "object"
@@ -3855,9 +3863,6 @@
       },
       "SearchResponseModelResult_children" : {
         "properties" : {
-          "mappings" : {
-            "$ref" : "#/components/schemas/SearchResponseModelResult_mappings"
-          },
           "attributes" : {
             "$ref" : "#/components/schemas/SearchResponseModelResultAttributes"
           }

package/spec/v1/snapi.oas.v1.yaml

@@ -4,7 +4,7 @@ info:
     name: Searchspring
   description: Searchspring Snap Search API
   title: snAPI
-  version: 0.1.22
+  version: 0.1.25
   x-logo:
     url: ./images/searchspring_logo.svg
     altText: Searchspring Snap
@@ -2766,6 +2766,7 @@ components:
           domain: domain
           userId: userId
         facets:
+          autoDrillDown: true
           valueLimit: 5
           include:
           - include
@@ -2835,6 +2836,7 @@ components:
       example:
         search:
           didYouMean: didYouMean
+          matchType: expanded
           query: query
           originalQuery: originalQuery
         pagination:
@@ -2874,43 +2876,9 @@ components:
               sku: sku
               brand: brand
           children:
-          - mappings:
-              core:
-                addToCartUrl: addToCartUrl
-                rating: 9.301444243932576
-                description: description
-                ratingCount: ratingCount
-                url: url
-                stockMessage: stockMessage
-                uid: uid
-                thumbnailImageUrl: thumbnailImageUrl
-                price: 2.3021358869347655
-                msrp: 7.061401241503109
-                imageUrl: imageUrl
-                popularity: 3.616076749251911
-                name: name
-                sku: sku
-                brand: brand
-            attributes:
+          - attributes:
               key: '{}'
-          - mappings:
-              core:
-                addToCartUrl: addToCartUrl
-                rating: 9.301444243932576
-                description: description
-                ratingCount: ratingCount
-                url: url
-                stockMessage: stockMessage
-                uid: uid
-                thumbnailImageUrl: thumbnailImageUrl
-                price: 2.3021358869347655
-                msrp: 7.061401241503109
-                imageUrl: imageUrl
-                popularity: 3.616076749251911
-                name: name
-                sku: sku
-                brand: brand
-            attributes:
+          - attributes:
               key: '{}'
           attributes:
             key: '{}'
@@ -2933,43 +2901,9 @@ components:
               sku: sku
               brand: brand
           children:
-          - mappings:
-              core:
-                addToCartUrl: addToCartUrl
-                rating: 9.301444243932576
-                description: description
-                ratingCount: ratingCount
-                url: url
-                stockMessage: stockMessage
-                uid: uid
-                thumbnailImageUrl: thumbnailImageUrl
-                price: 2.3021358869347655
-                msrp: 7.061401241503109
-                imageUrl: imageUrl
-                popularity: 3.616076749251911
-                name: name
-                sku: sku
-                brand: brand
-            attributes:
+          - attributes:
               key: '{}'
-          - mappings:
-              core:
-                addToCartUrl: addToCartUrl
-                rating: 9.301444243932576
-                description: description
-                ratingCount: ratingCount
-                url: url
-                stockMessage: stockMessage
-                uid: uid
-                thumbnailImageUrl: thumbnailImageUrl
-                price: 2.3021358869347655
-                msrp: 7.061401241503109
-                imageUrl: imageUrl
-                popularity: 3.616076749251911
-                name: name
-                sku: sku
-                brand: brand
-            attributes:
+          - attributes:
               key: '{}'
           attributes:
             key: '{}'
@@ -3081,43 +3015,9 @@ components:
             sku: sku
             brand: brand
         children:
-        - mappings:
-            core:
-              addToCartUrl: addToCartUrl
-              rating: 9.301444243932576
-              description: description
-              ratingCount: ratingCount
-              url: url
-              stockMessage: stockMessage
-              uid: uid
-              thumbnailImageUrl: thumbnailImageUrl
-              price: 2.3021358869347655
-              msrp: 7.061401241503109
-              imageUrl: imageUrl
-              popularity: 3.616076749251911
-              name: name
-              sku: sku
-              brand: brand
-          attributes:
+        - attributes:
             key: '{}'
-        - mappings:
-            core:
-              addToCartUrl: addToCartUrl
-              rating: 9.301444243932576
-              description: description
-              ratingCount: ratingCount
-              url: url
-              stockMessage: stockMessage
-              uid: uid
-              thumbnailImageUrl: thumbnailImageUrl
-              price: 2.3021358869347655
-              msrp: 7.061401241503109
-              imageUrl: imageUrl
-              popularity: 3.616076749251911
-              name: name
-              sku: sku
-              brand: brand
-          attributes:
+        - attributes:
             key: '{}'
         attributes:
           key: '{}'
@@ -3492,6 +3392,7 @@ components:
       type: object
     SearchRequestModel_facets:
       example:
+        autoDrillDown: true
         valueLimit: 5
         include:
         - include
@@ -3501,6 +3402,8 @@ components:
         - exclude
         - exclude
       properties:
+        autoDrillDown:
+          type: boolean
         limit:
           type: integer
         valueLimit:
@@ -3583,6 +3486,7 @@ components:
     SearchResponseModel_search:
       example:
         didYouMean: didYouMean
+        matchType: expanded
         query: query
         originalQuery: originalQuery
       properties:
@@ -3594,6 +3498,13 @@ components:
         originalQuery:
           description: Original query if spell correction occured.
           type: string
+        matchType:
+          description: Indicates the type of search matching that was required for
+            this search. Will return "expanded" when an Expanded Search is applied
+            after finding zero results for the initial strict search.
+          enum:
+          - expanded
+          type: string
       type: object
     SearchResponseModel_pagination:
       example:
@@ -3651,28 +3562,9 @@ components:
       type: object
     SearchResponseModelResult_children:
       example:
-        mappings:
-          core:
-            addToCartUrl: addToCartUrl
-            rating: 9.301444243932576
-            description: description
-            ratingCount: ratingCount
-            url: url
-            stockMessage: stockMessage
-            uid: uid
-            thumbnailImageUrl: thumbnailImageUrl
-            price: 2.3021358869347655
-            msrp: 7.061401241503109
-            imageUrl: imageUrl
-            popularity: 3.616076749251911
-            name: name
-            sku: sku
-            brand: brand
         attributes:
           key: '{}'
       properties:
-        mappings:
-          $ref: '#/components/schemas/SearchResponseModelResult_mappings'
         attributes:
           additionalProperties: true
           description: Additional fields for results - these are site specific fields