@dx-do/client 5.2.36 → 5.2.37

package/README.md

@@ -90,3 +90,40 @@ import { createServiceMonolith, DxSaasService, AlertService, DXDoConfiguration }
 ```
 
 For configuration shape variants and helpers, see exports under `./lib/model/config/` in the source tree (also re-exported from the package index where applicable).
+
+## API Reference
+
+Full generated API documentation lives in [`docs/client/api/`](../../docs/client/api/) at the repository root.
+
+To regenerate after source changes:
+
+```bash
+nx run client:docs
+```
+
+> The docs target requires `typedoc` and `typedoc-rhineai-theme` to be installed. Run `bun install` (or `npm install`) first.
+
+## Deprecated symbols
+
+The following symbols are retained for backwards compatibility but should not be used in new code:
+
+| Symbol | Replacement |
+|--------|-------------|
+| `AlertResponse.Alert` / `AlertResponse.AlertList` | `AlertResponseV2.*` |
+| `AlertResponse.AllAlertsRequestBody` | `AlertResponseV2.AllAlertsRequestBody` |
+| `DXSaaSConfigurationLegacy` | `DXSaaSConfiguration4` |
+| `DXSaaSConfiguration3` | `DXSaaSConfiguration4` |
+| `ChannelResponse.WebhookSpec` | `DXChannelWebhookSpecificConfiguration` |
+| `TemplatesResponse.LinkedEntity` | `PolicyResponse.LinkedEntity` |
+
+## ASM integration
+
+The ASM (Application Security Manager) SDK (`src/lib/model/asm/client/`) is auto-generated from the OpenAPI spec and is excluded from the TypeDoc output. To regenerate:
+
+```bash
+nx run client:generate-asm-client
+```
+
+The source spec is at: `https://api.asm.saas.broadcom.com/v3/documentation`.
+
+ASM API calls are routed through [`AsmService`](src/lib/services/asm.service.ts). Set `dxASMbaseAPIURL` and `dxASMToken` in `DXSaaSConfiguration4` to enable them.