asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

docs: enhance how references are generated (#5805)

Browse Source 
* adjusted configurations

* enhancements to tool and configurations

* change reference in docs

* fixed issue in workflows reference

* added project name

* more optimizations

* fix context error

* added a types reference

* resolved missing types

* fix reference reflection types not having children

* add an expand url parameter

* added new option to the README

* added details about new option
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-12-05 15:29:41 +02:00
1 parent a418e6cebc
commit 892d737c1f
4358 files changed
+947876 -534760
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/sidebars.js
+79 -79
View File
@@ -725,7 +725,7 @@ module.exports = {
},
{
type: "doc",
id: "references/fulfillment/classes/AbstractFulfillmentService",
id: "references/fulfillment/classes/fulfillment.AbstractFulfillmentService",
label: "Backend: Create Fulfillment Provider",
},
{
@@ -918,12 +918,12 @@ module.exports = {
},
{
type: "ref",
id: "references/inventory/interfaces/IInventoryService",
id: "references/inventory/interfaces/inventory.IInventoryService",
label: "Inventory Module Interface Reference",
},
{
type: "ref",
id: "references/stock-location/interfaces/IStockLocationService",
id: "references/stock_location/interfaces/stock_location.IStockLocationService",
label: "Stock Location Module Interface Reference",
},
{
@@ -1375,7 +1375,7 @@ module.exports = {
},
{
type: "ref",
id: "references/workflows/index",
id: "references/modules/workflows",
label: "API Reference",
},
],
@@ -1396,7 +1396,7 @@ module.exports = {
},
{
type: "ref",
id: "references/entities/classes/Address",
id: "references/entities/classes/entities.Address",
label: "Entities Reference",
},
{
@@ -1504,7 +1504,7 @@ module.exports = {
},
{
type: "ref",
id: "references/services/classes/AbstractBatchJobStrategy",
id: "references/services/classes/services.AnalyticsConfigService",
label: "Services Reference",
},
{
@@ -2730,7 +2730,7 @@ module.exports = {
},
{
type: "ref",
id: "references/pricing/interfaces/IPricingModuleService",
id: "references/pricing/interfaces/pricing.IPricingModuleService",
label: "Interface Reference",
},
],
@@ -2773,7 +2773,7 @@ module.exports = {
},
{
type: "ref",
id: "references/product/interfaces/IProductModuleService",
id: "references/product/interfaces/product.IProductModuleService",
label: "Interface Reference",
},
],
@@ -2835,204 +2835,204 @@ module.exports = {
collapsed: true,
link: {
type: "doc",
id: "references/js-client/classes/Admin",
id: "references/js_client/classes/js_client.Admin",
},
items: [
{
type: "doc",
id: "references/js-client/classes/AdminAuthResource",
id: "references/js_client/classes/js_client.AdminAuthResource",
label: "auth",
},
{
type: "doc",
id: "references/js-client/classes/AdminBatchJobsResource",
id: "references/js_client/classes/js_client.AdminBatchJobsResource",
label: "batchJobs",
},
{
type: "doc",
id: "references/js-client/classes/AdminCollectionsResource",
id: "references/js_client/classes/js_client.AdminCollectionsResource",
label: "collections",
},
{
type: "doc",
id: "references/js-client/classes/AdminCurrenciesResource",
id: "references/js_client/classes/js_client.AdminCurrenciesResource",
label: "currencies",
},
{
type: "doc",
id: "references/js-client/classes/AdminCustomResource",
id: "references/js_client/classes/js_client.AdminCustomResource",
label: "custom",
},
{
type: "doc",
id: "references/js-client/classes/AdminCustomerGroupsResource",
id: "references/js_client/classes/js_client.AdminCustomerGroupsResource",
label: "customerGroups",
},
{
type: "doc",
id: "references/js-client/classes/AdminCustomersResource",
id: "references/js_client/classes/js_client.AdminCustomersResource",
label: "customers",
},
{
type: "doc",
id: "references/js-client/classes/AdminDiscountsResource",
id: "references/js_client/classes/js_client.AdminDiscountsResource",
label: "discounts",
},
{
type: "doc",
id: "references/js-client/classes/AdminDraftOrdersResource",
id: "references/js_client/classes/js_client.AdminDraftOrdersResource",
label: "draftOrders",
},
{
type: "doc",
id: "references/js-client/classes/AdminGiftCardsResource",
id: "references/js_client/classes/js_client.AdminGiftCardsResource",
label: "giftCards",
},
{
type: "doc",
id: "references/js-client/classes/AdminInventoryItemsResource",
id: "references/js_client/classes/js_client.AdminInventoryItemsResource",
label: "inventoryItems",
},
{
type: "doc",
id: "references/js-client/classes/AdminInvitesResource",
id: "references/js_client/classes/js_client.AdminInvitesResource",
label: "invites",
},
{
type: "doc",
id: "references/js-client/classes/AdminNotesResource",
id: "references/js_client/classes/js_client.AdminNotesResource",
label: "notes",
},
{
type: "doc",
id: "references/js-client/classes/AdminNotificationsResource",
id: "references/js_client/classes/js_client.AdminNotificationsResource",
label: "notifications",
},
{
type: "doc",
id: "references/js-client/classes/AdminOrderEditsResource",
id: "references/js_client/classes/js_client.AdminOrderEditsResource",
label: "orderEdits",
},
{
type: "doc",
id: "references/js-client/classes/AdminOrdersResource",
id: "references/js_client/classes/js_client.AdminOrdersResource",
label: "orders",
},
{
type: "doc",
id: "references/js-client/classes/AdminPaymentCollectionsResource",
id: "references/js_client/classes/js_client.AdminPaymentCollectionsResource",
label: "paymentCollections",
},
{
type: "doc",
id: "references/js-client/classes/AdminPaymentsResource",
id: "references/js_client/classes/js_client.AdminPaymentsResource",
label: "payments",
},
{
type: "doc",
id: "references/js-client/classes/AdminPriceListResource",
id: "references/js_client/classes/js_client.AdminPriceListResource",
label: "priceLists",
},
{
type: "doc",
id: "references/js-client/classes/AdminProductCategoriesResource",
id: "references/js_client/classes/js_client.AdminProductCategoriesResource",
label: "productCategories",
},
{
type: "doc",
id: "references/js-client/classes/AdminProductTagsResource",
id: "references/js_client/classes/js_client.AdminProductTagsResource",
label: "productTags",
},
{
type: "doc",
id: "references/js-client/classes/AdminProductTypesResource",
id: "references/js_client/classes/js_client.AdminProductTypesResource",
label: "productTypes",
},
{
type: "doc",
id: "references/js-client/classes/AdminProductsResource",
id: "references/js_client/classes/js_client.AdminProductsResource",
label: "products",
},
{
type: "doc",
id: "references/js-client/classes/AdminPublishableApiKeyResource",
id: "references/js_client/classes/js_client.AdminPublishableApiKeyResource",
label: "publishableApiKeys",
},
{
type: "doc",
id: "references/js-client/classes/AdminRegionsResource",
id: "references/js_client/classes/js_client.AdminRegionsResource",
label: "regions",
},
{
type: "doc",
id: "references/js-client/classes/AdminReservationsResource",
id: "references/js_client/classes/js_client.AdminReservationsResource",
label: "reservations",
},
{
type: "doc",
id: "references/js-client/classes/AdminReturnReasonsResource",
id: "references/js_client/classes/js_client.AdminReturnReasonsResource",
label: "returnReasons",
},
{
type: "doc",
id: "references/js-client/classes/AdminReturnsResource",
id: "references/js_client/classes/js_client.AdminReturnsResource",
label: "returns",
},
{
type: "doc",
id: "references/js-client/classes/AdminSalesChannelsResource",
id: "references/js_client/classes/js_client.AdminSalesChannelsResource",
label: "salesChannels",
},
{
type: "doc",
id: "references/js-client/classes/AdminShippingOptionsResource",
id: "references/js_client/classes/js_client.AdminShippingOptionsResource",
label: "shippingOptions",
},
{
type: "doc",
id: "references/js-client/classes/AdminShippingProfilesResource",
id: "references/js_client/classes/js_client.AdminShippingProfilesResource",
label: "shippingProfiles",
},
{
type: "doc",
id: "references/js-client/classes/AdminStockLocationsResource",
id: "references/js_client/classes/js_client.AdminStockLocationsResource",
label: "stockLocations",
},
{
type: "doc",
id: "references/js-client/classes/AdminStoresResource",
id: "references/js_client/classes/js_client.AdminStoresResource",
label: "store",
},
{
type: "doc",
id: "references/js-client/classes/AdminSwapsResource",
id: "references/js_client/classes/js_client.AdminSwapsResource",
label: "swaps",
},
{
type: "doc",
id: "references/js-client/classes/AdminTaxRatesResource",
id: "references/js_client/classes/js_client.AdminTaxRatesResource",
label: "taxRates",
},
{
type: "doc",
id: "references/js-client/classes/AdminUploadsResource",
id: "references/js_client/classes/js_client.AdminUploadsResource",
label: "uploads",
},
{
type: "doc",
id: "references/js-client/classes/AdminUsersResource",
id: "references/js_client/classes/js_client.AdminUsersResource",
label: "users",
},
{
type: "doc",
id: "references/js-client/classes/AdminVariantsResource",
id: "references/js_client/classes/js_client.AdminVariantsResource",
label: "variants",
},
],
},
{
type: "doc",
id: "references/js-client/classes/AuthResource",
id: "references/js_client/classes/js_client.AuthResource",
label: "auth",
},
{
@@ -3040,20 +3040,20 @@ module.exports = {
label: "carts",
link: {
type: "doc",
id: "references/js-client/classes/CartsResource",
id: "references/js_client/classes/js_client.CartsResource",
},
collapsed: true,
items: [
{
type: "doc",
id: "references/js-client/classes/LineItemsResource",
id: "references/js_client/classes/js_client.LineItemsResource",
label: "lineItems",
},
],
},
{
type: "doc",
id: "references/js-client/classes/CollectionsResource",
id: "references/js_client/classes/js_client.CollectionsResource",
label: "collections",
},
{
@@ -3062,64 +3062,64 @@ module.exports = {
collapsed: true,
link: {
type: "doc",
id: "references/js-client/classes/CustomersResource",
id: "references/js_client/classes/js_client.CustomersResource",
},
items: [
{
type: "doc",
id: "references/js-client/classes/AddressesResource",
id: "references/js_client/classes/js_client.AddressesResource",
label: "addresses",
},
{
type: "doc",
id: "references/js-client/classes/PaymentMethodsResource",
id: "references/js_client/classes/js_client.PaymentMethodsResource",
label: "paymentMethods",
},
],
},
{
type: "doc",
id: "references/js-client/classes/GiftCardsResource",
id: "references/js_client/classes/js_client.GiftCardsResource",
label: "giftCards",
},
{
type: "doc",
id: "references/js-client/classes/OrderEditsResource",
id: "references/js_client/classes/js_client.OrderEditsResource",
label: "orderEdits",
},
{
type: "doc",
id: "references/js-client/classes/OrdersResource",
id: "references/js_client/classes/js_client.OrdersResource",
label: "orders",
},
{
type: "doc",
id: "references/js-client/classes/PaymentCollectionsResource",
id: "references/js_client/classes/js_client.PaymentCollectionsResource",
label: "paymentCollections",
},
{
type: "doc",
id: "references/js-client/classes/PaymentMethodsResource",
id: "references/js_client/classes/js_client.PaymentMethodsResource",
label: "paymentMethods",
},
{
type: "doc",
id: "references/js-client/classes/ProductCategoriesResource",
id: "references/js_client/classes/js_client.ProductCategoriesResource",
label: "productCategories",
},
{
type: "doc",
id: "references/js-client/classes/ProductTagsResource",
id: "references/js_client/classes/js_client.ProductTagsResource",
label: "productTags",
},
{
type: "doc",
id: "references/js-client/classes/ProductTypesResource",
id: "references/js_client/classes/js_client.ProductTypesResource",
label: "productTypes",
},
{
type: "doc",
id: "references/js-client/classes/ProductTypesResource",
id: "references/js_client/classes/js_client.ProductTypesResource",
label: "productTypes",
},
{
@@ -3127,40 +3127,40 @@ module.exports = {
label: "products",
link: {
type: "doc",
id: "references/js-client/classes/ProductsResource",
id: "references/js_client/classes/js_client.ProductsResource",
},
collapsed: true,
items: [
{
type: "doc",
id: "references/js-client/classes/ProductVariantsResource",
id: "references/js_client/classes/js_client.ProductVariantsResource",
label: "variants",
},
],
},
{
type: "doc",
id: "references/js-client/classes/RegionsResource",
id: "references/js_client/classes/js_client.RegionsResource",
label: "regions",
},
{
type: "doc",
id: "references/js-client/classes/ReturnReasonsResource",
id: "references/js_client/classes/js_client.ReturnReasonsResource",
label: "returnReasons",
},
{
type: "doc",
id: "references/js-client/classes/ReturnsResource",
id: "references/js_client/classes/js_client.ReturnsResource",
label: "returns",
},
{
type: "doc",
id: "references/js-client/classes/ShippingOptionsResource",
id: "references/js_client/classes/js_client.ShippingOptionsResource",
label: "shippingOptions",
},
{
type: "doc",
id: "references/js-client/classes/SwapsResource",
id: "references/js_client/classes/js_client.SwapsResource",
label: "swaps",
},
],
@@ -3201,7 +3201,7 @@ module.exports = {
},
{
type: "doc",
id: "references/pricing/interfaces/IPricingModuleService",
id: "references/pricing/interfaces/pricing.IPricingModuleService",
label: "Pricing Module Interface Reference",
customProps: {
sidebar_is_title: true,
@@ -3218,7 +3218,7 @@ module.exports = {
items: [
{
type: "autogenerated",
dirName: "references/pricing/IPricingModuleService/methods",
dirName: "references/IPricingModuleService/methods",
},
],
},
@@ -3235,7 +3235,7 @@ module.exports = {
},
{
type: "doc",
id: "references/product/interfaces/IProductModuleService",
id: "references/product/interfaces/product.IProductModuleService",
label: "Product Module Interface Reference",
customProps: {
sidebar_is_title: true,
@@ -3252,7 +3252,7 @@ module.exports = {
items: [
{
type: "autogenerated",
dirName: "references/product/IProductModuleService/methods",
dirName: "references/IProductModuleService/methods",
},
],
},
@@ -3269,7 +3269,7 @@ module.exports = {
},
{
type: "doc",
id: "references/inventory/interfaces/IInventoryService",
id: "references/inventory/interfaces/inventory.IInventoryService",
label: "Inventory Module Interface Reference",
customProps: {
sidebar_is_title: true,
@@ -3286,7 +3286,7 @@ module.exports = {
items: [
{
type: "autogenerated",
dirName: "references/inventory/IInventoryService/methods",
dirName: "references/IInventoryService/methods",
},
],
},
@@ -3303,7 +3303,7 @@ module.exports = {
},
{
type: "doc",
id: "references/stock-location/interfaces/IStockLocationService",
id: "references/stock_location/interfaces/stock_location.IStockLocationService",
label: "Stock Location Module Interface Reference",
customProps: {
sidebar_is_title: true,
@@ -3320,7 +3320,7 @@ module.exports = {
items: [
{
type: "autogenerated",
dirName: "references/stock-location/IStockLocationService/methods",
dirName: "references/IStockLocationService/methods",
},
],
},
@@ -3337,7 +3337,7 @@ module.exports = {
},
{
type: "doc",
id: "references/workflows/index",
id: "references/modules/workflows",
label: "Workflows API Reference",
customProps: {
sidebar_is_title: true,