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/storefront/roadmap.mdx
+3 -3
View File
@@ -59,7 +59,7 @@ Publishable API Keys are used to scope API requests to defined resources, such a
Also, when you're using Medusa's JS or React clients, you can pass the publishable API key when you first initialize the clients and it will be appended to all requests you send.
For example, you can create a publishable API key and associate it with one or more sales channels. Then, when you pass the publishable API key in the header of the request to the List Products endpoint, only products associated with that sales channel will be retrieved. The alternative would be to pass the sales channels as query parameters to the request.
For example, you can create a publishable API key and associate it with one or more sales channels. Then, when you pass the publishable API key in the header of the request to the List Products API Route, only products associated with that sales channel will be retrieved. The alternative would be to pass the sales channels as query parameters to the request.
There are two ways to create a publishable API Key: either using the admin dashboard, which requires the admin plugin to be installed on your Medusa backend, or using the Admin REST APIs.
@@ -84,7 +84,7 @@ There are two ways to create a publishable API Key: either using the admin dashb
},
]} />
After creating the publishable API key and associating it with sales channels, you can pass it in the header of your requests to Store API endpoints.
After creating the publishable API key and associating it with sales channels, you can pass it in the header of your requests to Store API Routes.
<DocCard item={{
type: 'link',
@@ -191,7 +191,7 @@ Medusa’s backend provides much more functionalities, such as allowing customer
label: 'Store API reference',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn about available REST API endpoints that you can use in your storefront.'
description: 'Learn about available REST API routes that you can use in your storefront.'
}
},
]} />