opensource/sim
3
0
Fork 0
mirror of https://github.com/simstudioai/sim.git synced 2026-09-24 15:45:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(cli): correct three descriptions the CLI publishes, and restore --no-recursive (#7093)

Browse Source 
Follow-ups from review of the v0.8.12 release PR, all on surfaces the CLI
audit touched.

- `credentialId` was one shared schema across PATCH and DELETE, so the
  disconnect reference offered "update or disconnect" for an operation that
  cannot update. Split into two, matching the two components OpenAPI already
  publishes for them.
- A boolean query param documents the spellings an HTTP caller may send and
  closes by calling them the whole accepted set. The CLI renders those fields
  as bare flags that take no value, leaving the sentence pointing at a list
  neither `--help` nor the reference ever prints. Stripped for bare flags only;
  the REST prose and OpenAPI specs are unchanged.
- `files list --recursive` became a bare switch in the audit, which removed the
  only way to send false. The API turns it on by itself as soon as `--search`
  is set, so a folder search always descended. The twin is back, declared per
  flag so the one-way toggles do not grow a meaningless negation.
This commit is contained in:
Waleed
2026-08-25 19:28:06 -07:00
committed by GitHub
parent 68d850a271
commit 2d85c0d1e1
11 changed files with 195 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/content/docs/en/cli/credentials.mdx
+2 -2
View File
@@ -21,7 +21,7 @@ sim credentials delete <credentialId> [options]
| Argument | Required | Description |
| --- | --- | --- |
| `credentialId` | Yes | Credential to update or disconnect. |
| `credentialId` | Yes | Credential to disconnect. |
</CommandTable>
@@ -84,7 +84,7 @@ sim credentials update <credentialId> [options]
| Argument | Required | Description |
| --- | --- | --- |
| `credentialId` | Yes | Credential to update or disconnect. |
| `credentialId` | Yes | Credential to update. |
</CommandTable>
apps/docs/content/docs/en/cli/files.mdx
+2 -1
View File
@@ -256,7 +256,8 @@ sim files list [options]
| Option | Required | Description |
| --- | --- | --- |
| `--folder <value>` | No | Folder path as shown in the app; the leading / is optional. |
| `--recursive` | No | Whether the folder filter includes files in subfolders. Defaults to true when a search is set, false otherwise, so listing a folder shows that folder while searching one looks through everything in it. Ignored when no folder filter is set, which already spans the workspace. The listed spellings are the whole accepted vocabulary and are case-sensitive; any other value is rejected. |
| `--recursive` | No | Whether the folder filter includes files in subfolders. Defaults to true when a search is set, false otherwise, so listing a folder shows that folder while searching one looks through everything in it. Ignored when no folder filter is set, which already spans the workspace. |
| `--no-recursive` | No | Send --recursive as false. |
| `--scope <value>` | No | Which lifecycle set to list: `active` (default) for live files, `archived` for files a `DELETE` soft-deleted. `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`. |
| `--search <value>` | No | Case-insensitive substring match against the file name. |
| `--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`, `size`, `uploadedAt`, `updatedAt`. |
apps/docs/content/docs/en/cli/reference.mdx
+4 -3
View File
@@ -379,7 +379,7 @@ sim credentials delete <credentialId> [options]
| Argument | Required | Description |
| --- | --- | --- |
| `credentialId` | Yes | Credential to update or disconnect. |
| `credentialId` | Yes | Credential to disconnect. |
</CommandTable>
@@ -448,7 +448,7 @@ sim credentials update <credentialId> [options]
| Argument | Required | Description |
| --- | --- | --- |
| `credentialId` | Yes | Credential to update or disconnect. |
| `credentialId` | Yes | Credential to update. |
</CommandTable>
@@ -950,7 +950,8 @@ sim files list [options]
| Option | Required | Description |
| --- | --- | --- |
| `--folder <value>` | No | Folder path as shown in the app; the leading / is optional. |
| `--recursive` | No | Whether the folder filter includes files in subfolders. Defaults to true when a search is set, false otherwise, so listing a folder shows that folder while searching one looks through everything in it. Ignored when no folder filter is set, which already spans the workspace. The listed spellings are the whole accepted vocabulary and are case-sensitive; any other value is rejected. |
| `--recursive` | No | Whether the folder filter includes files in subfolders. Defaults to true when a search is set, false otherwise, so listing a folder shows that folder while searching one looks through everything in it. Ignored when no folder filter is set, which already spans the workspace. |
| `--no-recursive` | No | Send --recursive as false. |
| `--scope <value>` | No | Which lifecycle set to list: `active` (default) for live files, `archived` for files a `DELETE` soft-deleted. `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`. |
| `--search <value>` | No | Case-insensitive substring match against the file name. |
| `--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`, `size`, `uploadedAt`, `updatedAt`. |
apps/docs/openapi-v2-resources.json
+4 -4
View File
@@ -2411,12 +2411,12 @@
"name": "credentialId",
"in": "path",
"required": true,
"description": "Credential to update or disconnect.",
"description": "Credential to disconnect.",
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Credential to update or disconnect."
"description": "Credential to disconnect."
}
},
{
@@ -2487,12 +2487,12 @@
"name": "credentialId",
"in": "path",
"required": true,
"description": "Credential to update or disconnect.",
"description": "Credential to update.",
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Credential to update or disconnect."
"description": "Credential to update."
}
},
{