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

chore(api): Rewrite Org Details docs #73293

Merged
merged 13 commits into from
Jul 15, 2024
Merged

Conversation

isabellaenriquez
Copy link
Member

@isabellaenriquez isabellaenriquez commented Jun 25, 2024

Updates the OrganizationDetailsEndpoint docs to use the modern format + more detailed parameters + updated examples and schema

localhost_3000_api_organizations_update-an-organization_ (5)

localhost_3000_api_organizations_update-an-organization_ (4)

@github-actions github-actions bot added Scope: Frontend Automatically applied to PRs that change frontend components Scope: Backend Automatically applied to PRs that change backend components labels Jun 25, 2024
Copy link
Contributor

🚨 Warning: This pull request contains Frontend and Backend changes!

It's discouraged to make changes to Sentry's Frontend and Backend in a single pull request. The Frontend and Backend are not atomically deployed. If the changes are interdependent of each other, they must be separated into two pull requests and be made forward or backwards compatible, such that the Backend or Frontend can be safely deployed independently.

Have questions? Please ask in the #discuss-dev-infra channel.

@isabellaenriquez isabellaenriquez changed the title chore(apidocs): Rewrite Org Details docs chore(api): Rewrite Org Details docs Jun 25, 2024
Copy link

codecov bot commented Jun 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.16%. Comparing base (85a1d70) to head (05332df).
Report is 48 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master   #73293       +/-   ##
===========================================
+ Coverage   57.06%   78.16%   +21.09%     
===========================================
  Files        6641     6652       +11     
  Lines      297198   297584      +386     
  Branches    51183    51249       +66     
===========================================
+ Hits       169594   232604    +63010     
+ Misses     122877    58716    -64161     
- Partials     4727     6264     +1537     
Files Coverage Δ
src/sentry/api/endpoints/organization_details.py 88.02% <100.00%> (+50.62%) ⬆️
src/sentry/api/serializers/models/organization.py 94.46% <100.00%> (+26.24%) ⬆️
src/sentry/api/serializers/models/project.py 96.62% <100.00%> (+19.73%) ⬆️
src/sentry/api/serializers/models/role.py 100.00% <100.00%> (ø)
src/sentry/api/serializers/types.py 100.00% <100.00%> (ø)
...c/sentry/apidocs/examples/organization_examples.py 100.00% <100.00%> (ø)
src/sentry/apidocs/examples/project_examples.py 100.00% <ø> (ø)
src/sentry/apidocs/examples/team_examples.py 100.00% <ø> (ø)
src/sentry/apidocs/parameters.py 98.90% <100.00%> (+0.01%) ⬆️

... and 1996 files with indirect coverage changes

Copy link

@vivianyentran vivianyentran left a comment

Choose a reason for hiding this comment

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

Added some copyedits. Thanks for updating!

src/sentry/api/endpoints/organization_details.py Outdated Show resolved Hide resolved
src/sentry/api/endpoints/organization_details.py Outdated Show resolved Hide resolved
src/sentry/api/endpoints/organization_details.py Outdated Show resolved Hide resolved
required=False,
)
allowSharedIssues = serializers.BooleanField(
help_text="Specify `true` to allow sharing of limited details on issues to anonymous users.",

Choose a reason for hiding this comment

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

What are anonymous users? This is the first time I've seen this mentioned. Is it users who aren't signed in?

Copy link
Member Author

Choose a reason for hiding this comment

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

yup exactly users who aren't signed in! i used the exact language used in the UI. it's for whether you can share public links of issues or not.

src/sentry/api/endpoints/organization_details.py Outdated Show resolved Hide resolved
src/sentry/api/endpoints/organization_details.py Outdated Show resolved Hide resolved
src/sentry/api/endpoints/organization_details.py Outdated Show resolved Hide resolved
src/sentry/api/endpoints/organization_details.py Outdated Show resolved Hide resolved
src/sentry/api/endpoints/organization_details.py Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jul 10, 2024

Bundle Report

Changes will increase total bundle size by 7.88kB ⬆️

Bundle name Size Change
app-webpack-bundle-array-push 27.3MB 7.88kB ⬆️

@schew2381 schew2381 merged commit 328f162 into master Jul 15, 2024
49 of 50 checks passed
@schew2381 schew2381 deleted the isabella/update-org-details-docs branch July 15, 2024 16:53
@github-actions github-actions bot locked and limited conversation to collaborators Jul 31, 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 Scope: Frontend Automatically applied to PRs that change frontend components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants