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

docs: add API page to docs using Swagger UI #11154

Merged
merged 2 commits into from
Oct 5, 2020

Conversation

mistercrunch
Copy link
Member

SUMMARY

Screen Shot 2020-10-03 at 10 49 44 AM

@codecov-commenter
Copy link

codecov-commenter commented Oct 3, 2020

Codecov Report

Merging #11154 into master will decrease coverage by 4.62%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #11154      +/-   ##
==========================================
- Coverage   65.84%   61.22%   -4.63%     
==========================================
  Files         827      827              
  Lines       39051    39037      -14     
  Branches     3673     3673              
==========================================
- Hits        25715    23901    -1814     
- Misses      13229    14955    +1726     
- Partials      107      181      +74     
Flag Coverage Δ
#cypress ?
#javascript 62.21% <ø> (ø)
#python 60.63% <ø> (-0.68%) ⬇️

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

Impacted Files Coverage Δ
superset-frontend/src/SqlLab/App.jsx 0.00% <0.00%> (-100.00%) ⬇️
superset-frontend/src/explore/App.jsx 0.00% <0.00%> (-100.00%) ⬇️
superset-frontend/src/dashboard/App.jsx 0.00% <0.00%> (-100.00%) ⬇️
superset-frontend/src/explore/index.jsx 0.00% <0.00%> (-100.00%) ⬇️
superset-frontend/src/dashboard/index.jsx 0.00% <0.00%> (-100.00%) ⬇️
superset-frontend/src/setup/setupColors.js 0.00% <0.00%> (-100.00%) ⬇️
superset-frontend/src/chart/ChartContainer.jsx 0.00% <0.00%> (-100.00%) ⬇️
superset-frontend/src/setup/setupFormatters.js 0.00% <0.00%> (-100.00%) ⬇️
superset-frontend/src/explore/reducers/index.js 0.00% <0.00%> (-100.00%) ⬇️
superset-frontend/src/setup/setupPluginsExtra.js 0.00% <0.00%> (-100.00%) ⬇️
... and 176 more

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 3d76f81...024d717. Read the comment docs.

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.

Minor non-blocking nit, apart from that LOVE IT! 🚀

<strong>NOTE! </strong>
You can find an interactive version of this documentation
on your local Superset instance
at <strong>/swagger/v1</strong> (if enabled)
Copy link
Member

Choose a reason for hiding this comment

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

nit: FAB_API_SWAGGER_UI is enabled by default:

Suggested change
at <strong>/swagger/v1</strong> (if enabled)
at <strong>/swagger/v1</strong>

@mistercrunch mistercrunch mentioned this pull request Oct 5, 2020
6 tasks
@mistercrunch mistercrunch merged commit 6358a7f into apache:master Oct 5, 2020
@mistercrunch mistercrunch deleted the swagger_docs branch October 5, 2020 05:01
@robdiciuccio
Copy link
Member

@mistercrunch what is the process for generating docs/src/resources/openapi.json and keeping it up to date?

auxten pushed a commit to auxten/incubator-superset that referenced this pull request Nov 20, 2020
* docs: add API page to docs using Swagger UI

* silence fossa
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.0.0 labels Mar 12, 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 🚢 1.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants