@searchspring/snapi-oas 0.1.41 → 0.1.44

package/README.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snapi-oas",
-	"version": "0.1.41",
+	"version": "0.1.44",
 	"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.41",
+    "version" : "0.1.44",
     "x-logo" : {
       "url" : "./images/searchspring_logo.svg",
       "altText" : "Searchspring Snap"
@@ -3126,11 +3126,26 @@
     "schemas" : {
       "AutocompleteRequestModel" : {
         "allOf" : [ {
+          "$ref" : "#/components/schemas/SearchRequestModel"
+        }, {
           "$ref" : "#/components/schemas/AutocompleteRequestModel_allOf"
+        } ]
+      },
+      "AutocompleteRequestModelSearch" : {
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/SearchRequestModelSearch"
         }, {
-          "$ref" : "#/components/schemas/SearchRequestModel"
+          "$ref" : "#/components/schemas/AutocompleteRequestModelSearch_allOf"
         } ]
       },
+      "AutocompleteRequestModelSuggestions" : {
+        "properties" : {
+          "count" : {
+            "type" : "integer"
+          }
+        },
+        "type" : "object"
+      },
       "AutocompleteResponseModel" : {
         "allOf" : [ {
           "$ref" : "#/components/schemas/AutocompleteResponseModel_allOf"
@@ -3151,7 +3166,7 @@
             "type" : "array"
           },
           "search" : {
-            "$ref" : "#/components/schemas/SearchRequestModel_search"
+            "$ref" : "#/components/schemas/SearchRequestModelSearch"
           },
           "filters" : {
             "items" : {
@@ -3178,6 +3193,30 @@
         "title" : "Search Request Data Model",
         "type" : "object"
       },
+      "SearchRequestModelSearch" : {
+        "properties" : {
+          "query" : {
+            "$ref" : "#/components/schemas/SearchRequestModelSearch_query"
+          },
+          "subQuery" : {
+            "type" : "string"
+          },
+          "originalQuery" : {
+            "description" : "Original query if spell correction occured.",
+            "type" : "string"
+          },
+          "fallbackQuery" : {
+            "description" : "Integrated spell correction parameter is used as a fallback when the query parameter fails to return results.",
+            "type" : "string"
+          },
+          "redirectResponse" : {
+            "description" : "Changes how Redirects behave in the response.",
+            "enum" : [ "full", "minimal", "direct" ],
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
       "SearchRequestModelFilter" : {
         "discriminator" : {
           "mapping" : {
@@ -3249,6 +3288,9 @@
           },
           "merchandising" : {
             "$ref" : "#/components/schemas/SearchResponseModelMerchandising"
+          },
+          "tracking" : {
+            "$ref" : "#/components/schemas/SearchResponseModelTracking"
           }
         },
         "title" : "Search Response Data Model",
@@ -3463,6 +3505,14 @@
         },
         "type" : "object"
       },
+      "SearchResponseModelTracking" : {
+        "properties" : {
+          "responseId" : {
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
       "MetaResponseModel" : {
         "properties" : {
           "sortOptions" : {
@@ -3637,19 +3687,26 @@
         "title" : "Meta Request Model",
         "type" : "object"
       },
-      "AutocompleteRequestModel_suggestions" : {
+      "AutocompleteRequestModel_allOf" : {
         "properties" : {
-          "count" : {
-            "type" : "integer"
+          "search" : {
+            "$ref" : "#/components/schemas/AutocompleteRequestModelSearch"
+          },
+          "suggestions" : {
+            "$ref" : "#/components/schemas/AutocompleteRequestModelSuggestions"
           }
         },
-        "title" : "AutocompleteRequestModel_suggestions",
         "type" : "object"
       },
-      "AutocompleteRequestModel_allOf" : {
+      "AutocompleteRequestModelSearch_allOf" : {
         "properties" : {
-          "suggestions" : {
-            "$ref" : "#/components/schemas/AutocompleteRequestModel_suggestions"
+          "input" : {
+            "description" : "current input from the user",
+            "type" : "string"
+          },
+          "source" : {
+            "description" : "source of the autocomplete request (\"historical\", \"popular\", \"suggested\" or \"typed\")",
+            "type" : "string"
           }
         },
         "type" : "object"
@@ -3718,42 +3775,6 @@
         },
         "type" : "object"
       },
-      "SearchRequestModel_search_query" : {
-        "properties" : {
-          "string" : {
-            "description" : "Query value will search the index for terms that match the query. Will support up to 256 characters.",
-            "type" : "string"
-          },
-          "spellCorrection" : {
-            "type" : "boolean"
-          }
-        },
-        "type" : "object"
-      },
-      "SearchRequestModel_search" : {
-        "properties" : {
-          "query" : {
-            "$ref" : "#/components/schemas/SearchRequestModel_search_query"
-          },
-          "subQuery" : {
-            "type" : "string"
-          },
-          "originalQuery" : {
-            "description" : "Original query if spell correction occured.",
-            "type" : "string"
-          },
-          "fallbackQuery" : {
-            "description" : "Integrated spell correction parameter is used as a fallback when the query parameter fails to return results.",
-            "type" : "string"
-          },
-          "redirectResponse" : {
-            "description" : "Changes how Redirects behave in the response.",
-            "enum" : [ "full", "minimal", "direct" ],
-            "type" : "string"
-          }
-        },
-        "type" : "object"
-      },
       "SearchRequestModel_pagination" : {
         "properties" : {
           "page" : {
@@ -3856,6 +3877,18 @@
         },
         "type" : "object"
       },
+      "SearchRequestModelSearch_query" : {
+        "properties" : {
+          "string" : {
+            "description" : "Query value will search the index for terms that match the query. Will support up to 256 characters.",
+            "type" : "string"
+          },
+          "spellCorrection" : {
+            "type" : "boolean"
+          }
+        },
+        "type" : "object"
+      },
       "SearchRequestModelFilterValue_allOf" : {
         "properties" : {
           "value" : {

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

@@ -4,7 +4,7 @@ info:
     name: Searchspring
   description: Searchspring Snap Search API
   title: snAPI
-  version: 0.1.41
+  version: 0.1.44
   x-logo:
     url: ./images/searchspring_logo.svg
     altText: Searchspring Snap
@@ -2720,8 +2720,17 @@ components:
   schemas:
     AutocompleteRequestModel:
       allOf:
-      - $ref: '#/components/schemas/AutocompleteRequestModel_allOf'
       - $ref: '#/components/schemas/SearchRequestModel'
+      - $ref: '#/components/schemas/AutocompleteRequestModel_allOf'
+    AutocompleteRequestModelSearch:
+      allOf:
+      - $ref: '#/components/schemas/SearchRequestModelSearch'
+      - $ref: '#/components/schemas/AutocompleteRequestModelSearch_allOf'
+    AutocompleteRequestModelSuggestions:
+      properties:
+        count:
+          type: integer
+      type: object
     AutocompleteResponseModel:
       allOf:
       - $ref: '#/components/schemas/AutocompleteResponseModel_allOf'
@@ -2789,7 +2798,7 @@ components:
             $ref: '#/components/schemas/SearchRequestModel_sorts'
           type: array
         search:
-          $ref: '#/components/schemas/SearchRequestModel_search'
+          $ref: '#/components/schemas/SearchRequestModelSearch'
         filters:
           items:
             $ref: '#/components/schemas/SearchRequestModelFilter'
@@ -2806,6 +2815,35 @@ components:
           $ref: '#/components/schemas/SearchRequestModel_personalization'
       title: Search Request Data Model
       type: object
+    SearchRequestModelSearch:
+      example:
+        query:
+          string: string
+          spellCorrection: true
+        originalQuery: originalQuery
+        redirectResponse: full
+        fallbackQuery: fallbackQuery
+        subQuery: subQuery
+      properties:
+        query:
+          $ref: '#/components/schemas/SearchRequestModelSearch_query'
+        subQuery:
+          type: string
+        originalQuery:
+          description: Original query if spell correction occured.
+          type: string
+        fallbackQuery:
+          description: Integrated spell correction parameter is used as a fallback
+            when the query parameter fails to return results.
+          type: string
+        redirectResponse:
+          description: Changes how Redirects behave in the response.
+          enum:
+          - full
+          - minimal
+          - direct
+          type: string
+      type: object
     SearchRequestModelFilter:
       discriminator:
         mapping:
@@ -2961,6 +2999,8 @@ components:
             banner:
             - banner
             - banner
+        tracking:
+          responseId: responseId
         facets:
         - field: field
           filtered: true
@@ -2991,6 +3031,8 @@ components:
           type: array
         merchandising:
           $ref: '#/components/schemas/SearchResponseModelMerchandising'
+        tracking:
+          $ref: '#/components/schemas/SearchResponseModelTracking'
       title: Search Response Data Model
       type: object
     SearchResponseModelFilter:
@@ -3240,6 +3282,13 @@ components:
         content:
           $ref: '#/components/schemas/SearchResponseModelMerchandising_content'
       type: object
+    SearchResponseModelTracking:
+      example:
+        responseId: responseId
+      properties:
+        responseId:
+          type: string
+      type: object
     MetaResponseModel:
       example:
         badges:
@@ -3426,16 +3475,22 @@ components:
       - siteId
       title: Meta Request Model
       type: object
-    AutocompleteRequestModel_suggestions:
-      properties:
-        count:
-          type: integer
-      title: AutocompleteRequestModel_suggestions
-      type: object
     AutocompleteRequestModel_allOf:
       properties:
+        search:
+          $ref: '#/components/schemas/AutocompleteRequestModelSearch'
         suggestions:
-          $ref: '#/components/schemas/AutocompleteRequestModel_suggestions'
+          $ref: '#/components/schemas/AutocompleteRequestModelSuggestions'
+      type: object
+    AutocompleteRequestModelSearch_allOf:
+      properties:
+        input:
+          description: current input from the user
+          type: string
+        source:
+          description: source of the autocomplete request ("historical", "popular",
+            "suggested" or "typed")
+          type: string
       type: object
     AutocompleteResponseModel_allOf_autocomplete_suggested:
       properties:
@@ -3484,47 +3539,6 @@ components:
           - desc
           type: string
       type: object
-    SearchRequestModel_search_query:
-      example:
-        string: string
-        spellCorrection: true
-      properties:
-        string:
-          description: Query value will search the index for terms that match the
-            query. Will support up to 256 characters.
-          type: string
-        spellCorrection:
-          type: boolean
-      type: object
-    SearchRequestModel_search:
-      example:
-        query:
-          string: string
-          spellCorrection: true
-        originalQuery: originalQuery
-        redirectResponse: full
-        fallbackQuery: fallbackQuery
-        subQuery: subQuery
-      properties:
-        query:
-          $ref: '#/components/schemas/SearchRequestModel_search_query'
-        subQuery:
-          type: string
-        originalQuery:
-          description: Original query if spell correction occured.
-          type: string
-        fallbackQuery:
-          description: Integrated spell correction parameter is used as a fallback
-            when the query parameter fails to return results.
-          type: string
-        redirectResponse:
-          description: Changes how Redirects behave in the response.
-          enum:
-          - full
-          - minimal
-          - direct
-          type: string
-      type: object
     SearchRequestModel_pagination:
       example:
         pageSize: 6
@@ -3625,6 +3639,18 @@ components:
           description: logged in shopper identifier
           type: string
       type: object
+    SearchRequestModelSearch_query:
+      example:
+        string: string
+        spellCorrection: true
+      properties:
+        string:
+          description: Query value will search the index for terms that match the
+            query. Will support up to 256 characters.
+          type: string
+        spellCorrection:
+          type: boolean
+      type: object
     SearchRequestModelFilterValue_allOf:
       properties:
         value: