docs(api): Improve api documentation for dashboard endpoints(filter_state, permalink, embedded) #32142
Conversation
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review by Korbit AI
Korbit automatically attempts to detect when you fix issues in new commits.
| Category | Issue | Fix Detected |
|---|---|---|
 |
Incorrect numerical range in filter example ▹ view | ✅ |
 |
Unclear API Summary ▹ view |
Need a new review? Comment
/korbit-reviewon this PR and I'll review your latest changes.Korbit Guide: Usage and Customization
Interacting with Korbit
- You can manually ask Korbit to review your PR using the
/korbit-reviewcommand in a comment at the root of your PR.- You can ask Korbit to generate a new PR description using the
/korbit-generate-pr-descriptioncommand in any comment on your PR.- Too many Korbit comments? I can resolve all my comment threads if you use the
/korbit-resolvecommand in any comment on your PR.- Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
- Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.
Customizing Korbit
- Check out our docs on how you can make Korbit work best for you and your team.
- Customize Korbit for your organization through the Korbit Console.
Feedback and Support
superset/embedded/api.py
Outdated
| @@ -71,13 +71,38 @@ def get(self, uuid: str) -> Response: | |||
| """Get the dashboard's embedded configuration. | |||
| --- | |||
| get: | |||
| summary: Get the dashboard's embedded configuration | |||
| summary: Get the dashboard's embedded configuration this endpoint is also used to embed dashboards. | |||
There was a problem hiding this comment.
Unclear API Summary 
Tell me more
What is the issue?
The summary is unclear and contains redundant information. The phrase 'this endpoint is also used to embed dashboards' is confusing and doesn't add value.
Why this matters
Unclear API documentation makes it harder for developers to understand the endpoint's primary purpose and can lead to misuse.
Suggested change ∙ Feature Preview
summary: Get configuration and renders dashboard for embedding
💬 Chat with Korbit by mentioning @korbit-ai.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #32142 +/- ##
===========================================
+ Coverage 60.48% 83.46% +22.98%
===========================================
Files 1931 545 -1386
Lines 76236 39042 -37194
Branches 8568 0 -8568
===========================================
- Hits 46114 32588 -13526
+ Misses 28017 6454 -21563
+ Partials 2105 0 -2105
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
geido
added
the
preset:bounty
|
Thanks for the great docs @msyavuz! Can we remove the Tagging some folks that might know if that folder is needed. @Vitor-Avila @betodealmeida |
|
No problem! As far as i know git doesn't deal with directories so it should be out of index already since its empty? Just need to run |
| @@ -1,16 +0,0 @@ | |||
| # Licensed to the Apache Software Foundation (ASF) under one | |||
There was a problem hiding this comment.
Any reasons for deleting this? Can you bring it back?
There was a problem hiding this comment.
I think this might be used by some organizations so we don't want to delete it if it is not necessary
There was a problem hiding this comment.
If this folder is used, it would be good to add some comment or README file. Empty folders can be deleted at any time during cleanup efforts.
SUMMARY
Add examples to filter_state and permalink endpoints and add parameters to embedded endpoint.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
After:
Note
Endpoint for filter_state accepts the body in the form of { "value": "stringified json" }. I documented the endpoint with actual json object and specified that it should be stringified and put into value field of the body in the examples. Other approach would be to just put the stringified example there which makes it unreadable but is more reflective.
TESTING INSTRUCTIONS
Go to local instance of swagger ui at /swagger/v1 and check for the documentation.
ADDITIONAL INFORMATION