chore(docs): Generated API Reference (v2) (#8890)

Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-08-30 08:35:10 +02:00
committed by GitHub
parent 891037081d
commit 524be62312
749 changed files with 9092 additions and 52161 deletions

View File

@@ -9,12 +9,6 @@ servers:
- url: http://localhost:9000
- url: https://api.medusajs.com
tags:
- name: Auth
description: |
Auth API routes allow you to manage an admin user's authentication.
externalDocs:
description: Learn more about the Auth Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/auth
- name: Api Keys
description: >
API keys can be used for authentication or resource-scoping.
@@ -30,6 +24,8 @@ tags:
externalDocs:
description: Learn more about the API Key Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/api-key
x-associatedSchema:
$ref: ./components/schemas/AdminApiKey.yaml
- name: Campaigns
description: >
A campaign is a group of promotions that have the same conditions, such as
@@ -42,6 +38,8 @@ tags:
description: Learn more about campaigns.
url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/promotion/campaign
x-associatedSchema:
$ref: ./components/schemas/AdminCampaign.yaml
- name: Claims
description: >
An admin creates a claim for an order when a customer reports that an item
@@ -118,8 +116,6 @@ tags:
externalDocs:
description: Learn more about the Order Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/order
x-associatedSchema:
$ref: ./components/schemas/AdminOrder.yaml
- name: Exchanges
description: >
An exchange is the replacement of an item that the customer ordered with
@@ -225,8 +221,6 @@ tags:
externalDocs:
description: Learn more about the Order Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/order
x-associatedSchema:
$ref: ./components/schemas/OrderChange.yaml
- name: Orders
description: |
An order is a purchase made by a customer through a storefront.
@@ -347,6 +341,8 @@ tags:
externalDocs:
description: Learn more about the Product Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/product
x-associatedSchema:
$ref: ./components/schemas/AdminProductType.yaml
- name: Product Variants
description: >
A product variant is a saleable form of the product.
@@ -444,6 +440,8 @@ tags:
description: Learn more about reservations and other inventory concepts.
url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/inventory/concepts
x-associatedSchema:
$ref: ./components/schemas/AdminReservation.yaml
- name: Return Reasons
description: >
A return reason is a possible reason that an item is returned from the
@@ -597,8 +595,6 @@ tags:
externalDocs:
description: Check out available file module providers.
url: https://docs.medusajs.com/v2/resources/architectural-modules/file
x-associatedSchema:
$ref: ./components/schemas/AdminFile.yaml
- name: Users
description: >
A user is an admin user that can authenticate and perform functionalities
@@ -627,8 +623,6 @@ tags:
description: Check out available Workflow Engine Modules
url: >-
https://docs.medusajs.com/v2/resources/architectural-modules/workflow-engine
x-associatedSchema:
$ref: ./components/schemas/AdminWorkflowExecution.yaml
paths:
/admin/api-keys:
$ref: paths/admin_api-keys.yaml
@@ -786,6 +780,8 @@ paths:
$ref: paths/admin_orders_{id}_archive.yaml
/admin/orders/{id}/cancel:
$ref: paths/admin_orders_{id}_cancel.yaml
/admin/orders/{id}/changes:
$ref: paths/admin_orders_{id}_changes.yaml
/admin/orders/{id}/complete:
$ref: paths/admin_orders_{id}_complete.yaml
/admin/orders/{id}/fulfillments: