docs: prep for v2 documentation (#6710)
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
This commit is contained in:
Shahed Nasser
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AllocationType
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# CartType
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ClaimFulfillmentStatus
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ClaimPaymentStatus
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ClaimReason
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ClaimType
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# DiscountConditionOperator
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# DiscountConditionType
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# DiscountRuleType
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# DraftOrderStatus
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# FulfillmentStatus
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# OrderEditItemChangeType
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# OrderEditStatus
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# OrderStatus
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# PaymentCollectionStatus
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# PaymentCollectionType
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# PaymentSessionStatus
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# PaymentStatus
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ProductStatus
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# RefundReason
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# RequirementType
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ReturnStatus
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ShippingOptionPriceType
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ShippingProfileType
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# SwapFulfillmentStatus
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# SwapPaymentStatus
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# UserRoles
|
||||
|
||||
|
||||
Reference in New Issue
Block a user