Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Prevent Test Results API

4 actions 4 updates phrasing extends openapi/sentry-system-test-results-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 4

$.info

$.paths['/organizations/{organization_id_or_slug}/prevent/test-results/'].get

$.paths['/organizations/{organization_id_or_slug}/prevent/test-results/metrics/'].get

$.paths['/organizations/{organization_id_or_slug}/prevent/test-results/suites/'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sentry Prevent Test Results API
  version: 1.0.0
extends: openapi/sentry-system-test-results-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: 3
- target: $.paths['/organizations/{organization_id_or_slug}/prevent/test-results/'].get
  update:
    x-apievangelist-phrasing:
      intent: List test results
      effect: read
      questions:
      - Which tests failed recently in my repository?
      - Can I page through test results for one repository?
      instructions:
      - text: List test results for {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show test results for repository {repositoryId} from cursor {cursor}.
        slots:
          repositoryId: query.repositoryId
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/prevent/test-results/metrics/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated test metrics
      effect: read
      questions:
      - How flaky is my test suite overall?
      - What are the aggregated test metrics for a repository?
      instructions:
      - text: Get aggregated test result metrics for {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show test metrics for repository {repositoryId}.
        slots:
          repositoryId: query.repositoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/prevent/test-results/suites/'].get
  update:
    x-apievangelist-phrasing:
      intent: List test suites for a repository
      effect: read
      questions:
      - Which test suites appear in my repository's results?
      - Can I see suite names to narrow test results?
      instructions:
      - text: List test suites in {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show test suites for repository {repositoryId}.
        slots:
          repositoryId: query.repositoryId
      method: generated
      generated: '2026-09-26'