From 3b632c513047931a8beccbd004349eb7bfc979e4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 11 Jan 2023 17:43:03 +0200 Subject: [PATCH] chore(docs): Generated API Reference (#2991) Co-authored-by: shahednasser --- docs/api/admin-spec3.json | 78 ++++++++++--------- docs/api/admin-spec3.yaml | 78 ++++++++++--------- .../publishable-api-key_{id}/postundefined | 8 +- .../publishable-api-keys/getundefined | 2 +- .../publishable-api-keys/postundefined | 10 ++- .../publishable-api-keys_{id}/deleteundefined | 8 +- .../publishable-api-keys_{id}/getundefined | 8 +- .../postundefined | 2 +- .../getundefined | 4 +- .../deleteundefined | 2 +- .../postundefined | 2 +- .../publishable-api-key_{id}/postundefined | 4 +- .../Shell/publishable-api-keys/postundefined | 7 +- .../publishable-api-keys_{id}/deleteundefined | 2 +- .../publishable-api-keys_{id}/getundefined | 3 +- .../postundefined | 3 +- .../getundefined | 2 +- .../deleteundefined | 2 +- .../postundefined | 2 +- 19 files changed, 121 insertions(+), 106 deletions(-) diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json index b3a3a5a979..3a591aca54 100644 --- a/docs/api/admin-spec3.json +++ b/docs/api/admin-spec3.json @@ -12314,7 +12314,7 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKeys.addSalesChannels(publishableApiKeyId, + medusa.admin.publishableApiKeys.addSalesChannelsBatch(publishableApiKeyId, { sales_channel_ids: [ { @@ -12330,7 +12330,7 @@ paths: label: cURL source: > curl --location --request POST - 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \ + 'https://medusa-url.com/admin/publishable-api-keys/{pak_id}/batch' \ --header 'Authorization: Bearer {api_token}' \ @@ -12398,7 +12398,7 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKeys.removeSalesChannels(publishableApiKeyId, + medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(publishableApiKeyId, { sales_channel_ids: [ { @@ -12414,7 +12414,7 @@ paths: label: cURL source: > curl --location --request DELETE - 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \ + 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/batch' \ --header 'Authorization: Bearer {api_token}' \ @@ -12475,19 +12475,26 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKey.create() - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) + medusa.admin.publishableApiKeys.create({ + title + }) + + .then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) + }) - lang: Shell label: cURL source: > curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys' \ - --header 'Authorization: Bearer {api_token}' + --header 'Authorization: Bearer {api_token}' \ - -d '{ "created_by": "user_123" }' + --header 'Content-Type: application/json' \ + + --data-raw '{ + "title": "Web API Key" + }' security: - api_token: [] - cookie_auth: [] @@ -12560,7 +12567,7 @@ paths: // must be previously logged in or use api token medusa.admin.publishableApiKeys.list() - .then(({ publishable_api_keys }) => { + .then(({ publishable_api_keys, count, limit, offset }) => { console.log(publishable_api_keys) }) - lang: Shell @@ -12622,15 +12629,16 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKey.delete(key_id) - .then(({ id, object, deleted }) => { - console.log(id) - }) + medusa.admin.publishableApiKeys.delete(publishableApiKeyId) + + .then(({ id, object, deleted }) => { + console.log(id) + }) - lang: Shell label: cURL source: > curl --location --request DELETE - 'https://medusa-url.com/admin/publishable-api-key/{id}' \ + 'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \ --header 'Authorization: Bearer {api_token}' security: @@ -12682,19 +12690,18 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKey.retrieve(pubKeyId) - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) + medusa.admin.publishableApiKeys.retrieve(publishableApiKeyId) + + .then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) + }) - lang: Shell label: cURL source: > curl --location --request GET - 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123' \ + 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}' \ --header 'Authorization: Bearer {api_token}' - - -d '{ "created_by": "user_123" }' security: - api_token: [] - cookie_auth: [] @@ -12752,14 +12759,14 @@ paths: // must be previously logged in or use api token medusa.admin.publishableApiKeys.listSalesChannels() - .then(({ sales_channels, limit, offset, count }) => { - console.log(sales_channels) + .then(({ sales_channels }) => { + console.log(sales_channels.length) }) - lang: Shell label: cURL source: > curl --location --request GET - 'https://medusa-url.com/admin/publishable-api-keys/pk_123/sales-channels' + 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/sales-channels' \ --header 'Authorization: Bearer {api_token}' @@ -12815,7 +12822,7 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKey.revoke() + medusa.admin.publishableApiKeys.revoke(publishableApiKeyId) .then(({ publishable_api_key }) => { console.log(publishable_api_key.id) }) @@ -12823,12 +12830,10 @@ paths: label: cURL source: > curl --location --request POST - 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123/revoke' + 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/revoke' \ --header 'Authorization: Bearer {api_token}' - - -d '{ "created_by": "user_123", "revoked_by": "user_123" }' security: - api_token: [] - cookie_auth: [] @@ -12886,24 +12891,25 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKey.update(publishable_key_id, { + medusa.admin.publishableApiKeys.update(publishableApiKeyId, { title: "new title" }) - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) + + .then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) + }) - lang: Shell label: cURL source: > curl --location --request POST - 'https://medusa-url.com/admin/publishable-api-key/{id}' \ + 'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \ --header 'Authorization: Bearer {api_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ - "title": "updated title" + "title": "new title" }' security: - api_token: [] diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml index b3a3a5a979..3a591aca54 100644 --- a/docs/api/admin-spec3.yaml +++ b/docs/api/admin-spec3.yaml @@ -12314,7 +12314,7 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKeys.addSalesChannels(publishableApiKeyId, + medusa.admin.publishableApiKeys.addSalesChannelsBatch(publishableApiKeyId, { sales_channel_ids: [ { @@ -12330,7 +12330,7 @@ paths: label: cURL source: > curl --location --request POST - 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \ + 'https://medusa-url.com/admin/publishable-api-keys/{pak_id}/batch' \ --header 'Authorization: Bearer {api_token}' \ @@ -12398,7 +12398,7 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKeys.removeSalesChannels(publishableApiKeyId, + medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(publishableApiKeyId, { sales_channel_ids: [ { @@ -12414,7 +12414,7 @@ paths: label: cURL source: > curl --location --request DELETE - 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \ + 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/batch' \ --header 'Authorization: Bearer {api_token}' \ @@ -12475,19 +12475,26 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKey.create() - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) + medusa.admin.publishableApiKeys.create({ + title + }) + + .then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) + }) - lang: Shell label: cURL source: > curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys' \ - --header 'Authorization: Bearer {api_token}' + --header 'Authorization: Bearer {api_token}' \ - -d '{ "created_by": "user_123" }' + --header 'Content-Type: application/json' \ + + --data-raw '{ + "title": "Web API Key" + }' security: - api_token: [] - cookie_auth: [] @@ -12560,7 +12567,7 @@ paths: // must be previously logged in or use api token medusa.admin.publishableApiKeys.list() - .then(({ publishable_api_keys }) => { + .then(({ publishable_api_keys, count, limit, offset }) => { console.log(publishable_api_keys) }) - lang: Shell @@ -12622,15 +12629,16 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKey.delete(key_id) - .then(({ id, object, deleted }) => { - console.log(id) - }) + medusa.admin.publishableApiKeys.delete(publishableApiKeyId) + + .then(({ id, object, deleted }) => { + console.log(id) + }) - lang: Shell label: cURL source: > curl --location --request DELETE - 'https://medusa-url.com/admin/publishable-api-key/{id}' \ + 'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \ --header 'Authorization: Bearer {api_token}' security: @@ -12682,19 +12690,18 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKey.retrieve(pubKeyId) - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) + medusa.admin.publishableApiKeys.retrieve(publishableApiKeyId) + + .then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) + }) - lang: Shell label: cURL source: > curl --location --request GET - 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123' \ + 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}' \ --header 'Authorization: Bearer {api_token}' - - -d '{ "created_by": "user_123" }' security: - api_token: [] - cookie_auth: [] @@ -12752,14 +12759,14 @@ paths: // must be previously logged in or use api token medusa.admin.publishableApiKeys.listSalesChannels() - .then(({ sales_channels, limit, offset, count }) => { - console.log(sales_channels) + .then(({ sales_channels }) => { + console.log(sales_channels.length) }) - lang: Shell label: cURL source: > curl --location --request GET - 'https://medusa-url.com/admin/publishable-api-keys/pk_123/sales-channels' + 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/sales-channels' \ --header 'Authorization: Bearer {api_token}' @@ -12815,7 +12822,7 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKey.revoke() + medusa.admin.publishableApiKeys.revoke(publishableApiKeyId) .then(({ publishable_api_key }) => { console.log(publishable_api_key.id) }) @@ -12823,12 +12830,10 @@ paths: label: cURL source: > curl --location --request POST - 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123/revoke' + 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/revoke' \ --header 'Authorization: Bearer {api_token}' - - -d '{ "created_by": "user_123", "revoked_by": "user_123" }' security: - api_token: [] - cookie_auth: [] @@ -12886,24 +12891,25 @@ paths: // must be previously logged in or use api token - medusa.admin.publishableApiKey.update(publishable_key_id, { + medusa.admin.publishableApiKeys.update(publishableApiKeyId, { title: "new title" }) - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) + + .then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) + }) - lang: Shell label: cURL source: > curl --location --request POST - 'https://medusa-url.com/admin/publishable-api-key/{id}' \ + 'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \ --header 'Authorization: Bearer {api_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ - "title": "updated title" + "title": "new title" }' security: - api_token: [] diff --git a/docs/api/admin/code_samples/JavaScript/publishable-api-key_{id}/postundefined b/docs/api/admin/code_samples/JavaScript/publishable-api-key_{id}/postundefined index 5559f00ea4..5b9e46f3d4 100644 --- a/docs/api/admin/code_samples/JavaScript/publishable-api-key_{id}/postundefined +++ b/docs/api/admin/code_samples/JavaScript/publishable-api-key_{id}/postundefined @@ -1,9 +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.publishableApiKey.update(publishable_key_id, { +medusa.admin.publishableApiKeys.update(publishableApiKeyId, { title: "new title" }) - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) +.then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) +}) diff --git a/docs/api/admin/code_samples/JavaScript/publishable-api-keys/getundefined b/docs/api/admin/code_samples/JavaScript/publishable-api-keys/getundefined index 893936cf51..0aed124df5 100644 --- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys/getundefined +++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys/getundefined @@ -2,6 +2,6 @@ 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.publishableApiKeys.list() - .then(({ publishable_api_keys }) => { + .then(({ publishable_api_keys, count, limit, offset }) => { console.log(publishable_api_keys) }) diff --git a/docs/api/admin/code_samples/JavaScript/publishable-api-keys/postundefined b/docs/api/admin/code_samples/JavaScript/publishable-api-keys/postundefined index 7daeb2fc03..2e83cfc321 100644 --- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys/postundefined +++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys/postundefined @@ -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.publishableApiKey.create() - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) +medusa.admin.publishableApiKeys.create({ + title +}) +.then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) +}) diff --git a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/deleteundefined b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/deleteundefined index 1b290cbee8..0da44544f5 100644 --- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/deleteundefined +++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/deleteundefined @@ -1,7 +1,7 @@ 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.publishableApiKey.delete(key_id) - .then(({ id, object, deleted }) => { - console.log(id) - }) +medusa.admin.publishableApiKeys.delete(publishableApiKeyId) +.then(({ id, object, deleted }) => { + console.log(id) +}) diff --git a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/getundefined b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/getundefined index 875ac03a4b..a49f6d1a5b 100644 --- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/getundefined +++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/getundefined @@ -1,7 +1,7 @@ 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.publishableApiKey.retrieve(pubKeyId) - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) +medusa.admin.publishableApiKeys.retrieve(publishableApiKeyId) +.then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) +}) diff --git a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_revoke/postundefined b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_revoke/postundefined index f3bd1513b7..3705a7e41d 100644 --- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_revoke/postundefined +++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_revoke/postundefined @@ -1,7 +1,7 @@ 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.publishableApiKey.revoke() +medusa.admin.publishableApiKeys.revoke(publishableApiKeyId) .then(({ publishable_api_key }) => { console.log(publishable_api_key.id) }) diff --git a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels/getundefined b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels/getundefined index b7039a418b..df67996f8d 100644 --- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels/getundefined +++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels/getundefined @@ -2,6 +2,6 @@ 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.publishableApiKeys.listSalesChannels() - .then(({ sales_channels, limit, offset, count }) => { - console.log(sales_channels) + .then(({ sales_channels }) => { + console.log(sales_channels.length) }) diff --git a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/deleteundefined b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/deleteundefined index 84e874b3a2..e4e422b731 100644 --- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/deleteundefined +++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/deleteundefined @@ -1,7 +1,7 @@ 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.publishableApiKeys.removeSalesChannels(publishableApiKeyId, { +medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(publishableApiKeyId, { sales_channel_ids: [ { id: channel_id diff --git a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/postundefined b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/postundefined index a74d1ede9f..1c882fcc81 100644 --- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/postundefined +++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/postundefined @@ -1,7 +1,7 @@ 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.publishableApiKeys.addSalesChannels(publishableApiKeyId, { +medusa.admin.publishableApiKeys.addSalesChannelsBatch(publishableApiKeyId, { sales_channel_ids: [ { id: channel_id diff --git a/docs/api/admin/code_samples/Shell/publishable-api-key_{id}/postundefined b/docs/api/admin/code_samples/Shell/publishable-api-key_{id}/postundefined index c52824266e..d215a07397 100644 --- a/docs/api/admin/code_samples/Shell/publishable-api-key_{id}/postundefined +++ b/docs/api/admin/code_samples/Shell/publishable-api-key_{id}/postundefined @@ -1,6 +1,6 @@ -curl --location --request POST 'https://medusa-url.com/admin/publishable-api-key/{id}' \ +curl --location --request POST 'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \ --header 'Authorization: Bearer {api_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ - "title": "updated title" + "title": "new title" }' diff --git a/docs/api/admin/code_samples/Shell/publishable-api-keys/postundefined b/docs/api/admin/code_samples/Shell/publishable-api-keys/postundefined index 87b05f49be..d76c693a80 100644 --- a/docs/api/admin/code_samples/Shell/publishable-api-keys/postundefined +++ b/docs/api/admin/code_samples/Shell/publishable-api-keys/postundefined @@ -1,3 +1,6 @@ curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys' \ ---header 'Authorization: Bearer {api_token}' --d '{ "created_by": "user_123" }' +--header 'Authorization: Bearer {api_token}' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "title": "Web API Key" +}' diff --git a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/deleteundefined b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/deleteundefined index 41922603be..2d06576df9 100644 --- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/deleteundefined +++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/deleteundefined @@ -1,2 +1,2 @@ -curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-key/{id}' \ +curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \ --header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/getundefined b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/getundefined index 3a3f1a00ed..7eebfe5c87 100644 --- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/getundefined +++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/getundefined @@ -1,3 +1,2 @@ -curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123' \ +curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}' \ --header 'Authorization: Bearer {api_token}' --d '{ "created_by": "user_123" }' diff --git a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_revoke/postundefined b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_revoke/postundefined index f742a92ad3..6c3c1731a0 100644 --- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_revoke/postundefined +++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_revoke/postundefined @@ -1,3 +1,2 @@ -curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123/revoke' \ +curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/revoke' \ --header 'Authorization: Bearer {api_token}' --d '{ "created_by": "user_123", "revoked_by": "user_123" }' diff --git a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels/getundefined b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels/getundefined index f3845038b6..9b1a9ec8f3 100644 --- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels/getundefined +++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels/getundefined @@ -1,2 +1,2 @@ -curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/pk_123/sales-channels' \ +curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/sales-channels' \ --header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/deleteundefined b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/deleteundefined index 390c392a78..464937929e 100644 --- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/deleteundefined +++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/deleteundefined @@ -1,4 +1,4 @@ -curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \ +curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/batch' \ --header 'Authorization: Bearer {api_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ diff --git a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/postundefined b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/postundefined index 6c7fc9369f..328abe74a6 100644 --- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/postundefined +++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/postundefined @@ -1,4 +1,4 @@ -curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \ +curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/{pak_id}/batch' \ --header 'Authorization: Bearer {api_token}' \ --header 'Content-Type: application/json' \ --data-raw '{