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

[config] Enables swagger UI by default #8732

Merged
merged 4 commits into from
Dec 4, 2019

Conversation

dpgaspar
Copy link
Member

@dpgaspar dpgaspar commented Dec 3, 2019

CATEGORY

  • Bug Fix
  • Enhancement (new features, refinement)
  • Refactor
  • Add tests
  • Build / Development Environment
  • Documentation

SUMMARY

This is a proposal to enable FAB Swagger UI by default. To access the UI, user's need to have a specific permission can show on SwaggerView, if set by default superset init will create the permission for swagger and associate it to the Admin role.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

image

TEST PLAN

ADDITIONAL INFORMATION

  • Has associated issue:
  • Changes UI
  • Requires DB Migration.
  • Confirm DB Migration upgrade and downgrade tested.
  • Introduces new feature or API
  • Removes existing feature or API

REVIEWERS

@codecov-io
Copy link

codecov-io commented Dec 3, 2019

Codecov Report

Merging #8732 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #8732   +/-   ##
=======================================
  Coverage   65.87%   65.87%           
=======================================
  Files         483      483           
  Lines       24123    24123           
  Branches     2767     2767           
=======================================
  Hits        15892    15892           
  Misses       8055     8055           
  Partials      176      176
Impacted Files Coverage Δ
superset/config.py 89.9% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c74bb6c...5ded0e5. Read the comment docs.

@willbarrett
Copy link
Member

I'm OK with this, given that it's behind a permission.

Copy link
Member

@villebro villebro left a comment

Choose a reason for hiding this comment

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

I think adding a row to the changelog would be appropriate, so nobody unknowingly exposes the swagger schema by mistake. Other than that (and the nit) LGTM.

superset/config.py Show resolved Hide resolved
Copy link
Member

@villebro villebro left a comment

Choose a reason for hiding this comment

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

LGTM; would still like a note in the changelog, but ok without it, too.

@dpgaspar dpgaspar merged commit 385484e into apache:master Dec 4, 2019
@dpgaspar dpgaspar deleted the fix/enable-swagger branch December 4, 2019 09:51
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.36.0 labels Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/XS 🚢 0.36.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants