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(feedback): Add deprecation notes to user report endpoint apidocs #75396

Merged
merged 1 commit into from
Jul 31, 2024

Conversation

aliu39
Copy link
Member

@aliu39 aliu39 commented Jul 31, 2024

Ref getsentry/sentry-docs#10643
The replay team decided on a call to revert #75079 because some users may still need this doc as a reference.

What it looks like:

Screenshot 2024-07-31 at 3 18 44 PM Screenshot 2024-07-31 at 3 27 25 PM

@aliu39 aliu39 requested a review from a team as a code owner July 31, 2024 22:26
@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 Jul 31, 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.

@aliu39 aliu39 requested a review from a team July 31, 2024 22:30
Copy link

codecov bot commented Jul 31, 2024

Bundle Report

Changes will increase total bundle size by 8.39kB ⬆️

Bundle name Size Change
app-webpack-bundle-array-push 28.53MB 8.39kB ⬆️

@@ -1,7 +1,7 @@
{
"get": {
"tags": ["Projects"],
"description": "Return a list of user feedback items within this project.",
"description": "Return a list of user feedback items within this project.\n\n*This list does not include submissions from the [User Feedback Widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget). This is because it is based on an older format called User Reports - read more [here](https://develop.sentry.dev/application/feedback-architecture/#user-reports).*",
Copy link
Member

Choose a reason for hiding this comment

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

was this manually modified?👀

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah - turns out the json files is what api-docs actually uses. But they want the docstrings to stay consistent since they might switch to using those in the future.

Copy link
Member

Choose a reason for hiding this comment

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

oh cool i did not know - TIL!

@aliu39 aliu39 enabled auto-merge (squash) July 31, 2024 22:36
@aliu39 aliu39 merged commit f2ed2e3 into master Jul 31, 2024
51 of 52 checks passed
@aliu39 aliu39 deleted the aliu/deprecate-userreport-endpoint branch July 31, 2024 22:57
@github-actions github-actions bot locked and limited conversation to collaborators Aug 16, 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