fix(oas): patch circular references in docs (#3285)

## What

Patch OAS circular references that causes the documentation to crash

## Test

* Run `yarn openapi:generate`
* Run `yarn redocly preview-docs docs/api/admin/openapi.yaml --config=./docs-util/redocly/config.yaml`
* Open preview docs url in a browser
* Expect the page to not crash

* Repeat with `yarn redocly preview-docs docs/api/store/openapi.yaml --config=./docs-util/redocly/config.yaml`
This commit is contained in:
Patrick
2023-02-17 12:42:11 +00:00
committed by GitHub
parent f88af0c28d
commit 9690f07bc0
2 changed files with 65 additions and 1 deletions
+5
View File
@@ -0,0 +1,5 @@
---
"@medusajs/medusa": patch
---
fix(oas): patch circular references in docs
+60 -1
View File
@@ -5,7 +5,7 @@ plugins:
# when Redocly attempts to render circular references. # when Redocly attempts to render circular references.
decorators: decorators:
plugin/circular-patch: plugin/circular-patch:
verbose: true verbose: false
schemas: schemas:
Address: Address:
- Customer - Customer
@@ -13,14 +13,26 @@ decorators:
- Customer - Customer
- Order - Order
- Payment - Payment
- PaymentSession
ClaimImage:
- ClaimItem
ClaimItem: ClaimItem:
- ClaimOrder - ClaimOrder
ClaimOrder: ClaimOrder:
- Fulfillment - Fulfillment
- Order - Order
- Return - Return
Country:
- Region
Customer: Customer:
- Order - Order
CustomerGroup:
- Customer
- PriceList
Discount:
- Discount
DiscountRule:
- DiscountCondition
DraftOrder: DraftOrder:
- Cart - Cart
- Order - Order
@@ -28,6 +40,8 @@ decorators:
- ClaimOrder - ClaimOrder
- Order - Order
- Swap - Swap
FulfillmentItem:
- Fulfillment
GiftCard: GiftCard:
- Order - Order
GiftCardTransaction: GiftCardTransaction:
@@ -39,6 +53,16 @@ decorators:
- Order - Order
- OrderEdit - OrderEdit
- Swap - Swap
LineItemAdjustment:
- LineItem
LineItemTaxLine:
- LineItem
MoneyAmount:
- PriceList
- ProductVariant
- Region
Notification:
- Notification
Order: Order:
- Cart - Cart
- ClaimOrder - ClaimOrder
@@ -52,10 +76,26 @@ decorators:
- Swap - Swap
OrderEdit: OrderEdit:
- Order - Order
OrderItemChange:
- OrderEdit
Payment: Payment:
- Cart - Cart
- Order - Order
- Swap - Swap
ProductCategory:
- ProductCategory
- Product
ProductCollection:
- Product
ProductOption:
- Product
ProductOptionValue:
- ProductOption
- ProductVariant
ProductVariant:
- Product
ProductVariantInventoryItem:
- ProductVariant
Refund: Refund:
- Order - Order
- Payment - Payment
@@ -63,6 +103,12 @@ decorators:
- ClaimOrder - ClaimOrder
- Order - Order
- Swap - Swap
ReturnItem:
- Return
ReturnReason:
- ReturnReason
SalesChannelLocation:
- SalesChannel
ShippingMethod: ShippingMethod:
- Cart - Cart
- ClaimOrder - ClaimOrder
@@ -70,12 +116,25 @@ decorators:
- Payment - Payment
- Return - Return
- Swap - Swap
ShippingMethodTaxLine:
- ShippingMethod
ShippingOption:
- Region
ShippingOptionRequirement:
- ShippingOption
ShippingProfile:
- Product
- ShippingOption
Swap: Swap:
- Cart - Cart
- Fulfillment - Fulfillment
- Order - Order
- Payment - Payment
- Return - Return
TaxRate:
- Region
TrackingLink:
- Fulfillment
# Similar config to /www/docs/docusaurus.config.js > redocusaurus # Similar config to /www/docs/docusaurus.config.js > redocusaurus
# Allows to emulate rendering of API public documentation when using `yarn redocly preview-docs openapi.yaml` # Allows to emulate rendering of API public documentation when using `yarn redocly preview-docs openapi.yaml`