Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

fix(docs): preserve inline API paths in generated SDK reference (#3619)

Alberto Schiabelf3dd9343e67a
diff --git a/docs/content/reference/sdk-reference/typescript/connected-accounts.mdx b/docs/content/reference/sdk-reference/typescript/connected-accounts.mdx
index 682030f98..448211c32 100644
--- a/docs/content/reference/sdk-reference/typescript/connected-accounts.mdx
+++ b/docs/content/reference/sdk-reference/typescript/connected-accounts.mdx
@@ -145,7 +145,7 @@ This function creates a new connected account and returns a connection request.
Users can then wait for the connection to be established using the `waitForConnection` method.
**Deprecated for Composio-managed OAuth (OAuth1, OAuth2, DCR_OAUTH).**
-The legacy `POST endpoint that this method
+The legacy `POST /api/v3/connected_accounts` endpoint that this method
wraps is being retired for Composio-managed auth configs on redirectable
schemes. The cutover is **2026-05-08** for new organizations and
**2026-07-03** for all remaining organizations. After your org's cutover,
diff --git a/ts/packages/core/scripts/generate-docs.ts b/ts/packages/core/scripts/generate-docs.ts
index ef3995aab..f9cbaf1e1 100644
--- a/ts/packages/core/scripts/generate-docs.ts
+++ b/ts/packages/core/scripts/generate-docs.ts
@@ -226,8 +226,15 @@ function extractDescription(comment?: TypeDocReflection['comment']): string {
if (!comment) return '';
let desc = extractText(comment.summary);
- // Clean up API paths that shouldn't be in user-facing docs
- desc = desc.replace(/\/?api\/v\d+\/[^\s]*/g, '').trim();
+ // Clean up bare API paths that shouldn't be in user-facing docs, while
+ // preserving intentional route references inside inline code spans.
+ desc = desc
+ .split(/(`[^`]*`)/g)
+ .map(segment =>
+ segment.startsWith('`') ? segment : segment.replace(/\/?api\/v\d+\/[^\s`),.;]*/g, '')
+ )
+ .join('')
+ .trim();
// Clean up multiple newlines and spaces
desc = desc