spree_api 4.4.0.rc1 → 4.4.0.rc2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/app/controllers/spree/api/v2/base_controller.rb +1 -0
  3. data/docs/v2/platform/index.yaml +724 -725
  4. data/docs/v2/storefront/index.yaml +109 -124
  5. metadata +7 -7
data/docs/v2/storefront/index.yaml CHANGED
@@ -771,9 +771,9 @@ paths:
771
771
  gateway_payment_profile_id:
772
772
  type: string
773
773
  month:
774
- type: string
774
+ type: number
775
775
  year:
776
- type: string
776
+ type: number
777
777
  cc_type:
778
778
  type: string
779
779
  name:
@@ -819,8 +819,8 @@ paths:
819
819
  gateway_payment_profile_id: ABC123
820
820
  cc_type: visa
821
821
  last_digits: '1111'
822
- month: '10'
823
- year: '2022'
822
+ month: 10
823
+ year: 2022
824
824
  name: John Doe
825
825
  description: |-
826
826
  ##### Add Customer Details
@@ -1008,10 +1008,10 @@ paths:
1008
1008
  type: string
1009
1009
  description: Last 4 digits of CC number
1010
1010
  month:
1011
- type: string
1011
+ type: number
1012
1012
  description: Expiration date month
1013
1013
  year:
1014
- type: string
1014
+ type: number
1015
1015
  description: Expiration date year
1016
1016
  name:
1017
1017
  type: string
@@ -1029,8 +1029,8 @@ paths:
1029
1029
  gateway_payment_profile_id: card_1JqvNB2eZvKYlo2C5OlqLV7S
1030
1030
  cc_type: visa
1031
1031
  last_digits: '1111'
1032
- month: '10'
1033
- year: '2026'
1032
+ month: 10
1033
+ year: 2026
1034
1034
  name: John Snow
1035
1035
  Use existing Credit Card:
1036
1036
  value:
@@ -1861,6 +1861,7 @@ components:
1861
1861
  type: string
1862
1862
  example: CA
1863
1863
  description: State abbreviation
1864
+ nullable: true
1864
1865
  country_name:
1865
1866
  type: string
1866
1867
  example: United States of America
@@ -2394,8 +2395,6 @@ components:
2394
2395
  default: credit_card
2395
2396
  attributes:
2396
2397
  type: object
2397
- required:
2398
- - relationships
2399
2398
  properties:
2400
2399
  cc_type:
2401
2400
  type: string
@@ -2409,12 +2408,12 @@ components:
2409
2408
  example: '1111'
2410
2409
  description: Last 4 digits of CC number
2411
2410
  month:
2412
- type: string
2411
+ type: number
2413
2412
  description: Expiration date month
2414
- example: '12'
2413
+ example: 12
2415
2414
  year:
2416
- type: string
2417
- example: '2026'
2415
+ type: number
2416
+ example: 2026
2418
2417
  description: Expiration date year
2419
2418
  name:
2420
2419
  type: string
@@ -2424,18 +2423,19 @@ components:
2424
2423
  type: boolean
2425
2424
  example: true
2426
2425
  description: Defines if this is the default CC for a signed in user
2427
- relationships:
2428
- type: object
2429
- properties:
2430
- payment_method:
2431
- type: object
2432
- properties:
2433
- data:
2434
- $ref: '#/components/schemas/Relation'
2426
+ relationships:
2427
+ type: object
2428
+ properties:
2429
+ payment_method:
2430
+ type: object
2431
+ properties:
2432
+ data:
2433
+ $ref: '#/components/schemas/Relation'
2435
2434
  required:
2436
2435
  - id
2437
2436
  - type
2438
2437
  - attributes
2438
+ - relationships
2439
2439
  CreditCardIncludes:
2440
2440
  x-internal: true
2441
2441
  title: Credit Card Includes
@@ -2472,34 +2472,29 @@ components:
2472
2472
  Image:
2473
2473
  type: object
2474
2474
  properties:
2475
- data:
2475
+ id:
2476
+ type: string
2477
+ example: '1'
2478
+ type:
2479
+ type: string
2480
+ default: image
2481
+ attributes:
2476
2482
  type: object
2477
- required:
2478
- - id
2479
- - type
2480
- - attributes
2481
2483
  properties:
2482
- id:
2483
- type: string
2484
- example: '1'
2485
- type:
2486
- type: string
2487
- default: image
2488
- attributes:
2489
- type: object
2490
- properties:
2491
- position:
2492
- type: integer
2493
- description: Sort order of images set in the Admin Panel
2494
- example: 0
2495
- minimum: 0
2496
- styles:
2497
- type: array
2498
- description: An array of pre-scaled image styles
2499
- items:
2500
- $ref: '#/components/schemas/ImageStyle'
2484
+ position:
2485
+ type: integer
2486
+ description: Sort order of images set in the Admin Panel
2487
+ example: 0
2488
+ minimum: 0
2489
+ styles:
2490
+ type: array
2491
+ description: An array of pre-scaled image styles
2492
+ items:
2493
+ $ref: '#/components/schemas/ImageStyle'
2501
2494
  required:
2502
- - data
2495
+ - id
2496
+ - type
2497
+ - attributes
2503
2498
  title: Image
2504
2499
  x-internal: true
2505
2500
  ImageStyle:
@@ -2811,33 +2806,28 @@ components:
2811
2806
  type: object
2812
2807
  x-internal: true
2813
2808
  properties:
2814
- data:
2809
+ id:
2810
+ type: string
2811
+ example: '1'
2812
+ type:
2813
+ type: string
2814
+ default: option_type
2815
+ attributes:
2815
2816
  type: object
2816
- required:
2817
- - id
2818
- - type
2819
- - attributes
2820
2817
  properties:
2821
- id:
2818
+ name:
2822
2819
  type: string
2823
- example: '1'
2824
- type:
2820
+ example: color
2821
+ presentation:
2825
2822
  type: string
2826
- default: option_type
2827
- attributes:
2828
- type: object
2829
- properties:
2830
- name:
2831
- type: string
2832
- example: color
2833
- presentation:
2834
- type: string
2835
- example: Color
2836
- position:
2837
- type: integer
2838
- example: 1
2823
+ example: Color
2824
+ position:
2825
+ type: integer
2826
+ example: 1
2839
2827
  required:
2840
- - data
2828
+ - id
2829
+ - type
2830
+ - attributes
2841
2831
  Payment:
2842
2832
  title: Payment
2843
2833
  type: object
@@ -2918,6 +2908,7 @@ components:
2918
2908
  description:
2919
2909
  type: string
2920
2910
  example: Stripe Payments
2911
+ nullable: true
2921
2912
  preferences:
2922
2913
  type: object
2923
2914
  required:
@@ -2944,21 +2935,25 @@ components:
2944
2935
  description:
2945
2936
  type: string
2946
2937
  example: Example description
2938
+ nullable: true
2947
2939
  available_on:
2948
2940
  type: string
2949
2941
  example: '2012-10-17T03:43:57Z'
2942
+ nullable: true
2950
2943
  slug:
2951
2944
  type: string
2952
2945
  example: example-product
2953
2946
  price:
2954
2947
  type: string
2955
2948
  example: '15.99'
2949
+ nullable: true
2956
2950
  currency:
2957
2951
  type: string
2958
2952
  example: USD
2959
2953
  display_price:
2960
2954
  type: string
2961
2955
  example: $15.99
2956
+ nullable: true
2962
2957
  purchasable:
2963
2958
  type: boolean
2964
2959
  description: Indicates if any of Variants are in stock or backorderable
@@ -3064,36 +3059,31 @@ components:
3064
3059
  title: Product Property
3065
3060
  type: object
3066
3061
  properties:
3067
- data:
3062
+ id:
3063
+ type: string
3064
+ example: '1'
3065
+ type:
3066
+ type: string
3067
+ default: product_property
3068
+ attributes:
3068
3069
  type: object
3069
- required:
3070
- - id
3071
- - type
3072
- - attributes
3073
3070
  properties:
3074
- id:
3071
+ value:
3075
3072
  type: string
3076
- example: '1'
3077
- type:
3073
+ example: Wilson
3074
+ filter_param:
3078
3075
  type: string
3079
- default: product_property
3080
- attributes:
3081
- type: object
3082
- properties:
3083
- value:
3084
- type: string
3085
- example: Wilson
3086
- filter_param:
3087
- type: string
3088
- example: wilson
3089
- name:
3090
- type: string
3091
- example: manufacturer
3092
- description:
3093
- type: string
3094
- example: Manufacturer
3076
+ example: wilson
3077
+ name:
3078
+ type: string
3079
+ example: manufacturer
3080
+ description:
3081
+ type: string
3082
+ example: Manufacturer
3095
3083
  required:
3096
- - data
3084
+ - id
3085
+ - type
3086
+ - attributes
3097
3087
  x-internal: true
3098
3088
  Promotion:
3099
3089
  type: object
@@ -3420,33 +3410,28 @@ components:
3420
3410
  TaxonImage:
3421
3411
  type: object
3422
3412
  properties:
3423
- data:
3413
+ id:
3414
+ type: string
3415
+ example: '1'
3416
+ type:
3417
+ type: string
3418
+ default: taxon_image
3419
+ attributes:
3424
3420
  type: object
3425
- required:
3426
- - id
3427
- - type
3428
- - attributes
3429
3421
  properties:
3430
- id:
3431
- type: string
3432
- example: '1'
3433
- type:
3434
- type: string
3435
- default: taxon_image
3436
- attributes:
3437
- type: object
3438
- properties:
3439
- position:
3440
- type: integer
3441
- example: 0
3442
- description: Sort order of images set in the Admin Panel
3443
- styles:
3444
- type: array
3445
- description: An array of pre-scaled image styles
3446
- items:
3447
- $ref: '#/components/schemas/ImageStyle'
3422
+ position:
3423
+ type: integer
3424
+ example: 0
3425
+ description: Sort order of images set in the Admin Panel
3426
+ styles:
3427
+ type: array
3428
+ description: An array of pre-scaled image styles
3429
+ items:
3430
+ $ref: '#/components/schemas/ImageStyle'
3448
3431
  required:
3449
- - data
3432
+ - id
3433
+ - type
3434
+ - attributes
3450
3435
  title: Taxon Image
3451
3436
  x-internal: true
3452
3437
  TaxonIncludes:
@@ -6054,8 +6039,8 @@ components:
6054
6039
  attributes:
6055
6040
  cc_type: visa
6056
6041
  last_digits: '4111'
6057
- month: '12'
6058
- year: '2026'
6042
+ month: 12
6043
+ year: 2026
6059
6044
  name: John Doe
6060
6045
  default: true
6061
6046
  relationships:
@@ -6103,8 +6088,8 @@ components:
6103
6088
  attributes:
6104
6089
  cc_type: visa
6105
6090
  last_digits: '1111'
6106
- month: '12'
6107
- year: '2026'
6091
+ month: 12
6092
+ year: 2026
6108
6093
  name: John Doe
6109
6094
  default: true
6110
6095
  relationships:
@@ -6117,8 +6102,8 @@ components:
6117
6102
  attributes:
6118
6103
  cc_type: mastercard
6119
6104
  last_digits: '6695'
6120
- month: '12'
6121
- year: '2030'
6105
+ month: 12
6106
+ year: 2030
6122
6107
  name: John Doe
6123
6108
  default: false
6124
6109
  relationships:
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: spree_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.4.0.rc1
4
+ version: 4.4.0.rc2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ryan Bigg
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-12-04 00:00:00.000000000 Z
11
+ date: 2022-01-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: i18n-tasks
@@ -148,14 +148,14 @@ dependencies:
148
148
  requirements:
149
149
  - - '='
150
150
  - !ruby/object:Gem::Version
151
- version: 4.4.0.rc1
151
+ version: 4.4.0.rc2
152
152
  type: :runtime
153
153
  prerelease: false
154
154
  version_requirements: !ruby/object:Gem::Requirement
155
155
  requirements:
156
156
  - - '='
157
157
  - !ruby/object:Gem::Version
158
- version: 4.4.0.rc1
158
+ version: 4.4.0.rc2
159
159
  description: Spree's API
160
160
  email:
161
161
  - ryan@spreecommerce.com
@@ -559,9 +559,9 @@ licenses:
559
559
  - BSD-3-Clause
560
560
  metadata:
561
561
  bug_tracker_uri: https://github.com/spree/spree/issues
562
- changelog_uri: https://github.com/spree/spree/releases/tag/v4.4.0.rc1
562
+ changelog_uri: https://github.com/spree/spree/releases/tag/v4.4.0.rc2
563
563
  documentation_uri: https://dev-docs.spreecommerce.org/
564
- source_code_uri: https://github.com/spree/spree/tree/v4.4.0.rc1
564
+ source_code_uri: https://github.com/spree/spree/tree/v4.4.0.rc2
565
565
  post_install_message:
566
566
  rdoc_options: []
567
567
  require_paths:
@@ -577,7 +577,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
577
577
  - !ruby/object:Gem::Version
578
578
  version: 1.3.1
579
579
  requirements: []
580
- rubygems_version: 3.2.22
580
+ rubygems_version: 3.2.32
581
581
  signing_key:
582
582
  specification_version: 4
583
583
  summary: Spree's API