Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Projects User Feedback API

3 actions 3 updates phrasing extends openapi/sentry-system-user-feedback-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Sentry's API. It is a proposal applied on top of the contract, not a document Sentry publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/user-feedback/'].get
$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/user-feedback/'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sentry Projects User Feedback API
  version: 1.0.0
extends: openapi/sentry-system-user-feedback-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/user-feedback/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's user feedback
      effect: read
      questions:
      - What feedback have users submitted for my app?
      - Can I read user comments attached to crashes in a project?
      instructions:
      - text: List user feedback for project {project} in {org}.
        slots:
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Show recent user feedback on project {project}.
        slots:
          project: path.project_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/user-feedback/'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit user feedback for an event
      effect: write
      questions:
      - How do I attach a user's comments to an error event?
      - What information is required to submit user feedback?
      instructions:
      - text: 'Submit feedback for event {event_id} in project {project} of {org} from {name} ({email}): {comments}.'
        slots:
          event_id: requestBody.event_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
          name: requestBody.name
          email: requestBody.email
          comments: requestBody.comments
      - text: Record {name} <{email}> saying {comments} about event {event_id}.
        slots:
          name: requestBody.name
          email: requestBody.email
          comments: requestBody.comments
          event_id: requestBody.event_id
      method: generated
      generated: '2026-09-26'