Skip to content

fix(open-api): Add missing FormatQueryPayloadSchema and DashboardScreenshotPostSchema to open-api component schemas #33202

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.

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

dogfootruler-kr
Copy link

@dogfootruler-kr dogfootruler-kr commented Apr 22, 2025

SUMMARY

FormatQueryPayloadSchema and DashboardScreenshotPostSchema were missing from the open-api spec component schemas which made the open-api invalid.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Before:
image
image

After:
image
image

TESTING INSTRUCTIONS

Check that FormatQueryPayloadSchema and DashboardScreenshotPostSchema now exists in open0api spec.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@github-actions github-actions bot added the api Related to the REST API label Apr 22, 2025
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've completed my review and didn't find any issues.

Files scanned
File Path Reviewed
superset/sqllab/api.py

Explore our documentation to understand the languages and file types we support and the files we ignore.

Check out our docs on how you can make Korbit work best for you and your team.

Loving Korbit!? Share us on LinkedIn Reddit and X

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Congrats on making your first PR and thank you for contributing to Superset! 🎉 ❤️

We hope to see you in our Slack community too! Not signed up? Use our Slack App to self-register.

Copy link

codecov bot commented Apr 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.25%. Comparing base (7530487) to head (26518d8).
Report is 8 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master   #33202       +/-   ##
===========================================
+ Coverage        0   83.25%   +83.25%     
===========================================
  Files           0      553      +553     
  Lines           0    39923    +39923     
===========================================
+ Hits            0    33237    +33237     
- Misses          0     6686     +6686     
Flag Coverage Δ
hive 48.29% <ø> (?)
mysql 75.46% <ø> (?)
postgres 75.53% <ø> (?)
presto 52.76% <ø> (?)
python 83.25% <ø> (?)
sqlite 75.03% <ø> (?)
unit 61.32% <ø> (?)

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

☔ View full report in Codecov by Sentry.
📢 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.

@dogfootruler-kr dogfootruler-kr changed the title fix(open-api): Add missing FormatQueryPayloadSchema to open-api component schemas fix(open-api): Add missing FormatQueryPayloadSchema and DashboardScreenshotPostSchema to open-api component schemas Apr 23, 2025
@EnxDev
Copy link
Contributor

EnxDev commented Apr 24, 2025

Hi @dogfootruler-kr, I recommend installing and setting up pre-commit: https://superset.apache.org/docs/contributing/development/#git-hooks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Related to the REST API size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants