@searchspring/snapi-oas 0.1.20 → 0.1.24

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 +36 -8
  4. package/spec/v1/snapi.oas.v1.yaml +46 -132
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Snap API OpenAPI Specification v0.1.20
1
+ # Snap API OpenAPI Specification v0.1.24
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.20",
3
+ "version": "0.1.24",
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.20",
9
+ "version" : "0.1.24",
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",
@@ -3693,6 +3698,9 @@
3693
3698
  },
3694
3699
  "SearchRequestModel_facets" : {
3695
3700
  "properties" : {
3701
+ "autoDrillDown" : {
3702
+ "type" : "boolean"
3703
+ },
3696
3704
  "limit" : {
3697
3705
  "type" : "integer"
3698
3706
  },
@@ -3733,10 +3741,33 @@
3733
3741
  },
3734
3742
  "SearchRequestModel_tracking" : {
3735
3743
  "properties" : {
3736
- "loggedInUserId" : {
3744
+ "userId" : {
3745
+ "description" : "shopper identifier",
3737
3746
  "type" : "string"
3738
3747
  },
3739
- "userId" : {
3748
+ "domain" : {
3749
+ "description" : "current website url",
3750
+ "type" : "string"
3751
+ }
3752
+ },
3753
+ "type" : "object"
3754
+ },
3755
+ "SearchRequestModel_personalization" : {
3756
+ "properties" : {
3757
+ "disabled" : {
3758
+ "description" : "ignore personalized boosts",
3759
+ "type" : "boolean"
3760
+ },
3761
+ "cart" : {
3762
+ "description" : "comma-separated list of the products in cart",
3763
+ "type" : "string"
3764
+ },
3765
+ "lastViewed" : {
3766
+ "description" : "comma-separated list of the last viewed products",
3767
+ "type" : "string"
3768
+ },
3769
+ "shopper" : {
3770
+ "description" : "logged in shopper identifier",
3740
3771
  "type" : "string"
3741
3772
  }
3742
3773
  },
@@ -3827,9 +3858,6 @@
3827
3858
  },
3828
3859
  "SearchResponseModelResult_children" : {
3829
3860
  "properties" : {
3830
- "mappings" : {
3831
- "$ref" : "#/components/schemas/SearchResponseModelResult_mappings"
3832
- },
3833
3861
  "attributes" : {
3834
3862
  "$ref" : "#/components/schemas/SearchResponseModelResultAttributes"
3835
3863
  }
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.20
7
+ version: 0.1.24
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,9 +2763,10 @@ components:
2756
2763
  - segments
2757
2764
  - segments
2758
2765
  tracking:
2759
- loggedInUserId: loggedInUserId
2766
+ domain: domain
2760
2767
  userId: userId
2761
2768
  facets:
2769
+ autoDrillDown: true
2762
2770
  valueLimit: 5
2763
2771
  include:
2764
2772
  - include
@@ -2789,6 +2797,8 @@ components:
2789
2797
  $ref: '#/components/schemas/SearchRequestModel_merchandising'
2790
2798
  tracking:
2791
2799
  $ref: '#/components/schemas/SearchRequestModel_tracking'
2800
+ personalization:
2801
+ $ref: '#/components/schemas/SearchRequestModel_personalization'
2792
2802
  title: Search Request Data Model
2793
2803
  type: object
2794
2804
  SearchRequestModelFilter:
@@ -2865,43 +2875,9 @@ components:
2865
2875
  sku: sku
2866
2876
  brand: brand
2867
2877
  children:
2868
- - mappings:
2869
- core:
2870
- addToCartUrl: addToCartUrl
2871
- rating: 9.301444243932576
2872
- description: description
2873
- ratingCount: ratingCount
2874
- url: url
2875
- stockMessage: stockMessage
2876
- uid: uid
2877
- thumbnailImageUrl: thumbnailImageUrl
2878
- price: 2.3021358869347655
2879
- msrp: 7.061401241503109
2880
- imageUrl: imageUrl
2881
- popularity: 3.616076749251911
2882
- name: name
2883
- sku: sku
2884
- brand: brand
2885
- attributes:
2878
+ - attributes:
2886
2879
  key: '{}'
2887
- - mappings:
2888
- core:
2889
- addToCartUrl: addToCartUrl
2890
- rating: 9.301444243932576
2891
- description: description
2892
- ratingCount: ratingCount
2893
- url: url
2894
- stockMessage: stockMessage
2895
- uid: uid
2896
- thumbnailImageUrl: thumbnailImageUrl
2897
- price: 2.3021358869347655
2898
- msrp: 7.061401241503109
2899
- imageUrl: imageUrl
2900
- popularity: 3.616076749251911
2901
- name: name
2902
- sku: sku
2903
- brand: brand
2904
- attributes:
2880
+ - attributes:
2905
2881
  key: '{}'
2906
2882
  attributes:
2907
2883
  key: '{}'
@@ -2924,43 +2900,9 @@ components:
2924
2900
  sku: sku
2925
2901
  brand: brand
2926
2902
  children:
2927
- - mappings:
2928
- core:
2929
- addToCartUrl: addToCartUrl
2930
- rating: 9.301444243932576
2931
- description: description
2932
- ratingCount: ratingCount
2933
- url: url
2934
- stockMessage: stockMessage
2935
- uid: uid
2936
- thumbnailImageUrl: thumbnailImageUrl
2937
- price: 2.3021358869347655
2938
- msrp: 7.061401241503109
2939
- imageUrl: imageUrl
2940
- popularity: 3.616076749251911
2941
- name: name
2942
- sku: sku
2943
- brand: brand
2944
- attributes:
2903
+ - attributes:
2945
2904
  key: '{}'
2946
- - mappings:
2947
- core:
2948
- addToCartUrl: addToCartUrl
2949
- rating: 9.301444243932576
2950
- description: description
2951
- ratingCount: ratingCount
2952
- url: url
2953
- stockMessage: stockMessage
2954
- uid: uid
2955
- thumbnailImageUrl: thumbnailImageUrl
2956
- price: 2.3021358869347655
2957
- msrp: 7.061401241503109
2958
- imageUrl: imageUrl
2959
- popularity: 3.616076749251911
2960
- name: name
2961
- sku: sku
2962
- brand: brand
2963
- attributes:
2905
+ - attributes:
2964
2906
  key: '{}'
2965
2907
  attributes:
2966
2908
  key: '{}'
@@ -3072,43 +3014,9 @@ components:
3072
3014
  sku: sku
3073
3015
  brand: brand
3074
3016
  children:
3075
- - mappings:
3076
- core:
3077
- addToCartUrl: addToCartUrl
3078
- rating: 9.301444243932576
3079
- description: description
3080
- ratingCount: ratingCount
3081
- url: url
3082
- stockMessage: stockMessage
3083
- uid: uid
3084
- thumbnailImageUrl: thumbnailImageUrl
3085
- price: 2.3021358869347655
3086
- msrp: 7.061401241503109
3087
- imageUrl: imageUrl
3088
- popularity: 3.616076749251911
3089
- name: name
3090
- sku: sku
3091
- brand: brand
3092
- attributes:
3017
+ - attributes:
3093
3018
  key: '{}'
3094
- - mappings:
3095
- core:
3096
- addToCartUrl: addToCartUrl
3097
- rating: 9.301444243932576
3098
- description: description
3099
- ratingCount: ratingCount
3100
- url: url
3101
- stockMessage: stockMessage
3102
- uid: uid
3103
- thumbnailImageUrl: thumbnailImageUrl
3104
- price: 2.3021358869347655
3105
- msrp: 7.061401241503109
3106
- imageUrl: imageUrl
3107
- popularity: 3.616076749251911
3108
- name: name
3109
- sku: sku
3110
- brand: brand
3111
- attributes:
3019
+ - attributes:
3112
3020
  key: '{}'
3113
3021
  attributes:
3114
3022
  key: '{}'
@@ -3483,6 +3391,7 @@ components:
3483
3391
  type: object
3484
3392
  SearchRequestModel_facets:
3485
3393
  example:
3394
+ autoDrillDown: true
3486
3395
  valueLimit: 5
3487
3396
  include:
3488
3397
  - include
@@ -3492,6 +3401,8 @@ components:
3492
3401
  - exclude
3493
3402
  - exclude
3494
3403
  properties:
3404
+ autoDrillDown:
3405
+ type: boolean
3495
3406
  limit:
3496
3407
  type: integer
3497
3408
  valueLimit:
@@ -3524,12 +3435,34 @@ components:
3524
3435
  type: object
3525
3436
  SearchRequestModel_tracking:
3526
3437
  example:
3527
- loggedInUserId: loggedInUserId
3438
+ domain: domain
3528
3439
  userId: userId
3529
3440
  properties:
3530
- loggedInUserId:
3531
- type: string
3532
3441
  userId:
3442
+ description: shopper identifier
3443
+ type: string
3444
+ domain:
3445
+ description: current website url
3446
+ type: string
3447
+ type: object
3448
+ SearchRequestModel_personalization:
3449
+ example:
3450
+ lastViewed: lastViewed
3451
+ shopper: shopper
3452
+ disabled: true
3453
+ cart: cart
3454
+ properties:
3455
+ disabled:
3456
+ description: ignore personalized boosts
3457
+ type: boolean
3458
+ cart:
3459
+ description: comma-separated list of the products in cart
3460
+ type: string
3461
+ lastViewed:
3462
+ description: comma-separated list of the last viewed products
3463
+ type: string
3464
+ shopper:
3465
+ description: logged in shopper identifier
3533
3466
  type: string
3534
3467
  type: object
3535
3468
  SearchRequestModelFilterValue_allOf:
@@ -3620,28 +3553,9 @@ components:
3620
3553
  type: object
3621
3554
  SearchResponseModelResult_children:
3622
3555
  example:
3623
- mappings:
3624
- core:
3625
- addToCartUrl: addToCartUrl
3626
- rating: 9.301444243932576
3627
- description: description
3628
- ratingCount: ratingCount
3629
- url: url
3630
- stockMessage: stockMessage
3631
- uid: uid
3632
- thumbnailImageUrl: thumbnailImageUrl
3633
- price: 2.3021358869347655
3634
- msrp: 7.061401241503109
3635
- imageUrl: imageUrl
3636
- popularity: 3.616076749251911
3637
- name: name
3638
- sku: sku
3639
- brand: brand
3640
3556
  attributes:
3641
3557
  key: '{}'
3642
3558
  properties:
3643
- mappings:
3644
- $ref: '#/components/schemas/SearchResponseModelResult_mappings'
3645
3559
  attributes:
3646
3560
  additionalProperties: true
3647
3561
  description: Additional fields for results - these are site specific fields