@searchspring/snapi-oas 0.1.29 → 0.1.31

package/README.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snapi-oas",
-	"version": "0.1.29",
+	"version": "0.1.31",
 	"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.29",
+    "version" : "0.1.31",
     "x-logo" : {
       "url" : "./images/searchspring_logo.svg",
       "altText" : "Searchspring Snap"
@@ -3459,6 +3459,9 @@
               "$ref" : "#/components/schemas/MetaResponseModelFacet"
             },
             "type" : "object"
+          },
+          "pagination" : {
+            "$ref" : "#/components/schemas/MetaResponseModel_pagination"
           }
         },
         "type" : "object"
@@ -3683,6 +3686,10 @@
             "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" ],
@@ -3849,9 +3856,6 @@
           "page" : {
             "type" : "integer"
           },
-          "defaultPageSize" : {
-            "type" : "integer"
-          },
           "pageSize" : {
             "type" : "integer"
           },
@@ -4038,6 +4042,14 @@
         },
         "type" : "object"
       },
+      "MetaResponseModel_pagination" : {
+        "properties" : {
+          "defaultPageSize" : {
+            "type" : "number"
+          }
+        },
+        "type" : "object"
+      },
       "MetaResponseModelFacetSlider_allOf" : {
         "properties" : {
           "formatSeparator" : {

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

@@ -4,7 +4,7 @@ info:
     name: Searchspring
   description: Searchspring Snap Search API
   title: snAPI
-  version: 0.1.29
+  version: 0.1.31
   x-logo:
     url: ./images/searchspring_logo.svg
     altText: Searchspring Snap
@@ -2739,6 +2739,7 @@ components:
             spellCorrection: true
           originalQuery: originalQuery
           redirectResponse: full
+          fallbackQuery: fallbackQuery
           subQuery: subQuery
         pagination:
           pageSize: 6
@@ -2845,9 +2846,8 @@ components:
           originalQuery: originalQuery
         pagination:
           totalResults: 0
-          defaultPageSize: 1
           totalPages: 5
-          pageSize: 5
+          pageSize: 1
           page: 6
         sorting:
         - field: field
@@ -2865,17 +2865,17 @@ components:
         - mappings:
             core:
               addToCartUrl: addToCartUrl
-              rating: 9.301444243932576
+              rating: 7.061401241503109
               description: description
               ratingCount: ratingCount
               url: url
               stockMessage: stockMessage
               uid: uid
               thumbnailImageUrl: thumbnailImageUrl
-              price: 2.3021358869347655
-              msrp: 7.061401241503109
+              price: 5.637376656633329
+              msrp: 2.3021358869347655
               imageUrl: imageUrl
-              popularity: 3.616076749251911
+              popularity: 9.301444243932576
               name: name
               sku: sku
               brand: brand
@@ -2890,17 +2890,17 @@ components:
         - mappings:
             core:
               addToCartUrl: addToCartUrl
-              rating: 9.301444243932576
+              rating: 7.061401241503109
               description: description
               ratingCount: ratingCount
               url: url
               stockMessage: stockMessage
               uid: uid
               thumbnailImageUrl: thumbnailImageUrl
-              price: 2.3021358869347655
-              msrp: 7.061401241503109
+              price: 5.637376656633329
+              msrp: 2.3021358869347655
               imageUrl: imageUrl
-              popularity: 3.616076749251911
+              popularity: 9.301444243932576
               name: name
               sku: sku
               brand: brand
@@ -2925,11 +2925,11 @@ components:
             inline:
             - config:
                 position:
-                  index: 2.027123023002322
+                  index: 3.616076749251911
               value: value
             - config:
                 position:
-                  index: 2.027123023002322
+                  index: 3.616076749251911
               value: value
             footer:
             - footer
@@ -3011,17 +3011,17 @@ components:
         mappings:
           core:
             addToCartUrl: addToCartUrl
-            rating: 9.301444243932576
+            rating: 7.061401241503109
             description: description
             ratingCount: ratingCount
             url: url
             stockMessage: stockMessage
             uid: uid
             thumbnailImageUrl: thumbnailImageUrl
-            price: 2.3021358869347655
-            msrp: 7.061401241503109
+            price: 5.637376656633329
+            msrp: 2.3021358869347655
             imageUrl: imageUrl
-            popularity: 3.616076749251911
+            popularity: 9.301444243932576
             name: name
             sku: sku
             brand: brand
@@ -3054,17 +3054,17 @@ components:
       description: Mapping of core fields for the result object
       example:
         addToCartUrl: addToCartUrl
-        rating: 9.301444243932576
+        rating: 7.061401241503109
         description: description
         ratingCount: ratingCount
         url: url
         stockMessage: stockMessage
         uid: uid
         thumbnailImageUrl: thumbnailImageUrl
-        price: 2.3021358869347655
-        msrp: 7.061401241503109
+        price: 5.637376656633329
+        msrp: 2.3021358869347655
         imageUrl: imageUrl
-        popularity: 3.616076749251911
+        popularity: 9.301444243932576
         name: name
         sku: sku
         brand: brand
@@ -3169,11 +3169,11 @@ components:
           inline:
           - config:
               position:
-                index: 2.027123023002322
+                index: 3.616076749251911
             value: value
           - config:
               position:
-                index: 2.027123023002322
+                index: 3.616076749251911
             value: value
           footer:
           - footer
@@ -3199,6 +3199,8 @@ components:
       type: object
     MetaResponseModel:
       example:
+        pagination:
+          defaultPageSize: 0.8008281904610115
         sortOptions:
         - field: field
           label: label
@@ -3220,6 +3222,8 @@ components:
           additionalProperties:
             $ref: '#/components/schemas/MetaResponseModelFacet'
           type: object
+        pagination:
+          $ref: '#/components/schemas/MetaResponseModel_pagination'
       type: object
     MetaResponseModelSortOption:
       example:
@@ -3385,6 +3389,7 @@ components:
           spellCorrection: true
         originalQuery: originalQuery
         redirectResponse: full
+        fallbackQuery: fallbackQuery
         subQuery: subQuery
       properties:
         query:
@@ -3394,6 +3399,10 @@ components:
         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:
@@ -3545,17 +3554,14 @@ components:
     SearchResponseModel_pagination:
       example:
         totalResults: 0
-        defaultPageSize: 1
         totalPages: 5
-        pageSize: 5
+        pageSize: 1
         page: 6
       properties:
         totalResults:
           type: integer
         page:
           type: integer
-        defaultPageSize:
-          type: integer
         pageSize:
           type: integer
         totalPages:
@@ -3578,17 +3584,17 @@ components:
       example:
         core:
           addToCartUrl: addToCartUrl
-          rating: 9.301444243932576
+          rating: 7.061401241503109
           description: description
           ratingCount: ratingCount
           url: url
           stockMessage: stockMessage
           uid: uid
           thumbnailImageUrl: thumbnailImageUrl
-          price: 2.3021358869347655
-          msrp: 7.061401241503109
+          price: 5.637376656633329
+          msrp: 2.3021358869347655
           imageUrl: imageUrl
-          popularity: 3.616076749251911
+          popularity: 9.301444243932576
           name: name
           sku: sku
           brand: brand
@@ -3670,7 +3676,7 @@ components:
       type: object
     SearchResponseModelMerchandising_content_config_position:
       example:
-        index: 2.027123023002322
+        index: 3.616076749251911
       properties:
         index:
           type: number
@@ -3678,7 +3684,7 @@ components:
     SearchResponseModelMerchandising_content_config:
       example:
         position:
-          index: 2.027123023002322
+          index: 3.616076749251911
       properties:
         position:
           $ref: '#/components/schemas/SearchResponseModelMerchandising_content_config_position'
@@ -3687,7 +3693,7 @@ components:
       example:
         config:
           position:
-            index: 2.027123023002322
+            index: 3.616076749251911
         value: value
       properties:
         config:
@@ -3700,11 +3706,11 @@ components:
         inline:
         - config:
             position:
-              index: 2.027123023002322
+              index: 3.616076749251911
           value: value
         - config:
             position:
-              index: 2.027123023002322
+              index: 3.616076749251911
           value: value
         footer:
         - footer
@@ -3740,6 +3746,13 @@ components:
             $ref: '#/components/schemas/SearchResponseModelMerchandising_content_inline'
           type: array
       type: object
+    MetaResponseModel_pagination:
+      example:
+        defaultPageSize: 0.8008281904610115
+      properties:
+        defaultPageSize:
+          type: number
+      type: object
     MetaResponseModelFacetSlider_allOf:
       properties:
         formatSeparator: