API Docs Build Fix

[MuhammadKhalilzadeh]

API Docs Build Fix

Please ensure all items are checked off before requesting a review:

• I deployed the code locally.
• I have performed a self-review of my code.
• I have included the issue # in the PR.
• I have labelled the PR correctly.
• The issue I am working on is assigned to me.
• I have avoided using hardcoded values to ensure scalability and maintain consistency across the application.
• I have ensured that font sizes, color choices, and other UI elements are referenced from the theme.
• My pull request is focused and addresses a single, specific feature.

---

Problem

After generating endpoints.ts from swagger.yaml and updating App.tsx, the docs/api-docs app failed to build due to:

1. Missing endpoint groups — slackWebhookEndpoints, tokenEndpoints, and userPreferenceEndpoints were imported in App.tsx but didn't exist in endpoints.ts because the swagger spec tagged those endpoints under parent categories (Integrations, Authentication, Users).
2. Missing nav items/sections — Several generated endpoint groups (demoData, internal, riskHistory, setting, webhooks) had no corresponding sidebar entries or EndpointSection renders.
3. Generated TypeScript errors — The endpoint generator produced in: 'undefined' and in: 'cookie' parameter values that violated the Parameter type.
4. UserGuide icon type errors — Three UserGuide components used collection.icon (a string) directly as a JSX component, causing TS errors.
5. Missing index.html — The Vite entry point was absent, preventing both npm run dev and npm run build.
6. Deprecated baseUrl in tsconfig — TypeScript native preview (TS 7) flagged baseUrl as removed and required relative path prefixes.

---

Changes Made

Commit 1 — fix(swagger): re-tag slack-webhooks, tokens, user-preferences as separate groups

File: Servers/swagger.yaml

Re-tagged 14 operations so the generator creates dedicated endpoint groups:

Endpoints	Old Tag	New Tag
/slackWebhooks/* (6 ops)	Integrations	Slack Webhooks
/tokens/* (3 ops)	Authentication	Tokens
/user-preferences/* (3 ops)	Users	User Preferences
/users/login, /users/refresh-token (2 ops)	Users - Authentication	Authentication

Commit 2 — feat(api-docs): regenerate endpoints.ts with corrected tags

Files: Servers/scripts/generateEndpointsTs.ts, docs/api-docs/src/config/endpoints.ts

• Added Authentication to the explicit tag-to-variable-name map in the generator.
• Added parameter filtering to skip entries with undefined name/in or non-standard in values (e.g., cookie).
• Regenerated endpoints.ts — now produces 62 endpoint groups (up from 61), including the new slackWebhookEndpoints, tokenEndpoints, userPreferenceEndpoints, and authenticationEndpoints.

Commit 3 — fix(api-docs): add missing nav items/sections and fix UserGuide icon types

Files: docs/api-docs/src/App.tsx, docs/api-docs/src/components/UserGuide/iconResolver.ts (new), ArticlePage.tsx, CollectionPage.tsx, UserGuideLanding.tsx

• Added imports for demoDataEndpoints, internalEndpoints, riskHistoryEndpoints, settingEndpoints.
• Added 5 sidebar nav items: Risk history, Settings, Webhooks, Demo data, Internal.
• Added 5 EndpointSection renders for the above groups.
• Created iconResolver.ts — maps IconName strings to lucide-react components.
• Fixed three UserGuide components to use resolveIcon(collection.icon) instead of using the string directly as JSX.

Commit 4 — fix(api-docs): add missing index.html for standalone dev and build

File: docs/api-docs/index.html (new)

Added the standard Vite entry point HTML file that mounts the React app at #root.

Commit 5 — fix(api-docs): remove baseUrl and use relative paths in tsconfig

File: docs/api-docs/tsconfig.json

• Removed deprecated baseUrl option (removed in TypeScript 7).
• Changed path values to use relative ./ prefixes ("./src/*", "./node_modules/lucide-react").
• Changed include entry from "src" to "./src".

---

Verification

Check	Result
npx tsc --noEmit	Pass (0 errors)
npm run build (tsc + vite)	Pass
npm run dev	Serves at localhost:5173, HTTP 200

---

Notes

• The docs/api-docs app is a standalone Vite/React application. It is not integrated into the main Clients app.
• The vite build emits a chunk size warning (2.1 MB bundle) — this is advisory only and could be addressed with code-splitting in the future.
• Total endpoint count: 553 endpoints across 62 groups.