Skip to content

feat(cli): add testsprite api for authenticated raw requests to the CLI API #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Shubhdeep12 wants to merge 1 commit into from
Closed

feat(cli): add testsprite api for authenticated raw requests to the CLI API #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions DOCUMENTATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The full reference for the TestSprite CLI: install verification, manual setup, e
- [Schedules (`schedule`)](#schedules-schedule)
- [CI integration (`ci init`)](#ci-integration-ci-init)
- [Account & diagnostics](#account--diagnostics)
- [Raw API requests (`api`)](#raw-api-requests-api)
- [Configuration](#configuration)
- [Output & scripting](#output--scripting)
- [Continuous integration](#continuous-integration)
Expand Down Expand Up @@ -1157,6 +1158,27 @@ testsprite doctor && testsprite test run test_xxxxxxxx --wait

Every check reuses the same helpers the real commands use, so the report reflects exactly what a subsequent command would resolve. For an org-scoped key, the report also lists `Organizations` (account-wide membership list) and `Org binding` (this key's bound organization) checks.

### Raw API requests (`api`)

#### `testsprite api <path>`

Send an authenticated request to any CLI API endpoint and print the JSON response — for an endpoint no command wraps yet, or a field a command does not show. Like `gh api`, it reuses everything the other commands use: the active profile and `--endpoint-url`, the API key, retries, `--debug` tracing (secrets redacted), the typed error envelope and the [exit codes](#exit-codes).

```bash
testsprite api /me
testsprite api '/tests?projectId=proj_xxxxxxxx' --output json
testsprite api /runs/run_xxxxxxxx
testsprite api /schedules --method POST --input schedule.json
testsprite api /tests/test_xxxxxxxx --method PATCH --data '{"name":"Checkout"}' --dry-run
```

- `<path>` — a path under the CLI API; a pasted `/api/cli/v1` prefix and a query string are fine. A full URL is refused (exit 5): the request always goes to the configured API host, so the API key is never sent anywhere else. `.`/`..` segments are refused too.
- `-X, --method <method>` — `GET` (default), `POST`, `PUT`, `PATCH` or `DELETE`. A request body never turns a `GET` into a write on its own: `--data`/`--input` without a write method exits 5.
- `--data <json>` / `--input <file>` — the JSON request body, inline or from a file of up to 5 MB (one or the other; reading from stdin with `--input -` is not supported).
- `--idempotency-key <key>` — every write sends an `Idempotency-Key`, auto-minted when omitted and printed to stderr under `--output json`, `--verbose` or `--debug`. Re-running with the same key does not apply the write twice, and the CLI can safely retry it after a network error or a `500`; reusing a key with a different body is refused (exit 6).

The response is printed as JSON in both output modes (a `204` prints nothing). `--dry-run` prints the request that would be sent — method, path, body and idempotency key — without sending it.

## Configuration

### Profiles & credentials
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ See [the full local-testing reference](./DOCUMENTATION.md#local-frontend-testing
| **Auth** | `auth status` | Resolve the active profile to its user, key, env, and scopes |
| | `auth remove` | Remove the active profile from the credentials file |
| | `usage` (alias `credits`) | Account pre-flight: identity, plus credit balance / plan info when the backend supplies them |
| | `api <path>` | Raw authenticated request to any CLI API endpoint (like `gh api`) — prints the JSON response with the CLI's auth, retries and exit codes |
| **Read** | `project list` / `project get` | List projects / fetch one by id, including the default environment and environment count when the server reports them |
| | `test list` / `test get` | List tests under a project / fetch one by id; `test list --env <name>` selects frontend status and the ENV column names its source |
| | `test code get` | Print (or write) the generated test source |
Expand Down
Loading
Loading