Skip to content

Commit e5fb75c

Browse files
shahednasserclaude
andauthored
docs(packages): migrate legacy API reference links to new page paths in TSDocs (#16184)
Rewrites hash-anchor API-reference links (e.g. `/api/admin#carts_getcartsid`) to the new real page paths (`/api/admin/carts/get-a-cart`) in TSDoc comments across core-flows, js-sdk, types, and utils. Includes hand-fixed renames (MFA, order transfer, customer addresses, etc.). Comment-only changes. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 426c19d commit e5fb75c

294 files changed

Lines changed: 761 additions & 761 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

packages/core/core-flows/src/api-key/workflows/create-api-keys.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export type CreateApiKeysWorkflowOutput = ApiKeyDTO[]
2525
export const createApiKeysWorkflowId = "create-api-keys"
2626
/**
2727
* This workflow creates one or more API keys, which can be secret or publishable. It's used by the
28-
* [Create API Key Admin API Route](https://docs.medusajs.com/api/admin#api-keys_postapikeys).
28+
* [Create API Key Admin API Route](https://docs.medusajs.com/api/admin/api-keys/create-api-key).
2929
*
3030
* You can use this workflow within your customizations or your own custom workflows, allowing you to
3131
* create API keys within your custom flows.

packages/core/core-flows/src/api-key/workflows/delete-api-keys.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export type DeleteApiKeysWorkflowInput = {
1616
export const deleteApiKeysWorkflowId = "delete-api-keys"
1717
/**
1818
* This workflow deletes one or more secret or publishable API keys. It's used by the
19-
* [Delete API Key Admin API Route](https://docs.medusajs.com/api/admin#api-keys_deleteapikeysid).
19+
* [Delete API Key Admin API Route](https://docs.medusajs.com/api/admin/api-keys/delete-an-api-key).
2020
*
2121
* You can use this workflow within your customizations or your own custom workflows, allowing you to
2222
* delete API keys within your custom flows.

packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const linkSalesChannelsToApiKeyWorkflowId =
1818
"link-sales-channels-to-api-key"
1919
/**
2020
* This workflow manages the sales channels of a publishable API key. It's used by the
21-
* [Manage Sales Channels API Route](https://docs.medusajs.com/api/admin#api-keys_postapikeysidsaleschannels).
21+
* [Manage Sales Channels API Route](https://docs.medusajs.com/api/admin/api-keys/manage-sales-channels).
2222
*
2323
* You can use this workflow within your customizations or your own custom workflows, allowing you to
2424
* manage the sales channels of a publishable API key within your custom flows.

packages/core/core-flows/src/api-key/workflows/revoke-api-keys.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export const revokeApiKeysWorkflowId = "revoke-api-keys"
3434
* This workflow revokes one or more API keys. If the API key is a secret,
3535
* it can't be used for authentication anymore. If it's publishable, it can't be used by client applications.
3636
*
37-
* This workflow is used by the [Revoke API Key API Route](https://docs.medusajs.com/api/admin#api-keys_postapikeysidrevoke).
37+
* This workflow is used by the [Revoke API Key API Route](https://docs.medusajs.com/api/admin/api-keys/revoke-api-key).
3838
*
3939
* You can use this workflow within your customizations or your own custom workflows, allowing you to
4040
* revoke API keys within your custom flows.

packages/core/core-flows/src/api-key/workflows/update-api-keys.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export type UpdateApiKeysWorkflowOutput = ApiKeyDTO[]
3232
export const updateApiKeysWorkflowId = "update-api-keys"
3333
/**
3434
* This workflow updates one or more secret or publishable API keys. It's used by the
35-
* [Update API Key Admin API Route](https://docs.medusajs.com/api/admin#api-keys_postapikeysid).
35+
* [Update API Key Admin API Route](https://docs.medusajs.com/api/admin/api-keys/update-an-api-key).
3636
*
3737
* You can use this workflow within your customizations or your own custom workflows, allowing you to
3838
* update API keys within your custom flows.

packages/core/core-flows/src/auth/workflows/generate-reset-password-token.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ const RESET_PASSWORD_TOKEN_TTL_SECONDS = 15 * 60
1515

1616
/**
1717
* This workflow generates a reset password token for a user. It's used by the
18-
* [Generate Reset Password Token for Admin](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword)
19-
* and [Generate Reset Password Token for Customer](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerresetpassword)
18+
* [Generate Reset Password Token for Admin](https://docs.medusajs.com/api/admin/auth/generate-reset-password-token)
19+
* and [Generate Reset Password Token for Customer](https://docs.medusajs.com/api/store/auth/generate-reset-password-token)
2020
* API Routes.
2121
*
2222
* The workflow emits the `auth.password_reset` event, which you can listen to in

packages/core/core-flows/src/cart/workflows/add-shipping-method-to-cart.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export interface AddShippingMethodToCartWorkflowInput {
5151
export const addShippingMethodToCartWorkflowId = "add-shipping-method-to-cart"
5252
/**
5353
* This workflow adds a shipping method to a cart. It's executed by the
54-
* [Add Shipping Method Store API Route](https://docs.medusajs.com/api/store#carts_postcartsidshippingmethods).
54+
* [Add Shipping Method Store API Route](https://docs.medusajs.com/api/store/carts/add-shipping-method).
5555
*
5656
* You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding a shipping method to the cart.
5757
*

packages/core/core-flows/src/cart/workflows/add-to-cart.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ const variantFields = deduplicate([
5454
export const addToCartWorkflowId = "add-to-cart"
5555
/**
5656
* This workflow adds a product variant to a cart as a line item. It's executed by the
57-
* [Add Line Item Store API Route](https://docs.medusajs.com/api/store#carts_postcartsidlineitems).
57+
* [Add Line Item Store API Route](https://docs.medusajs.com/api/store/carts/add-line-item).
5858
*
5959
* You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding an item to the cart.
6060
* For example, you can use this workflow to add a line item to the cart with a custom price.

packages/core/core-flows/src/cart/workflows/complete-cart.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ const TWO_MINUTES = 60 * 2
7373
export const completeCartWorkflowId = "complete-cart"
7474
/**
7575
* This workflow completes a cart and places an order for the customer. It's executed by the
76-
* [Complete Cart Store API Route](https://docs.medusajs.com/api/store#carts_postcartsidcomplete).
76+
* [Complete Cart Store API Route](https://docs.medusajs.com/api/store/carts/complete-cart).
7777
*
7878
* You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around completing a cart.
7979
* For example, in the [Subscriptions recipe](https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard#create-workflow),

packages/core/core-flows/src/cart/workflows/create-carts.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ export const prepareCartToCreateStep = createStep(
112112
export const createCartWorkflowId = "create-cart"
113113
/**
114114
* This workflow creates and returns a cart. You can set the cart's items, region, customer, and other details. This workflow is executed by the
115-
* [Create Cart Store API Route](https://docs.medusajs.com/api/store#carts_postcarts).
115+
* [Create Cart Store API Route](https://docs.medusajs.com/api/store/carts/create-cart).
116116
*
117117
* This workflow has a hook that allows you to perform custom actions on the created cart. You can see an example in [this guide](https://docs.medusajs.com/resources/commerce-modules/cart/extend#step-4-consume-cartcreated-workflow-hook).
118118
*

0 commit comments

Comments
 (0)