Skip to content

Commit fe7995c

Browse files
committed
chore: regenerate the API reference, CLI surface, and CLI docs
Carries the contract wording and the new bulk-document response shape into the published reference, the generated command surface, and the command pages.
1 parent 7697d7f commit fe7995c

18 files changed

Lines changed: 161 additions & 134 deletions

apps/docs/content/docs/en/cli/billing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Show billing status and current-period credit usage (credits and storage require
3131
sim billing logs [options]
3232
```
3333

34-
List credit usage events (a personal API key reports only your own events; a workspace API key reports every member's)
34+
List credit usage events (a personal API key reports only your own events; a workspace API key reports every member's in aggregate, unattributed)
3535

3636
**Options**
3737

apps/docs/content/docs/en/cli/credentials.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Disconnect Credential (personal API key required)
3333

3434
| Option | Required | Description |
3535
| --- | --- | --- |
36-
| `-y, --yes` | Yes | Confirm this destructive operation. |
36+
| `-y, --yes` | Yes | Confirm this operation. |
3737

3838
</CommandTable>
3939

apps/docs/content/docs/en/cli/custom-tools.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ sim custom-tools delete <customToolId> [options]
4949

5050
| Option | Required | Description |
5151
| --- | --- | --- |
52-
| `-y, --yes` | Yes | Confirm this destructive operation. |
52+
| `-y, --yes` | Yes | Confirm this operation. |
5353

5454
</CommandTable>
5555

apps/docs/content/docs/en/cli/files.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ sim files batch-delete [options]
2222
| Option | Required | Description |
2323
| --- | --- | --- |
2424
| `--file-ids <value...>` | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
25-
| `-y, --yes` | Yes | Confirm this destructive operation. |
25+
| `-y, --yes` | Yes | Confirm this operation. |
2626

2727
</CommandTable>
2828

@@ -85,11 +85,11 @@ sim files folders delete <path> [options]
8585
| Option | Required | Description |
8686
| --- | --- | --- |
8787
| `--recursive` | No | Delete the folder and its descendants. |
88-
| `-y, --yes` | Yes | Confirm this destructive operation. |
88+
| `-y, --yes` | Yes | Confirm this operation. |
8989

9090
</CommandTable>
9191

92-
## List folders
92+
## List folders; returns the whole set, so there is no --limit and no paging
9393

9494
```bash
9595
sim files folders list [options]
@@ -168,7 +168,7 @@ sim files delete <fileId> [options]
168168

169169
| Option | Required | Description |
170170
| --- | --- | --- |
171-
| `-y, --yes` | Yes | Confirm this destructive operation. |
171+
| `-y, --yes` | Yes | Confirm this operation. |
172172

173173
</CommandTable>
174174

@@ -377,7 +377,7 @@ sim files unzip <fileId> [options]
377377

378378
| Option | Required | Description |
379379
| --- | --- | --- |
380-
| `-y, --yes` | Yes | Confirm this destructive operation. |
380+
| `-y, --yes` | Yes | Confirm this operation. |
381381

382382
</CommandTable>
383383

apps/docs/content/docs/en/cli/knowledge.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Delete Tag (personal API key required)
120120

121121
| Option | Required | Description |
122122
| --- | --- | --- |
123-
| `-y, --yes` | Yes | Confirm this destructive operation. |
123+
| `-y, --yes` | Yes | Confirm this operation. |
124124

125125
</CommandTable>
126126

@@ -150,7 +150,7 @@ Remove tag definitions no document still uses (personal API key required)
150150
| --- | --- | --- |
151151
| `--unused` | No | Whether to remove only the tag definitions no document in the knowledge base still carries a value for. Defaults to true. Pass --no-unused to delete every definition on the knowledge base, which also clears its slot on every document and chunk and is not recoverable. |
152152
| `--no-unused` | No | Send --unused as false. |
153-
| `-y, --yes` | Yes | Confirm this destructive operation. |
153+
| `-y, --yes` | Yes | Confirm this operation. |
154154

155155
</CommandTable>
156156

@@ -273,7 +273,7 @@ Enable, disable, or delete many chunks at once (personal API key required)
273273
| --- | --- | --- |
274274
| `--operation <value>` | Yes | What to do with the selected chunks. Accepted values: `enable`, `disable`, `delete`. |
275275
| `--chunk <value...>` | Yes | Chunks to operate on, by identifier. An id naming no chunk in the document is reported in errors and does not fail the request. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
276-
| `-y, --yes` | Yes | Confirm this destructive operation. |
276+
| `-y, --yes` | Yes | Confirm this operation. |
277277

278278
</CommandTable>
279279

@@ -334,7 +334,7 @@ Delete Chunk (personal API key required)
334334

335335
| Option | Required | Description |
336336
| --- | --- | --- |
337-
| `-y, --yes` | Yes | Confirm this destructive operation. |
337+
| `-y, --yes` | Yes | Confirm this operation. |
338338

339339
</CommandTable>
340340

@@ -477,7 +477,7 @@ sim knowledge documents delete <knowledgeBaseId> <documentId> [options]
477477

478478
| Option | Required | Description |
479479
| --- | --- | --- |
480-
| `-y, --yes` | Yes | Confirm this destructive operation. |
480+
| `-y, --yes` | Yes | Confirm this operation. |
481481

482482
</CommandTable>
483483

@@ -606,8 +606,8 @@ sim knowledge documents upload <knowledgeBaseId> <path> [options]
606606
| --- | --- | --- |
607607
| `--name <name>` | No | Store it under a different name. |
608608
| `--tag <value...>` | No | Document tags, in tag1 through tag7 order. |
609-
| `--recipe <name>` | No | Document processing recipe. |
610-
| `--lang <code>` | No | Document language code. |
609+
| `--recipe <name>` | No | Document processing recipe. Accepted values: `default`, `plain`, `markdown`, `code`. |
610+
| `--lang <code>` | No | Document language tag: hyphen-separated letter and digit subtags, for example en or en-US. |
611611

612612
</CommandTable>
613613

@@ -689,7 +689,7 @@ Delete Knowledge Connector (personal API key required)
689689
| --- | --- | --- |
690690
| `--delete-documents` | No | Also permanently delete documents produced by this connector. |
691691
| `--no-delete-documents` | No | Send --delete-documents as false. |
692-
| `-y, --yes` | Yes | Confirm this destructive operation. |
692+
| `-y, --yes` | Yes | Confirm this operation. |
693693

694694
</CommandTable>
695695

@@ -903,11 +903,11 @@ sim knowledge folders delete <path> [options]
903903
| Option | Required | Description |
904904
| --- | --- | --- |
905905
| `--recursive` | No | Delete the folder and its descendants. |
906-
| `-y, --yes` | Yes | Confirm this destructive operation. |
906+
| `-y, --yes` | Yes | Confirm this operation. |
907907

908908
</CommandTable>
909909

910-
## List folders
910+
## List folders; returns the whole set, so there is no --limit and no paging
911911

912912
```bash
913913
sim knowledge folders list [options]
@@ -969,7 +969,7 @@ sim knowledge delete <knowledgeBaseId> [options]
969969

970970
| Option | Required | Description |
971971
| --- | --- | --- |
972-
| `-y, --yes` | Yes | Confirm this destructive operation. |
972+
| `-y, --yes` | Yes | Confirm this operation. |
973973

974974
</CommandTable>
975975

@@ -985,7 +985,7 @@ sim knowledge get <knowledgeBaseId>
985985

986986
| Argument | Required | Description |
987987
| --- | --- | --- |
988-
| `knowledgeBaseId` | Yes | Unique knowledge base identifier. |
988+
| `knowledgeBaseId` | Yes | Knowledge base to read. Active knowledge bases only: an archived one answers 404 here, is listed by `scope=archived`, and is brought back by the restore endpoint. |
989989

990990
</CommandTable>
991991

@@ -1001,7 +1001,7 @@ sim knowledge list [options]
10011001

10021002
| Option | Required | Description |
10031003
| --- | --- | --- |
1004-
| `--scope <value>` | No | Which lifecycle set to list: `active` (default) for live knowledge bases, `archived` for knowledge bases a `DELETE` archived and `POST /knowledge/&#123;knowledgeBaseId&#125;/restore` can bring back. `folderPath` resolves against active folders only, so pairing it with `scope=archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`. |
1004+
| `--scope <value>` | No | Which lifecycle set to list: `active` (default) for live knowledge bases, `archived` for knowledge bases a delete archived and the restore operation can bring back. The folder filter resolves against active folders only, so pairing it with `archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`. |
10051005
| `--folder <value>` | No | Folder path as shown in the app; the leading / is optional. |
10061006
| `--search <value>` | No | Case-insensitive substring match against the resource name. |
10071007
| `--sort-by <value>` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |

apps/docs/content/docs/en/cli/logs.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ sim logs get <runId> [options]
2121

2222
| Argument | Required | Description |
2323
| --- | --- | --- |
24-
| `runId` | Yes | Unique workflow run identifier. |
24+
| `runId` | Yes | Unique workflow run identifier. A run is addressed globally by this id: unlike the list and statistics routes, this route takes no workspace. The run carries its own workspace and the caller is authorized against that one, so a run the caller cannot reach is concealed as a 404 rather than filtered out. |
2525

2626
</CommandTable>
2727

@@ -35,7 +35,7 @@ sim logs get <runId> [options]
3535

3636
</CommandTable>
3737

38-
## Summarize run counts, failures, and cost over a window
38+
## Summarize run counts, failures and latency over a window
3939

4040
```bash
4141
sim logs stats [options]

apps/docs/content/docs/en/cli/mcp-servers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ sim mcp-servers delete <mcpServerId> [options]
5858

5959
| Option | Required | Description |
6060
| --- | --- | --- |
61-
| `-y, --yes` | Yes | Confirm this destructive operation. |
61+
| `-y, --yes` | Yes | Confirm this operation. |
6262

6363
</CommandTable>
6464

0 commit comments

Comments
 (0)