@searchspring/snapi-oas 0.1.20 → 0.1.22

package/README.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snapi-oas",
-	"version": "0.1.20",
+	"version": "0.1.22",
 	"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.20",
+    "version" : "0.1.22",
     "x-logo" : {
       "url" : "./images/searchspring_logo.svg",
       "altText" : "Searchspring Snap"
@@ -929,7 +929,8 @@
             "totalResults" : 1305,
             "page" : 1,
             "defaultPageSize" : 24,
-            "pageSize" : 2
+            "pageSize" : 2,
+            "totalPages" : 653
           },
           "results" : [ {
             "id" : "175130",
@@ -1887,7 +1888,8 @@
             "totalResults" : 758,
             "page" : 1,
             "defaultPageSize" : 24,
-            "pageSize" : 2
+            "pageSize" : 2,
+            "totalPages" : 379
           },
           "results" : [ {
             "id" : "134892",
@@ -3168,6 +3170,9 @@
           },
           "tracking" : {
             "$ref" : "#/components/schemas/SearchRequestModel_tracking"
+          },
+          "personalization" : {
+            "$ref" : "#/components/schemas/SearchRequestModel_personalization"
           }
         },
         "title" : "Search Request Data Model",
@@ -3733,10 +3738,33 @@
       },
       "SearchRequestModel_tracking" : {
         "properties" : {
-          "loggedInUserId" : {
+          "userId" : {
+            "description" : "shopper identifier",
             "type" : "string"
           },
-          "userId" : {
+          "domain" : {
+            "description" : "current website url",
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
+      "SearchRequestModel_personalization" : {
+        "properties" : {
+          "disabled" : {
+            "description" : "ignore personalized boosts",
+            "type" : "boolean"
+          },
+          "cart" : {
+            "description" : "comma-separated list of the products in cart",
+            "type" : "string"
+          },
+          "lastViewed" : {
+            "description" : "comma-separated list of the last viewed products",
+            "type" : "string"
+          },
+          "shopper" : {
+            "description" : "logged in shopper identifier",
             "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.20
+  version: 0.1.22
   x-logo:
     url: ./images/searchspring_logo.svg
     altText: Searchspring Snap
@@ -841,6 +841,7 @@ components:
           page: 1
           defaultPageSize: 24
           pageSize: 2
+          totalPages: 653
         results:
         - id: "175130"
           mappings:
@@ -1676,6 +1677,7 @@ components:
           page: 1
           defaultPageSize: 24
           pageSize: 2
+          totalPages: 379
         results:
         - id: "134892"
           mappings:
@@ -2726,6 +2728,11 @@ components:
       - $ref: '#/components/schemas/SearchResponseModel'
     SearchRequestModel:
       example:
+        personalization:
+          lastViewed: lastViewed
+          shopper: shopper
+          disabled: true
+          cart: cart
         search:
           query:
             string: string
@@ -2756,7 +2763,7 @@ components:
           - segments
           - segments
         tracking:
-          loggedInUserId: loggedInUserId
+          domain: domain
           userId: userId
         facets:
           valueLimit: 5
@@ -2789,6 +2796,8 @@ components:
           $ref: '#/components/schemas/SearchRequestModel_merchandising'
         tracking:
           $ref: '#/components/schemas/SearchRequestModel_tracking'
+        personalization:
+          $ref: '#/components/schemas/SearchRequestModel_personalization'
       title: Search Request Data Model
       type: object
     SearchRequestModelFilter:
@@ -3524,12 +3533,34 @@ components:
       type: object
     SearchRequestModel_tracking:
       example:
-        loggedInUserId: loggedInUserId
+        domain: domain
         userId: userId
       properties:
-        loggedInUserId:
-          type: string
         userId:
+          description: shopper identifier
+          type: string
+        domain:
+          description: current website url
+          type: string
+      type: object
+    SearchRequestModel_personalization:
+      example:
+        lastViewed: lastViewed
+        shopper: shopper
+        disabled: true
+        cart: cart
+      properties:
+        disabled:
+          description: ignore personalized boosts
+          type: boolean
+        cart:
+          description: comma-separated list of the products in cart
+          type: string
+        lastViewed:
+          description: comma-separated list of the last viewed products
+          type: string
+        shopper:
+          description: logged in shopper identifier
           type: string
       type: object
     SearchRequestModelFilterValue_allOf: