@searchspring/snapi-oas 0.1.17 → 0.1.22

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.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Snap API OpenAPI Specification v0.1.17
1
+ # Snap API OpenAPI Specification v0.1.22
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.17",
3
+ "version": "0.1.22",
4
4
  "description": "Snap OpenAPI Specification",
5
5
  "author": "Searchspring",
6
6
  "license": "MIT",
@@ -6,7 +6,7 @@
6
6
  },
7
7
  "description" : "Searchspring Snap Search API",
8
8
  "title" : "snAPI",
9
- "version" : "0.1.17",
9
+ "version" : "0.1.22",
10
10
  "x-logo" : {
11
11
  "url" : "./images/searchspring_logo.svg",
12
12
  "altText" : "Searchspring Snap"
@@ -929,7 +929,8 @@
929
929
  "totalResults" : 1305,
930
930
  "page" : 1,
931
931
  "defaultPageSize" : 24,
932
- "pageSize" : 2
932
+ "pageSize" : 2,
933
+ "totalPages" : 653
933
934
  },
934
935
  "results" : [ {
935
936
  "id" : "175130",
@@ -1887,7 +1888,8 @@
1887
1888
  "totalResults" : 758,
1888
1889
  "page" : 1,
1889
1890
  "defaultPageSize" : 24,
1890
- "pageSize" : 2
1891
+ "pageSize" : 2,
1892
+ "totalPages" : 379
1891
1893
  },
1892
1894
  "results" : [ {
1893
1895
  "id" : "134892",
@@ -3168,6 +3170,9 @@
3168
3170
  },
3169
3171
  "tracking" : {
3170
3172
  "$ref" : "#/components/schemas/SearchRequestModel_tracking"
3173
+ },
3174
+ "personalization" : {
3175
+ "$ref" : "#/components/schemas/SearchRequestModel_personalization"
3171
3176
  }
3172
3177
  },
3173
3178
  "title" : "Search Request Data Model",
@@ -3314,6 +3319,22 @@
3314
3319
  "description" : "Unique identifier of result",
3315
3320
  "type" : "string"
3316
3321
  },
3322
+ "sku" : {
3323
+ "description" : "SKU for result",
3324
+ "type" : "string"
3325
+ },
3326
+ "name" : {
3327
+ "description" : "Name for result",
3328
+ "type" : "string"
3329
+ },
3330
+ "url" : {
3331
+ "description" : "URL of result",
3332
+ "type" : "string"
3333
+ },
3334
+ "addToCartUrl" : {
3335
+ "description" : "Add to cart URL of result",
3336
+ "type" : "string"
3337
+ },
3317
3338
  "price" : {
3318
3339
  "description" : "Normal price of result",
3319
3340
  "type" : "number"
@@ -3322,29 +3343,37 @@
3322
3343
  "description" : "MSRP price of result",
3323
3344
  "type" : "number"
3324
3345
  },
3325
- "url" : {
3326
- "description" : "URL of result",
3346
+ "imageUrl" : {
3347
+ "description" : "Normal thumbnail image URL for result",
3327
3348
  "type" : "string"
3328
3349
  },
3329
3350
  "thumbnailImageUrl" : {
3330
3351
  "description" : "Smaller thumbnail image URL for result",
3331
3352
  "type" : "string"
3332
3353
  },
3333
- "imageUrl" : {
3334
- "description" : "Normal thumbnail image URL for result",
3354
+ "rating" : {
3355
+ "description" : "Review rating of result",
3356
+ "type" : "number"
3357
+ },
3358
+ "ratingCount" : {
3359
+ "description" : "Number of reviews for result",
3335
3360
  "type" : "string"
3336
3361
  },
3337
- "name" : {
3338
- "description" : "Name for result",
3362
+ "description" : {
3363
+ "description" : "Description of result",
3339
3364
  "type" : "string"
3340
3365
  },
3341
- "sku" : {
3342
- "description" : "SKU for result",
3366
+ "stockMessage" : {
3367
+ "description" : "Stock Message of result",
3343
3368
  "type" : "string"
3344
3369
  },
3345
3370
  "brand" : {
3346
3371
  "description" : "Brand of result",
3347
3372
  "type" : "string"
3373
+ },
3374
+ "popularity" : {
3375
+ "description" : "Popularity rating of result",
3376
+ "type" : "number"
3348
3377
  }
3349
3378
  },
3350
3379
  "title" : "Result Core Field Mappings",
@@ -3709,7 +3738,33 @@
3709
3738
  },
3710
3739
  "SearchRequestModel_tracking" : {
3711
3740
  "properties" : {
3712
- "loggedInUserId" : {
3741
+ "userId" : {
3742
+ "description" : "shopper identifier",
3743
+ "type" : "string"
3744
+ },
3745
+ "domain" : {
3746
+ "description" : "current website url",
3747
+ "type" : "string"
3748
+ }
3749
+ },
3750
+ "type" : "object"
3751
+ },
3752
+ "SearchRequestModel_personalization" : {
3753
+ "properties" : {
3754
+ "disabled" : {
3755
+ "description" : "ignore personalized boosts",
3756
+ "type" : "boolean"
3757
+ },
3758
+ "cart" : {
3759
+ "description" : "comma-separated list of the products in cart",
3760
+ "type" : "string"
3761
+ },
3762
+ "lastViewed" : {
3763
+ "description" : "comma-separated list of the last viewed products",
3764
+ "type" : "string"
3765
+ },
3766
+ "shopper" : {
3767
+ "description" : "logged in shopper identifier",
3713
3768
  "type" : "string"
3714
3769
  }
3715
3770
  },
@@ -3771,6 +3826,9 @@
3771
3826
  },
3772
3827
  "pageSize" : {
3773
3828
  "type" : "integer"
3829
+ },
3830
+ "totalPages" : {
3831
+ "type" : "integer"
3774
3832
  }
3775
3833
  },
3776
3834
  "type" : "object"
@@ -4,7 +4,7 @@ info:
4
4
  name: Searchspring
5
5
  description: Searchspring Snap Search API
6
6
  title: snAPI
7
- version: 0.1.17
7
+ version: 0.1.22
8
8
  x-logo:
9
9
  url: ./images/searchspring_logo.svg
10
10
  altText: Searchspring Snap
@@ -841,6 +841,7 @@ components:
841
841
  page: 1
842
842
  defaultPageSize: 24
843
843
  pageSize: 2
844
+ totalPages: 653
844
845
  results:
845
846
  - id: "175130"
846
847
  mappings:
@@ -1676,6 +1677,7 @@ components:
1676
1677
  page: 1
1677
1678
  defaultPageSize: 24
1678
1679
  pageSize: 2
1680
+ totalPages: 379
1679
1681
  results:
1680
1682
  - id: "134892"
1681
1683
  mappings:
@@ -2726,6 +2728,11 @@ components:
2726
2728
  - $ref: '#/components/schemas/SearchResponseModel'
2727
2729
  SearchRequestModel:
2728
2730
  example:
2731
+ personalization:
2732
+ lastViewed: lastViewed
2733
+ shopper: shopper
2734
+ disabled: true
2735
+ cart: cart
2729
2736
  search:
2730
2737
  query:
2731
2738
  string: string
@@ -2756,7 +2763,8 @@ components:
2756
2763
  - segments
2757
2764
  - segments
2758
2765
  tracking:
2759
- loggedInUserId: loggedInUserId
2766
+ domain: domain
2767
+ userId: userId
2760
2768
  facets:
2761
2769
  valueLimit: 5
2762
2770
  include:
@@ -2788,6 +2796,8 @@ components:
2788
2796
  $ref: '#/components/schemas/SearchRequestModel_merchandising'
2789
2797
  tracking:
2790
2798
  $ref: '#/components/schemas/SearchRequestModel_tracking'
2799
+ personalization:
2800
+ $ref: '#/components/schemas/SearchRequestModel_personalization'
2791
2801
  title: Search Request Data Model
2792
2802
  type: object
2793
2803
  SearchRequestModelFilter:
@@ -2830,6 +2840,7 @@ components:
2830
2840
  pagination:
2831
2841
  totalResults: 0
2832
2842
  defaultPageSize: 1
2843
+ totalPages: 5
2833
2844
  pageSize: 5
2834
2845
  page: 6
2835
2846
  sorting:
@@ -2847,40 +2858,58 @@ components:
2847
2858
  results:
2848
2859
  - mappings:
2849
2860
  core:
2861
+ addToCartUrl: addToCartUrl
2862
+ rating: 9.301444243932576
2863
+ description: description
2864
+ ratingCount: ratingCount
2865
+ url: url
2866
+ stockMessage: stockMessage
2850
2867
  uid: uid
2851
2868
  thumbnailImageUrl: thumbnailImageUrl
2852
- price: 5.637376656633329
2853
- msrp: 2.3021358869347655
2869
+ price: 2.3021358869347655
2870
+ msrp: 7.061401241503109
2854
2871
  imageUrl: imageUrl
2872
+ popularity: 3.616076749251911
2855
2873
  name: name
2856
2874
  sku: sku
2857
2875
  brand: brand
2858
- url: url
2859
2876
  children:
2860
2877
  - mappings:
2861
2878
  core:
2879
+ addToCartUrl: addToCartUrl
2880
+ rating: 9.301444243932576
2881
+ description: description
2882
+ ratingCount: ratingCount
2883
+ url: url
2884
+ stockMessage: stockMessage
2862
2885
  uid: uid
2863
2886
  thumbnailImageUrl: thumbnailImageUrl
2864
- price: 5.637376656633329
2865
- msrp: 2.3021358869347655
2887
+ price: 2.3021358869347655
2888
+ msrp: 7.061401241503109
2866
2889
  imageUrl: imageUrl
2890
+ popularity: 3.616076749251911
2867
2891
  name: name
2868
2892
  sku: sku
2869
2893
  brand: brand
2870
- url: url
2871
2894
  attributes:
2872
2895
  key: '{}'
2873
2896
  - mappings:
2874
2897
  core:
2898
+ addToCartUrl: addToCartUrl
2899
+ rating: 9.301444243932576
2900
+ description: description
2901
+ ratingCount: ratingCount
2902
+ url: url
2903
+ stockMessage: stockMessage
2875
2904
  uid: uid
2876
2905
  thumbnailImageUrl: thumbnailImageUrl
2877
- price: 5.637376656633329
2878
- msrp: 2.3021358869347655
2906
+ price: 2.3021358869347655
2907
+ msrp: 7.061401241503109
2879
2908
  imageUrl: imageUrl
2909
+ popularity: 3.616076749251911
2880
2910
  name: name
2881
2911
  sku: sku
2882
2912
  brand: brand
2883
- url: url
2884
2913
  attributes:
2885
2914
  key: '{}'
2886
2915
  attributes:
@@ -2888,40 +2917,58 @@ components:
2888
2917
  id: id
2889
2918
  - mappings:
2890
2919
  core:
2920
+ addToCartUrl: addToCartUrl
2921
+ rating: 9.301444243932576
2922
+ description: description
2923
+ ratingCount: ratingCount
2924
+ url: url
2925
+ stockMessage: stockMessage
2891
2926
  uid: uid
2892
2927
  thumbnailImageUrl: thumbnailImageUrl
2893
- price: 5.637376656633329
2894
- msrp: 2.3021358869347655
2928
+ price: 2.3021358869347655
2929
+ msrp: 7.061401241503109
2895
2930
  imageUrl: imageUrl
2931
+ popularity: 3.616076749251911
2896
2932
  name: name
2897
2933
  sku: sku
2898
2934
  brand: brand
2899
- url: url
2900
2935
  children:
2901
2936
  - mappings:
2902
2937
  core:
2938
+ addToCartUrl: addToCartUrl
2939
+ rating: 9.301444243932576
2940
+ description: description
2941
+ ratingCount: ratingCount
2942
+ url: url
2943
+ stockMessage: stockMessage
2903
2944
  uid: uid
2904
2945
  thumbnailImageUrl: thumbnailImageUrl
2905
- price: 5.637376656633329
2906
- msrp: 2.3021358869347655
2946
+ price: 2.3021358869347655
2947
+ msrp: 7.061401241503109
2907
2948
  imageUrl: imageUrl
2949
+ popularity: 3.616076749251911
2908
2950
  name: name
2909
2951
  sku: sku
2910
2952
  brand: brand
2911
- url: url
2912
2953
  attributes:
2913
2954
  key: '{}'
2914
2955
  - mappings:
2915
2956
  core:
2957
+ addToCartUrl: addToCartUrl
2958
+ rating: 9.301444243932576
2959
+ description: description
2960
+ ratingCount: ratingCount
2961
+ url: url
2962
+ stockMessage: stockMessage
2916
2963
  uid: uid
2917
2964
  thumbnailImageUrl: thumbnailImageUrl
2918
- price: 5.637376656633329
2919
- msrp: 2.3021358869347655
2965
+ price: 2.3021358869347655
2966
+ msrp: 7.061401241503109
2920
2967
  imageUrl: imageUrl
2968
+ popularity: 3.616076749251911
2921
2969
  name: name
2922
2970
  sku: sku
2923
2971
  brand: brand
2924
- url: url
2925
2972
  attributes:
2926
2973
  key: '{}'
2927
2974
  attributes:
@@ -2933,11 +2980,11 @@ components:
2933
2980
  inline:
2934
2981
  - config:
2935
2982
  position:
2936
- index: 7.061401241503109
2983
+ index: 2.027123023002322
2937
2984
  value: value
2938
2985
  - config:
2939
2986
  position:
2940
- index: 7.061401241503109
2987
+ index: 2.027123023002322
2941
2988
  value: value
2942
2989
  footer:
2943
2990
  - footer
@@ -3018,40 +3065,58 @@ components:
3018
3065
  example:
3019
3066
  mappings:
3020
3067
  core:
3068
+ addToCartUrl: addToCartUrl
3069
+ rating: 9.301444243932576
3070
+ description: description
3071
+ ratingCount: ratingCount
3072
+ url: url
3073
+ stockMessage: stockMessage
3021
3074
  uid: uid
3022
3075
  thumbnailImageUrl: thumbnailImageUrl
3023
- price: 5.637376656633329
3024
- msrp: 2.3021358869347655
3076
+ price: 2.3021358869347655
3077
+ msrp: 7.061401241503109
3025
3078
  imageUrl: imageUrl
3079
+ popularity: 3.616076749251911
3026
3080
  name: name
3027
3081
  sku: sku
3028
3082
  brand: brand
3029
- url: url
3030
3083
  children:
3031
3084
  - mappings:
3032
3085
  core:
3086
+ addToCartUrl: addToCartUrl
3087
+ rating: 9.301444243932576
3088
+ description: description
3089
+ ratingCount: ratingCount
3090
+ url: url
3091
+ stockMessage: stockMessage
3033
3092
  uid: uid
3034
3093
  thumbnailImageUrl: thumbnailImageUrl
3035
- price: 5.637376656633329
3036
- msrp: 2.3021358869347655
3094
+ price: 2.3021358869347655
3095
+ msrp: 7.061401241503109
3037
3096
  imageUrl: imageUrl
3097
+ popularity: 3.616076749251911
3038
3098
  name: name
3039
3099
  sku: sku
3040
3100
  brand: brand
3041
- url: url
3042
3101
  attributes:
3043
3102
  key: '{}'
3044
3103
  - mappings:
3045
3104
  core:
3105
+ addToCartUrl: addToCartUrl
3106
+ rating: 9.301444243932576
3107
+ description: description
3108
+ ratingCount: ratingCount
3109
+ url: url
3110
+ stockMessage: stockMessage
3046
3111
  uid: uid
3047
3112
  thumbnailImageUrl: thumbnailImageUrl
3048
- price: 5.637376656633329
3049
- msrp: 2.3021358869347655
3113
+ price: 2.3021358869347655
3114
+ msrp: 7.061401241503109
3050
3115
  imageUrl: imageUrl
3116
+ popularity: 3.616076749251911
3051
3117
  name: name
3052
3118
  sku: sku
3053
3119
  brand: brand
3054
- url: url
3055
3120
  attributes:
3056
3121
  key: '{}'
3057
3122
  attributes:
@@ -3077,43 +3142,67 @@ components:
3077
3142
  SearchResponseModelResultCoreMappings:
3078
3143
  description: Mapping of core fields for the result object
3079
3144
  example:
3145
+ addToCartUrl: addToCartUrl
3146
+ rating: 9.301444243932576
3147
+ description: description
3148
+ ratingCount: ratingCount
3149
+ url: url
3150
+ stockMessage: stockMessage
3080
3151
  uid: uid
3081
3152
  thumbnailImageUrl: thumbnailImageUrl
3082
- price: 5.637376656633329
3083
- msrp: 2.3021358869347655
3153
+ price: 2.3021358869347655
3154
+ msrp: 7.061401241503109
3084
3155
  imageUrl: imageUrl
3156
+ popularity: 3.616076749251911
3085
3157
  name: name
3086
3158
  sku: sku
3087
3159
  brand: brand
3088
- url: url
3089
3160
  properties:
3090
3161
  uid:
3091
3162
  description: Unique identifier of result
3092
3163
  type: string
3164
+ sku:
3165
+ description: SKU for result
3166
+ type: string
3167
+ name:
3168
+ description: Name for result
3169
+ type: string
3170
+ url:
3171
+ description: URL of result
3172
+ type: string
3173
+ addToCartUrl:
3174
+ description: Add to cart URL of result
3175
+ type: string
3093
3176
  price:
3094
3177
  description: Normal price of result
3095
3178
  type: number
3096
3179
  msrp:
3097
3180
  description: MSRP price of result
3098
3181
  type: number
3099
- url:
3100
- description: URL of result
3182
+ imageUrl:
3183
+ description: Normal thumbnail image URL for result
3101
3184
  type: string
3102
3185
  thumbnailImageUrl:
3103
3186
  description: Smaller thumbnail image URL for result
3104
3187
  type: string
3105
- imageUrl:
3106
- description: Normal thumbnail image URL for result
3188
+ rating:
3189
+ description: Review rating of result
3190
+ type: number
3191
+ ratingCount:
3192
+ description: Number of reviews for result
3107
3193
  type: string
3108
- name:
3109
- description: Name for result
3194
+ description:
3195
+ description: Description of result
3110
3196
  type: string
3111
- sku:
3112
- description: SKU for result
3197
+ stockMessage:
3198
+ description: Stock Message of result
3113
3199
  type: string
3114
3200
  brand:
3115
3201
  description: Brand of result
3116
3202
  type: string
3203
+ popularity:
3204
+ description: Popularity rating of result
3205
+ type: number
3117
3206
  title: Result Core Field Mappings
3118
3207
  type: object
3119
3208
  SearchResponseModelResultAttributes:
@@ -3162,11 +3251,11 @@ components:
3162
3251
  inline:
3163
3252
  - config:
3164
3253
  position:
3165
- index: 7.061401241503109
3254
+ index: 2.027123023002322
3166
3255
  value: value
3167
3256
  - config:
3168
3257
  position:
3169
- index: 7.061401241503109
3258
+ index: 2.027123023002322
3170
3259
  value: value
3171
3260
  footer:
3172
3261
  - footer
@@ -3444,9 +3533,34 @@ components:
3444
3533
  type: object
3445
3534
  SearchRequestModel_tracking:
3446
3535
  example:
3447
- loggedInUserId: loggedInUserId
3536
+ domain: domain
3537
+ userId: userId
3448
3538
  properties:
3449
- loggedInUserId:
3539
+ userId:
3540
+ description: shopper identifier
3541
+ type: string
3542
+ domain:
3543
+ description: current website url
3544
+ type: string
3545
+ type: object
3546
+ SearchRequestModel_personalization:
3547
+ example:
3548
+ lastViewed: lastViewed
3549
+ shopper: shopper
3550
+ disabled: true
3551
+ cart: cart
3552
+ properties:
3553
+ disabled:
3554
+ description: ignore personalized boosts
3555
+ type: boolean
3556
+ cart:
3557
+ description: comma-separated list of the products in cart
3558
+ type: string
3559
+ lastViewed:
3560
+ description: comma-separated list of the last viewed products
3561
+ type: string
3562
+ shopper:
3563
+ description: logged in shopper identifier
3450
3564
  type: string
3451
3565
  type: object
3452
3566
  SearchRequestModelFilterValue_allOf:
@@ -3485,6 +3599,7 @@ components:
3485
3599
  example:
3486
3600
  totalResults: 0
3487
3601
  defaultPageSize: 1
3602
+ totalPages: 5
3488
3603
  pageSize: 5
3489
3604
  page: 6
3490
3605
  properties:
@@ -3496,6 +3611,8 @@ components:
3496
3611
  type: integer
3497
3612
  pageSize:
3498
3613
  type: integer
3614
+ totalPages:
3615
+ type: integer
3499
3616
  type: object
3500
3617
  SearchResponseModel_sorting:
3501
3618
  example:
@@ -3513,15 +3630,21 @@ components:
3513
3630
  SearchResponseModelResult_mappings:
3514
3631
  example:
3515
3632
  core:
3633
+ addToCartUrl: addToCartUrl
3634
+ rating: 9.301444243932576
3635
+ description: description
3636
+ ratingCount: ratingCount
3637
+ url: url
3638
+ stockMessage: stockMessage
3516
3639
  uid: uid
3517
3640
  thumbnailImageUrl: thumbnailImageUrl
3518
- price: 5.637376656633329
3519
- msrp: 2.3021358869347655
3641
+ price: 2.3021358869347655
3642
+ msrp: 7.061401241503109
3520
3643
  imageUrl: imageUrl
3644
+ popularity: 3.616076749251911
3521
3645
  name: name
3522
3646
  sku: sku
3523
3647
  brand: brand
3524
- url: url
3525
3648
  properties:
3526
3649
  core:
3527
3650
  $ref: '#/components/schemas/SearchResponseModelResultCoreMappings'
@@ -3530,15 +3653,21 @@ components:
3530
3653
  example:
3531
3654
  mappings:
3532
3655
  core:
3656
+ addToCartUrl: addToCartUrl
3657
+ rating: 9.301444243932576
3658
+ description: description
3659
+ ratingCount: ratingCount
3660
+ url: url
3661
+ stockMessage: stockMessage
3533
3662
  uid: uid
3534
3663
  thumbnailImageUrl: thumbnailImageUrl
3535
- price: 5.637376656633329
3536
- msrp: 2.3021358869347655
3664
+ price: 2.3021358869347655
3665
+ msrp: 7.061401241503109
3537
3666
  imageUrl: imageUrl
3667
+ popularity: 3.616076749251911
3538
3668
  name: name
3539
3669
  sku: sku
3540
3670
  brand: brand
3541
- url: url
3542
3671
  attributes:
3543
3672
  key: '{}'
3544
3673
  properties:
@@ -3600,7 +3729,7 @@ components:
3600
3729
  type: object
3601
3730
  SearchResponseModelMerchandising_content_config_position:
3602
3731
  example:
3603
- index: 7.061401241503109
3732
+ index: 2.027123023002322
3604
3733
  properties:
3605
3734
  index:
3606
3735
  type: number
@@ -3608,7 +3737,7 @@ components:
3608
3737
  SearchResponseModelMerchandising_content_config:
3609
3738
  example:
3610
3739
  position:
3611
- index: 7.061401241503109
3740
+ index: 2.027123023002322
3612
3741
  properties:
3613
3742
  position:
3614
3743
  $ref: '#/components/schemas/SearchResponseModelMerchandising_content_config_position'
@@ -3617,7 +3746,7 @@ components:
3617
3746
  example:
3618
3747
  config:
3619
3748
  position:
3620
- index: 7.061401241503109
3749
+ index: 2.027123023002322
3621
3750
  value: value
3622
3751
  properties:
3623
3752
  config:
@@ -3630,11 +3759,11 @@ components:
3630
3759
  inline:
3631
3760
  - config:
3632
3761
  position:
3633
- index: 7.061401241503109
3762
+ index: 2.027123023002322
3634
3763
  value: value
3635
3764
  - config:
3636
3765
  position:
3637
- index: 7.061401241503109
3766
+ index: 2.027123023002322
3638
3767
  value: value
3639
3768
  footer:
3640
3769
  - footer