@searchspring/snapi-oas 0.1.43 → 0.1.45

package/README.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snapi-oas",
-	"version": "0.1.43",
+	"version": "0.1.45",
 	"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.43",
+    "version" : "0.1.45",
     "x-logo" : {
       "url" : "./images/searchspring_logo.svg",
       "altText" : "Searchspring Snap"
@@ -547,6 +547,9 @@
           "merchandising" : {
             "redirect" : "",
             "content" : { }
+          },
+          "tracking" : {
+            "responseId" : "248176b4-7929-4c32-a8cf-484073befe28"
           }
         }
       },
@@ -884,6 +887,9 @@
           "merchandising" : {
             "redirect" : "",
             "content" : { }
+          },
+          "tracking" : {
+            "responseId" : "248176b4-7929-4c32-a8cf-484073befe28"
           }
         }
       },
@@ -1876,6 +1882,9 @@
           "merchandising" : {
             "redirect" : "",
             "content" : { }
+          },
+          "tracking" : {
+            "responseId" : "aa6967b1-9685-4eb8-94ff-27d139dcfb89"
           }
         }
       },
@@ -2992,6 +3001,9 @@
           "merchandising" : {
             "redirect" : "",
             "content" : { }
+          },
+          "tracking" : {
+            "responseId" : "aa6967b1-9685-4eb8-94ff-27d139dcfb89"
           }
         }
       },
@@ -3288,8 +3300,12 @@
           },
           "merchandising" : {
             "$ref" : "#/components/schemas/SearchResponseModelMerchandising"
+          },
+          "tracking" : {
+            "$ref" : "#/components/schemas/SearchResponseModelTracking"
           }
         },
+        "required" : [ "tracking" ],
         "title" : "Search Response Data Model",
         "type" : "object"
       },
@@ -3502,6 +3518,15 @@
         },
         "type" : "object"
       },
+      "SearchResponseModelTracking" : {
+        "properties" : {
+          "responseId" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "responseId" ],
+        "type" : "object"
+      },
       "MetaResponseModel" : {
         "properties" : {
           "sortOptions" : {
@@ -3694,7 +3719,8 @@
             "type" : "string"
           },
           "source" : {
-            "description" : "source of the autocomplete request (\"historical\", \"popular\", \"suggested\" or \"typed\")",
+            "description" : "source of the autocomplete request",
+            "enum" : [ "historical", "trending", "suggested", "typed" ],
             "type" : "string"
           }
         },

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

@@ -4,7 +4,7 @@ info:
     name: Searchspring
   description: Searchspring Snap Search API
   title: snAPI
-  version: 0.1.43
+  version: 0.1.45
   x-logo:
     url: ./images/searchspring_logo.svg
     altText: Searchspring Snap
@@ -478,6 +478,8 @@ components:
         merchandising:
           redirect: ""
           content: {}
+        tracking:
+          responseId: 248176b4-7929-4c32-a8cf-484073befe28
     autocomplete-response-example-2:
       value:
         autocomplete:
@@ -810,6 +812,8 @@ components:
         merchandising:
           redirect: ""
           content: {}
+        tracking:
+          responseId: 248176b4-7929-4c32-a8cf-484073befe28
     search-request-example-1:
       value:
         siteId: scmq7n
@@ -1668,6 +1672,8 @@ components:
         merchandising:
           redirect: ""
           content: {}
+        tracking:
+          responseId: aa6967b1-9685-4eb8-94ff-27d139dcfb89
     search-response-example-2:
       value:
         search:
@@ -2618,6 +2624,8 @@ components:
         merchandising:
           redirect: ""
           content: {}
+        tracking:
+          responseId: aa6967b1-9685-4eb8-94ff-27d139dcfb89
     meta-request-example-1:
       value:
         siteId: scmq7n
@@ -2999,6 +3007,8 @@ components:
             banner:
             - banner
             - banner
+        tracking:
+          responseId: responseId
         facets:
         - field: field
           filtered: true
@@ -3029,6 +3039,10 @@ components:
           type: array
         merchandising:
           $ref: '#/components/schemas/SearchResponseModelMerchandising'
+        tracking:
+          $ref: '#/components/schemas/SearchResponseModelTracking'
+      required:
+      - tracking
       title: Search Response Data Model
       type: object
     SearchResponseModelFilter:
@@ -3278,6 +3292,15 @@ components:
         content:
           $ref: '#/components/schemas/SearchResponseModelMerchandising_content'
       type: object
+    SearchResponseModelTracking:
+      example:
+        responseId: responseId
+      properties:
+        responseId:
+          type: string
+      required:
+      - responseId
+      type: object
     MetaResponseModel:
       example:
         badges:
@@ -3477,8 +3500,12 @@ components:
           description: current input from the user
           type: string
         source:
-          description: source of the autocomplete request ("historical", "popular",
-            "suggested" or "typed")
+          description: source of the autocomplete request
+          enum:
+          - historical
+          - trending
+          - suggested
+          - typed
           type: string
       type: object
     AutocompleteResponseModel_allOf_autocomplete_suggested: