docs: generate OAS for v2 (#7883)
This commit is contained in:
Shahed Nasser
GitHub
@@ -12,6 +12,8 @@ tags:
|
||||
- name: Api Keys
|
||||
- name: Campaigns
|
||||
- name: Collections
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminCollection.yaml
|
||||
- name: Currencies
|
||||
description: >
|
||||
A store can use unlimited currencies, and each region must be associated
|
||||
@@ -24,15 +26,8 @@ tags:
|
||||
url: >-
|
||||
https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies
|
||||
- name: Customer Groups
|
||||
description: >
|
||||
Customer Groups can be used to organize customers that share similar data
|
||||
or attributes into dedicated groups.
|
||||
|
||||
This can be useful for different purposes such as setting a different
|
||||
price for a specific customer group.
|
||||
externalDocs:
|
||||
description: How to manage customer groups
|
||||
url: https://docs.medusajs.com/modules/customers/admin/manage-customer-groups
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminCustomerGroup.yaml
|
||||
- name: Customers
|
||||
description: >
|
||||
Customers can either be created when they register through the Store APIs,
|
||||
@@ -40,16 +35,17 @@ tags:
|
||||
externalDocs:
|
||||
description: How to manage customers
|
||||
url: https://docs.medusajs.com/modules/customers/admin/manage-customers
|
||||
- name: Fulfillment
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminCustomer.yaml
|
||||
- name: Draft Orders
|
||||
- name: Fulfillment Providers
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminFulfillmentProvider.yaml
|
||||
- name: Fulfillment Sets
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminFulfillmentSet.yaml
|
||||
- name: Fulfillments
|
||||
- name: Inventory Items
|
||||
description: >
|
||||
Inventory items, provided by the [Inventory
|
||||
Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module),
|
||||
can be used to manage the inventory of saleable items in your store.
|
||||
externalDocs:
|
||||
description: How to manage inventory items
|
||||
url: >-
|
||||
https://docs.medusajs.com/modules/multiwarehouse/admin/manage-inventory-items
|
||||
- name: Invites
|
||||
description: >
|
||||
An admin can invite new users to manage their team. This would allow new
|
||||
@@ -57,26 +53,17 @@ tags:
|
||||
externalDocs:
|
||||
description: How to manage invites
|
||||
url: https://docs.medusajs.com/modules/users/admin/manage-invites
|
||||
- name: Orders
|
||||
- name: Payments
|
||||
description: >
|
||||
A payment can be related to an order, swap, return, or more. It can be
|
||||
captured or refunded.
|
||||
- name: Price Lists
|
||||
description: >
|
||||
A price list are special prices applied to products based on a set of
|
||||
conditions, such as customer group.
|
||||
externalDocs:
|
||||
description: How to manage price lists
|
||||
url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists
|
||||
- name: Pricing
|
||||
- name: Product Categories
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminProductCategory.yaml
|
||||
- name: Product Tags
|
||||
- name: Product Types
|
||||
- name: Products
|
||||
description: >
|
||||
Products are saleable items in a store. This also includes [saleable gift
|
||||
cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product)
|
||||
in a store.
|
||||
externalDocs:
|
||||
description: How to manage products
|
||||
url: https://docs.medusajs.com/modules/products/admin/manage-products
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminProduct.yaml
|
||||
- name: Promotions
|
||||
- name: Regions
|
||||
description: >
|
||||
@@ -88,6 +75,9 @@ tags:
|
||||
description: How to manage regions
|
||||
url: >-
|
||||
https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions
|
||||
- name: Reservations
|
||||
- name: Return Reasons
|
||||
- name: Returns
|
||||
- name: Sales Channels
|
||||
description: >
|
||||
A sales channel indicates a channel where products can be sold in. For
|
||||
@@ -97,24 +87,20 @@ tags:
|
||||
externalDocs:
|
||||
description: How to manage sales channels
|
||||
url: https://docs.medusajs.com/modules/sales-channels/admin/manage
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminSalesChannel.yaml
|
||||
- name: Shipping Options
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminShippingOption.yaml
|
||||
- name: Shipping Profiles
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/AdminShippingProfile.yaml
|
||||
- name: Stock Locations
|
||||
- name: Stores
|
||||
- name: Tax Rates
|
||||
description: >
|
||||
Each region has at least a default tax rate. Admins can create and manage
|
||||
additional tax rates that can be applied for certain conditions, such as
|
||||
for specific product types.
|
||||
externalDocs:
|
||||
description: How to manage tax rates
|
||||
url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates
|
||||
- name: Tax Regions
|
||||
- name: Uploads
|
||||
- name: Users
|
||||
description: >
|
||||
A store can have more than one user, each having the same privileges.
|
||||
Admins can manage users, their passwords, and more.
|
||||
externalDocs:
|
||||
description: How to manage users
|
||||
url: https://docs.medusajs.com/modules/users/admin/manage-users
|
||||
- name: Workflows Executions
|
||||
paths:
|
||||
/admin/api-keys:
|
||||
@@ -123,14 +109,20 @@ paths:
|
||||
$ref: paths/admin_api-keys_{id}.yaml
|
||||
/admin/api-keys/{id}/revoke:
|
||||
$ref: paths/admin_api-keys_{id}_revoke.yaml
|
||||
/admin/api-keys/{id}/sales-channels:
|
||||
$ref: paths/admin_api-keys_{id}_sales-channels.yaml
|
||||
/admin/campaigns:
|
||||
$ref: paths/admin_campaigns.yaml
|
||||
/admin/campaigns/{id}:
|
||||
$ref: paths/admin_campaigns_{id}.yaml
|
||||
/admin/campaigns/{id}/promotions:
|
||||
$ref: paths/admin_campaigns_{id}_promotions.yaml
|
||||
/admin/collections:
|
||||
$ref: paths/admin_collections.yaml
|
||||
/admin/collections/{id}:
|
||||
$ref: paths/admin_collections_{id}.yaml
|
||||
/admin/collections/{id}/products:
|
||||
$ref: paths/admin_collections_{id}_products.yaml
|
||||
/admin/currencies:
|
||||
$ref: paths/admin_currencies.yaml
|
||||
/admin/currencies/{code}:
|
||||
@@ -141,10 +133,6 @@ paths:
|
||||
$ref: paths/admin_customer-groups_{id}.yaml
|
||||
/admin/customer-groups/{id}/customers:
|
||||
$ref: paths/admin_customer-groups_{id}_customers.yaml
|
||||
/admin/customer-groups/{id}/customers/batch:
|
||||
$ref: paths/admin_customer-groups_{id}_customers_batch.yaml
|
||||
/admin/customer-groups/{id}/customers/remove:
|
||||
$ref: paths/admin_customer-groups_{id}_customers_remove.yaml
|
||||
/admin/customers:
|
||||
$ref: paths/admin_customers.yaml
|
||||
/admin/customers/{id}:
|
||||
@@ -153,16 +141,32 @@ paths:
|
||||
$ref: paths/admin_customers_{id}_addresses.yaml
|
||||
/admin/customers/{id}/addresses/{address_id}:
|
||||
$ref: paths/admin_customers_{id}_addresses_{address_id}.yaml
|
||||
/admin/fulfillment/shipping-options/{id}/rules/batch/add:
|
||||
$ref: paths/admin_fulfillment_shipping-options_{id}_rules_batch_add.yaml
|
||||
/admin/fulfillment/shipping-options/{id}/rules/batch/remove:
|
||||
$ref: paths/admin_fulfillment_shipping-options_{id}_rules_batch_remove.yaml
|
||||
/admin/draft-orders:
|
||||
$ref: paths/admin_draft-orders.yaml
|
||||
/admin/draft-orders/{id}:
|
||||
$ref: paths/admin_draft-orders_{id}.yaml
|
||||
/admin/fulfillment-providers:
|
||||
$ref: paths/admin_fulfillment-providers.yaml
|
||||
/admin/fulfillment-sets/{id}:
|
||||
$ref: paths/admin_fulfillment-sets_{id}.yaml
|
||||
/admin/fulfillment-sets/{id}/service-zones:
|
||||
$ref: paths/admin_fulfillment-sets_{id}_service-zones.yaml
|
||||
/admin/fulfillment-sets/{id}/service-zones/{zone_id}:
|
||||
$ref: paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml
|
||||
/admin/fulfillments:
|
||||
$ref: paths/admin_fulfillments.yaml
|
||||
/admin/fulfillments/{id}/cancel:
|
||||
$ref: paths/admin_fulfillments_{id}_cancel.yaml
|
||||
/admin/fulfillments/{id}/shipment:
|
||||
$ref: paths/admin_fulfillments_{id}_shipment.yaml
|
||||
/admin/inventory-items:
|
||||
$ref: paths/admin_inventory-items.yaml
|
||||
/admin/inventory-items/{id}:
|
||||
$ref: paths/admin_inventory-items_{id}.yaml
|
||||
/admin/inventory-items/{id}/location-levels:
|
||||
$ref: paths/admin_inventory-items_{id}_location-levels.yaml
|
||||
/admin/inventory-items/{id}/location-levels/batch:
|
||||
$ref: paths/admin_inventory-items_{id}_location-levels_batch.yaml
|
||||
/admin/inventory-items/{id}/location-levels/{location_id}:
|
||||
$ref: paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml
|
||||
/admin/invites:
|
||||
@@ -173,8 +177,26 @@ paths:
|
||||
$ref: paths/admin_invites_{id}.yaml
|
||||
/admin/invites/{id}/resend:
|
||||
$ref: paths/admin_invites_{id}_resend.yaml
|
||||
/admin/orders:
|
||||
$ref: paths/admin_orders.yaml
|
||||
/admin/orders/{id}:
|
||||
$ref: paths/admin_orders_{id}.yaml
|
||||
/admin/orders/{id}/archive:
|
||||
$ref: paths/admin_orders_{id}_archive.yaml
|
||||
/admin/orders/{id}/cancel:
|
||||
$ref: paths/admin_orders_{id}_cancel.yaml
|
||||
/admin/orders/{id}/complete:
|
||||
$ref: paths/admin_orders_{id}_complete.yaml
|
||||
/admin/orders/{id}/fulfillments:
|
||||
$ref: paths/admin_orders_{id}_fulfillments.yaml
|
||||
/admin/orders/{id}/fulfillments/{fulfillment_id}/cancel:
|
||||
$ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
|
||||
/admin/orders/{id}/fulfillments/{fulfillment_id}/shipment:
|
||||
$ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment.yaml
|
||||
/admin/payments:
|
||||
$ref: paths/admin_payments.yaml
|
||||
/admin/payments/payment-providers:
|
||||
$ref: paths/admin_payments_payment-providers.yaml
|
||||
/admin/payments/{id}:
|
||||
$ref: paths/admin_payments_{id}.yaml
|
||||
/admin/payments/{id}/capture:
|
||||
@@ -185,16 +207,28 @@ paths:
|
||||
$ref: paths/admin_price-lists.yaml
|
||||
/admin/price-lists/{id}:
|
||||
$ref: paths/admin_price-lists_{id}.yaml
|
||||
/admin/price-lists/{id}/prices/batch/add:
|
||||
$ref: paths/admin_price-lists_{id}_prices_batch_add.yaml
|
||||
/admin/price-lists/{id}/prices/batch/remove:
|
||||
$ref: paths/admin_price-lists_{id}_prices_batch_remove.yaml
|
||||
/admin/pricing/rule-types:
|
||||
$ref: paths/admin_pricing_rule-types.yaml
|
||||
/admin/pricing/rule-types/{id}:
|
||||
$ref: paths/admin_pricing_rule-types_{id}.yaml
|
||||
/admin/price-lists/{id}/prices/batch:
|
||||
$ref: paths/admin_price-lists_{id}_prices_batch.yaml
|
||||
/admin/price-lists/{id}/products:
|
||||
$ref: paths/admin_price-lists_{id}_products.yaml
|
||||
/admin/product-categories:
|
||||
$ref: paths/admin_product-categories.yaml
|
||||
/admin/product-categories/{id}:
|
||||
$ref: paths/admin_product-categories_{id}.yaml
|
||||
/admin/product-categories/{id}/products:
|
||||
$ref: paths/admin_product-categories_{id}_products.yaml
|
||||
/admin/product-tags:
|
||||
$ref: paths/admin_product-tags.yaml
|
||||
/admin/product-tags/{id}:
|
||||
$ref: paths/admin_product-tags_{id}.yaml
|
||||
/admin/product-types:
|
||||
$ref: paths/admin_product-types.yaml
|
||||
/admin/product-types/{id}:
|
||||
$ref: paths/admin_product-types_{id}.yaml
|
||||
/admin/products:
|
||||
$ref: paths/admin_products.yaml
|
||||
/admin/products/batch:
|
||||
$ref: paths/admin_products_batch.yaml
|
||||
/admin/products/{id}:
|
||||
$ref: paths/admin_products_{id}.yaml
|
||||
/admin/products/{id}/options:
|
||||
@@ -203,40 +237,78 @@ paths:
|
||||
$ref: paths/admin_products_{id}_options_{option_id}.yaml
|
||||
/admin/products/{id}/variants:
|
||||
$ref: paths/admin_products_{id}_variants.yaml
|
||||
/admin/products/{id}/variants/batch:
|
||||
$ref: paths/admin_products_{id}_variants_batch.yaml
|
||||
/admin/products/{id}/variants/inventory-items/batch:
|
||||
$ref: paths/admin_products_{id}_variants_inventory-items_batch.yaml
|
||||
/admin/products/{id}/variants/{variant_id}:
|
||||
$ref: paths/admin_products_{id}_variants_{variant_id}.yaml
|
||||
/admin/products/{id}/variants/{variant_id}/inventory-items:
|
||||
$ref: paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml
|
||||
/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}:
|
||||
$ref: >-
|
||||
paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml
|
||||
/admin/promotions:
|
||||
$ref: paths/admin_promotions.yaml
|
||||
/admin/promotions/rule-attribute-options/{rule_type}:
|
||||
$ref: paths/admin_promotions_rule-attribute-options_{rule_type}.yaml
|
||||
/admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}:
|
||||
$ref: >-
|
||||
paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml
|
||||
/admin/promotions/{id}:
|
||||
$ref: paths/admin_promotions_{id}.yaml
|
||||
/admin/promotions/{id}/buy-rules/batch/add:
|
||||
$ref: paths/admin_promotions_{id}_buy-rules_batch_add.yaml
|
||||
/admin/promotions/{id}/buy-rules/batch/remove:
|
||||
$ref: paths/admin_promotions_{id}_buy-rules_batch_remove.yaml
|
||||
/admin/promotions/{id}/rules/batch/add:
|
||||
$ref: paths/admin_promotions_{id}_rules_batch_add.yaml
|
||||
/admin/promotions/{id}/rules/batch/remove:
|
||||
$ref: paths/admin_promotions_{id}_rules_batch_remove.yaml
|
||||
/admin/promotions/{id}/rules/batch/update:
|
||||
$ref: paths/admin_promotions_{id}_rules_batch_update.yaml
|
||||
/admin/promotions/{id}/target-rules/batch/add:
|
||||
$ref: paths/admin_promotions_{id}_target-rules_batch_add.yaml
|
||||
/admin/promotions/{id}/target-rules/batch/remove:
|
||||
$ref: paths/admin_promotions_{id}_target-rules_batch_remove.yaml
|
||||
/admin/promotions/{id}/buy-rules/batch:
|
||||
$ref: paths/admin_promotions_{id}_buy-rules_batch.yaml
|
||||
/admin/promotions/{id}/rules/batch:
|
||||
$ref: paths/admin_promotions_{id}_rules_batch.yaml
|
||||
/admin/promotions/{id}/target-rules/batch:
|
||||
$ref: paths/admin_promotions_{id}_target-rules_batch.yaml
|
||||
/admin/promotions/{id}/{rule_type}:
|
||||
$ref: paths/admin_promotions_{id}_{rule_type}.yaml
|
||||
/admin/regions:
|
||||
$ref: paths/admin_regions.yaml
|
||||
/admin/regions/{id}:
|
||||
$ref: paths/admin_regions_{id}.yaml
|
||||
/admin/reservations:
|
||||
$ref: paths/admin_reservations.yaml
|
||||
/admin/reservations/{id}:
|
||||
$ref: paths/admin_reservations_{id}.yaml
|
||||
/admin/return-reasons:
|
||||
$ref: paths/admin_return-reasons.yaml
|
||||
/admin/return-reasons/{id}:
|
||||
$ref: paths/admin_return-reasons_{id}.yaml
|
||||
/admin/returns:
|
||||
$ref: paths/admin_returns.yaml
|
||||
/admin/returns/{id}:
|
||||
$ref: paths/admin_returns_{id}.yaml
|
||||
/admin/returns/{id}/cancel:
|
||||
$ref: paths/admin_returns_{id}_cancel.yaml
|
||||
/admin/returns/{id}/receive:
|
||||
$ref: paths/admin_returns_{id}_receive.yaml
|
||||
/admin/sales-channels:
|
||||
$ref: paths/admin_sales-channels.yaml
|
||||
/admin/sales-channels/{id}:
|
||||
$ref: paths/admin_sales-channels_{id}.yaml
|
||||
/admin/sales-channels/{id}/products/batch/add:
|
||||
$ref: paths/admin_sales-channels_{id}_products_batch_add.yaml
|
||||
/admin/sales-channels/{id}/products:
|
||||
$ref: paths/admin_sales-channels_{id}_products.yaml
|
||||
/admin/shipping-options:
|
||||
$ref: paths/admin_shipping-options.yaml
|
||||
/admin/shipping-options/{id}:
|
||||
$ref: paths/admin_shipping-options_{id}.yaml
|
||||
/admin/shipping-options/{id}/rules/batch:
|
||||
$ref: paths/admin_shipping-options_{id}_rules_batch.yaml
|
||||
/admin/shipping-profiles:
|
||||
$ref: paths/admin_shipping-profiles.yaml
|
||||
/admin/shipping-profiles/{id}:
|
||||
$ref: paths/admin_shipping-profiles_{id}.yaml
|
||||
/admin/stock-locations:
|
||||
$ref: paths/admin_stock-locations.yaml
|
||||
/admin/stock-locations/{id}:
|
||||
$ref: paths/admin_stock-locations_{id}.yaml
|
||||
/admin/stock-locations/{id}/fulfillment-sets:
|
||||
$ref: paths/admin_stock-locations_{id}_fulfillment-sets.yaml
|
||||
/admin/stock-locations/{id}/sales-channels:
|
||||
$ref: paths/admin_stock-locations_{id}_sales-channels.yaml
|
||||
/admin/stores:
|
||||
$ref: paths/admin_stores.yaml
|
||||
/admin/stores/{id}:
|
||||
@@ -253,6 +325,10 @@ paths:
|
||||
$ref: paths/admin_tax-regions.yaml
|
||||
/admin/tax-regions/{id}:
|
||||
$ref: paths/admin_tax-regions_{id}.yaml
|
||||
/admin/uploads:
|
||||
$ref: paths/admin_uploads.yaml
|
||||
/admin/uploads/{id}:
|
||||
$ref: paths/admin_uploads_{id}.yaml
|
||||
/admin/users:
|
||||
$ref: paths/admin_users.yaml
|
||||
/admin/users/me:
|
||||
|
||||
Reference in New Issue
Block a user