@searchspring/snapi-oas 0.1.24 → 0.1.27

package/README.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snapi-oas",
-	"version": "0.1.24",
+	"version": "0.1.27",
 	"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.24",
+    "version" : "0.1.27",
     "x-logo" : {
       "url" : "./images/searchspring_logo.svg",
       "altText" : "Searchspring Snap"
@@ -3434,6 +3434,12 @@
           "redirect" : {
             "type" : "string"
           },
+          "campaigns" : {
+            "items" : {
+              "$ref" : "#/components/schemas/SearchResponseModelMerchandising_campaigns"
+            },
+            "type" : "array"
+          },
           "content" : {
             "$ref" : "#/components/schemas/SearchResponseModelMerchandising_content"
           }
@@ -3735,6 +3741,9 @@
           },
           "landingPage" : {
             "type" : "string"
+          },
+          "intellisuggest" : {
+            "type" : "boolean"
           }
         },
         "type" : "object"
@@ -3812,6 +3821,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"
@@ -3937,6 +3951,20 @@
         },
         "type" : "object"
       },
+      "SearchResponseModelMerchandising_campaigns" : {
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "title" : {
+            "type" : "string"
+          },
+          "type" : {
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
       "SearchResponseModelMerchandising_content_config_position" : {
         "properties" : {
           "index" : {

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

@@ -4,7 +4,7 @@ info:
     name: Searchspring
   description: Searchspring Snap Search API
   title: snAPI
-  version: 0.1.24
+  version: 0.1.27
   x-logo:
     url: ./images/searchspring_logo.svg
     altText: Searchspring Snap
@@ -2757,6 +2757,7 @@ components:
         - field: field
           direction: asc
         merchandising:
+          intellisuggest: true
           landingPage: landingPage
           disabled: true
           segments:
@@ -2836,6 +2837,7 @@ components:
       example:
         search:
           didYouMean: didYouMean
+          matchType: expanded
           query: query
           originalQuery: originalQuery
         pagination:
@@ -2909,6 +2911,13 @@ components:
           id: id
         merchandising:
           redirect: redirect
+          campaigns:
+          - id: id
+            title: title
+            type: type
+          - id: id
+            title: title
+            type: type
           content:
             inline:
             - config:
@@ -3146,6 +3155,13 @@ components:
     SearchResponseModelMerchandising:
       example:
         redirect: redirect
+        campaigns:
+        - id: id
+          title: title
+          type: type
+        - id: id
+          title: title
+          type: type
         content:
           inline:
           - config:
@@ -3171,6 +3187,10 @@ components:
       properties:
         redirect:
           type: string
+        campaigns:
+          items:
+            $ref: '#/components/schemas/SearchResponseModelMerchandising_campaigns'
+          type: array
         content:
           $ref: '#/components/schemas/SearchResponseModelMerchandising_content'
       type: object
@@ -3418,6 +3438,7 @@ components:
       type: object
     SearchRequestModel_merchandising:
       example:
+        intellisuggest: true
         landingPage: landingPage
         disabled: true
         segments:
@@ -3432,6 +3453,8 @@ components:
           type: array
         landingPage:
           type: string
+        intellisuggest:
+          type: boolean
       type: object
     SearchRequestModel_tracking:
       example:
@@ -3485,6 +3508,7 @@ components:
     SearchResponseModel_search:
       example:
         didYouMean: didYouMean
+        matchType: expanded
         query: query
         originalQuery: originalQuery
       properties:
@@ -3496,6 +3520,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:
@@ -3610,6 +3641,19 @@ components:
         active:
           $ref: '#/components/schemas/SearchRequestModelFilterRange_allOf_value'
       type: object
+    SearchResponseModelMerchandising_campaigns:
+      example:
+        id: id
+        title: title
+        type: type
+      properties:
+        id:
+          type: string
+        title:
+          type: string
+        type:
+          type: string
+      type: object
     SearchResponseModelMerchandising_content_config_position:
       example:
         index: 2.027123023002322