# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BigPanda Major Incident Management API
  version: 1.0.0
extends: openapi/bigpanda-major-incident-management-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: 7
- target: $.paths['/mim/executions/{executionId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a major incident execution
      effect: destructive
      questions:
      - How do I call off a major incident workflow that was started by mistake?
      - What's the difference between cancelling and resolving a MIM execution?
      instructions:
      - text: Cancel MIM execution {executionId} without closing-out work.
        slots:
          executionId: path.executionId
      - text: Cancel major incident run {executionId} because {reason}.
        slots:
          executionId: path.executionId
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mim/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a major incident workflow from a template
      effect: write
      questions:
      - How do I kick off a major incident with channels and automated actions from a template?
      - Can I set the incident priority when starting a MIM workflow?
      - What do I get back right away when I launch a major incident?
      instructions:
      - text: Start a major incident {mimName} from template {templateId}.
        slots:
          mimName: requestBody.mimName
          templateId: requestBody.templateId
      - text: Launch MIM template {templateId} at priority {incidentPriority} with details {incidentDetails}.
        slots:
          templateId: requestBody.templateId
          incidentPriority: requestBody.incidentPriority
          incidentDetails: requestBody.incidentDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mim/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List major incident templates
      effect: read
      questions:
      - Which major incident templates are configured for my organization?
      - How many automated actions does each MIM template have?
      instructions:
      - text: List our MIM templates.
      - text: Show {limit} MIM templates starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mim/executions/{executionId}/resolve'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve a major incident execution
      effect: write
      questions:
      - How do I close out a major incident so final reports run and channels get archived?
      - Can I resolve a MIM execution that's currently paused?
      instructions:
      - text: Resolve MIM execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Mark major incident {executionId} resolved with reason {reason}.
        slots:
          executionId: path.executionId
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mim/executions/{executionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a major incident execution's details
      effect: read
      questions:
      - Which automated actions have finished for a running major incident?
      - Can I poll the status of a MIM execution after starting it?
      instructions:
      - text: Get details of MIM execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Show action statuses and channels for execution {executionId}.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mim/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List major incident executions
      effect: read
      questions:
      - Which major incidents are active right now?
      - Can I filter MIM executions by status for a dashboard?
      instructions:
      - text: List all MIM executions.
      - text: Show major incident executions with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mim/templates/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a major incident template's actions
      effect: read
      questions:
      - Which actions in a MIM template require approval before they run?
      - Can I see the scheduling and execution mode of a template's actions?
      instructions:
      - text: Get MIM template {templateId}.
        slots:
          templateId: path.templateId
      - text: Show the full action definitions of template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-09-26'