sentry-docs
sentry-docs copied to clipboard
Incorrect annotations schema in documentation
Environment
SaaS (https://sentry.io/)
Steps to Reproduce
- visit the docs for listing a project's issues: https://docs.sentry.io/api/events/list-a-projects-issues/
- view the schema for a 200 response
- observe the annotations schema is out of date
Expected Result
Expect schema for annotations to be:
"annotations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
Actual Result
Docs reflect the schema prior to this change:
"annotations": {
"type": "array",
"items": {
"type": "string"
}
}
Product Area
Other
Link
No response
DSN
No response
Version
No response
Assigning to @getsentry/support for routing ⏲️
Similar to getsentry/sentry#75203. I'm happy to submit a PR with the updated schema. Let me know if there's anywhere else that might have the old schema and I'll update too.
Routing to @getsentry/product-owners-apis for triage ⏲️
@oioki Can you take a look and confirm if this needs to be updated?