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/docs/content/modules/customers/admin/manage-customer-groups.mdx
+8 -8
View File
@@ -48,7 +48,7 @@ You can learn more about [authenticating as an admin user in the API reference](
## Create Customer Groups
You can create a customer group by sending a request to the Create Customer Group endpoint:
You can create a customer group by sending a request to the Create Customer Group API Route:
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
@@ -131,7 +131,7 @@ This request requires the `name` parameter and optionally accepts the `metadata`
## List Customer Groups
You can get a list of all customer groups by sending a request to the List Customer Groups endpoint:
You can get a list of all customer groups by sending a request to the List Customer Groups API Route:
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
@@ -212,7 +212,7 @@ You can also pass filters and other selection query parameters to the request. C
## Retrieve a Customer Group
You can retrieve a single customer group by sending a request to the Get a Customer Group endpoint:
You can retrieve a single customer group by sending a request to the Get a Customer Group API Route:
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
@@ -279,7 +279,7 @@ This request accepts the ID of the customer group to retrieve as a path paramete
## Update a Customer Group
You can update a customer group’s data by sending a request to the Update Customer Group endpoint:
You can update a customer group’s data by sending a request to the Update Customer Group API Route:
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
@@ -373,7 +373,7 @@ This request accepts the ID of the customer group as a path parameter, and optio
## Delete Customer Group
You can delete a customer group by sending a request to the Delete a Customer Group endpoint:
You can delete a customer group by sending a request to the Delete a Customer Group API Route:
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
@@ -443,7 +443,7 @@ This request accepts the ID of the customer group to delete as a path parameter.
### Add Customer to Group
You can add a customer to a group by sending a request to the Customer Group’s Add Customer endpoint:
You can add a customer to a group by sending a request to the Customer Group’s Add Customer API Route:
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
@@ -543,7 +543,7 @@ This request accepts the ID of the customer group as a path parameter. In its bo
### List Customers
You can retrieve a list of all customers in a customer group using the List Customers endpoint:
You can retrieve a list of all customers in a customer group using the List Customers API Route:
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
@@ -626,7 +626,7 @@ Removing customers from a group does not remove them entirely. They’ll still b
:::
You can remove customers from a customer group by sending a request to the Remove Customers endpoint:
You can remove customers from a customer group by sending a request to the Remove Customers API Route:
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
www/apps/docs/content/modules/customers/admin/manage-customers.mdx
+3 -3
View File
@@ -52,7 +52,7 @@ You can learn more about [authenticating as an admin user in the API reference](
## List Customers
You can show a list of customers by sending a request to the [List Customers](https://docs.medusajs.com/api/admin#customers_getcustomers) endpoint:
You can show a list of customers by sending a request to the [List Customers API Route](https://docs.medusajs.com/api/admin#customers_getcustomers):
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
@@ -139,7 +139,7 @@ You can learn more about pagination in the [API reference](https://docs.medusajs
Admins can create customer accounts. They have to supply the customer’s credentials and basic info.
You can create a customer account by sending a request to the [Create a Customer](https://docs.medusajs.com/api/admin#customers_postcustomers) endpoint:
You can create a customer account by sending a request to the [Create a Customer API Route](https://docs.medusajs.com/api/admin#customers_postcustomers):
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
@@ -246,7 +246,7 @@ The request returns the created customer object in the response.
An admin can edit a customer’s basic information and credentials.
You can edit a customer’s information by sending a request to the [Update a Customer](https://docs.medusajs.com/api/admin#customers_postcustomerscustomer) endpoint:
You can edit a customer’s information by sending a request to the [Update a Customer API Route](https://docs.medusajs.com/api/admin#customers_postcustomerscustomer):
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>