@searchspring/snapi-oas 0.1.32 → 0.1.34

package/README.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snapi-oas",
-	"version": "0.1.32",
+	"version": "0.1.34",
 	"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.32",
+    "version" : "0.1.34",
     "x-logo" : {
       "url" : "./images/searchspring_logo.svg",
       "altText" : "Searchspring Snap"
@@ -3465,6 +3465,9 @@
           },
           "pagination" : {
             "$ref" : "#/components/schemas/MetaResponseModel_pagination"
+          },
+          "badges" : {
+            "$ref" : "#/components/schemas/MetaResponseModel_badges"
           }
         },
         "type" : "object"
@@ -3573,6 +3576,44 @@
           "$ref" : "#/components/schemas/MetaResponseModelFacetHierarchy_allOf"
         } ]
       },
+      "MetaResponseModelBadgeLocation" : {
+        "properties" : {
+          "name" : {
+            "type" : "string"
+          },
+          "label" : {
+            "type" : "string"
+          },
+          "description" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "name" ],
+        "type" : "object"
+      },
+      "MetaResponseModelBadgeTag" : {
+        "properties" : {
+          "location" : {
+            "type" : "string"
+          },
+          "component" : {
+            "type" : "string"
+          },
+          "priority" : {
+            "type" : "number"
+          },
+          "enabled" : {
+            "type" : "boolean"
+          },
+          "parameters" : {
+            "additionalProperties" : true,
+            "description" : "Additional badge parameters - these are template specific fields which can have various value types",
+            "type" : "object"
+          }
+        },
+        "required" : [ "component", "enabled", "location", "parameters", "priority" ],
+        "type" : "object"
+      },
       "Meta_Request_Model" : {
         "properties" : {
           "siteId" : {
@@ -3669,6 +3710,7 @@
       "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" : {
@@ -3880,10 +3922,30 @@
         },
         "type" : "object"
       },
+      "SearchResponseModelResult_mappings_badges" : {
+        "properties" : {
+          "tag" : {
+            "type" : "string"
+          },
+          "value" : {
+            "type" : "string"
+          }
+        },
+        "required" : [ "tag" ],
+        "type" : "object"
+      },
       "SearchResponseModelResult_mappings" : {
         "properties" : {
           "core" : {
             "$ref" : "#/components/schemas/SearchResponseModelResultCoreMappings"
+          },
+          "badges" : {
+            "description" : "List of matching badges for the result",
+            "items" : {
+              "$ref" : "#/components/schemas/SearchResponseModelResult_mappings_badges"
+            },
+            "title" : "Result Badges Array",
+            "type" : "array"
           }
         },
         "type" : "object"
@@ -4053,6 +4115,54 @@
         },
         "type" : "object"
       },
+      "MetaResponseModel_badges_locations_overlay" : {
+        "properties" : {
+          "left" : {
+            "items" : {
+              "$ref" : "#/components/schemas/MetaResponseModelBadgeLocation"
+            },
+            "type" : "array"
+          },
+          "right" : {
+            "items" : {
+              "$ref" : "#/components/schemas/MetaResponseModelBadgeLocation"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "left", "right" ],
+        "type" : "object"
+      },
+      "MetaResponseModel_badges_locations" : {
+        "properties" : {
+          "overlay" : {
+            "$ref" : "#/components/schemas/MetaResponseModel_badges_locations_overlay"
+          },
+          "callouts" : {
+            "items" : {
+              "$ref" : "#/components/schemas/MetaResponseModelBadgeLocation"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "callouts", "overlay" ],
+        "type" : "object"
+      },
+      "MetaResponseModel_badges" : {
+        "properties" : {
+          "locations" : {
+            "$ref" : "#/components/schemas/MetaResponseModel_badges_locations"
+          },
+          "tags" : {
+            "additionalProperties" : {
+              "$ref" : "#/components/schemas/MetaResponseModelBadgeTag"
+            },
+            "type" : "object"
+          }
+        },
+        "required" : [ "locations", "tags" ],
+        "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.32
+  version: 0.1.34
   x-logo:
     url: ./images/searchspring_logo.svg
     altText: Searchspring Snap
@@ -2863,6 +2863,11 @@ components:
           type: value
         results:
         - mappings:
+            badges:
+            - tag: tag
+              value: value
+            - tag: tag
+              value: value
             core:
               addToCartUrl: addToCartUrl
               rating: 7.061401241503109
@@ -2888,6 +2893,11 @@ components:
             key: '{}'
           id: id
         - mappings:
+            badges:
+            - tag: tag
+              value: value
+            - tag: tag
+              value: value
             core:
               addToCartUrl: addToCartUrl
               rating: 7.061401241503109
@@ -3010,6 +3020,11 @@ components:
     SearchResponseModelResult:
       example:
         mappings:
+          badges:
+          - tag: tag
+            value: value
+          - tag: tag
+            value: value
           core:
             addToCartUrl: addToCartUrl
             rating: 7.061401241503109
@@ -3203,6 +3218,38 @@ components:
       type: object
     MetaResponseModel:
       example:
+        badges:
+          locations:
+            callouts:
+            - name: name
+              description: description
+              label: label
+            - name: name
+              description: description
+              label: label
+            overlay:
+              left:
+              - name: name
+                description: description
+                label: label
+              - name: name
+                description: description
+                label: label
+              right:
+              - name: name
+                description: description
+                label: label
+              - name: name
+                description: description
+                label: label
+          tags:
+            key:
+              component: component
+              location: location
+              priority: 6.027456183070403
+              parameters:
+                key: '{}'
+              enabled: true
         pagination:
           defaultPageSize: 0.8008281904610115
         sortOptions:
@@ -3228,6 +3275,8 @@ components:
           type: object
         pagination:
           $ref: '#/components/schemas/MetaResponseModel_pagination'
+        badges:
+          $ref: '#/components/schemas/MetaResponseModel_badges'
       type: object
     MetaResponseModelSortOption:
       example:
@@ -3308,6 +3357,50 @@ components:
       - $ref: '#/components/schemas/MetaResponseModelFacetDefaults'
       - $ref: '#/components/schemas/MetaResponseModelFacetValue'
       - $ref: '#/components/schemas/MetaResponseModelFacetHierarchy_allOf'
+    MetaResponseModelBadgeLocation:
+      example:
+        name: name
+        description: description
+        label: label
+      properties:
+        name:
+          type: string
+        label:
+          type: string
+        description:
+          type: string
+      required:
+      - name
+      type: object
+    MetaResponseModelBadgeTag:
+      example:
+        component: component
+        location: location
+        priority: 6.027456183070403
+        parameters:
+          key: '{}'
+        enabled: true
+      properties:
+        location:
+          type: string
+        component:
+          type: string
+        priority:
+          type: number
+        enabled:
+          type: boolean
+        parameters:
+          additionalProperties: true
+          description: Additional badge parameters - these are template specific fields
+            which can have various value types
+          type: object
+      required:
+      - component
+      - enabled
+      - location
+      - parameters
+      - priority
+      type: object
     Meta_Request_Model:
       properties:
         siteId:
@@ -3382,6 +3475,8 @@ components:
         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
@@ -3584,8 +3679,25 @@ components:
           - desc
           type: string
       type: object
+    SearchResponseModelResult_mappings_badges:
+      example:
+        tag: tag
+        value: value
+      properties:
+        tag:
+          type: string
+        value:
+          type: string
+      required:
+      - tag
+      type: object
     SearchResponseModelResult_mappings:
       example:
+        badges:
+        - tag: tag
+          value: value
+        - tag: tag
+          value: value
         core:
           addToCartUrl: addToCartUrl
           rating: 7.061401241503109
@@ -3605,6 +3717,12 @@ components:
       properties:
         core:
           $ref: '#/components/schemas/SearchResponseModelResultCoreMappings'
+        badges:
+          description: List of matching badges for the result
+          items:
+            $ref: '#/components/schemas/SearchResponseModelResult_mappings_badges'
+          title: Result Badges Array
+          type: array
       type: object
     SearchResponseModelResult_children:
       example:
@@ -3757,6 +3875,114 @@ components:
         defaultPageSize:
           type: number
       type: object
+    MetaResponseModel_badges_locations_overlay:
+      example:
+        left:
+        - name: name
+          description: description
+          label: label
+        - name: name
+          description: description
+          label: label
+        right:
+        - name: name
+          description: description
+          label: label
+        - name: name
+          description: description
+          label: label
+      properties:
+        left:
+          items:
+            $ref: '#/components/schemas/MetaResponseModelBadgeLocation'
+          type: array
+        right:
+          items:
+            $ref: '#/components/schemas/MetaResponseModelBadgeLocation'
+          type: array
+      required:
+      - left
+      - right
+      type: object
+    MetaResponseModel_badges_locations:
+      example:
+        callouts:
+        - name: name
+          description: description
+          label: label
+        - name: name
+          description: description
+          label: label
+        overlay:
+          left:
+          - name: name
+            description: description
+            label: label
+          - name: name
+            description: description
+            label: label
+          right:
+          - name: name
+            description: description
+            label: label
+          - name: name
+            description: description
+            label: label
+      properties:
+        overlay:
+          $ref: '#/components/schemas/MetaResponseModel_badges_locations_overlay'
+        callouts:
+          items:
+            $ref: '#/components/schemas/MetaResponseModelBadgeLocation'
+          type: array
+      required:
+      - callouts
+      - overlay
+      type: object
+    MetaResponseModel_badges:
+      example:
+        locations:
+          callouts:
+          - name: name
+            description: description
+            label: label
+          - name: name
+            description: description
+            label: label
+          overlay:
+            left:
+            - name: name
+              description: description
+              label: label
+            - name: name
+              description: description
+              label: label
+            right:
+            - name: name
+              description: description
+              label: label
+            - name: name
+              description: description
+              label: label
+        tags:
+          key:
+            component: component
+            location: location
+            priority: 6.027456183070403
+            parameters:
+              key: '{}'
+            enabled: true
+      properties:
+        locations:
+          $ref: '#/components/schemas/MetaResponseModel_badges_locations'
+        tags:
+          additionalProperties:
+            $ref: '#/components/schemas/MetaResponseModelBadgeTag'
+          type: object
+      required:
+      - locations
+      - tags
+      type: object
     MetaResponseModelFacetSlider_allOf:
       properties:
         formatSeparator: