From fdce0efb164f9e267eee36ecac8713e313cb536e Mon Sep 17 00:00:00 2001 From: searchspring-machine Date: Thu, 28 Mar 2024 21:26:41 +0000 Subject: [PATCH] chore(generation): 0.1.34 --- README.md | 2 +- docs/spec/v1/snapi.oas.v1.yaml | 73 ++++++++++++++++++++++------------ package.json | 2 +- spec/v1/snapi.oas.v1.json | 42 ++++++++++--------- spec/v1/snapi.oas.v1.yaml | 73 ++++++++++++++++++++++------------ 5 files changed, 120 insertions(+), 72 deletions(-) diff --git a/README.md b/README.md index 2dcfd4a..ff1d1e2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Snap API OpenAPI Specification v0.1.33 +# Snap API OpenAPI Specification v0.1.34 https://searchspring.github.io/snapi-oas/ diff --git a/docs/spec/v1/snapi.oas.v1.yaml b/docs/spec/v1/snapi.oas.v1.yaml index 7616727..cf28f91 100644 --- a/docs/spec/v1/snapi.oas.v1.yaml +++ b/docs/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.34 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 @@ -3374,6 +3369,8 @@ components: type: string description: type: string + required: + - name 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 @@ -3888,6 +3900,9 @@ components: items: $ref: '#/components/schemas/MetaResponseModelBadgeLocation' type: array + required: + - left + - right type: object MetaResponseModel_badges_locations: example: @@ -3920,6 +3935,9 @@ components: items: $ref: '#/components/schemas/MetaResponseModelBadgeLocation' type: array + required: + - callouts + - overlay type: object MetaResponseModel_badges: example: @@ -3961,6 +3979,9 @@ components: additionalProperties: $ref: '#/components/schemas/MetaResponseModelBadgeTag' type: object + required: + - locations + - tags type: object MetaResponseModelFacetSlider_allOf: properties: diff --git a/package.json b/package.json index 1d430e4..682cd08 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@searchspring/snapi-oas", - "version": "0.1.33", + "version": "0.1.34", "description": "Snap OpenAPI Specification", "author": "Searchspring", "license": "MIT", diff --git a/spec/v1/snapi.oas.v1.json b/spec/v1/snapi.oas.v1.json index ea94f3e..40ca2dd 100644 --- a/spec/v1/snapi.oas.v1.json +++ b/spec/v1/snapi.oas.v1.json @@ -6,7 +6,7 @@ }, "description" : "Searchspring Snap Search API", "title" : "snAPI", - "version" : "0.1.33", + "version" : "0.1.34", "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", @@ -3604,6 +3588,7 @@ "type" : "string" } }, + "required" : [ "name" ], "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" @@ -4127,6 +4130,7 @@ "type" : "array" } }, + "required" : [ "left", "right" ], "type" : "object" }, "MetaResponseModel_badges_locations" : { @@ -4141,6 +4145,7 @@ "type" : "array" } }, + "required" : [ "callouts", "overlay" ], "type" : "object" }, "MetaResponseModel_badges" : { @@ -4155,6 +4160,7 @@ "type" : "object" } }, + "required" : [ "locations", "tags" ], "type" : "object" }, "MetaResponseModelFacetSlider_allOf" : { diff --git a/spec/v1/snapi.oas.v1.yaml b/spec/v1/snapi.oas.v1.yaml index 7616727..cf28f91 100644 --- a/spec/v1/snapi.oas.v1.yaml +++ b/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.34 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 @@ -3374,6 +3369,8 @@ components: type: string description: type: string + required: + - name 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 @@ -3888,6 +3900,9 @@ components: items: $ref: '#/components/schemas/MetaResponseModelBadgeLocation' type: array + required: + - left + - right type: object MetaResponseModel_badges_locations: example: @@ -3920,6 +3935,9 @@ components: items: $ref: '#/components/schemas/MetaResponseModelBadgeLocation' type: array + required: + - callouts + - overlay type: object MetaResponseModel_badges: example: @@ -3961,6 +3979,9 @@ components: additionalProperties: $ref: '#/components/schemas/MetaResponseModelBadgeTag' type: object + required: + - locations + - tags type: object MetaResponseModelFacetSlider_allOf: properties: