Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Releases Deploys API

3 actions 3 updates phrasing extends openapi/sentry-system-deploys-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['/organizations/{organization_id_or_slug}/releases/{version}/deploys/'].get
$.paths['/organizations/{organization_id_or_slug}/releases/{version}/deploys/'].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 Releases Deploys API
  version: 1.0.0
extends: openapi/sentry-system-deploys-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['/organizations/{organization_id_or_slug}/releases/{version}/deploys/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a release's deploys
      effect: read
      questions:
      - Where has a given release been deployed?
      - Which environments received a specific version?
      instructions:
      - text: List deploys of release {version} in {org}.
        slots:
          version: path.version
          org: path.organization_id_or_slug
      - text: Show every deploy recorded for version {version}.
        slots:
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/releases/{version}/deploys/'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a deploy of a release
      effect: write
      questions:
      - How do I tell Sentry a release was deployed to production?
      - Can I record start and finish times for a deploy?
      instructions:
      - text: Record a deploy of release {version} to {environment} in {org}.
        slots:
          version: path.version
          environment: requestBody.environment
          org: path.organization_id_or_slug
      - text: Log deploy of {version} to {environment} that started {dateStarted} and finished {dateFinished}.
        slots:
          version: path.version
          environment: requestBody.environment
          dateStarted: requestBody.dateStarted
          dateFinished: requestBody.dateFinished
      method: generated
      generated: '2026-09-26'