You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "fisjac (via GitHub)" <gi...@apache.org> on 2024/04/10 03:48:51 UTC
[PR] Dashboard tabs endpoint [superset]
fisjac opened a new pull request, #27962:
URL: https://github.com/apache/superset/pull/27962
<!---
Please write the PR title following the conventions at https://www.conventionalcommits.org/en/v1.0.0/
Example:
fix(dashboard): load charts correctly
-->
### SUMMARY
<!--- Describe the change below, including rationale and design decisions -->
This is a proof of concept for accessing the tabs associated with a dashboard.
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
<!--- Skip this if not applicable -->
### TESTING INSTRUCTIONS
<!--- Required! What steps can be taken to manually verify the changes? -->
### ADDITIONAL INFORMATION
<!--- Check any relevant boxes with "x" -->
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] 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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] feat: Dashboard tabs api endpoint [superset]
Posted by "fisjac (via GitHub)" <gi...@apache.org>.
fisjac commented on code in PR #27962:
URL: https://github.com/apache/superset/pull/27962#discussion_r1640023515
##########
tests/integration_tests/dashboards/api_tests.py:
##########
@@ -869,6 +869,185 @@ def test_get_dashboards_created_by_me(self):
for key, value in expected_results[idx].items():
assert response_item[key] == value
+ def test_get_dashboard_tabs(self):
+ """
+ Dashboard API: Test get dashboard tabs
+ """
+ position_data = {
+ "GRID_ID": {"children": [], "id": "GRID_ID", "type": "GRID"},
+ "ROOT_ID": {
+ "children": ["TABS-tDGEcwZ82u"],
+ "id": "ROOT_ID",
+ "type": "ROOT",
+ },
+ "TAB-0TkqQRxzg7": {
+ "children": [],
+ "id": "TAB-0TkqQRxzg7",
+ "meta": {"text": "P2 - T1"},
+ "type": "TAB",
+ },
+ "TAB-1iG_yOlKA2": {
+ "children": [],
+ "id": "TAB-1iG_yOlKA2",
+ "meta": {"text": "P1 - T1"},
+ "type": "TAB",
+ },
+ "TAB-2dgADEurF": {
+ "children": ["TABS-LsyXZWG2rk"],
+ "id": "TAB-2dgADEurF",
+ "meta": {"text": "P1 - T2"},
+ "type": "TAB",
+ },
+ "TAB-BJIt5SdCx3": {
+ "children": [],
+ "id": "TAB-BJIt5SdCx3",
+ "meta": {"text": "P1 - T2 - T1"},
+ "type": "TAB",
+ },
+ "TAB-CjZlNL5Uz": {
+ "children": ["TABS-Ji_K1ZBE0M"],
+ "id": "TAB-CjZlNL5Uz",
+ "meta": {"text": "Parent Tab 2"},
+ "type": "TAB",
+ },
+ "TAB-Nct5fiHtn": {
+ "children": [],
+ "id": "TAB-Nct5fiHtn",
+ "meta": {"text": "P1 - T2 - T3"},
+ "type": "TAB",
+ },
+ "TAB-PumuDkWKq": {
+ "children": [],
+ "id": "TAB-PumuDkWKq",
+ "meta": {"text": "P2 - T2"},
+ "type": "TAB",
+ },
+ "TAB-hyTv5L7zz": {
+ "children": [],
+ "id": "TAB-hyTv5L7zz",
+ "meta": {"text": "P1 - T2 - T2"},
+ "type": "TAB",
+ },
+ "TAB-qL7fSzr3jl": {
+ "children": ["TABS-N8ODUqp2sE"],
+ "id": "TAB-qL7fSzr3jl",
+ "meta": {"text": "Parent Tab 1"},
+ "type": "TAB",
+ },
+ "TABS-Ji_K1ZBE0M": {
+ "children": ["TAB-0TkqQRxzg7", "TAB-PumuDkWKq"],
+ "id": "TABS-Ji_K1ZBE0M",
+ "meta": {},
+ "type": "TABS",
+ },
+ "TABS-LsyXZWG2rk": {
+ "children": ["TAB-BJIt5SdCx3", "TAB-hyTv5L7zz", "TAB-Nct5fiHtn"],
+ "id": "TABS-LsyXZWG2rk",
+ "meta": {},
+ "type": "TABS",
+ },
+ "TABS-N8ODUqp2sE": {
+ "children": ["TAB-1iG_yOlKA2", "TAB-2dgADEurF"],
+ "id": "TABS-N8ODUqp2sE",
+ "meta": {},
+ "type": "TABS",
+ },
+ "TABS-tDGEcwZ82u": {
+ "children": ["TAB-qL7fSzr3jl", "TAB-CjZlNL5Uz"],
+ "id": "TABS-tDGEcwZ82u",
+ "meta": {},
+ "type": "TABS",
+ },
+ }
+ admin_id = self.get_user("admin").id
+ dashboard = self.insert_dashboard(
+ "title", "slug", [admin_id], position_json=json.dumps(position_data)
+ )
+ self.login(ADMIN_USERNAME)
+ uri = f"api/v1/dashboard/{dashboard.id}/tabs"
+ rv = self.get_assert_metric(uri, "get_tabs")
+ response = json.loads(rv.data.decode("utf-8"))
+ expected_response = {
+ "result": {
+ "all_tabs": {
+ "TAB-0TkqQRxzg7": "P2 - T1",
+ "TAB-1iG_yOlKA2": "P1 - T1",
+ "TAB-2dgADEurF": "P1 - T2",
+ "TAB-BJIt5SdCx3": "P1 - T2 - T1",
+ "TAB-CjZlNL5Uz": "Parent Tab 2",
+ "TAB-Nct5fiHtn": "P1 - T2 - T3",
+ "TAB-PumuDkWKq": "P2 - T2",
+ "TAB-hyTv5L7zz": "P1 - T2 - T2",
+ "TAB-qL7fSzr3jl": "Parent Tab 1",
+ },
+ "tab_tree": [
+ {
+ "children": [
+ {
+ "children": [],
+ "title": "P1 - T1",
+ "value": "TAB-1iG_yOlKA2",
+ },
+ {
+ "children": [
+ {
+ "children": [],
+ "title": "P1 - T2 - T1",
+ "value": "TAB-BJIt5SdCx3",
+ },
+ {
+ "children": [],
+ "title": "P1 - T2 - T2",
+ "value": "TAB-hyTv5L7zz",
+ },
+ {
+ "children": [],
+ "title": "P1 - T2 - T3",
+ "value": "TAB-Nct5fiHtn",
+ },
+ ],
+ "title": "P1 - T2",
+ "value": "TAB-2dgADEurF",
+ },
+ ],
+ "title": "Parent Tab 1",
+ "value": "TAB-qL7fSzr3jl",
+ },
+ {
+ "children": [
+ {
+ "children": [],
+ "title": "P2 - T1",
+ "value": "TAB-0TkqQRxzg7",
+ },
+ {
+ "children": [],
+ "title": "P2 - T2",
+ "value": "TAB-PumuDkWKq",
+ },
+ ],
+ "title": "Parent Tab 2",
+ "value": "TAB-CjZlNL5Uz",
+ },
+ ],
+ }
+ }
+ self.assertEqual(rv.status_code, 200)
+ self.assertEqual(response, expected_response)
+ db.session.delete(dashboard)
+ db.session.commit()
+
+ @pytest.mark.usefixtures("load_world_bank_dashboard_with_slices")
Review Comment:
currently the only tests that explicitly check permissions for the dashboard api are for PUT and DELETE requests. My understanding is that the FlaskAppbuilder @protect decorator is doing most of the work for ensuring permissions for GET requests. Presumably the @protect decorator is being tested somewhere else within the codebase?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] feat: Dashboard tabs api endpoint [superset]
Posted by "geido (via GitHub)" <gi...@apache.org>.
geido commented on code in PR #27962:
URL: https://github.com/apache/superset/pull/27962#discussion_r1603237368
##########
tests/integration_tests/dashboards/api_tests.py:
##########
@@ -869,6 +869,185 @@ def test_get_dashboards_created_by_me(self):
for key, value in expected_results[idx].items():
assert response_item[key] == value
+ def test_get_dashboard_tabs(self):
+ """
+ Dashboard API: Test get dashboard tabs
+ """
+ position_data = {
+ "GRID_ID": {"children": [], "id": "GRID_ID", "type": "GRID"},
+ "ROOT_ID": {
+ "children": ["TABS-tDGEcwZ82u"],
+ "id": "ROOT_ID",
+ "type": "ROOT",
+ },
+ "TAB-0TkqQRxzg7": {
+ "children": [],
+ "id": "TAB-0TkqQRxzg7",
+ "meta": {"text": "P2 - T1"},
+ "type": "TAB",
+ },
+ "TAB-1iG_yOlKA2": {
+ "children": [],
+ "id": "TAB-1iG_yOlKA2",
+ "meta": {"text": "P1 - T1"},
+ "type": "TAB",
+ },
+ "TAB-2dgADEurF": {
+ "children": ["TABS-LsyXZWG2rk"],
+ "id": "TAB-2dgADEurF",
+ "meta": {"text": "P1 - T2"},
+ "type": "TAB",
+ },
+ "TAB-BJIt5SdCx3": {
+ "children": [],
+ "id": "TAB-BJIt5SdCx3",
+ "meta": {"text": "P1 - T2 - T1"},
+ "type": "TAB",
+ },
+ "TAB-CjZlNL5Uz": {
+ "children": ["TABS-Ji_K1ZBE0M"],
+ "id": "TAB-CjZlNL5Uz",
+ "meta": {"text": "Parent Tab 2"},
+ "type": "TAB",
+ },
+ "TAB-Nct5fiHtn": {
+ "children": [],
+ "id": "TAB-Nct5fiHtn",
+ "meta": {"text": "P1 - T2 - T3"},
+ "type": "TAB",
+ },
+ "TAB-PumuDkWKq": {
+ "children": [],
+ "id": "TAB-PumuDkWKq",
+ "meta": {"text": "P2 - T2"},
+ "type": "TAB",
+ },
+ "TAB-hyTv5L7zz": {
+ "children": [],
+ "id": "TAB-hyTv5L7zz",
+ "meta": {"text": "P1 - T2 - T2"},
+ "type": "TAB",
+ },
+ "TAB-qL7fSzr3jl": {
+ "children": ["TABS-N8ODUqp2sE"],
+ "id": "TAB-qL7fSzr3jl",
+ "meta": {"text": "Parent Tab 1"},
+ "type": "TAB",
+ },
+ "TABS-Ji_K1ZBE0M": {
+ "children": ["TAB-0TkqQRxzg7", "TAB-PumuDkWKq"],
+ "id": "TABS-Ji_K1ZBE0M",
+ "meta": {},
+ "type": "TABS",
+ },
+ "TABS-LsyXZWG2rk": {
+ "children": ["TAB-BJIt5SdCx3", "TAB-hyTv5L7zz", "TAB-Nct5fiHtn"],
+ "id": "TABS-LsyXZWG2rk",
+ "meta": {},
+ "type": "TABS",
+ },
+ "TABS-N8ODUqp2sE": {
+ "children": ["TAB-1iG_yOlKA2", "TAB-2dgADEurF"],
+ "id": "TABS-N8ODUqp2sE",
+ "meta": {},
+ "type": "TABS",
+ },
+ "TABS-tDGEcwZ82u": {
+ "children": ["TAB-qL7fSzr3jl", "TAB-CjZlNL5Uz"],
+ "id": "TABS-tDGEcwZ82u",
+ "meta": {},
+ "type": "TABS",
+ },
+ }
+ admin_id = self.get_user("admin").id
+ dashboard = self.insert_dashboard(
+ "title", "slug", [admin_id], position_json=json.dumps(position_data)
+ )
+ self.login(ADMIN_USERNAME)
+ uri = f"api/v1/dashboard/{dashboard.id}/tabs"
+ rv = self.get_assert_metric(uri, "get_tabs")
+ response = json.loads(rv.data.decode("utf-8"))
+ expected_response = {
+ "result": {
+ "all_tabs": {
+ "TAB-0TkqQRxzg7": "P2 - T1",
+ "TAB-1iG_yOlKA2": "P1 - T1",
+ "TAB-2dgADEurF": "P1 - T2",
+ "TAB-BJIt5SdCx3": "P1 - T2 - T1",
+ "TAB-CjZlNL5Uz": "Parent Tab 2",
+ "TAB-Nct5fiHtn": "P1 - T2 - T3",
+ "TAB-PumuDkWKq": "P2 - T2",
+ "TAB-hyTv5L7zz": "P1 - T2 - T2",
+ "TAB-qL7fSzr3jl": "Parent Tab 1",
+ },
+ "tab_tree": [
+ {
+ "children": [
+ {
+ "children": [],
+ "title": "P1 - T1",
+ "value": "TAB-1iG_yOlKA2",
+ },
+ {
+ "children": [
+ {
+ "children": [],
+ "title": "P1 - T2 - T1",
+ "value": "TAB-BJIt5SdCx3",
+ },
+ {
+ "children": [],
+ "title": "P1 - T2 - T2",
+ "value": "TAB-hyTv5L7zz",
+ },
+ {
+ "children": [],
+ "title": "P1 - T2 - T3",
+ "value": "TAB-Nct5fiHtn",
+ },
+ ],
+ "title": "P1 - T2",
+ "value": "TAB-2dgADEurF",
+ },
+ ],
+ "title": "Parent Tab 1",
+ "value": "TAB-qL7fSzr3jl",
+ },
+ {
+ "children": [
+ {
+ "children": [],
+ "title": "P2 - T1",
+ "value": "TAB-0TkqQRxzg7",
+ },
+ {
+ "children": [],
+ "title": "P2 - T2",
+ "value": "TAB-PumuDkWKq",
+ },
+ ],
+ "title": "Parent Tab 2",
+ "value": "TAB-CjZlNL5Uz",
+ },
+ ],
+ }
+ }
+ self.assertEqual(rv.status_code, 200)
+ self.assertEqual(response, expected_response)
+ db.session.delete(dashboard)
+ db.session.commit()
+
+ @pytest.mark.usefixtures("load_world_bank_dashboard_with_slices")
Review Comment:
Should we add other negative paths, such as testing for permissions or invalid schema?
##########
superset/dashboards/api.py:
##########
@@ -395,6 +399,64 @@ def get_datasets(self, id_or_slug: str) -> Response:
except DashboardNotFoundError:
return self.response_404()
+ @expose("/<id_or_slug>/tabs", methods=("GET",))
+ @protect()
+ @safe
+ @statsd_metrics
+ @event_logger.log_this_with_context(
+ action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.get_tabs",
+ log_to_statsd=False,
+ )
+ def get_tabs(self, id_or_slug: str) -> Response:
+ """Get dashboard's tabs.
+ ---
+ get:
+ summary: Get dashboard's tabs
+ description: >-
+ Returns a list of a dashboard's tabs and dashboard's nested tree structure for associated tabs.
+ parameters:
+ - in: path
+ schema:
+ type: string
+ name: id_or_slug
+ description: Either the id of the dashboard, or its slug
+ responses:
+ 200:
+ description: Dashboard tabs
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ result:
+ type: object
+ items:
+ $ref: '#/components/schemas/TabsPayloadSchema'
+ 400:
+ $ref: '#/components/responses/400'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 404:
+ $ref: '#/components/responses/404'
+ """
+ try:
+ tabs = DashboardDAO.get_tabs_for_dashboard(id_or_slug)
+ result = self.tab_schema.dump(tabs)
+ return self.response(200, result=result)
+
+ except (TypeError, ValueError) as err:
+ return self.response_400(
+ message=gettext(
+ "Tab schema is invalid, caused by: %(error)s", error=str(err)
Review Comment:
I don't think we need to surface the specific error here in the response. We might want to log it instead.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] feat: Dashboard tabs api endpoint [superset]
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #27962:
URL: https://github.com/apache/superset/pull/27962#issuecomment-2110534592
## [Codecov](https://app.codecov.io/gh/apache/superset/pull/27962?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
Attention: Patch coverage is `30.00000%` with `42 lines` in your changes are missing coverage. Please review.
> Project coverage is 64.37%. Comparing base [(`76d897e`)](https://app.codecov.io/gh/apache/superset/commit/76d897eaa2f9e137102bc194c2e3109c29d0348f?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) to head [(`21a56b6`)](https://app.codecov.io/gh/apache/superset/pull/27962?dropdown=coverage&src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
> Report is 109 commits behind head on master.
| [Files](https://app.codecov.io/gh/apache/superset/pull/27962?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Patch % | Lines |
|---|---|---|
| [superset/models/dashboard.py](https://app.codecov.io/gh/apache/superset/pull/27962?src=pr&el=tree&filepath=superset%2Fmodels%2Fdashboard.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQvbW9kZWxzL2Rhc2hib2FyZC5weQ==) | 9.37% | [29 Missing :warning: ](https://app.codecov.io/gh/apache/superset/pull/27962?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) |
| [superset/dashboards/api.py](https://app.codecov.io/gh/apache/superset/pull/27962?src=pr&el=tree&filepath=superset%2Fdashboards%2Fapi.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQvZGFzaGJvYXJkcy9hcGkucHk=) | 41.17% | [10 Missing :warning: ](https://app.codecov.io/gh/apache/superset/pull/27962?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) |
| [superset/daos/dashboard.py](https://app.codecov.io/gh/apache/superset/pull/27962?src=pr&el=tree&filepath=superset%2Fdaos%2Fdashboard.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQvZGFvcy9kYXNoYm9hcmQucHk=) | 50.00% | [2 Missing :warning: ](https://app.codecov.io/gh/apache/superset/pull/27962?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) |
| [superset/dashboards/schemas.py](https://app.codecov.io/gh/apache/superset/pull/27962?src=pr&el=tree&filepath=superset%2Fdashboards%2Fschemas.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQvZGFzaGJvYXJkcy9zY2hlbWFzLnB5) | 85.71% | [1 Missing :warning: ](https://app.codecov.io/gh/apache/superset/pull/27962?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) |
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## master #27962 +/- ##
==========================================
+ Coverage 60.48% 64.37% +3.89%
==========================================
Files 1931 521 -1410
Lines 76236 37526 -38710
Branches 8568 0 -8568
==========================================
- Hits 46114 24159 -21955
+ Misses 28017 13367 -14650
+ Partials 2105 0 -2105
```
| [Flag](https://app.codecov.io/gh/apache/superset/pull/27962/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
|---|---|---|
| [hive](https://app.codecov.io/gh/apache/superset/pull/27962/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `49.06% <30.00%> (-0.10%)` | :arrow_down: |
| [javascript](https://app.codecov.io/gh/apache/superset/pull/27962/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
| [presto](https://app.codecov.io/gh/apache/superset/pull/27962/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `53.61% <30.00%> (-0.19%)` | :arrow_down: |
| [python](https://app.codecov.io/gh/apache/superset/pull/27962/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `64.37% <30.00%> (+0.89%)` | :arrow_up: |
| [unit](https://app.codecov.io/gh/apache/superset/pull/27962/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `58.77% <30.00%> (+1.14%)` | :arrow_up: |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
</details>
[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/superset/pull/27962?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] feat: Dashboard tabs api endpoint [superset]
Posted by "fisjac (via GitHub)" <gi...@apache.org>.
fisjac commented on code in PR #27962:
URL: https://github.com/apache/superset/pull/27962#discussion_r1640004076
##########
superset/dashboards/api.py:
##########
@@ -395,6 +399,64 @@ def get_datasets(self, id_or_slug: str) -> Response:
except DashboardNotFoundError:
return self.response_404()
+ @expose("/<id_or_slug>/tabs", methods=("GET",))
+ @protect()
+ @safe
+ @statsd_metrics
+ @event_logger.log_this_with_context(
+ action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.get_tabs",
+ log_to_statsd=False,
+ )
+ def get_tabs(self, id_or_slug: str) -> Response:
+ """Get dashboard's tabs.
+ ---
+ get:
+ summary: Get dashboard's tabs
+ description: >-
+ Returns a list of a dashboard's tabs and dashboard's nested tree structure for associated tabs.
+ parameters:
+ - in: path
+ schema:
+ type: string
+ name: id_or_slug
+ description: Either the id of the dashboard, or its slug
+ responses:
+ 200:
+ description: Dashboard tabs
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ result:
+ type: object
+ items:
+ $ref: '#/components/schemas/TabsPayloadSchema'
+ 400:
+ $ref: '#/components/responses/400'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 404:
+ $ref: '#/components/responses/404'
+ """
+ try:
+ tabs = DashboardDAO.get_tabs_for_dashboard(id_or_slug)
+ result = self.tab_schema.dump(tabs)
+ return self.response(200, result=result)
+
+ except (TypeError, ValueError) as err:
+ return self.response_400(
+ message=gettext(
+ "Tab schema is invalid, caused by: %(error)s", error=str(err)
Review Comment:
I borrowed this error handler from the `GET dashboard/<id>/datasets` endpoint, which throws when an invalid schema is detected. My thought was to ensure consistent validation behavior for similar endpoints.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org