Skip to content

Conversation

@edwardgou-sentry
Copy link
Contributor

Documents the dashboards endpoint and makes GET and POST methods public API.

@edwardgou-sentry edwardgou-sentry requested a review from a team as a code owner July 17, 2024 05:03
@edwardgou-sentry edwardgou-sentry requested a review from a team July 17, 2024 05:03
@github-actions github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Jul 17, 2024
@codecov
Copy link

codecov bot commented Jul 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.23%. Comparing base (403b094) to head (a8f80f7).
Report is 21 commits behind head on master.

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     
Files Coverage Δ
...rc/sentry/api/endpoints/organization_dashboards.py 95.37% <100.00%> (+0.37%) ⬆️
src/sentry/api/serializers/models/dashboard.py 99.34% <100.00%> (+0.03%) ⬆️
src/sentry/apidocs/examples/dashboard_examples.py 100.00% <100.00%> (ø)

... and 558 files with indirect coverage changes

parameters=[GlobalParams.ORG_ID_OR_SLUG],
request=None,
responses={
200: inline_sentry_response_serializer(
Copy link
Contributor Author

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.

Copy link
Member

@sentaur-athena sentaur-athena left a 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
Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Looks good!

Base automatically changed from nar/feat/api-document-dashboard-details-endpoint to master July 24, 2024 15:10
@edwardgou-sentry edwardgou-sentry merged commit 76a7e5d into master Jul 29, 2024
@edwardgou-sentry edwardgou-sentry deleted the egou/feat/dashboards-get-and-create-api-docs branch July 29, 2024 17:01
@github-actions github-actions bot locked and limited conversation to collaborators Aug 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Scope: Backend Automatically applied to PRs that change backend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants