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

docs: update endpoints to use file-routing approach (#5397)

Browse Source 
- Move the original guides for creating endpoints and middlewares to sub-sections in the Endpoints category.
- Replace existing guides for endpoints and middlewares with the new approach.
- Update all endpoints-related snippets across docs to use this new approach.
This commit is contained in:
Shahed Nasser
2023-10-19 15:56:26 +00:00
committed by GitHub
parent b38f73726d
commit c28935b4e8
170 changed files with 3658 additions and 3344 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/admin/openapi.yaml
+9 -9
View File
@@ -13,11 +13,11 @@ tags:
that, they can create an Oauth provider within the plugin that handles the
authentication.
The Apps Oauth endpoints allows admins to manage and generate token for an
The Apps Oauth API Routes allows admins to manage and generate token for an
app using its oauth provider.
- name: Auth
description: >
Authentication endpoints allow admin users to manage their session, such
Authentication API Routes allow admin users to manage their session, such
as login or log out.
When an admin user is logged in, the cookie header is set indicating the
@@ -31,7 +31,7 @@ tags:
asynchronusly. For example, the Import Product feature is implemented
using batch jobs.
Batch Job endpoints allows admins to manage the batch jobs and their
Batch Job API Routes allows admins to manage the batch jobs and their
state.
externalDocs:
description: How to import products
@@ -41,7 +41,7 @@ tags:
A store can use unlimited currencies, and each region must be associated
with at least one currency.
Currencies are defined within the Medusa backend. Currency endpoints allow
Currencies are defined within the Medusa backend. Currency API Routes allow
admins to list and update currencies.
externalDocs:
description: How to manage currencies
@@ -69,7 +69,7 @@ tags:
Admins can create discounts with conditions and rules, providing them with
advanced settings for variety of cases.
The Discount endpoints can be used to manage discounts, their conditions,
The Discount API Routes can be used to manage discounts, their conditions,
resources, and more.
externalDocs:
description: How to manage discounts
@@ -87,7 +87,7 @@ tags:
specifying options like their balance, region, and more.
These gift cards are different than the saleable gift cards in a store,
which are created and managed through Product endpoints.
which are created and managed through Product API Routes.
externalDocs:
description: How to manage gift cards
url: >-
@@ -195,7 +195,7 @@ tags:
Product variants are the actual salable item in your store. Each variant
is a combination of the different option values available on the product.
Product variants can be managed through the Products endpoints.
Product variants can be managed through the Products API Routes.
externalDocs:
description: How to manage product variants
url: >-
@@ -207,7 +207,7 @@ tags:
For example, a publishable API key can be associated with one or more
sales channels. When it is passed in the header of a request to the List
Product store endpoint,
Product store API Route,
the sales channels are inferred from the key and only products associated
with those sales channels are retrieved.
@@ -330,7 +330,7 @@ tags:
url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates
- name: Uploads
description: >
The upload endpoints are used to upload any type of resources. For
The upload API Routes are used to upload any type of resources. For
example, they can be used to upload CSV files that are used to import
products into the store.
externalDocs:
www/apps/api-reference/specs/store/openapi.yaml
+8 -8
View File
@@ -8,7 +8,7 @@ info:
tags:
- name: Auth
description: >
Authentication endpoints allow customers to manage their session, such as
Authentication API Routes allow customers to manage their session, such as
login or log out.
When a customer is logged in, the cookie header is set indicating the
@@ -40,8 +40,8 @@ tags:
Customers can use gift cards during checkout to deduct the gift card's
balance from the checkout total.
The Gift Card endpoints allow retrieving a gift card's details by its
code. A gift card can be applied to a cart using the Carts endpoints.
The Gift Card API Routes allow retrieving a gift card's details by its
code. A gift card can be applied to a cart using the Carts API Routes.
externalDocs:
description: How to use gift cards in a storefront
url: https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards
@@ -49,8 +49,8 @@ tags:
description: >
Orders are purchases made by customers, typically through a storefront.
Orders are placed and created using the Carts endpoints. The Orders
endpoints allow retrieving and claiming orders.
Orders are placed and created using the Carts API Routes. The Orders
API Routes allow retrieving and claiming orders.
externalDocs:
description: How to retrieve order details in a storefront
url: >-
@@ -75,7 +75,7 @@ tags:
cards](https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards)
in a store.
Using these endpoints, you can filter products by categories, collections,
Using these API Routes, you can filter products by categories, collections,
sales channels, and more.
externalDocs:
description: How to show products in a storefront
@@ -89,7 +89,7 @@ tags:
Products can be categoriezed into categories. A product can be associated
more than one category.
Using these endpoints, you can list or retrieve a category's details and
Using these API Routes, you can list or retrieve a category's details and
products.
externalDocs:
description: How to use product categories in a storefront
@@ -100,7 +100,7 @@ tags:
such as marketing or discount purposes. For example, you can create a
Summer Collection.
Using these endpoints, you can list or retrieve a collection's details and
Using these API Routes, you can list or retrieve a collection's details and
products.
- name: Product Tags
description: |