Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry System Releases API

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

$.info
$.paths['/organizations/{organization_id_or_slug}/releases/'].get
$.paths['/organizations/{organization_id_or_slug}/releases/'].post
$.paths['/organizations/{organization_id_or_slug}/releases/{version}/'].get
$.paths['/organizations/{organization_id_or_slug}/releases/{version}/'].put
$.paths['/organizations/{organization_id_or_slug}/releases/{version}/'].delete
$.paths['/organizations/{organization_id_or_slug}/release-thresholds/'].get

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 System Releases API
  version: 1.0.0
extends: openapi/sentry-system-releases-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: 6
- target: $.paths['/organizations/{organization_id_or_slug}/releases/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's releases
      effect: read
      questions:
      - Which releases have been created in my org?
      - Can I search releases by version text?
      instructions:
      - text: List releases in organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Find releases in {org} matching {query}.
        slots:
          org: path.organization_id_or_slug
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/releases/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a release
      effect: write
      questions:
      - How do I tell Sentry about a new version I'm shipping?
      - Can I attach commits when creating a release?
      instructions:
      - text: Create release {version} for projects {projects} in {org}.
        slots:
          version: requestBody.version
          projects: requestBody.projects
          org: path.organization_id_or_slug
      - text: Create release {version} on projects {projects} at ref {ref} with commits {commits}.
        slots:
          version: requestBody.version
          projects: requestBody.projects
          ref: requestBody.ref
          commits: requestBody.commits
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/releases/{version}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release
      effect: read
      questions:
      - What are the details of a specific version?
      - When was a release created and what projects is it in?
      instructions:
      - text: Show release {version} in {org}.
        slots:
          version: path.version
          org: path.organization_id_or_slug
      - text: Fetch details for version {version}.
        slots:
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/releases/{version}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a release
      effect: write
      questions:
      - How do I mark a release as released with a date?
      - Can I add commits to a release after creating it?
      instructions:
      - text: Set release {version} in {org} as released on {dateReleased}.
        slots:
          version: path.version
          org: path.organization_id_or_slug
          dateReleased: requestBody.dateReleased
      - text: Attach commits {commits} to release {version}.
        slots:
          commits: requestBody.commits
          version: path.version
      - text: Set release {version}'s ref to {ref} and URL to {url}.
        slots:
          version: path.version
          ref: requestBody.ref
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/releases/{version}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a release
      effect: destructive
      questions:
      - How do I delete a release I created by mistake?
      - Does deleting a release remove its files too?
      instructions:
      - text: Delete release {version} from {org}.
        slots:
          version: path.version
          org: path.organization_id_or_slug
      - text: Remove version {version}.
        slots:
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/release-thresholds/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check release threshold statuses
      effect: read
      questions:
      - Are my releases passing their health thresholds?
      - Which release thresholds are currently breached?
      instructions:
      - text: Show release threshold statuses for {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Check current release threshold health in organization {org}.
        slots:
          org: path.organization_id_or_slug
      method: generated
      generated: '2026-09-26'