API Evangelist conversational phrasing for Bigpanda Incidents API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bigpanda Incidents API
  version: 1.0.0
extends: openapi/bigpanda-incidents-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: 21
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents'].get
  update:
    x-apievangelist-phrasing:
      intent: List incidents in an environment
      effect: read
      questions:
      - Which incidents are currently open in my BigPanda environment?
      - Can I list only active incidents for one environment?
      instructions:
      - text: List the incidents in environment {environment_id}.
        slots:
          environment_id: path.environment_id
      - text: Show incidents in environment {environment_id} with active set to {active}.
        slots:
          environment_id: path.environment_id
          active: query.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incident's details
      effect: read
      questions:
      - What are the details of a specific incident?
      - Can I pull the full record for one incident by its ID?
      instructions:
      - text: Get incident {incident_id} in environment {environment_id}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Show me everything about incident {incident_id} from environment {environment_id}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List all tags on an incident
      effect: read
      questions:
      - Which incident tags have been set on this incident?
      - Can I see every tag value attached to one incident?
      instructions:
      - text: List all incident tags on incident {incident_id} in environment {environment_id}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Show the tag values set on incident {incident_id} in {environment_id}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set several tags on an incident at once
      effect: write
      questions:
      - Can I add or update several incident tags in one request?
      - How do I bulk-set tag values on a single incident?
      instructions:
      - text: Set multiple incident tags on incident {incident_id} in environment {environment_id}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Bulk-update the tags on incident {incident_id} ({environment_id}) with these values.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all tags from an incident
      effect: destructive
      questions:
      - Can I clear every tag off an incident in one go?
      - How do I wipe all incident tag values from a single incident?
      instructions:
      - text: Delete all incident tags from incident {incident_id} in environment {environment_id}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Clear every tag on incident {incident_id} in {environment_id}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags/{incidenttag_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one tag's value on an incident
      effect: read
      questions:
      - What value does a particular tag have on this incident?
      - Can I read just one incident tag from an incident?
      instructions:
      - text: Get tag {incidenttag_id} on incident {incident_id} in environment {environment_id}.
        slots:
          incidenttag_id: path.incidenttag_id
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Tell me the {incidenttag_id} value on incident {incident_id} ({environment_id}).
        slots:
          incidenttag_id: path.incidenttag_id
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags/{incidenttag_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a single tag value on an incident
      effect: write
      questions:
      - Can I set one incident tag, like priority, on a specific incident?
      - Does setting an incident tag overwrite a value that's already there?
      instructions:
      - text: Set tag {incidenttag_id} to {tag_value} on incident {incident_id} in environment {environment_id}.
        slots:
          incidenttag_id: path.incidenttag_id
          tag_value: requestBody.tag_value
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Update the {incidenttag_id} tag on incident {incident_id} ({environment_id}) to {tag_value}.
        slots:
          incidenttag_id: path.incidenttag_id
          incident_id: path.incident_id
          environment_id: path.environment_id
          tag_value: requestBody.tag_value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags/{incidenttag_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one tag from an incident
      effect: destructive
      questions:
      - Can I remove a single tag value from an incident but keep the others?
      - How do I clear just one incident tag on an incident?
      instructions:
      - text: Delete tag {incidenttag_id} from incident {incident_id} in environment {environment_id}.
        slots:
          incidenttag_id: path.incidenttag_id
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Clear only the {incidenttag_id} tag on incident {incident_id} ({environment_id}).
        slots:
          incidenttag_id: path.incidenttag_id
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/assignment'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign an incident to a user
      effect: write
      questions:
      - How do I assign an incident to someone on my team?
      - Can I make a specific user responsible for an incident through the API?
      instructions:
      - text: Assign incident {incident_id} in environment {environment_id} to {assignee}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
          assignee: requestBody.assignee
      - text: Make {assignee} the owner of incident {incident_id} ({environment_id}).
        slots:
          assignee: requestBody.assignee
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/assignment'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign an incident
      effect: destructive
      questions:
      - Can I remove the assignee from an incident?
      - How do I leave an incident with nobody assigned?
      instructions:
      - text: Unassign incident {incident_id} in environment {environment_id}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Remove whoever is assigned to incident {incident_id} ({environment_id}).
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on an incident
      effect: write
      questions:
      - Can I post a note to an incident's timeline from a script?
      - How do I add a comment to a BigPanda incident?
      instructions:
      - text: Comment {comment} on incident {incident_id} in environment {environment_id}.
        slots:
          comment: requestBody.comment
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Add the note {comment} to incident {incident_id} ({environment_id}).
        slots:
          comment: requestBody.comment
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/incidents/tags/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List incident tag definitions
      effect: read
      questions:
      - What incident tags are defined for my organization?
      - Can I list only the active incident tag definitions of a given type?
      instructions:
      - text: List all incident tag definitions.
      - text: Show incident tag definitions of type {type} with active set to {active}.
        slots:
          type: query.type
          active: query.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/incidents/tags/definitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new incident tag
      effect: write
      questions:
      - How do I define a new incident tag that users can fill in manually?
      - Can a new incident tag definition be enriched automatically?
      instructions:
      - text: Create an incident tag definition named {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Define incident tag {name} ({type}) described as {description}, with manual input set to {canManualInput}.
        slots:
          name: requestBody.name
          type: requestBody.type
          description: requestBody.description
          canManualInput: requestBody.canManualInput
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/incidents/{incident_id}/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List enrichment activity on an incident
      effect: read
      questions:
      - What enrichment actions have been taken on this incident?
      - Can I filter an incident's activity log by activity type?
      instructions:
      - text: Get the activities for incident {incident_id}.
        slots:
          incident_id: path.incident_id
      - text: List {types} activities on incident {incident_id}, page {page} with {per_page} per page.
        slots:
          types: query.types
          incident_id: path.incident_id
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/incidents/tags/definitions/{incidenttag_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incident tag definition
      effect: read
      questions:
      - How is a particular incident tag defined?
      - Can I look up one incident tag definition by its ID?
      instructions:
      - text: Get incident tag definition {incidenttag_id}.
        slots:
          incidenttag_id: path.incidenttag_id
      - text: Show the type and settings of the {incidenttag_id} tag definition.
        slots:
          incidenttag_id: path.incidenttag_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/incidents/tags/definitions/{incidenttag_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an incident tag definition
      effect: write
      questions:
      - Can I rename an incident tag definition or turn it off?
      - Can I change how an existing incident tag definition is enriched?
      instructions:
      - text: Update incident tag definition {incidenttag_id} to name {name} and type {type}.
        slots:
          incidenttag_id: path.incidenttag_id
          name: requestBody.name
          type: requestBody.type
      - text: Change the enrichment config of tag definition {incidenttag_id} to {enrichment_config}, keeping name {name} and type {type}.
        slots:
          incidenttag_id: path.incidenttag_id
          enrichment_config: requestBody.enrichment_config
          name: requestBody.name
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge incidents into one
      effect: write
      questions:
      - How do I merge several related incidents into a single incident?
      - Is there a limit on how many alerts a merged incident can hold?
      instructions:
      - text: Merge incidents {source_incidents} into incident {incident_id} in environment {environment_id}.
        slots:
          source_incidents: requestBody.source_incidents
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Fold {source_incidents} into {incident_id} ({environment_id}) with the comment {comment}.
        slots:
          source_incidents: requestBody.source_incidents
          incident_id: path.incident_id
          environment_id: path.environment_id
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/resolve'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve an incident
      effect: write
      questions:
      - Can I resolve an incident from an automation once the fix is in?
      - What do I have to include when resolving an incident through the API?
      instructions:
      - text: Resolve incident {incident_id} in environment {environment_id} with comments {comments}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
          comments: requestBody.comments
      - text: Close out incident {incident_id} ({environment_id}) noting {comments}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
          comments: requestBody.comments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/snooze'].put
  update:
    x-apievangelist-phrasing:
      intent: Snooze an incident until a set time
      effect: write
      questions:
      - Can I snooze a noisy incident until a specific time?
      - Can a snooze be cancelled automatically if the incident gets updated?
      instructions:
      - text: Snooze incident {incident_id} in environment {environment_id} until {end_time}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
          end_time: requestBody.end_time
      - text: Snooze {incident_id} ({environment_id}) until {end_time}, cancelling on updates set to {cancel_on_incident_updates}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
          end_time: requestBody.end_time
          cancel_on_incident_updates: requestBody.cancel_on_incident_updates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/snooze'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsnooze an incident
      effect: destructive
      questions:
      - How do I wake up an incident I snoozed earlier?
      - Can I end a snooze before its end time?
      instructions:
      - text: Unsnooze incident {incident_id} in environment {environment_id}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Remove the snooze from incident {incident_id} ({environment_id}) now.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/split'].post
  update:
    x-apievangelist-phrasing:
      intent: Split alerts out into a new incident
      effect: write
      questions:
      - Can I move some alerts out of an incident into a new one?
      - How do I split an incident that correlated unrelated alerts?
      instructions:
      - text: Split alerts {alerts} from incident {incident_id} in environment {environment_id} into a new incident.
        slots:
          alerts: requestBody.alerts
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Pull alerts {alerts} out of {incident_id} ({environment_id}) into their own incident, commenting {comment}.
        slots:
          alerts: requestBody.alerts
          incident_id: path.incident_id
          environment_id: path.environment_id
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'