Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Make schemas publicly visible for better documentation.

Matthew Kennedyfd7d14e36ef8
diff --git a/api/docs/oauth/index.yml b/api/docs/oauth/index.yml
index b558874078..d13546f117 100644
--- a/api/docs/oauth/index.yml
+++ b/api/docs/oauth/index.yml
@@ -139,7 +139,7 @@ components:
- expires_in
- refresh_token
- created_at
- x-internal: true
+ x-internal: false
CreateTokenBody:
type: object
x-examples:
@@ -152,7 +152,7 @@ components:
password: spree123
scope: admin
- x-internal: true
+ x-internal: false
title: 'Create a new token (grant_type: password)'
description: ''
properties:
@@ -186,7 +186,7 @@ components:
example-1:
grant_type: refresh_token
refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
- x-internal: true
+ x-internal: false
title: 'Create a new token (grant_type: client_credentials)'
description: ''
properties:
@@ -213,7 +213,7 @@ components:
example-1:
grant_type: refresh_token
refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
- x-internal: true
+ x-internal: false
title: 'Refresh an existing token (grant_type: refresh_token)'
description: ''
properties:
diff --git a/api/docs/v2/storefront/index.yaml b/api/docs/v2/storefront/index.yaml
index 8c8b04cb54..9414666964 100644
--- a/api/docs/v2/storefront/index.yaml
+++ b/api/docs/v2/storefront/index.yaml
@@ -1913,7 +1913,7 @@ components:
- id
- type
- attributes
- x-internal: true
+ x-internal: false
AddressPayload:
example:
firstname: John
@@ -1926,7 +1926,7 @@ components:
state_name: MD
country_iso: US
type: object
- x-internal: true
+ x-internal: false
title: ''
x-examples: {}
description: ''
@@ -1973,7 +1973,7 @@ components:
description: 'The Cart provides a central place to collect information about an order, including line items, adjustments, payments, addresses, and shipments. [Read more in Spree docs](https://dev-docs.spreecommerce.org/internals/orders)'
type: object
title: Cart
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2181,7 +2181,7 @@ components:
- attributes
- relationships
CartIncludes:
- x-internal: true
+ x-internal: false
title: Cart Includes
anyOf:
- $ref: '#/components/schemas/LineItem'
@@ -2197,7 +2197,7 @@ components:
type: object
title: CMS Page
description: 'The CMS Page model contains page data for Standard pages, Feature Pages and Homepages.'
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2250,7 +2250,7 @@ components:
- attributes
- relationships
CmsPageIncludes:
- x-internal: true
+ x-internal: false
title: CMS Page Includes
allOf:
- $ref: '#/components/schemas/CmsSection'
@@ -2259,7 +2259,7 @@ components:
type: object
title: CMS Section
description: The CMS Section model represents a single section belonging to a CMS Page. CMS Sections can link to other resources through the `linked_resource`.
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2361,7 +2361,7 @@ components:
title: Country
description: 'Countries within Spree are used as a container for states. Countries can be zone members, and also link to an address. The difference between one country and another on an address record can determine which tax rates and shipping methods are used for the order.[Read more about Countries in Spree](https://dev-docs.spreecommerce.org/internals/addresses#countries)'
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2407,14 +2407,14 @@ components:
- attributes
- relationships
CountryIncludes:
- x-internal: true
+ x-internal: false
title: Country Includes
oneOf:
- $ref: '#/components/schemas/State'
CreditCard:
title: Credit Card
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2467,12 +2467,12 @@ components:
- attributes
- relationships
CreditCardIncludes:
- x-internal: true
+ x-internal: false
title: Credit Card Includes
allOf:
- $ref: '#/components/schemas/PaymentMethod'
Error:
- x-internal: true
+ x-internal: false
title: Error
type: object
properties:
@@ -2482,7 +2482,7 @@ components:
type: object
description: 'The Icon object contains a url attribute pointing to an Active Storage asset. '
title: Icon
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2526,9 +2526,9 @@ components:
- type
- attributes
title: Image
- x-internal: true
+ x-internal: false
ImageStyle:
- x-internal: true
+ x-internal: false
title: Image Style
type: object
properties:
@@ -2545,7 +2545,7 @@ components:
example: 1080
description: Actual height of image
ListLinks:
- x-internal: true
+ x-internal: false
type: object
title: Pagination Links
properties:
@@ -2566,7 +2566,7 @@ components:
description: URL to the first page of the listing
ListMeta:
type: object
- x-internal: true
+ x-internal: false
title: Pagination Meta
properties:
count:
@@ -2584,7 +2584,7 @@ components:
LineItem:
title: Line Item
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2693,7 +2693,7 @@ components:
Menu:
type: object
title: Menu
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2734,7 +2734,7 @@ components:
MenuItem:
title: Menu Item
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2823,7 +2823,7 @@ components:
- attributes
- relationships
MenuIncludes:
- x-internal: true
+ x-internal: false
title: Menu Includes
anyOf:
- $ref: '#/components/schemas/MenuItem'
@@ -2834,7 +2834,7 @@ components:
OptionType:
title: Option Type
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2862,7 +2862,7 @@ components:
title: Payment
type: object
description: ''
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2918,7 +2918,7 @@ components:
title: Payment Method
description: ''
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -2948,7 +2948,7 @@ components:
Product:
type: object
title: Product
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3077,7 +3077,7 @@ components:
- attributes
- relationships
ProductIncludes:
- x-internal: true
+ x-internal: false
title: Product Includes
anyOf:
- $ref: '#/components/schemas/OptionType'
@@ -3086,7 +3086,7 @@ components:
- $ref: '#/components/schemas/Image'
- $ref: '#/components/schemas/Taxon'
StoreIncludes:
- x-internal: true
+ x-internal: false
title: Store Includes
anyOf:
- $ref: '#/components/schemas/Country'
@@ -3121,7 +3121,7 @@ components:
- id
- type
- attributes
- x-internal: true
+ x-internal: false
Promotion:
type: object
title: Promotion
@@ -3154,7 +3154,7 @@ components:
- id
- type
- attributes
- x-internal: true
+ x-internal: false
Relation:
type: object
nullable: true
@@ -3166,7 +3166,7 @@ components:
required:
- id
- type
- x-internal: true
+ x-internal: false
description: ''
State:
type: object
@@ -3181,12 +3181,12 @@ components:
type: string
example: New York
description: State name
- x-internal: true
+ x-internal: false
Store:
type: object
description: Stores are the center of the Spree ecosystem. Each Spree installation can have multiple Stores. Each Store operates on a different domain or subdomain.
title: Store
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3301,7 +3301,7 @@ components:
Shipment:
type: object
title: Shipment
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3371,7 +3371,7 @@ components:
- attributes
- relationships
ShipmentIncludes:
- x-internal: true
+ x-internal: false
title: Shipment Includes
allOf:
- $ref: '#/components/schemas/ShippingRate'
@@ -3380,7 +3380,7 @@ components:
type: object
title: Shipping Rate
description: ''
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3434,7 +3434,7 @@ components:
StockLocation:
title: Stock Location
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3455,7 +3455,7 @@ components:
Taxon:
title: Taxon
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3586,9 +3586,9 @@ components:
- type
- attributes
title: Taxon Image
- x-internal: true
+ x-internal: false
TaxonIncludes:
- x-internal: true
+ x-internal: false
title: Taxon Includes
anyOf:
- $ref: '#/components/schemas/Product'
@@ -3597,7 +3597,7 @@ components:
Taxonomy:
type: object
title: Taxonomy
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3622,7 +3622,7 @@ components:
type: string
format: date-time
example: '2020-02-16T07:14:54.617Z'
- x-internal: true
+ x-internal: false
title: Time Stamp
x-examples:
example-1: '2020-02-16T07:14:54.617Z'
@@ -3630,7 +3630,7 @@ components:
type: object
title: User
description: ' '
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3687,7 +3687,7 @@ components:
description: 'Variant records track the individual variants of a Product. Variants are of two types: master variants and normal variants.'
x-examples: {}
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3769,7 +3769,7 @@ components:
- relationships
WishedItem:
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3803,7 +3803,7 @@ components:
- attributes
- relationships
WishedItemIncludes:
- x-internal: true
+ x-internal: false
title: Wished Item Includes
allOf:
- $ref: '#/components/schemas/Variant'
@@ -3811,7 +3811,7 @@ components:
description: ''
type: object
title: Wishlist
- x-internal: true
+ x-internal: false
properties:
id:
type: string
@@ -3849,14 +3849,14 @@ components:
- attributes
- relationships
WishlistIncludes:
- x-internal: true
+ x-internal: false
title: Wishlist Includes
allOf:
- $ref: '#/components/schemas/WishedItem'
DigitalLink:
title: Digital Link
type: object
- x-internal: true
+ x-internal: false
properties:
id:
type: string