docs/v2/storefront/index.yaml in spree_api-4.4.0.rc1 vs docs/v2/storefront/index.yaml in spree_api-4.4.0.rc2
- old
+ new
@@ -769,13 +769,13 @@
type: object
properties:
gateway_payment_profile_id:
type: string
month:
- type: string
+ type: number
year:
- type: string
+ type: number
cc_type:
type: string
name:
type: string
required:
@@ -817,12 +817,12 @@
- payment_method_id: '1'
source_attributes:
gateway_payment_profile_id: ABC123
cc_type: visa
last_digits: '1111'
- month: '10'
- year: '2022'
+ month: 10
+ year: 2022
name: John Doe
description: |-
##### Add Customer Details
Adding customer details is achieved by passing the customer-related attributes shown in the corresponding request body example.
@@ -1006,14 +1006,14 @@
- amex
last_digits:
type: string
description: Last 4 digits of CC number
month:
- type: string
+ type: number
description: Expiration date month
year:
- type: string
+ type: number
description: Expiration date year
name:
type: string
description: Card holder name
required:
@@ -1027,12 +1027,12 @@
payment_method_id: '1'
source_attributes:
gateway_payment_profile_id: card_1JqvNB2eZvKYlo2C5OlqLV7S
cc_type: visa
last_digits: '1111'
- month: '10'
- year: '2026'
+ month: 10
+ year: 2026
name: John Snow
Use existing Credit Card:
value:
payment_method_id: '1'
source_id: '1'
@@ -1859,10 +1859,11 @@
example: California
state_code:
type: string
example: CA
description: State abbreviation
+ nullable: true
country_name:
type: string
example: United States of America
country_iso3:
type: string
@@ -2392,12 +2393,10 @@
type: string
example: credit_card
default: credit_card
attributes:
type: object
- required:
- - relationships
properties:
cc_type:
type: string
enum:
- visa
@@ -2407,37 +2406,38 @@
last_digits:
type: string
example: '1111'
description: Last 4 digits of CC number
month:
- type: string
+ type: number
description: Expiration date month
- example: '12'
+ example: 12
year:
- type: string
- example: '2026'
+ type: number
+ example: 2026
description: Expiration date year
name:
type: string
example: John Doe
description: Card holder name
default:
type: boolean
example: true
description: Defines if this is the default CC for a signed in user
- relationships:
- type: object
- properties:
- payment_method:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
+ relationships:
+ type: object
+ properties:
+ payment_method:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
+ - relationships
CreditCardIncludes:
x-internal: true
title: Credit Card Includes
allOf:
- $ref: '#/components/schemas/PaymentMethod'
@@ -2470,38 +2470,33 @@
- type
- attributes
Image:
type: object
properties:
- data:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: image
+ attributes:
type: object
- required:
- - id
- - type
- - attributes
properties:
- id:
- type: string
- example: '1'
- type:
- type: string
- default: image
- attributes:
- type: object
- properties:
- position:
- type: integer
- description: Sort order of images set in the Admin Panel
- example: 0
- minimum: 0
- styles:
- type: array
- description: An array of pre-scaled image styles
- items:
- $ref: '#/components/schemas/ImageStyle'
+ position:
+ type: integer
+ description: Sort order of images set in the Admin Panel
+ example: 0
+ minimum: 0
+ styles:
+ type: array
+ description: An array of pre-scaled image styles
+ items:
+ $ref: '#/components/schemas/ImageStyle'
required:
- - data
+ - id
+ - type
+ - attributes
title: Image
x-internal: true
ImageStyle:
x-internal: true
title: Image Style
@@ -2809,37 +2804,32 @@
OptionType:
title: Option Type
type: object
x-internal: true
properties:
- data:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: option_type
+ attributes:
type: object
- required:
- - id
- - type
- - attributes
properties:
- id:
+ name:
type: string
- example: '1'
- type:
+ example: color
+ presentation:
type: string
- default: option_type
- attributes:
- type: object
- properties:
- name:
- type: string
- example: color
- presentation:
- type: string
- example: Color
- position:
- type: integer
- example: 1
+ example: Color
+ position:
+ type: integer
+ example: 1
required:
- - data
+ - id
+ - type
+ - attributes
Payment:
title: Payment
type: object
description: ''
x-internal: true
@@ -2916,10 +2906,11 @@
type: string
example: Stripe
description:
type: string
example: Stripe Payments
+ nullable: true
preferences:
type: object
required:
- id
- type
@@ -2942,25 +2933,29 @@
type: string
example: Example product
description:
type: string
example: Example description
+ nullable: true
available_on:
type: string
example: '2012-10-17T03:43:57Z'
+ nullable: true
slug:
type: string
example: example-product
price:
type: string
example: '15.99'
+ nullable: true
currency:
type: string
example: USD
display_price:
type: string
example: $15.99
+ nullable: true
purchasable:
type: boolean
description: Indicates if any of Variants are in stock or backorderable
in_stock:
type: boolean
@@ -3062,40 +3057,35 @@
- $ref: '#/components/schemas/Taxon'
ProductProperty:
title: Product Property
type: object
properties:
- data:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: product_property
+ attributes:
type: object
- required:
- - id
- - type
- - attributes
properties:
- id:
+ value:
type: string
- example: '1'
- type:
+ example: Wilson
+ filter_param:
type: string
- default: product_property
- attributes:
- type: object
- properties:
- value:
- type: string
- example: Wilson
- filter_param:
- type: string
- example: wilson
- name:
- type: string
- example: manufacturer
- description:
- type: string
- example: Manufacturer
+ example: wilson
+ name:
+ type: string
+ example: manufacturer
+ description:
+ type: string
+ example: Manufacturer
required:
- - data
+ - id
+ - type
+ - attributes
x-internal: true
Promotion:
type: object
title: Promotion
properties:
@@ -3418,37 +3408,32 @@
- attributes
- relationships
TaxonImage:
type: object
properties:
- data:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: taxon_image
+ attributes:
type: object
- required:
- - id
- - type
- - attributes
properties:
- id:
- type: string
- example: '1'
- type:
- type: string
- default: taxon_image
- attributes:
- type: object
- properties:
- position:
- type: integer
- example: 0
- description: Sort order of images set in the Admin Panel
- styles:
- type: array
- description: An array of pre-scaled image styles
- items:
- $ref: '#/components/schemas/ImageStyle'
+ position:
+ type: integer
+ example: 0
+ description: Sort order of images set in the Admin Panel
+ styles:
+ type: array
+ description: An array of pre-scaled image styles
+ items:
+ $ref: '#/components/schemas/ImageStyle'
required:
- - data
+ - id
+ - type
+ - attributes
title: Taxon Image
x-internal: true
TaxonIncludes:
x-internal: true
title: Taxon Includes
@@ -6052,12 +6037,12 @@
id: '1'
type: credit_card
attributes:
cc_type: visa
last_digits: '4111'
- month: '12'
- year: '2026'
+ month: 12
+ year: 2026
name: John Doe
default: true
relationships:
payment_method:
data:
@@ -6101,12 +6086,12 @@
- id: '1'
type: credit_card
attributes:
cc_type: visa
last_digits: '1111'
- month: '12'
- year: '2026'
+ month: 12
+ year: 2026
name: John Doe
default: true
relationships:
payment_method:
data:
@@ -6115,11 +6100,11 @@
- id: '2'
type: credit_card
attributes:
cc_type: mastercard
last_digits: '6695'
- month: '12'
- year: '2030'
+ month: 12
+ year: 2030
name: John Doe
default: false
relationships:
payment_method:
data: