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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Make schemas publicly visible for better documentation.
Matthew Kennedyfd7d14e36ef8
diff --git a/api/docs/oauth/index.yml b/api/docs/oauth/index.ymlindex 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: falseCreateTokenBody:type: objectx-examples:@@ -152,7 +152,7 @@ components:username: [email protected]password: spree123scope: admin- x-internal: true+ x-internal: falsetitle: 'Create a new token (grant_type: password)'description: ''properties:@@ -186,7 +186,7 @@ components:example-1:grant_type: refresh_tokenrefresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k- x-internal: true+ x-internal: falsetitle: 'Create a new token (grant_type: client_credentials)'description: ''properties:@@ -213,7 +213,7 @@ components:example-1:grant_type: refresh_tokenrefresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k- x-internal: true+ x-internal: falsetitle: '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.yamlindex 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: falseAddressPayload:example:firstname: John@@ -1926,7 +1926,7 @@ components:state_name: MDcountry_iso: UStype: object- x-internal: true+ x-internal: falsetitle: ''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: objecttitle: Cart- x-internal: true+ x-internal: falseproperties:id:type: string@@ -2181,7 +2181,7 @@ components:- attributes- relationshipsCartIncludes:- x-internal: true+ x-internal: falsetitle: Cart IncludesanyOf:- $ref: '#/components/schemas/LineItem'@@ -2197,7 +2197,7 @@ components:type: objecttitle: CMS Pagedescription: 'The CMS Page model contains page data for Standard pages, Feature Pages and Homepages.'- x-internal: true+ x-internal: falseproperties:id:type: string@@ -2250,7 +2250,7 @@ components:- attributes- relationshipsCmsPageIncludes:- x-internal: true+ x-internal: falsetitle: CMS Page IncludesallOf:- $ref: '#/components/schemas/CmsSection'@@ -2259,7 +2259,7 @@ components:type: objecttitle: CMS Sectiondescription: 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: falseproperties:id:type: string@@ -2361,7 +2361,7 @@ components:title: Countrydescription: '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: falseproperties:id:type: string@@ -2407,14 +2407,14 @@ components:- attributes- relationshipsCountryIncludes:- x-internal: true+ x-internal: falsetitle: Country IncludesoneOf:- $ref: '#/components/schemas/State'CreditCard:title: Credit Cardtype: object- x-internal: true+ x-internal: falseproperties:id:type: string@@ -2467,12 +2467,12 @@ components:- attributes- relationshipsCreditCardIncludes:- x-internal: true+ x-internal: falsetitle: Credit Card IncludesallOf:- $ref: '#/components/schemas/PaymentMethod'Error:- x-internal: true+ x-internal: falsetitle: Errortype: objectproperties:@@ -2482,7 +2482,7 @@ components:type: objectdescription: 'The Icon object contains a url attribute pointing to an Active Storage asset. 'title: Icon- x-internal: true+ x-internal: falseproperties:id:type: string@@ -2526,9 +2526,9 @@ components:- type- attributestitle: Image- x-internal: true+ x-internal: falseImageStyle:- x-internal: true+ x-internal: falsetitle: Image Styletype: objectproperties:@@ -2545,7 +2545,7 @@ components:example: 1080description: Actual height of imageListLinks:- x-internal: true+ x-internal: falsetype: objecttitle: Pagination Linksproperties:@@ -2566,7 +2566,7 @@ components:description: URL to the first page of the listingListMeta:type: object- x-internal: true+ x-internal: falsetitle: Pagination Metaproperties:count:@@ -2584,7 +2584,7 @@ components:LineItem:title: Line Itemtype: object- x-internal: true+ x-internal: falseproperties:id:type: string@@ -2693,7 +2693,7 @@ components:Menu:type: objecttitle: Menu- x-internal: true+ x-internal: falseproperties:id:type: string@@ -2734,7 +2734,7 @@ components:MenuItem:title: Menu Itemtype: object- x-internal: true+ x-internal: falseproperties:id:type: string@@ -2823,7 +2823,7 @@ components:- attributes- relationshipsMenuIncludes:- x-internal: true+ x-internal: falsetitle: Menu IncludesanyOf:- $ref: '#/components/schemas/MenuItem'@@ -2834,7 +2834,7 @@ components:OptionType:title: Option Typetype: object- x-internal: true+ x-internal: falseproperties:id:type: string@@ -2862,7 +2862,7 @@ components:title: Paymenttype: objectdescription: ''- x-internal: true+ x-internal: falseproperties:id:type: string@@ -2918,7 +2918,7 @@ components:title: Payment Methoddescription: ''type: object- x-internal: true+ x-internal: falseproperties:id:type: string@@ -2948,7 +2948,7 @@ components:Product:type: objecttitle: Product- x-internal: true+ x-internal: falseproperties:id:type: string@@ -3077,7 +3077,7 @@ components:- attributes- relationshipsProductIncludes:- x-internal: true+ x-internal: falsetitle: Product IncludesanyOf:- $ref: '#/components/schemas/OptionType'@@ -3086,7 +3086,7 @@ components:- $ref: '#/components/schemas/Image'- $ref: '#/components/schemas/Taxon'StoreIncludes:- x-internal: true+ x-internal: falsetitle: Store IncludesanyOf:- $ref: '#/components/schemas/Country'@@ -3121,7 +3121,7 @@ components:- id- type- attributes- x-internal: true+ x-internal: falsePromotion:type: objecttitle: Promotion@@ -3154,7 +3154,7 @@ components:- id- type- attributes- x-internal: true+ x-internal: falseRelation:type: objectnullable: true@@ -3166,7 +3166,7 @@ components:required:- id- type- x-internal: true+ x-internal: falsedescription: ''State:type: object@@ -3181,12 +3181,12 @@ components:type: stringexample: New Yorkdescription: State name- x-internal: true+ x-internal: falseStore:type: objectdescription: 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: falseproperties:id:type: string@@ -3301,7 +3301,7 @@ components:Shipment:type: objecttitle: Shipment- x-internal: true+ x-internal: falseproperties:id:type: string@@ -3371,7 +3371,7 @@ components:- attributes- relationshipsShipmentIncludes:- x-internal: true+ x-internal: falsetitle: Shipment IncludesallOf:- $ref: '#/components/schemas/ShippingRate'@@ -3380,7 +3380,7 @@ components:type: objecttitle: Shipping Ratedescription: ''- x-internal: true+ x-internal: falseproperties:id:type: string@@ -3434,7 +3434,7 @@ components:StockLocation:title: Stock Locationtype: object- x-internal: true+ x-internal: falseproperties:id:type: string@@ -3455,7 +3455,7 @@ components:Taxon:title: Taxontype: object- x-internal: true+ x-internal: falseproperties:id:type: string@@ -3586,9 +3586,9 @@ components:- type- attributestitle: Taxon Image- x-internal: true+ x-internal: falseTaxonIncludes:- x-internal: true+ x-internal: falsetitle: Taxon IncludesanyOf:- $ref: '#/components/schemas/Product'@@ -3597,7 +3597,7 @@ components:Taxonomy:type: objecttitle: Taxonomy- x-internal: true+ x-internal: falseproperties:id:type: string@@ -3622,7 +3622,7 @@ components:type: stringformat: date-timeexample: '2020-02-16T07:14:54.617Z'- x-internal: true+ x-internal: falsetitle: Time Stampx-examples:example-1: '2020-02-16T07:14:54.617Z'@@ -3630,7 +3630,7 @@ components:type: objecttitle: Userdescription: ' '- x-internal: true+ x-internal: falseproperties: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: falseproperties:id:type: string@@ -3769,7 +3769,7 @@ components:- relationshipsWishedItem:type: object- x-internal: true+ x-internal: falseproperties:id:type: string@@ -3803,7 +3803,7 @@ components:- attributes- relationshipsWishedItemIncludes:- x-internal: true+ x-internal: falsetitle: Wished Item IncludesallOf:- $ref: '#/components/schemas/Variant'@@ -3811,7 +3811,7 @@ components:description: ''type: objecttitle: Wishlist- x-internal: true+ x-internal: falseproperties:id:type: string@@ -3849,14 +3849,14 @@ components:- attributes- relationshipsWishlistIncludes:- x-internal: true+ x-internal: falsetitle: Wishlist IncludesallOf:- $ref: '#/components/schemas/WishedItem'DigitalLink:title: Digital Linktype: object- x-internal: true+ x-internal: falseproperties:id:type: string