Skip to content

Commit 5370d4a

Browse files
committed
docs: remove redundant "Do NOT use" warnings now that CLI validates datasets
1 parent 6ebf7f4 commit 5370d4a

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/src/content/docs/agent-guidance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Use **common** types for general dashboards. Use **specialized** only when speci
130130

131131
**Dataset selection:**
132132

133-
Use the default `spans` dataset for most widgets — it covers spans, and transactions when filtered with `is_transaction:true`. Do NOT use `discover` or `transaction-like` — the Sentry Dashboard API rejects both as deprecated.
133+
Use the default `spans` dataset for most widgets — it covers spans, and transactions when filtered with `is_transaction:true`.
134134

135135
| Dataset | Use for | Notes |
136136
|---|---|---|
@@ -184,6 +184,6 @@ sentry dashboard widget add <dashboard> "Transaction Count" \
184184
- **Not using `--web`**: View commands support `-w`/`--web` to open the resource in the browser — useful for sharing links.
185185
- **Fetching API schemas instead of using the CLI**: Prefer `sentry schema` to browse the API and `sentry api` to make requests — the CLI handles authentication and endpoint resolution, so there's rarely a need to download OpenAPI specs separately.
186186
- **Using `sentry api` when CLI commands suffice**: `sentry issue list --json` already includes `shortId`, `title`, `priority`, `level`, `status`, `permalink`, and other fields at the top level. Some fields like `count`, `userCount`, `firstSeen`, and `lastSeen` may be null depending on the issue. Use `--fields` to select specific fields and `--help` to see all available fields. Only fall back to `sentry api` for data the CLI doesn't expose.
187-
- **Using deprecated dashboard datasets**: Do NOT use `--dataset discover` or `--dataset transaction-like` — the API rejects both. Use the default `spans` dataset. To query transactions, add `--where "is_transaction:true"`.
187+
- **Using deprecated dashboard datasets**: `--dataset discover` and `--dataset transaction-like` are rejected — the CLI validates against accepted datasets. Use the default `spans` dataset. To query transactions, add `--where "is_transaction:true"`.
188188
- **Forgetting `--limit` with `--group-by`**: Dashboard widgets with `--group-by` require `--limit` — the API will reject the widget without it. Table widgets cap at 10 rows.
189189
- **`--sort` with leading dash**: `--sort -count` is misinterpreted as the `-c` flag alias. Use `--sort="-count"` (with `=`) instead.

plugins/sentry-cli/skills/sentry-cli/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Use **common** types for general dashboards. Use **specialized** only when speci
140140

141141
**Dataset selection:**
142142

143-
Use the default `spans` dataset for most widgets — it covers spans, and transactions when filtered with `is_transaction:true`. Do NOT use `discover` or `transaction-like` — the Sentry Dashboard API rejects both as deprecated.
143+
Use the default `spans` dataset for most widgets — it covers spans, and transactions when filtered with `is_transaction:true`.
144144

145145
| Dataset | Use for | Notes |
146146
|---|---|---|
@@ -194,7 +194,7 @@ sentry dashboard widget add <dashboard> "Transaction Count" \
194194
- **Not using `--web`**: View commands support `-w`/`--web` to open the resource in the browser — useful for sharing links.
195195
- **Fetching API schemas instead of using the CLI**: Prefer `sentry schema` to browse the API and `sentry api` to make requests — the CLI handles authentication and endpoint resolution, so there's rarely a need to download OpenAPI specs separately.
196196
- **Using `sentry api` when CLI commands suffice**: `sentry issue list --json` already includes `shortId`, `title`, `priority`, `level`, `status`, `permalink`, and other fields at the top level. Some fields like `count`, `userCount`, `firstSeen`, and `lastSeen` may be null depending on the issue. Use `--fields` to select specific fields and `--help` to see all available fields. Only fall back to `sentry api` for data the CLI doesn't expose.
197-
- **Using deprecated dashboard datasets**: Do NOT use `--dataset discover` or `--dataset transaction-like` — the API rejects both. Use the default `spans` dataset. To query transactions, add `--where "is_transaction:true"`.
197+
- **Using deprecated dashboard datasets**: `--dataset discover` and `--dataset transaction-like` are rejected — the CLI validates against accepted datasets. Use the default `spans` dataset. To query transactions, add `--where "is_transaction:true"`.
198198
- **Forgetting `--limit` with `--group-by`**: Dashboard widgets with `--group-by` require `--limit` — the API will reject the widget without it. Table widgets cap at 10 rows.
199199
- **`--sort` with leading dash**: `--sort -count` is misinterpreted as the `-c` flag alias. Use `--sort="-count"` (with `=`) instead.
200200

0 commit comments

Comments
 (0)