From 0dbca9552e2fd32d1dcc741e5c8e35cf105995bb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 4 May 2023 14:23:29 +0300 Subject: [PATCH] chore(docs): Generated API Reference (#4014) Co-authored-by: olivermrbl Co-authored-by: Shahed Nasser --- docs/api/admin.oas.json | 8 ++++---- docs/api/admin/code_samples/JavaScript/admin_auth/post.js | 3 ++- .../post.js | 3 ++- .../post.js | 4 +++- .../code_samples/Shell/admin_product-categories/post.sh | 2 +- 5 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/api/admin.oas.json b/docs/api/admin.oas.json index 0b0fd38f9f..b489feb120 100644 --- a/docs/api/admin.oas.json +++ b/docs/api/admin.oas.json @@ -359,7 +359,7 @@ { "lang": "JavaScript", "label": "JS Client", - "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.admin.auth.createSession({\n email: 'user@example.com',\n password: 'supersecret'\n}).then((({ user }) => {\n console.log(user.id);\n});\n" + "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.admin.auth.createSession({\n email: 'user@example.com',\n password: 'supersecret'\n})\n.then(({ user }) => {\n console.log(user.id);\n});\n" }, { "lang": "Shell", @@ -9831,7 +9831,7 @@ { "lang": "JavaScript", "label": "JS Client", - "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.orders.fulfillClaim(order_id, claim_id)\n.then(({ order }) => {\n console.log(order.id);\n});\n" + "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.orders.fulfillClaim(order_id, claim_id, {\n})\n.then(({ order }) => {\n console.log(order.id);\n});\n" }, { "lang": "Shell", @@ -11231,7 +11231,7 @@ { "lang": "JavaScript", "label": "JS Client", - "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.orders.fulfillSwap(order_id, swap_id)\n.then(({ order }) => {\n console.log(order.id);\n});\n" + "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.orders.fulfillSwap(order_id, swap_id, {\n\n})\n.then(({ order }) => {\n console.log(order.id);\n});\n" }, { "lang": "Shell", @@ -13547,7 +13547,7 @@ { "lang": "Shell", "label": "cURL", - "source": "curl --location --request POST 'https://medusa-url.com/admin/product-categories' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"name\": \"Skinny Jeans\",\n}'\n" + "source": "curl --location --request POST 'https://medusa-url.com/admin/product-categories' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"name\": \"Skinny Jeans\"\n}'\n" } ], "security": [ diff --git a/docs/api/admin/code_samples/JavaScript/admin_auth/post.js b/docs/api/admin/code_samples/JavaScript/admin_auth/post.js index bced0691ff..8bafacb359 100644 --- a/docs/api/admin/code_samples/JavaScript/admin_auth/post.js +++ b/docs/api/admin/code_samples/JavaScript/admin_auth/post.js @@ -3,6 +3,7 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.auth.createSession({ email: 'user@example.com', password: 'supersecret' -}).then((({ user }) => { +}) +.then(({ user }) => { console.log(user.id); }); diff --git a/docs/api/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments/post.js b/docs/api/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments/post.js index 9d7d51688b..69a52c88dd 100644 --- a/docs/api/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments/post.js +++ b/docs/api/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments/post.js @@ -1,7 +1,8 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token -medusa.admin.orders.fulfillClaim(order_id, claim_id) +medusa.admin.orders.fulfillClaim(order_id, claim_id, { +}) .then(({ order }) => { console.log(order.id); }); diff --git a/docs/api/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.js b/docs/api/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.js index c8cfa86c08..e68da19f99 100644 --- a/docs/api/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.js +++ b/docs/api/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.js @@ -1,7 +1,9 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token -medusa.admin.orders.fulfillSwap(order_id, swap_id) +medusa.admin.orders.fulfillSwap(order_id, swap_id, { + +}) .then(({ order }) => { console.log(order.id); }); diff --git a/docs/api/admin/code_samples/Shell/admin_product-categories/post.sh b/docs/api/admin/code_samples/Shell/admin_product-categories/post.sh index 712e20f60f..11856f7a09 100644 --- a/docs/api/admin/code_samples/Shell/admin_product-categories/post.sh +++ b/docs/api/admin/code_samples/Shell/admin_product-categories/post.sh @@ -2,5 +2,5 @@ curl --location --request POST 'https://medusa-url.com/admin/product-categories' --header 'Authorization: Bearer {api_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ - "name": "Skinny Jeans", + "name": "Skinny Jeans" }'