-
-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
fix(apidocs): fix typo in user feedback api #85280
Conversation
🚨 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 |
1af71a0
to
c1c358e
Compare
@@ -47,7 +47,7 @@ def get(self, request: Request, project) -> Response: | |||
|
|||
Return a list of user feedback items within this project. | |||
|
|||
*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).* | |||
*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). To return a list of user feedback items from the widget, please use the [issue API](https://docs.sentry.io/api/events/list-a-projects-issues/) with the filter `issue.category:feedback`.* |
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.
this isn't used to render the api docs (we're still using the old way above) but we should keep them in sync with each other if we ever convert to the new api schema format
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.
we chatted offline - this endpoint will eventually be deprecated/removed and we will delete the docs, so not worth the effort to move this over to the new doc standards
rm the extra asterisk
after
![SCR-20250214-luoz](https://private-user-images.githubusercontent.com/56095982/413466308-41aa3592-16f1-4a94-83c6-183f3edb7b38.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MjA2MjYsIm5iZiI6MTczOTYyMDMyNiwicGF0aCI6Ii81NjA5NTk4Mi80MTM0NjYzMDgtNDFhYTM1OTItMTZmMS00YTk0LTgzYzYtMTgzZjNlZGI3YjM4LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjE1VDExNTIwNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWU2MDRlZWI3ODFmOTcyNWUxMTkzNTE4Nzg1NDBiZTg3MzE0ZjJiZmEzNmU4MTAwNDNlN2RiODM5MTc5NjE3MDAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.FbjvAvSdxXa_BsU4kHQUQUZb8LVptnp1vonAeI9QIXU)