chore(docs): Generated API Reference (#5601)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-11-10 14:27:17 +02:00
parent 02e2ee4e8a
commit 01d4047976
496 changed files with 1456 additions and 867 deletions
@@ -15,6 +15,7 @@ properties:
    example: 16128234334802
  company:
    type: string
+    description: Company
  address_1:
    description: Address line 1
    type: string
@@ -8,10 +8,14 @@ allOf:
      - modules
    properties:
      payment_providers:
+        description: The store's payment providers.
        $ref: ./PaymentProvider.yaml
      fulfillment_providers:
+        description: The store's fulfillment providers.
        $ref: ./FulfillmentProvider.yaml
      feature_flags:
+        description: The feature flags enabled in the store's backend.
        $ref: ./FeatureFlagsResponse.yaml
      modules:
+        description: The modules installed in the store's backend.
        $ref: ./ModulesResponse.yaml
@@ -2,6 +2,10 @@ type: object
 required:
  - sku
 properties:
+  id:
+    description: The inventory item's ID.
+    type: string
+    example: iitem_12334
  sku:
    description: The Stock Keeping Unit (SKU) code of the Inventory Item.
    type: string
@@ -59,7 +59,7 @@ properties:
    $ref: ./Region.yaml
  currency_code:
    description: >-
-      The 3 character ISO code for the currency this payment collection is
+      The three character ISO code for the currency this payment collection is
      associated with.
    type: string
    example: usd
@@ -5,6 +5,7 @@ allOf:
  - type: object
    properties:
      variants:
+        description: The product variants and their prices.
        type: array
        items:
          $ref: ./PricedVariant.yaml
@@ -25,6 +25,10 @@ properties:
    description: The product category's name
    type: string
    example: Regular Fit
+  description:
+    description: The product category's description.
+    type: string
+    default: ''
  handle:
    description: >-
      A unique string that identifies the Product Category - can for example be
@@ -30,7 +30,7 @@ properties:
    type: string
    example: EU
  currency_code:
-    description: The 3 character currency code used in the region.
+    description: The three character currency code used in the region.
    type: string
    example: usd
    externalDocs:
@@ -3,4 +3,5 @@ allOf:
  - type: object
    properties:
      sales_channels:
+        description: The associated sales channels.
        $ref: ./SalesChannel.yaml
@@ -24,8 +24,9 @@ properties:
    description: The name of the Store - this may be displayed to the Customer.
    type: string
    example: Medusa Store
+    default: Medusa Store
  default_currency_code:
-    description: The 3 character currency code that is the default of the store.
+    description: The three character currency code that is the default of the store.
    type: string
    example: usd
    externalDocs:
@@ -34,6 +35,7 @@ properties:
  default_currency:
    description: The details of the store's default currency.
    x-expandable: default_currency
+    default: usd
    nullable: true
    $ref: ./Currency.yaml
  currencies:
@@ -1,4 +1,5 @@
 type: object
+description: The customer's details.
 x-expanded-relations:
  field: customer
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The access token details.
 properties:
  access_token:
    description: Access token that can be used to send authenticated requests.
@@ -1,4 +1,5 @@
 type: object
+description: The cart's details.
 x-expanded-relations:
  field: cart
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The list of product collections with pagination fields.
 required:
  - collections
  - count
@@ -1,4 +1,5 @@
 type: object
+description: The details of the product collection.
 required:
  - collection
 properties:
@@ -1,4 +1,8 @@
 type: object
+description: >-
+  If the cart is completed successfully, this will have the created order or the
+  swap's details, based on the cart's type. Otherwise, it'll be the cart's
+  details.
 required:
  - type
  - data
@@ -1,4 +1,5 @@
 type: object
+description: The list of the customer's orders with pagination fields.
 x-expanded-relations:
  field: orders
  relations:
@@ -1,10 +1,11 @@
 type: object
+description: The payment method's details.
 required:
  - payment_methods
 properties:
  payment_methods:
    type: array
-    description: An array of saved payment method details.
+    description: The details of the saved payment methods.
    items:
      type: object
      required:
@@ -1,4 +1,5 @@
 type: object
+description: The customer's details.
 x-expanded-relations:
  field: customer
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: Details on whether the email exists.
 required:
  - exists
 properties:
@@ -1,4 +1,5 @@
 type: object
+description: The product category's details.
 x-expanded-relations:
  field: product_category
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The list of product categories with pagination fields.
 x-expanded-relations:
  field: product_categories
  relations:
@@ -1,3 +1,4 @@
+description: The gift card's details.
 type: object
 required:
  - gift_card
@@ -1,4 +1,5 @@
 type: object
+description: The order edit's details.
 x-expanded-relations:
  field: order_edit
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The order's details.
 required:
  - order
 x-expanded-relations:
@@ -1,4 +1,5 @@
 type: object
+description: The payment collection's details.
 x-expanded-relations:
  field: payment_collection
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The details of the cart to be created.
 properties:
  region_id:
    type: string
@@ -25,7 +26,7 @@ properties:
  country_code:
    type: string
    description: >-
-      The 2 character ISO country code to create the Cart in. Setting this
+      The two character ISO country code to create the Cart in. Setting this
      parameter will set the country code of the shipping address.
    externalDocs:
      url: >-
@@ -4,8 +4,8 @@ required:
 properties:
  sessions:
    description: >-
-      An array of payment sessions related to the Payment Collection. Existing
-      sessions that are not added in this array will be deleted.
+      Payment sessions related to the Payment Collection. Existing sessions that
+      are not added in this array will be deleted.
    type: array
    items:
      type: object
@@ -1,3 +1,4 @@
+description: The list of search results.
 allOf:
  - type: object
    required:
@@ -1,4 +1,5 @@
 type: object
+description: The list of product tags with pagination fields.
 required:
  - product_tags
  - count
@@ -1,4 +1,5 @@
 type: object
+description: The list of products with pagination fields.
 x-expanded-relations:
  field: products
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The list of regions with pagination fields.
 x-expanded-relations:
  field: regions
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The region's details.
 x-expanded-relations:
  field: region
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The list of return reasons.
 x-expanded-relations:
  field: return_reasons
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The return reason's details.
 x-expanded-relations:
  field: return_reason
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The return's details.
 x-expanded-relations:
  field: return
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The list of shipping options.
 x-expanded-relations:
  field: shipping_options
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The swap's details.
 x-expanded-relations:
  field: swap
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The list of product variants.
 x-expanded-relations:
  field: variants
  relations:
@@ -1,4 +1,5 @@
 type: object
+description: The product variant's details.
 x-expanded-relations:
  field: variant
  relations: