Skip to content
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

feat(dashboard): expose the embedded dashboard configuration on the api #23321

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

agubler
Copy link

@agubler agubler commented Mar 9, 2023

SUMMARY

Adds an embedded property to the existing dashboard API that returns the embedded configuration if it exists. This users can use the API with a single call to get a list of embeddable dashboards, whilst currently this would require an extra API request per dashboard.

TESTING INSTRUCTIONS

Run the branch, set the EMBEDDED_SUPERSET to True and configure a dashboard as embeddable within the UI. Request the dashboard api from /api/v1/dashboard and request the specific dashboard api from /api/v1/dashboard/{id} and review the embedded configuration.

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

If there are additional automated tests that need adding and/or if the embedded configuration on the API needs to be behind the same EMBEDDED_SUPERSET please let me know

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.

@rusackas
Copy link
Member

rusackas commented Feb 9, 2024

Thanks for the contribution, and sorry this slipped under the radar for so long. Would you be willing to give this a rebase? I'll add a couple potential reviewers in the meantime that might be able to assess/raise any api/scaling/security questions.

@rusackas
Copy link
Member

rusackas commented Dec 9, 2024

Marking this as a draft until it gets rebased. It may be closed eventually if that doesn't happen.

@rusackas rusackas marked this pull request as draft December 9, 2024 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants