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

Update all curl documentation examples and references with new x-medusa-access-token header (#6326)

Browse Source 
## What

This is to update incorrect documentation in regards to authentication to the Admin API - raised in https://github.com/medusajs/medusa/issues/6264.

## Why

Because the current documentation has been incorrect since the September 2023 release of [v1.17.0](https://github.com/medusajs/medusa/releases/tag/v1.17.0), which had breaking changes to API token usage.

## How

Simple search and replace. I was asked to replace occurrences under `www/apps/docs/content/` but there were also additional places where I thought references should also be updated:

- `packages/medusa/src/api/`
- `www/apps/api-reference/`

Feel free to revert them as needed.

There is also some inconsistency between the format shown in examples e.g. `<API_TOKEN>` vs `{api_token}` vs `{access_token}`.

I have kept the format the same in all cases as the original, as surrounding documentation text would not have format updated as well. I suggest maybe reviewing the documentation and keeping to a consistent format e.g. `<API_TOKEN>`.

 
## Testing 

I have not tested these changes. I would assume the `packages/medusa/src/api/` changes may need more thorough testing?
This commit is contained in:
Ira
2024-02-07 08:41:38 +00:00
committed by GitHub
parent e2cb72efd8
commit 44470bf8c5
32 changed files with 217 additions and 217 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/modules/price-lists/admin/_import-prices.mdx
+4 -4
View File
@@ -202,7 +202,7 @@ You can do that by sending the following request to the [Upload Files API Route]
```bash
curl -L -X POST '<BACKEND_URL>/admin/uploads' \
-H 'Authorization: Bearer {api_token}' \
-H 'x-medusa-access-token: {api_token}' \
-H 'Content-Type: text/csv' \
-F 'files=@"<FILE_PATH_1>"'
```
@@ -293,7 +293,7 @@ You can do that by sending the following request to the [Create a Batch Job API
```bash
curl -L -X POST '<BACKEND_URL>/admin/batch-jobs' \
-H 'Authorization: Bearer {api_token}' \
-H 'x-medusa-access-token: {api_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"type": "price-list-import",
@@ -393,7 +393,7 @@ You can retrieve all the details of the batch job, including its status and the
```bash
curl -L -X GET '<BACKEND_URL>/admin/batch-jobs/<BATCH_JOB_ID>' \
-H 'Authorization: Bearer {api_token}'
-H 'x-medusa-access-token: {api_token}'
# <BATCH_JOB_ID> is the ID of the batch job
```
@@ -481,7 +481,7 @@ To confirm a batch job send the following request:
```bash
curl -L -X POST '<BACKEND_URL>/admin/batch-jobs/<BATCH_JOB_ID>/confirm' \
-H 'Authorization: Bearer {api_token}'
-H 'x-medusa-access-token: {api_token}'
# <BATCH_JOB_ID> is the ID of the batch job
```
www/apps/docs/content/modules/price-lists/admin/manage-price-lists.mdx
+7 -7
View File
@@ -195,7 +195,7 @@ For example, sending the following request creates a price list with two prices:
```bash
curl -L -X POST '<YOUR_BACKEND_URL>/admin/price-lists' \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'x-medusa-access-token: <API_TOKEN>' \
-H 'Content-Type: application/json' \
--data-raw '{
"name": "New Price List",
@@ -289,7 +289,7 @@ You can retrieve all of a price list’s details using the Get a Price List API
```bash
curl -L -X GET '<BACKEND_URL>/admin/price-lists/{id}' \
-H 'Authorization: Bearer <API_TOKEN>'
-H 'x-medusa-access-token: <API_TOKEN>'
```
</TabItem>
@@ -374,7 +374,7 @@ For example, by sending the following request the end date of the price list wil
```bash
curl -L -X POST '<BACKEND_URL>/admin/price-lists/<PRICE_LIST_ID>' \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'x-medusa-access-token: <API_TOKEN>' \
-H 'Content-Type: application/json' \
--data-raw '{
"ends_at": "2022-10-11"
@@ -489,7 +489,7 @@ For example, sending the following request adds a new price to the price list:
```bash
curl -L -X POST '<BACKEND_URL>/admin/price-lists/<PRICE_LIST_ID>' \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'x-medusa-access-token: <API_TOKEN>' \
-H 'Content-Type: application/json' \
--data-raw '{
"prices": [
@@ -587,7 +587,7 @@ You can delete all the prices of a product’s variants using the [Delete Produc
```bash
curl -L -X DELETE '<BACKEND_URL>/admin/price-lists/<PRICE_LIST_ID>/products/<PRODUCT_ID>/prices' \
-H 'Authorization: Bearer <API_TOKEN>'
-H 'x-medusa-access-token: <API_TOKEN>'
```
</TabItem>
@@ -673,7 +673,7 @@ You can delete all the prices of a variant using the [Delete Variant Prices API
```bash
curl -L -X DELETE '<BACKEND_URL>/admin/price-lists/<PRICE_LIST_ID>/variants/<VARIANT_ID>/prices' \
-H 'Authorization: Bearer <API_TOKEN>'
-H 'x-medusa-access-token: <API_TOKEN>'
```
</TabItem>
@@ -746,7 +746,7 @@ You can delete a price list, and subsequently all prices defined in it, using th
```bash
curl -L -X DELETE '<BACKEND_URL>/admin/price-lists/<PRICE_LIST_ID>' \
-H 'Authorization: Bearer <API_TOKEN>'
-H 'x-medusa-access-token: <API_TOKEN>'
```
</TabItem>