Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Environments API

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

$.info

$.paths['/organizations/{organization_id_or_slug}/environments/'].get

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/environments/'].get

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/environments/{environment}/'].get

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/environments/{environment}/'].put

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 Environments API
  version: 1.0.0
extends: openapi/sentry-system-environments-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: 4
- target: $.paths['/organizations/{organization_id_or_slug}/environments/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's environments
      effect: read
      questions:
      - Which environments exist across my whole organization?
      - Can I see production, staging and every other environment org-wide?
      instructions:
      - text: List all environments in organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show every environment name used across {org}.
        slots:
          org: path.organization_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/environments/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's environments
      effect: read
      questions:
      - What environments does a single project report from?
      - Which environments are tied to one project?
      instructions:
      - text: List environments for project {project} in {org}.
        slots:
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Show project {project}'s environments.
        slots:
          project: path.project_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/environments/{environment}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project environment
      effect: read
      questions:
      - Is a particular environment hidden in my project?
      - How can I look up one environment's settings for a project?
      instructions:
      - text: Show environment {environment} for project {project} in {org}.
        slots:
          environment: path.environment
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Fetch settings of environment {environment} in project {project}.
        slots:
          environment: path.environment
          project: path.project_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/environments/{environment}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Hide or show a project environment
      effect: write
      questions:
      - Can I hide a noisy environment from a project's views?
      - How do I unhide an environment I hid before?
      instructions:
      - text: Set hidden to {isHidden} for environment {environment} in project {project} of {org}.
        slots:
          isHidden: requestBody.isHidden
          environment: path.environment
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Hide the {environment} environment in project {project}.
        slots:
          environment: path.environment
          project: path.project_id_or_slug
      method: generated
      generated: '2026-09-26'