Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Releases Release Files API

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

$.info

$.paths['/organizations/{organization_id_or_slug}/releases/{version}/files/'].get

$.paths['/organizations/{organization_id_or_slug}/releases/{version}/files/'].post

$.paths['/organizations/{organization_id_or_slug}/releases/{version}/files/{file_id}/'].get

$.paths['/organizations/{organization_id_or_slug}/releases/{version}/files/{file_id}/'].put

$.paths['/organizations/{organization_id_or_slug}/releases/{version}/files/{file_id}/'].delete

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 Releases Release Files API
  version: 1.0.0
extends: openapi/sentry-system-release-files-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: 5
- target: $.paths['/organizations/{organization_id_or_slug}/releases/{version}/files/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a release's uploaded files
      effect: read
      questions:
      - Which source maps and artifacts were uploaded for a release?
      - Can I page through the files attached to a version?
      instructions:
      - text: List files uploaded to release {version} in {org}.
        slots:
          version: path.version
          org: path.organization_id_or_slug
      - text: Show the next page of files for release {version} from cursor {cursor}.
        slots:
          version: path.version
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/releases/{version}/files/'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to a release
      effect: write
      questions:
      - How do I upload a source map to a release?
      - Can I set a custom name or header on an uploaded release file?
      instructions:
      - text: Upload {file} to release {version} in {org}.
        slots:
          file: requestBody.file
          version: path.version
          org: path.organization_id_or_slug
      - text: Upload {file} to release {version} as {name} with header {header}.
        slots:
          file: requestBody.file
          version: path.version
          name: requestBody.name
          header: requestBody.header
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/releases/{version}/files/{file_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release file
      effect: read
      questions:
      - Can I check one file attached to a release?
      - What are the details of a specific release artifact?
      instructions:
      - text: Show file {file_id} in release {version} of {org}.
        slots:
          file_id: path.file_id
          version: path.version
          org: path.organization_id_or_slug
      - text: Fetch release file {file_id} from {version}.
        slots:
          file_id: path.file_id
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/releases/{version}/files/{file_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a release file
      effect: write
      questions:
      - How do I fix the name of a source map I uploaded to a release?
      - Can I change the path of an existing release file?
      instructions:
      - text: Rename file {file_id} in release {version} of {org} to {name}.
        slots:
          file_id: path.file_id
          version: path.version
          org: path.organization_id_or_slug
          name: requestBody.name
      - text: Change release file {file_id}'s name to {name}.
        slots:
          file_id: path.file_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/releases/{version}/files/{file_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a release file
      effect: destructive
      questions:
      - How do I remove a wrong source map from a release?
      - Can I delete one artifact without deleting the release?
      instructions:
      - text: Delete file {file_id} from release {version} in {org}.
        slots:
          file_id: path.file_id
          version: path.version
          org: path.organization_id_or_slug
      - text: Remove release file {file_id} from {version}.
        slots:
          file_id: path.file_id
          version: path.version
      method: generated
      generated: '2026-09-26'