sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Incorrect annotations schema in documentation

Open jakeoeding opened this issue 1 year ago • 3 comments

Environment

SaaS (https://sentry.io/)

Steps to Reproduce

  1. visit the docs for listing a project's issues: https://docs.sentry.io/api/events/list-a-projects-issues/
  2. view the schema for a 200 response
  3. 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

jakeoeding avatar Oct 03 '24 16:10 jakeoeding

Assigning to @getsentry/support for routing ⏲️

getsantry[bot] avatar Oct 03 '24 16:10 getsantry[bot]

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.

jakeoeding avatar Oct 03 '24 16:10 jakeoeding

Routing to @getsentry/product-owners-apis for triage ⏲️

getsantry[bot] avatar Oct 10 '24 21:10 getsantry[bot]

@oioki Can you take a look and confirm if this needs to be updated?

coolguyzone avatar Oct 31 '24 21:10 coolguyzone