@searchspring/snapi-oas 0.1.33 → 0.1.35

package/README.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snapi-oas",
-	"version": "0.1.33",
+	"version": "0.1.35",
 	"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.33",
+    "version" : "0.1.35",
     "x-logo" : {
       "url" : "./images/searchspring_logo.svg",
       "altText" : "Searchspring Snap"
@@ -3379,22 +3379,6 @@
         "title" : "Result Core Field Mappings",
         "type" : "object"
       },
-      "SearchResponseModelResultBadges" : {
-        "description" : "List of matching badges for the result",
-        "items" : {
-          "properties" : {
-            "tag" : {
-              "type" : "string"
-            },
-            "value" : {
-              "type" : "string"
-            }
-          },
-          "type" : "object"
-        },
-        "title" : "Result Badges Array",
-        "type" : "array"
-      },
       "SearchResponseModelResultAttributes" : {
         "additionalProperties" : true,
         "description" : "Additional fields for results - these are site specific fields which can have various value types",
@@ -3594,16 +3578,17 @@
       },
       "MetaResponseModelBadgeLocation" : {
         "properties" : {
-          "name" : {
+          "tag" : {
             "type" : "string"
           },
-          "label" : {
+          "name" : {
             "type" : "string"
           },
           "description" : {
             "type" : "string"
           }
         },
+        "required" : [ "name", "tag" ],
         "type" : "object"
       },
       "MetaResponseModelBadgeTag" : {
@@ -3626,6 +3611,7 @@
             "type" : "object"
           }
         },
+        "required" : [ "component", "enabled", "location", "parameters", "priority" ],
         "type" : "object"
       },
       "Meta_Request_Model" : {
@@ -3936,13 +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" : {
-            "$ref" : "#/components/schemas/SearchResponseModelResultBadges"
+            "description" : "List of matching badges for the result",
+            "items" : {
+              "$ref" : "#/components/schemas/SearchResponseModelResult_mappings_badges"
+            },
+            "title" : "Result Badges Array",
+            "type" : "array"
           }
         },
         "type" : "object"
@@ -4112,35 +4115,28 @@
         },
         "type" : "object"
       },
-      "MetaResponseModel_badges_locations_overlay" : {
+      "MetaResponseModel_badges_locations" : {
         "properties" : {
-          "left" : {
+          "overlay/left" : {
             "items" : {
               "$ref" : "#/components/schemas/MetaResponseModelBadgeLocation"
             },
             "type" : "array"
           },
-          "right" : {
+          "overlay/right" : {
             "items" : {
               "$ref" : "#/components/schemas/MetaResponseModelBadgeLocation"
             },
             "type" : "array"
-          }
-        },
-        "type" : "object"
-      },
-      "MetaResponseModel_badges_locations" : {
-        "properties" : {
-          "overlay" : {
-            "$ref" : "#/components/schemas/MetaResponseModel_badges_locations_overlay"
           },
-          "callouts" : {
+          "callout" : {
             "items" : {
               "$ref" : "#/components/schemas/MetaResponseModelBadgeLocation"
             },
             "type" : "array"
           }
         },
+        "required" : [ "callout", "overlay/left", "overlay/right" ],
         "type" : "object"
       },
       "MetaResponseModel_badges" : {
@@ -4155,6 +4151,7 @@
             "type" : "object"
           }
         },
+        "required" : [ "locations" ],
         "type" : "object"
       },
       "MetaResponseModelFacetSlider_allOf" : {

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

@@ -4,7 +4,7 @@ info:
     name: Searchspring
   description: Searchspring Snap Search API
   title: snAPI
-  version: 0.1.33
+  version: 0.1.35
   x-logo:
     url: ./images/searchspring_logo.svg
     altText: Searchspring Snap
@@ -2864,8 +2864,10 @@ components:
         results:
         - mappings:
             badges:
-            - '{}'
-            - '{}'
+            - tag: tag
+              value: value
+            - tag: tag
+              value: value
             core:
               addToCartUrl: addToCartUrl
               rating: 7.061401241503109
@@ -2892,8 +2894,10 @@ components:
           id: id
         - mappings:
             badges:
-            - '{}'
-            - '{}'
+            - tag: tag
+              value: value
+            - tag: tag
+              value: value
             core:
               addToCartUrl: addToCartUrl
               rating: 7.061401241503109
@@ -3017,8 +3021,10 @@ components:
       example:
         mappings:
           badges:
-          - '{}'
-          - '{}'
+          - tag: tag
+            value: value
+          - tag: tag
+            value: value
           core:
             addToCartUrl: addToCartUrl
             rating: 7.061401241503109
@@ -3126,17 +3132,6 @@ components:
           type: number
       title: Result Core Field Mappings
       type: object
-    SearchResponseModelResultBadges:
-      description: List of matching badges for the result
-      items:
-        properties:
-          tag:
-            type: string
-          value:
-            type: string
-        type: object
-      title: Result Badges Array
-      type: array
     SearchResponseModelResultAttributes:
       additionalProperties: true
       description: Additional fields for results - these are site specific fields
@@ -3225,28 +3220,27 @@ components:
       example:
         badges:
           locations:
-            callouts:
+            overlay/right:
+            - name: name
+              description: description
+              tag: tag
             - name: name
               description: description
-              label: label
+              tag: tag
+            callout:
             - 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
+              tag: tag
+            - name: name
+              description: description
+              tag: tag
+            overlay/left:
+            - name: name
+              description: description
+              tag: tag
+            - name: name
+              description: description
+              tag: tag
           tags:
             key:
               component: component
@@ -3366,14 +3360,17 @@ components:
       example:
         name: name
         description: description
-        label: label
+        tag: tag
       properties:
-        name:
+        tag:
           type: string
-        label:
+        name:
           type: string
         description:
           type: string
+      required:
+      - name
+      - tag
       type: object
     MetaResponseModelBadgeTag:
       example:
@@ -3397,6 +3394,12 @@ components:
           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:
@@ -3676,11 +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
@@ -3703,12 +3720,7 @@ components:
         badges:
           description: List of matching badges for the result
           items:
-            properties:
-              tag:
-                type: string
-              value:
-                type: string
-            type: object
+            $ref: '#/components/schemas/SearchResponseModelResult_mappings_badges'
           title: Result Badges Array
           type: array
       type: object
@@ -3863,89 +3875,71 @@ components:
         defaultPageSize:
           type: number
       type: object
-    MetaResponseModel_badges_locations_overlay:
+    MetaResponseModel_badges_locations:
       example:
-        left:
+        overlay/right:
         - name: name
           description: description
-          label: label
+          tag: tag
         - name: name
           description: description
-          label: label
-        right:
+          tag: tag
+        callout:
         - name: name
           description: description
-          label: label
+          tag: tag
         - name: name
           description: description
-          label: label
+          tag: tag
+        overlay/left:
+        - name: name
+          description: description
+          tag: tag
+        - name: name
+          description: description
+          tag: tag
       properties:
-        left:
+        overlay/left:
           items:
             $ref: '#/components/schemas/MetaResponseModelBadgeLocation'
           type: array
-        right:
+        overlay/right:
           items:
             $ref: '#/components/schemas/MetaResponseModelBadgeLocation'
           type: array
+        callout:
+          items:
+            $ref: '#/components/schemas/MetaResponseModelBadgeLocation'
+          type: array
+      required:
+      - callout
+      - overlay/left
+      - overlay/right
       type: object
-    MetaResponseModel_badges_locations:
+    MetaResponseModel_badges:
       example:
-        callouts:
-        - name: name
-          description: description
-          label: label
-        - name: name
-          description: description
-          label: label
-        overlay:
-          left:
+        locations:
+          overlay/right:
           - name: name
             description: description
-            label: label
+            tag: tag
           - name: name
             description: description
-            label: label
-          right:
+            tag: tag
+          callout:
           - name: name
             description: description
-            label: label
+            tag: tag
           - name: name
             description: description
-            label: label
-      properties:
-        overlay:
-          $ref: '#/components/schemas/MetaResponseModel_badges_locations_overlay'
-        callouts:
-          items:
-            $ref: '#/components/schemas/MetaResponseModelBadgeLocation'
-          type: array
-      type: object
-    MetaResponseModel_badges:
-      example:
-        locations:
-          callouts:
+            tag: tag
+          overlay/left:
           - name: name
             description: description
-            label: label
+            tag: tag
           - 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
+            tag: tag
         tags:
           key:
             component: component
@@ -3961,6 +3955,8 @@ components:
           additionalProperties:
             $ref: '#/components/schemas/MetaResponseModelBadgeTag'
           type: object
+      required:
+      - locations
       type: object
     MetaResponseModelFacetSlider_allOf:
       properties: