fix(api): add example to get_export_ids_schema so Swagger "Try it out" pre-fills a valid array

[Abdulrehman-PIAIC80387]

SUMMARY

Fixes #28180.

The 6 get_export_ids_schema JSON-Schema dicts (dashboards, charts, datasets, databases, saved_queries, themes) had no example field, so Swagger UI's "Try it out" defaulted the q query parameter to {} instead of an array like !(1,2,3). Executing then hit parse_rison which returned a 400 with:

"Not a valid rison schema {} is not of type 'array'"

This made every export endpoint look broken via the docs UI.

Adding "example": [1, 2, 3] to each schema gives Swagger UI a concrete default; "Try it out" now pre-fills the field with a valid array instead of {}. Same one-line addition applied to all 6 identical schemas.

Root cause diagnosis by @rusackas on the issue thread.

TESTING INSTRUCTIONS

1. Open /swagger/v1 on a running Superset instance
2. Navigate to any export endpoint (e.g. GET /api/v1/database/export/)
3. Click "Try it out"
4. Before fix: q pre-fills with {}, Execute returns 400
5. After fix: q pre-fills with [1,2,3], Execute returns 200 (or 404 if the IDs don't exist, but not a 400 validation error)

ADDITIONAL INFORMATION

• Has associated issue: Fixes REST API Exports doen not work (dashboard, dataset etc) #28180
• Required feature flags: none
• Changes UI: no
• Includes DB Migration: no
• Includes CLI or Node.js commands: no
• Breaking change: no

[bito-code-review]

Code Review Agent Run #ffd809

Actionable Suggestions - 0

Additional Suggestions - 2

• superset/charts/schemas.py - 1

  • CONSISTENCY: Missing example in similar schema · Line 131-131
    The `get_fav_star_ids_schema` lacks an `example` field while the adjacent `get_export_ids_schema` (line 125-129) now has one. These schemas share identical structure. For consistency across related schemas, add the same example field to `get_fav_star_ids_schema`.
• superset/queries/saved_queries/schemas.py - 1

  • Consistency within schema file · Line 45-50
    Within this file, `get_delete_ids_schema` (line 45) lacks the `example` field while `get_export_ids_schema` (line 46) now includes it. Since both are exported module-level constants used as OpenAPI schemas for bulk operations, maintaining consistent formatting improves documentation clarity and developer experience.

Review Details

• Files reviewed - 6 · Commit Range: 627a7f9..627a7f9

  • superset/charts/schemas.py
  • superset/dashboards/schemas.py
  • superset/databases/schemas.py
  • superset/datasets/schemas.py
  • superset/queries/saved_queries/schemas.py
  • superset/themes/schemas.py
• Files skipped - 0
• Tools

  • MyPy (Static Code Analysis) - ✔︎ Successful
  • Astral Ruff (Static Code Analysis) - ✔︎ Successful
  • Whispers (Secret Scanner) - ✔︎ Successful
  • Detect-secrets (Secret Scanner) - ✔︎ Successful

---

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

• /review - Manually triggers a full AI review.

• /pause - Pauses automatic reviews on this pull request.

• /resume - Resumes automatic reviews.

• /resolve - Marks all Bito-posted review comments as resolved.

• /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

• Customize agent settings
• Review rules
• General documentation
• FAQ

AI Code Review powered by

[netlify]

✅ Deploy Preview for superset-docs-preview ready!

Name	Link
🔨 Latest commit	584a7e3
🔍 Latest deploy log	https://app.netlify.com/projects/superset-docs-preview/deploys/6a6065d7857d9400082a28fa
😎 Deploy Preview	https://deploy-preview-42265--superset-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.14%. Comparing base (1392fbc) to head (e6bea68).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #42265      +/-   ##
==========================================
- Coverage   65.15%   65.14%   -0.01%     
==========================================
  Files        2789     2789              
  Lines      157568   157568              
  Branches    35870    35870              
==========================================
- Hits       102660   102654       -6     
- Misses      52936    52942       +6     
  Partials     1972     1972              

Flag	Coverage Δ
hive	38.73% <100.00%> (ø)
mysql	57.65% <100.00%> (ø)
postgres	57.70% <100.00%> (ø)
presto	40.65% <100.00%> (ø)
python	59.08% <100.00%> (ø)
sqlite	57.32% <100.00%> (ø)
unit	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[rusackas]

LGTM, this fixes the {} rison error from #28180. Same gap exists on get_delete_ids_schema and get_fav_star_ids_schema (bito flagged it too) though, any interest in a follow-up covering those while you're in here? Would be nice to fix all of that in one shot.

[Abdulrehman-PIAIC80387]

Thanks @rusackas — extended the PR to cover both get_delete_ids_schema (11 more schemas) and get_fav_star_ids_schema (2 more), all with the same "example": [1, 2, 3] pattern (and ["task_id_1", "task_id_2"] for tasks/schemas.py where items are strings).

Now 12 files / 19 schema definitions total, covering 18 API endpoints (6 export + 10 delete + 2 favorite-status). Force-pushed with the extended change.

[bito-code-review]

Code Review Agent Run #ec7bad

Actionable Suggestions - 0

Additional Suggestions - 2

• superset/datasets/schemas.py - 1

  • Semantic duplication in diff · Line 39-48
    The two schemas `get_delete_ids_schema` and `get_export_ids_schema` are now structurally identical (lines 39-48), creating semantic duplication. If the structure needs to change in the future (e.g., adding validation or changing type), both definitions must be updated together, creating divergence risk. Consider using a single shared constant or importing from a common definitions module.
• superset/tasks/schemas.py - 1

  • Data Consistency Issue · Line 23-27
    The example `['task_id_1', 'task_id_2']` is placeholder text that doesn't reflect actual UUID format. UUID examples should follow proper format like `'550e8400-e29b-41d4-a716-446655440000'` for API documentation accuracy.

Filtered by Review Rules

Bito filtered these suggestions based on rules created automatically for your feedback. Manage rules.

• superset/databases/schemas.py - 1

  • OpenAPI schema inconsistency across modules · Line 169-173
• superset/tasks/schemas.py - 1

  • CWE-398: Dead Code Added · Line 23-27

Review Details

• Files reviewed - 12 · Commit Range: e6bea68..e6bea68

  • superset/annotation_layers/annotations/schemas.py
  • superset/annotation_layers/schemas.py
  • superset/charts/schemas.py
  • superset/css_templates/schemas.py
  • superset/dashboards/schemas.py
  • superset/databases/schemas.py
  • superset/datasets/schemas.py
  • superset/queries/saved_queries/schemas.py
  • superset/reports/schemas.py
  • superset/row_level_security/schemas.py
  • superset/tasks/schemas.py
  • superset/themes/schemas.py
• Files skipped - 0
• Tools

  • MyPy (Static Code Analysis) - ✔︎ Successful
  • Astral Ruff (Static Code Analysis) - ✔︎ Successful
  • Whispers (Secret Scanner) - ✔︎ Successful
  • Detect-secrets (Secret Scanner) - ✔︎ Successful

---

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

• /review - Manually triggers a full AI review.

• /pause - Pauses automatic reviews on this pull request.

• /resume - Resumes automatic reviews.

• /resolve - Marks all Bito-posted review comments as resolved.

• /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

• Customize agent settings
• Review rules
• General documentation
• FAQ

AI Code Review powered by

[rusackas]

Thanks @Abdulrehman-PIAIC80387, this covers everything I asked for, all 19 occurrences across the codebase now have the example. LGTM.

Bito's duplication note on get_delete_ids_schema/get_export_ids_schema is fair but matches how these constants are already duplicated per-module throughout the codebase, so consolidating them is bigger scope than this fix. The tasks/schemas.py one is unused anyway, so the placeholder example there doesn't matter functionally.

Approving, will merge once it's through.