# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Test Observer Environments API
  version: 1.0.0
extends: openapi/canonical-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: 5
- target: $.paths['/v1/environments/reported-issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List issues reported against environments
      effect: read
      questions:
      - Which test environments have known reported issues?
      - Can I see only confirmed environment issues?
      instructions:
      - text: List reported environment issues.
      - text: Show environment issues where confirmed is {is_confirmed}.
        slots:
          is_confirmed: query.is_confirmed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments/reported-issues'].post
  update:
    x-apievangelist-phrasing:
      intent: Report an issue with a test environment
      effect: write
      questions:
      - How do I flag a problem with a specific test environment?
      - Can I link a bug URL when reporting an environment issue?
      instructions:
      - text: 'Report an issue on environment {env}: {description} (confirmed {is_confirmed}).'
        slots:
          env: requestBody.environment_name
          description: requestBody.description
          is_confirmed: requestBody.is_confirmed
      - text: Log a confirmed ({is_confirmed}) problem on {env} described as {description}, tracked at {url}.
        slots:
          is_confirmed: requestBody.is_confirmed
          env: requestBody.environment_name
          description: requestBody.description
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments/reported-issues/{issue_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a reported environment issue
      effect: write
      questions:
      - Can I mark a reported environment issue as confirmed later?
      - How do I edit the description of an environment issue I already reported?
      instructions:
      - text: Update environment issue {issue_id} on {env} with description {description} and confirmed {is_confirmed}.
        slots:
          issue_id: path.issue_id
          env: requestBody.environment_name
          description: requestBody.description
          is_confirmed: requestBody.is_confirmed
      - text: Set the tracking URL of environment issue {issue_id} to {url}.
        slots:
          issue_id: path.issue_id
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments/reported-issues/{issue_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a reported environment issue
      effect: destructive
      questions:
      - How do I remove an environment issue that was reported by mistake?
      - Can a resolved environment issue be deleted?
      instructions:
      - text: Delete reported environment issue {issue_id}.
        slots:
          issue_id: path.issue_id
      - text: Remove environment issue report {issue_id}.
        slots:
          issue_id: path.issue_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments used in test runs
      effect: read
      questions:
      - Which environments have been used in test executions?
      - Can I search the list of test environments by name or family?
      instructions:
      - text: List the environments used in test executions.
      - text: Search environments for {q} in families {families}.
        slots:
          q: query.q
          families: query.families
      method: generated
      generated: '2026-09-26'