kb-cloud-client-typescript 2.3.0-alpha.62 → 2.3.0-alpha.65

package/README.md

@@ -1,17 +1,19 @@
-# kb-cloud-client-typescript
+# KubeBlocks Cloud TypeScript SDK
 
 Auto-generated TypeScript SDK for KubeBlocks Cloud API.
 
-## SDKs
+## Install
 
-| SDK | Source | Description |
-|-----|--------|-------------|
-| `openapi` | `openapi.yaml` | User Portal API |
-| `adminapi` | `adminapi.yaml` | Admin Portal API |
-| `internalapi` | `internalapi.yaml` | Internal API |
+```bash
+npm install kb-cloud-client-typescript
+# or
+yarn add kb-cloud-client-typescript
+```
 
 ## Usage
 
+### User Portal API (`openapi`)
+
 ```ts
 import { Configuration, OpenApi } from 'kb-cloud-client-typescript';
 
@@ -21,53 +23,34 @@ const api = new OpenApi.OrganizationApi(
 const orgs = await api.listOrg();
 ```
 
-## Development
-
-### Setup
-
-```bash
-git clone https://github.com/apecloud/kb-cloud-client-typescript.git
-cd kb-cloud-client-typescript
-yarn install
-
-# Clone the OpenAPI spec source (required for SDK generation)
-git clone --depth 1 https://github.com/apecloud/apecloud.git apecloud
-```
-
-To target a specific branch or tag:
+### Admin Portal API (`adminapi`)
 
-```bash
-# Specific branch
-git clone --depth 1 --branch release-2.2 https://github.com/apecloud/apecloud.git apecloud
+```ts
+import { Configuration, AdminApi } from 'kb-cloud-client-typescript/adminapi';
 
-# Specific tag
-git clone --depth 1 --branch v2.2.6 https://github.com/apecloud/apecloud.git apecloud
+const api = new AdminApi.OrganizationApi(
+  new Configuration({ basePath: 'https://api.example.com' })
+);
 ```
 
-If already cloned, switch with:
-
-```bash
-cd apecloud
-git fetch --tags
-git checkout v2.2.6
-```
+### Internal API (`internalapi`)
 
-### Generate SDK
+```ts
+import { Configuration, InternalApi } from 'kb-cloud-client-typescript/internalapi';
 
-```bash
-yarn api:build    # Bundle specs + generate all three SDKs + tsc
+const api = new InternalApi.SomeApi(
+  new Configuration({ basePath: 'https://api.example.com' })
+);
 ```
 
-### Publish
-
-```bash
-yarn publish      # Publish to npm
-```
+## Available SDKs
 
-## CI
+| Import Path | Description |
+|---|---|
+| `kb-cloud-client-typescript` | User Portal API |
+| `kb-cloud-client-typescript/adminapi` | Admin Portal API |
+| `kb-cloud-client-typescript/internalapi` | Internal API |
 
-GitHub Actions workflow (`.github/workflows/generate-and-publish.yml`) auto-generates on push to main:
+## API Documentation
 
-1. Clone `apecloud/apecloud` (default branch, overridable via `workflow_dispatch`)
-2. `redocly bundle` → `openapi-generator-cli` → `tsc`
-3. Publish to npm (requires `NPM_TOKEN` secret)
+Refer to the [KubeBlocks API documentation](https://docs.kubeblocks.io) for endpoint details.