@searchspring/snapi-oas 0.1.36 → 0.1.38

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 +41 -24
  4. package/spec/v1/snapi.oas.v1.yaml +67 -62
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Snap API OpenAPI Specification v0.1.36
1
+ # Snap API OpenAPI Specification v0.1.38
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.36",
3
+ "version": "0.1.38",
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.36",
9
+ "version" : "0.1.38",
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",
@@ -3440,6 +3448,12 @@
3440
3448
  },
3441
3449
  "type" : "array"
3442
3450
  },
3451
+ "experiments" : {
3452
+ "items" : {
3453
+ "$ref" : "#/components/schemas/SearchResponseModelMerchandising_experiments"
3454
+ },
3455
+ "type" : "array"
3456
+ },
3443
3457
  "personalized" : {
3444
3458
  "type" : "boolean"
3445
3459
  },
@@ -3583,9 +3597,6 @@
3583
3597
  },
3584
3598
  "name" : {
3585
3599
  "type" : "string"
3586
- },
3587
- "description" : {
3588
- "type" : "string"
3589
3600
  }
3590
3601
  },
3591
3602
  "required" : [ "name", "tag" ],
@@ -3922,30 +3933,10 @@
3922
3933
  },
3923
3934
  "type" : "object"
3924
3935
  },
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
3936
  "SearchResponseModelResult_mappings" : {
3938
3937
  "properties" : {
3939
3938
  "core" : {
3940
3939
  "$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
3940
  }
3950
3941
  },
3951
3942
  "type" : "object"
@@ -3958,6 +3949,18 @@
3958
3949
  },
3959
3950
  "type" : "object"
3960
3951
  },
3952
+ "SearchResponseModelResult_badges" : {
3953
+ "properties" : {
3954
+ "tag" : {
3955
+ "type" : "string"
3956
+ },
3957
+ "value" : {
3958
+ "type" : "string"
3959
+ }
3960
+ },
3961
+ "required" : [ "tag" ],
3962
+ "type" : "object"
3963
+ },
3961
3964
  "SearchResponseModelFacetValue_allOf_values" : {
3962
3965
  "properties" : {
3963
3966
  "filtered" : {
@@ -4045,6 +4048,20 @@
4045
4048
  },
4046
4049
  "type" : "object"
4047
4050
  },
4051
+ "SearchResponseModelMerchandising_experiments" : {
4052
+ "properties" : {
4053
+ "campaignId" : {
4054
+ "type" : "string"
4055
+ },
4056
+ "experimentId" : {
4057
+ "type" : "string"
4058
+ },
4059
+ "variationId" : {
4060
+ "type" : "string"
4061
+ }
4062
+ },
4063
+ "type" : "object"
4064
+ },
4048
4065
  "SearchResponseModelMerchandising_content_config_position" : {
4049
4066
  "properties" : {
4050
4067
  "index" : {
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.36
7
+ version: 0.1.38
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
@@ -2931,6 +2931,13 @@ components:
2931
2931
  - id: id
2932
2932
  title: title
2933
2933
  type: type
2934
+ experiments:
2935
+ - variationId: variationId
2936
+ campaignId: campaignId
2937
+ experimentId: experimentId
2938
+ - variationId: variationId
2939
+ campaignId: campaignId
2940
+ experimentId: experimentId
2934
2941
  personalized: true
2935
2942
  content:
2936
2943
  inline:
@@ -3019,12 +3026,12 @@ components:
3019
3026
  - $ref: '#/components/schemas/SearchRequestModelFilterRange_allOf'
3020
3027
  SearchResponseModelResult:
3021
3028
  example:
3029
+ badges:
3030
+ - tag: tag
3031
+ value: value
3032
+ - tag: tag
3033
+ value: value
3022
3034
  mappings:
3023
- badges:
3024
- - tag: tag
3025
- value: value
3026
- - tag: tag
3027
- value: value
3028
3035
  core:
3029
3036
  addToCartUrl: addToCartUrl
3030
3037
  rating: 7.061401241503109
@@ -3064,6 +3071,12 @@ components:
3064
3071
  items:
3065
3072
  $ref: '#/components/schemas/SearchResponseModelResult_children'
3066
3073
  type: array
3074
+ badges:
3075
+ description: List of matching badges for the result
3076
+ items:
3077
+ $ref: '#/components/schemas/SearchResponseModelResult_badges'
3078
+ title: Result Badges Array
3079
+ type: array
3067
3080
  title: Result
3068
3081
  type: object
3069
3082
  SearchResponseModelResultCoreMappings:
@@ -3181,6 +3194,13 @@ components:
3181
3194
  - id: id
3182
3195
  title: title
3183
3196
  type: type
3197
+ experiments:
3198
+ - variationId: variationId
3199
+ campaignId: campaignId
3200
+ experimentId: experimentId
3201
+ - variationId: variationId
3202
+ campaignId: campaignId
3203
+ experimentId: experimentId
3184
3204
  personalized: true
3185
3205
  content:
3186
3206
  inline:
@@ -3211,6 +3231,10 @@ components:
3211
3231
  items:
3212
3232
  $ref: '#/components/schemas/SearchResponseModelMerchandising_campaigns'
3213
3233
  type: array
3234
+ experiments:
3235
+ items:
3236
+ $ref: '#/components/schemas/SearchResponseModelMerchandising_experiments'
3237
+ type: array
3214
3238
  personalized:
3215
3239
  type: boolean
3216
3240
  content:
@@ -3222,24 +3246,18 @@ components:
3222
3246
  locations:
3223
3247
  callout:
3224
3248
  - name: name
3225
- description: description
3226
3249
  tag: tag
3227
3250
  - name: name
3228
- description: description
3229
3251
  tag: tag
3230
3252
  left:
3231
3253
  - name: name
3232
- description: description
3233
3254
  tag: tag
3234
3255
  - name: name
3235
- description: description
3236
3256
  tag: tag
3237
3257
  right:
3238
3258
  - name: name
3239
- description: description
3240
3259
  tag: tag
3241
3260
  - name: name
3242
- description: description
3243
3261
  tag: tag
3244
3262
  tags:
3245
3263
  key:
@@ -3359,15 +3377,12 @@ components:
3359
3377
  MetaResponseModelBadgeLocation:
3360
3378
  example:
3361
3379
  name: name
3362
- description: description
3363
3380
  tag: tag
3364
3381
  properties:
3365
3382
  tag:
3366
3383
  type: string
3367
3384
  name:
3368
3385
  type: string
3369
- description:
3370
- type: string
3371
3386
  required:
3372
3387
  - name
3373
3388
  - tag
@@ -3679,25 +3694,8 @@ components:
3679
3694
  - desc
3680
3695
  type: string
3681
3696
  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
3697
  SearchResponseModelResult_mappings:
3695
3698
  example:
3696
- badges:
3697
- - tag: tag
3698
- value: value
3699
- - tag: tag
3700
- value: value
3701
3699
  core:
3702
3700
  addToCartUrl: addToCartUrl
3703
3701
  rating: 7.061401241503109
@@ -3717,12 +3715,6 @@ components:
3717
3715
  properties:
3718
3716
  core:
3719
3717
  $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
3718
  type: object
3727
3719
  SearchResponseModelResult_children:
3728
3720
  example:
@@ -3736,6 +3728,18 @@ components:
3736
3728
  title: Result Custom Attributes
3737
3729
  type: object
3738
3730
  type: object
3731
+ SearchResponseModelResult_badges:
3732
+ example:
3733
+ tag: tag
3734
+ value: value
3735
+ properties:
3736
+ tag:
3737
+ type: string
3738
+ value:
3739
+ type: string
3740
+ required:
3741
+ - tag
3742
+ type: object
3739
3743
  SearchResponseModelFacetValue_allOf_values:
3740
3744
  properties:
3741
3745
  filtered:
@@ -3796,6 +3800,19 @@ components:
3796
3800
  type:
3797
3801
  type: string
3798
3802
  type: object
3803
+ SearchResponseModelMerchandising_experiments:
3804
+ example:
3805
+ variationId: variationId
3806
+ campaignId: campaignId
3807
+ experimentId: experimentId
3808
+ properties:
3809
+ campaignId:
3810
+ type: string
3811
+ experimentId:
3812
+ type: string
3813
+ variationId:
3814
+ type: string
3815
+ type: object
3799
3816
  SearchResponseModelMerchandising_content_config_position:
3800
3817
  example:
3801
3818
  index: 3.616076749251911
@@ -3879,24 +3896,18 @@ components:
3879
3896
  example:
3880
3897
  callout:
3881
3898
  - name: name
3882
- description: description
3883
3899
  tag: tag
3884
3900
  - name: name
3885
- description: description
3886
3901
  tag: tag
3887
3902
  left:
3888
3903
  - name: name
3889
- description: description
3890
3904
  tag: tag
3891
3905
  - name: name
3892
- description: description
3893
3906
  tag: tag
3894
3907
  right:
3895
3908
  - name: name
3896
- description: description
3897
3909
  tag: tag
3898
3910
  - name: name
3899
- description: description
3900
3911
  tag: tag
3901
3912
  properties:
3902
3913
  left:
@@ -3921,24 +3932,18 @@ components:
3921
3932
  locations:
3922
3933
  callout:
3923
3934
  - name: name
3924
- description: description
3925
3935
  tag: tag
3926
3936
  - name: name
3927
- description: description
3928
3937
  tag: tag
3929
3938
  left:
3930
3939
  - name: name
3931
- description: description
3932
3940
  tag: tag
3933
3941
  - name: name
3934
- description: description
3935
3942
  tag: tag
3936
3943
  right:
3937
3944
  - name: name
3938
- description: description
3939
3945
  tag: tag
3940
3946
  - name: name
3941
- description: description
3942
3947
  tag: tag
3943
3948
  tags:
3944
3949
  key: