-
-
Notifications
You must be signed in to change notification settings - Fork 4.5k
feat(dashboards): Adds public api docs for post and get /dashboards #74404
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(dashboards): Adds public api docs for post and get /dashboards #74404
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #74404 +/- ##
==========================================
+ Coverage 78.10% 78.23% +0.12%
==========================================
Files 6757 6685 -72
Lines 301551 299878 -1673
Branches 51888 51623 -265
==========================================
- Hits 235533 234605 -928
+ Misses 59680 58930 -750
- Partials 6338 6343 +5
|
| parameters=[GlobalParams.ORG_ID_OR_SLUG], | ||
| request=None, | ||
| responses={ | ||
| 200: inline_sentry_response_serializer( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I couldn't figure out a way to extend DashboardListSerializer to a list, so I created DashboardListResponse instead, and also typed DashboardListSerializer to use DashboardListResponse.
sentaur-athena
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For easier review, you can follow these steps and see how your published API looks like in docs: https://develop.sentry.dev/application/api/public/#building-and-testing-locally
…thub.com:getsentry/sentry into egou/feat/dashboards-get-and-create-api-docs
lizokm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
…ashboards-get-and-create-api-docs
….com:getsentry/sentry into egou/feat/dashboards-get-and-create-api-docs
Documents the dashboards endpoint and makes GET and POST methods public API.