@searchspring/snapi-oas 0.1.35 → 0.1.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/spec/v1/snapi.oas.v1.json +24 -27
  4. package/spec/v1/snapi.oas.v1.yaml +49 -75
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Snap API OpenAPI Specification v0.1.35
1
+ # Snap API OpenAPI Specification v0.1.37
2
2
 
3
3
  https://searchspring.github.io/snapi-oas/
4
4
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@searchspring/snapi-oas",
3
- "version": "0.1.35",
3
+ "version": "0.1.37",
4
4
  "description": "Snap OpenAPI Specification",
5
5
  "author": "Searchspring",
6
6
  "license": "MIT",
package/spec/v1/snapi.oas.v1.json CHANGED
@@ -6,7 +6,7 @@
6
6
  },
7
7
  "description" : "Searchspring Snap Search API",
8
8
  "title" : "snAPI",
9
- "version" : "0.1.35",
9
+ "version" : "0.1.37",
10
10
  "x-logo" : {
11
11
  "url" : "./images/searchspring_logo.svg",
12
12
  "altText" : "Searchspring Snap"
@@ -3307,6 +3307,14 @@
3307
3307
  "$ref" : "#/components/schemas/SearchResponseModelResult_children"
3308
3308
  },
3309
3309
  "type" : "array"
3310
+ },
3311
+ "badges" : {
3312
+ "description" : "List of matching badges for the result",
3313
+ "items" : {
3314
+ "$ref" : "#/components/schemas/SearchResponseModelResult_badges"
3315
+ },
3316
+ "title" : "Result Badges Array",
3317
+ "type" : "array"
3310
3318
  }
3311
3319
  },
3312
3320
  "title" : "Result",
@@ -3583,9 +3591,6 @@
3583
3591
  },
3584
3592
  "name" : {
3585
3593
  "type" : "string"
3586
- },
3587
- "description" : {
3588
- "type" : "string"
3589
3594
  }
3590
3595
  },
3591
3596
  "required" : [ "name", "tag" ],
@@ -3922,30 +3927,10 @@
3922
3927
  },
3923
3928
  "type" : "object"
3924
3929
  },
3925
- "SearchResponseModelResult_mappings_badges" : {
3926
- "properties" : {
3927
- "tag" : {
3928
- "type" : "string"
3929
- },
3930
- "value" : {
3931
- "type" : "string"
3932
- }
3933
- },
3934
- "required" : [ "tag" ],
3935
- "type" : "object"
3936
- },
3937
3930
  "SearchResponseModelResult_mappings" : {
3938
3931
  "properties" : {
3939
3932
  "core" : {
3940
3933
  "$ref" : "#/components/schemas/SearchResponseModelResultCoreMappings"
3941
- },
3942
- "badges" : {
3943
- "description" : "List of matching badges for the result",
3944
- "items" : {
3945
- "$ref" : "#/components/schemas/SearchResponseModelResult_mappings_badges"
3946
- },
3947
- "title" : "Result Badges Array",
3948
- "type" : "array"
3949
3934
  }
3950
3935
  },
3951
3936
  "type" : "object"
@@ -3958,6 +3943,18 @@
3958
3943
  },
3959
3944
  "type" : "object"
3960
3945
  },
3946
+ "SearchResponseModelResult_badges" : {
3947
+ "properties" : {
3948
+ "tag" : {
3949
+ "type" : "string"
3950
+ },
3951
+ "value" : {
3952
+ "type" : "string"
3953
+ }
3954
+ },
3955
+ "required" : [ "tag" ],
3956
+ "type" : "object"
3957
+ },
3961
3958
  "SearchResponseModelFacetValue_allOf_values" : {
3962
3959
  "properties" : {
3963
3960
  "filtered" : {
@@ -4117,13 +4114,13 @@
4117
4114
  },
4118
4115
  "MetaResponseModel_badges_locations" : {
4119
4116
  "properties" : {
4120
- "overlay/left" : {
4117
+ "left" : {
4121
4118
  "items" : {
4122
4119
  "$ref" : "#/components/schemas/MetaResponseModelBadgeLocation"
4123
4120
  },
4124
4121
  "type" : "array"
4125
4122
  },
4126
- "overlay/right" : {
4123
+ "right" : {
4127
4124
  "items" : {
4128
4125
  "$ref" : "#/components/schemas/MetaResponseModelBadgeLocation"
4129
4126
  },
@@ -4136,7 +4133,7 @@
4136
4133
  "type" : "array"
4137
4134
  }
4138
4135
  },
4139
- "required" : [ "callout", "overlay/left", "overlay/right" ],
4136
+ "required" : [ "callout", "left", "right" ],
4140
4137
  "type" : "object"
4141
4138
  },
4142
4139
  "MetaResponseModel_badges" : {
package/spec/v1/snapi.oas.v1.yaml CHANGED
@@ -4,7 +4,7 @@ info:
4
4
  name: Searchspring
5
5
  description: Searchspring Snap Search API
6
6
  title: snAPI
7
- version: 0.1.35
7
+ version: 0.1.37
8
8
  x-logo:
9
9
  url: ./images/searchspring_logo.svg
10
10
  altText: Searchspring Snap
@@ -2862,12 +2862,12 @@ components:
2862
2862
  label: label
2863
2863
  type: value
2864
2864
  results:
2865
- - mappings:
2866
- badges:
2867
- - tag: tag
2868
- value: value
2869
- - tag: tag
2870
- value: value
2865
+ - badges:
2866
+ - tag: tag
2867
+ value: value
2868
+ - tag: tag
2869
+ value: value
2870
+ mappings:
2871
2871
  core:
2872
2872
  addToCartUrl: addToCartUrl
2873
2873
  rating: 7.061401241503109
@@ -2892,12 +2892,12 @@ components:
2892
2892
  attributes:
2893
2893
  key: '{}'
2894
2894
  id: id
2895
- - mappings:
2896
- badges:
2897
- - tag: tag
2898
- value: value
2899
- - tag: tag
2900
- value: value
2895
+ - badges:
2896
+ - tag: tag
2897
+ value: value
2898
+ - tag: tag
2899
+ value: value
2900
+ mappings:
2901
2901
  core:
2902
2902
  addToCartUrl: addToCartUrl
2903
2903
  rating: 7.061401241503109
@@ -3019,12 +3019,12 @@ components:
3019
3019
  - $ref: '#/components/schemas/SearchRequestModelFilterRange_allOf'
3020
3020
  SearchResponseModelResult:
3021
3021
  example:
3022
+ badges:
3023
+ - tag: tag
3024
+ value: value
3025
+ - tag: tag
3026
+ value: value
3022
3027
  mappings:
3023
- badges:
3024
- - tag: tag
3025
- value: value
3026
- - tag: tag
3027
- value: value
3028
3028
  core:
3029
3029
  addToCartUrl: addToCartUrl
3030
3030
  rating: 7.061401241503109
@@ -3064,6 +3064,12 @@ components:
3064
3064
  items:
3065
3065
  $ref: '#/components/schemas/SearchResponseModelResult_children'
3066
3066
  type: array
3067
+ badges:
3068
+ description: List of matching badges for the result
3069
+ items:
3070
+ $ref: '#/components/schemas/SearchResponseModelResult_badges'
3071
+ title: Result Badges Array
3072
+ type: array
3067
3073
  title: Result
3068
3074
  type: object
3069
3075
  SearchResponseModelResultCoreMappings:
@@ -3220,26 +3226,20 @@ components:
3220
3226
  example:
3221
3227
  badges:
3222
3228
  locations:
3223
- overlay/right:
3229
+ callout:
3224
3230
  - name: name
3225
- description: description
3226
3231
  tag: tag
3227
3232
  - name: name
3228
- description: description
3229
3233
  tag: tag
3230
- callout:
3234
+ left:
3231
3235
  - name: name
3232
- description: description
3233
3236
  tag: tag
3234
3237
  - name: name
3235
- description: description
3236
3238
  tag: tag
3237
- overlay/left:
3239
+ right:
3238
3240
  - name: name
3239
- description: description
3240
3241
  tag: tag
3241
3242
  - name: name
3242
- description: description
3243
3243
  tag: tag
3244
3244
  tags:
3245
3245
  key:
@@ -3359,15 +3359,12 @@ components:
3359
3359
  MetaResponseModelBadgeLocation:
3360
3360
  example:
3361
3361
  name: name
3362
- description: description
3363
3362
  tag: tag
3364
3363
  properties:
3365
3364
  tag:
3366
3365
  type: string
3367
3366
  name:
3368
3367
  type: string
3369
- description:
3370
- type: string
3371
3368
  required:
3372
3369
  - name
3373
3370
  - tag
@@ -3679,25 +3676,8 @@ components:
3679
3676
  - desc
3680
3677
  type: string
3681
3678
  type: object
3682
- SearchResponseModelResult_mappings_badges:
3683
- example:
3684
- tag: tag
3685
- value: value
3686
- properties:
3687
- tag:
3688
- type: string
3689
- value:
3690
- type: string
3691
- required:
3692
- - tag
3693
- type: object
3694
3679
  SearchResponseModelResult_mappings:
3695
3680
  example:
3696
- badges:
3697
- - tag: tag
3698
- value: value
3699
- - tag: tag
3700
- value: value
3701
3681
  core:
3702
3682
  addToCartUrl: addToCartUrl
3703
3683
  rating: 7.061401241503109
@@ -3717,12 +3697,6 @@ components:
3717
3697
  properties:
3718
3698
  core:
3719
3699
  $ref: '#/components/schemas/SearchResponseModelResultCoreMappings'
3720
- badges:
3721
- description: List of matching badges for the result
3722
- items:
3723
- $ref: '#/components/schemas/SearchResponseModelResult_mappings_badges'
3724
- title: Result Badges Array
3725
- type: array
3726
3700
  type: object
3727
3701
  SearchResponseModelResult_children:
3728
3702
  example:
@@ -3736,6 +3710,18 @@ components:
3736
3710
  title: Result Custom Attributes
3737
3711
  type: object
3738
3712
  type: object
3713
+ SearchResponseModelResult_badges:
3714
+ example:
3715
+ tag: tag
3716
+ value: value
3717
+ properties:
3718
+ tag:
3719
+ type: string
3720
+ value:
3721
+ type: string
3722
+ required:
3723
+ - tag
3724
+ type: object
3739
3725
  SearchResponseModelFacetValue_allOf_values:
3740
3726
  properties:
3741
3727
  filtered:
@@ -3877,33 +3863,27 @@ components:
3877
3863
  type: object
3878
3864
  MetaResponseModel_badges_locations:
3879
3865
  example:
3880
- overlay/right:
3866
+ callout:
3881
3867
  - name: name
3882
- description: description
3883
3868
  tag: tag
3884
3869
  - name: name
3885
- description: description
3886
3870
  tag: tag
3887
- callout:
3871
+ left:
3888
3872
  - name: name
3889
- description: description
3890
3873
  tag: tag
3891
3874
  - name: name
3892
- description: description
3893
3875
  tag: tag
3894
- overlay/left:
3876
+ right:
3895
3877
  - name: name
3896
- description: description
3897
3878
  tag: tag
3898
3879
  - name: name
3899
- description: description
3900
3880
  tag: tag
3901
3881
  properties:
3902
- overlay/left:
3882
+ left:
3903
3883
  items:
3904
3884
  $ref: '#/components/schemas/MetaResponseModelBadgeLocation'
3905
3885
  type: array
3906
- overlay/right:
3886
+ right:
3907
3887
  items:
3908
3888
  $ref: '#/components/schemas/MetaResponseModelBadgeLocation'
3909
3889
  type: array
@@ -3913,32 +3893,26 @@ components:
3913
3893
  type: array
3914
3894
  required:
3915
3895
  - callout
3916
- - overlay/left
3917
- - overlay/right
3896
+ - left
3897
+ - right
3918
3898
  type: object
3919
3899
  MetaResponseModel_badges:
3920
3900
  example:
3921
3901
  locations:
3922
- overlay/right:
3902
+ callout:
3923
3903
  - name: name
3924
- description: description
3925
3904
  tag: tag
3926
3905
  - name: name
3927
- description: description
3928
3906
  tag: tag
3929
- callout:
3907
+ left:
3930
3908
  - name: name
3931
- description: description
3932
3909
  tag: tag
3933
3910
  - name: name
3934
- description: description
3935
3911
  tag: tag
3936
- overlay/left:
3912
+ right:
3937
3913
  - name: name
3938
- description: description
3939
3914
  tag: tag
3940
3915
  - name: name
3941
- description: description
3942
3916
  tag: tag
3943
3917
  tags:
3944
3918
  key: