@searchspring/snapi-oas 0.1.18 → 0.1.23

package/README.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snapi-oas",
-	"version": "0.1.18",
+	"version": "0.1.23",
 	"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.18",
+    "version" : "0.1.23",
     "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,7 +3738,33 @@
       },
       "SearchRequestModel_tracking" : {
         "properties" : {
-          "loggedInUserId" : {
+          "userId" : {
+            "description" : "shopper identifier",
+            "type" : "string"
+          },
+          "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"
           }
         },
@@ -3795,6 +3826,9 @@
           },
           "pageSize" : {
             "type" : "integer"
+          },
+          "totalPages" : {
+            "type" : "integer"
           }
         },
         "type" : "object"
@@ -3821,9 +3855,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.18
+  version: 0.1.23
   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,8 @@ components:
           - segments
           - segments
         tracking:
-          loggedInUserId: loggedInUserId
+          domain: domain
+          userId: userId
         facets:
           valueLimit: 5
           include:
@@ -2788,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:
@@ -2830,6 +2840,7 @@ components:
         pagination:
           totalResults: 0
           defaultPageSize: 1
+          totalPages: 5
           pageSize: 5
           page: 6
         sorting:
@@ -2848,58 +2859,24 @@ components:
         - mappings:
             core:
               addToCartUrl: addToCartUrl
-              rating: 7.061401241503109
+              rating: 9.301444243932576
               description: description
               ratingCount: ratingCount
               url: url
               stockMessage: stockMessage
               uid: uid
               thumbnailImageUrl: thumbnailImageUrl
-              price: 5.637376656633329
-              msrp: 2.3021358869347655
+              price: 2.3021358869347655
+              msrp: 7.061401241503109
               imageUrl: imageUrl
-              popularity: 9.301444243932576
+              popularity: 3.616076749251911
               name: name
               sku: sku
               brand: brand
           children:
-          - mappings:
-              core:
-                addToCartUrl: addToCartUrl
-                rating: 7.061401241503109
-                description: description
-                ratingCount: ratingCount
-                url: url
-                stockMessage: stockMessage
-                uid: uid
-                thumbnailImageUrl: thumbnailImageUrl
-                price: 5.637376656633329
-                msrp: 2.3021358869347655
-                imageUrl: imageUrl
-                popularity: 9.301444243932576
-                name: name
-                sku: sku
-                brand: brand
-            attributes:
+          - attributes:
               key: '{}'
-          - mappings:
-              core:
-                addToCartUrl: addToCartUrl
-                rating: 7.061401241503109
-                description: description
-                ratingCount: ratingCount
-                url: url
-                stockMessage: stockMessage
-                uid: uid
-                thumbnailImageUrl: thumbnailImageUrl
-                price: 5.637376656633329
-                msrp: 2.3021358869347655
-                imageUrl: imageUrl
-                popularity: 9.301444243932576
-                name: name
-                sku: sku
-                brand: brand
-            attributes:
+          - attributes:
               key: '{}'
           attributes:
             key: '{}'
@@ -2907,58 +2884,24 @@ components:
         - mappings:
             core:
               addToCartUrl: addToCartUrl
-              rating: 7.061401241503109
+              rating: 9.301444243932576
               description: description
               ratingCount: ratingCount
               url: url
               stockMessage: stockMessage
               uid: uid
               thumbnailImageUrl: thumbnailImageUrl
-              price: 5.637376656633329
-              msrp: 2.3021358869347655
+              price: 2.3021358869347655
+              msrp: 7.061401241503109
               imageUrl: imageUrl
-              popularity: 9.301444243932576
+              popularity: 3.616076749251911
               name: name
               sku: sku
               brand: brand
           children:
-          - mappings:
-              core:
-                addToCartUrl: addToCartUrl
-                rating: 7.061401241503109
-                description: description
-                ratingCount: ratingCount
-                url: url
-                stockMessage: stockMessage
-                uid: uid
-                thumbnailImageUrl: thumbnailImageUrl
-                price: 5.637376656633329
-                msrp: 2.3021358869347655
-                imageUrl: imageUrl
-                popularity: 9.301444243932576
-                name: name
-                sku: sku
-                brand: brand
-            attributes:
+          - attributes:
               key: '{}'
-          - mappings:
-              core:
-                addToCartUrl: addToCartUrl
-                rating: 7.061401241503109
-                description: description
-                ratingCount: ratingCount
-                url: url
-                stockMessage: stockMessage
-                uid: uid
-                thumbnailImageUrl: thumbnailImageUrl
-                price: 5.637376656633329
-                msrp: 2.3021358869347655
-                imageUrl: imageUrl
-                popularity: 9.301444243932576
-                name: name
-                sku: sku
-                brand: brand
-            attributes:
+          - attributes:
               key: '{}'
           attributes:
             key: '{}'
@@ -2969,11 +2912,11 @@ components:
             inline:
             - config:
                 position:
-                  index: 3.616076749251911
+                  index: 2.027123023002322
               value: value
             - config:
                 position:
-                  index: 3.616076749251911
+                  index: 2.027123023002322
               value: value
             footer:
             - footer
@@ -3055,58 +2998,24 @@ components:
         mappings:
           core:
             addToCartUrl: addToCartUrl
-            rating: 7.061401241503109
+            rating: 9.301444243932576
             description: description
             ratingCount: ratingCount
             url: url
             stockMessage: stockMessage
             uid: uid
             thumbnailImageUrl: thumbnailImageUrl
-            price: 5.637376656633329
-            msrp: 2.3021358869347655
+            price: 2.3021358869347655
+            msrp: 7.061401241503109
             imageUrl: imageUrl
-            popularity: 9.301444243932576
+            popularity: 3.616076749251911
             name: name
             sku: sku
             brand: brand
         children:
-        - mappings:
-            core:
-              addToCartUrl: addToCartUrl
-              rating: 7.061401241503109
-              description: description
-              ratingCount: ratingCount
-              url: url
-              stockMessage: stockMessage
-              uid: uid
-              thumbnailImageUrl: thumbnailImageUrl
-              price: 5.637376656633329
-              msrp: 2.3021358869347655
-              imageUrl: imageUrl
-              popularity: 9.301444243932576
-              name: name
-              sku: sku
-              brand: brand
-          attributes:
+        - attributes:
             key: '{}'
-        - mappings:
-            core:
-              addToCartUrl: addToCartUrl
-              rating: 7.061401241503109
-              description: description
-              ratingCount: ratingCount
-              url: url
-              stockMessage: stockMessage
-              uid: uid
-              thumbnailImageUrl: thumbnailImageUrl
-              price: 5.637376656633329
-              msrp: 2.3021358869347655
-              imageUrl: imageUrl
-              popularity: 9.301444243932576
-              name: name
-              sku: sku
-              brand: brand
-          attributes:
+        - attributes:
             key: '{}'
         attributes:
           key: '{}'
@@ -3132,17 +3041,17 @@ components:
       description: Mapping of core fields for the result object
       example:
         addToCartUrl: addToCartUrl
-        rating: 7.061401241503109
+        rating: 9.301444243932576
         description: description
         ratingCount: ratingCount
         url: url
         stockMessage: stockMessage
         uid: uid
         thumbnailImageUrl: thumbnailImageUrl
-        price: 5.637376656633329
-        msrp: 2.3021358869347655
+        price: 2.3021358869347655
+        msrp: 7.061401241503109
         imageUrl: imageUrl
-        popularity: 9.301444243932576
+        popularity: 3.616076749251911
         name: name
         sku: sku
         brand: brand
@@ -3240,11 +3149,11 @@ components:
           inline:
           - config:
               position:
-                index: 3.616076749251911
+                index: 2.027123023002322
             value: value
           - config:
               position:
-                index: 3.616076749251911
+                index: 2.027123023002322
             value: value
           footer:
           - footer
@@ -3522,9 +3431,34 @@ components:
       type: object
     SearchRequestModel_tracking:
       example:
-        loggedInUserId: loggedInUserId
+        domain: domain
+        userId: userId
+      properties:
+        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:
-        loggedInUserId:
+        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:
@@ -3563,6 +3497,7 @@ components:
       example:
         totalResults: 0
         defaultPageSize: 1
+        totalPages: 5
         pageSize: 5
         page: 6
       properties:
@@ -3574,6 +3509,8 @@ components:
           type: integer
         pageSize:
           type: integer
+        totalPages:
+          type: integer
       type: object
     SearchResponseModel_sorting:
       example:
@@ -3592,17 +3529,17 @@ components:
       example:
         core:
           addToCartUrl: addToCartUrl
-          rating: 7.061401241503109
+          rating: 9.301444243932576
           description: description
           ratingCount: ratingCount
           url: url
           stockMessage: stockMessage
           uid: uid
           thumbnailImageUrl: thumbnailImageUrl
-          price: 5.637376656633329
-          msrp: 2.3021358869347655
+          price: 2.3021358869347655
+          msrp: 7.061401241503109
           imageUrl: imageUrl
-          popularity: 9.301444243932576
+          popularity: 3.616076749251911
           name: name
           sku: sku
           brand: brand
@@ -3612,28 +3549,9 @@ components:
       type: object
     SearchResponseModelResult_children:
       example:
-        mappings:
-          core:
-            addToCartUrl: addToCartUrl
-            rating: 7.061401241503109
-            description: description
-            ratingCount: ratingCount
-            url: url
-            stockMessage: stockMessage
-            uid: uid
-            thumbnailImageUrl: thumbnailImageUrl
-            price: 5.637376656633329
-            msrp: 2.3021358869347655
-            imageUrl: imageUrl
-            popularity: 9.301444243932576
-            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
@@ -3690,7 +3608,7 @@ components:
       type: object
     SearchResponseModelMerchandising_content_config_position:
       example:
-        index: 3.616076749251911
+        index: 2.027123023002322
       properties:
         index:
           type: number
@@ -3698,7 +3616,7 @@ components:
     SearchResponseModelMerchandising_content_config:
       example:
         position:
-          index: 3.616076749251911
+          index: 2.027123023002322
       properties:
         position:
           $ref: '#/components/schemas/SearchResponseModelMerchandising_content_config_position'
@@ -3707,7 +3625,7 @@ components:
       example:
         config:
           position:
-            index: 3.616076749251911
+            index: 2.027123023002322
         value: value
       properties:
         config:
@@ -3720,11 +3638,11 @@ components:
         inline:
         - config:
             position:
-              index: 3.616076749251911
+              index: 2.027123023002322
           value: value
         - config:
             position:
-              index: 3.616076749251911
+              index: 2.027123023002322
           value: value
         footer:
         - footer