# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Privacy Automation - Incident Management Incidents API
  version: 1.0.0
extends: openapi/onetrust-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: 7
- target: $.paths['/incident/v1/assignments/entities/{entityId}/stage'].post
  update:
    x-apievangelist-phrasing:
      intent: Move an incident to its next workflow stage
      effect: write
      questions:
      - How do I advance a privacy incident to the next stage of its workflow?
      - Can I move an incident into a stage by the stage's name?
      instructions:
      - text: Move incident {entityId} to stage {nextStageName}.
        slots:
          entityId: path.entityId
          nextStageName: requestBody.nextStageName
      - text: Advance incident {entityId} to the {nextStageName} stage of its default workflow.
        slots:
          entityId: path.entityId
          nextStageName: requestBody.nextStageName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incident/v1/assignments/entities/{entityId}/types/{type}/stage'].post
  update:
    x-apievangelist-phrasing:
      intent: Move an incident's stage within a workflow type
      effect: write
      questions:
      - How do I change an incident's stage in a specific workflow type rather than the default?
      - Can an incident be staged separately per workflow type?
      instructions:
      - text: Move incident {entityId} to stage {nextStageName} in its {type} workflow.
        slots:
          entityId: path.entityId
          nextStageName: requestBody.nextStageName
          type: path.type
      - text: Set the {type} workflow stage of incident {entityId} to {nextStageName}.
        slots:
          type: path.type
          entityId: path.entityId
          nextStageName: requestBody.nextStageName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incident/v1/incidents'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a new incident in the Incident Register
      effect: write
      questions:
      - How do I record a new data breach in the incident register?
      - Can I set when an incident occurred and was discovered as I log it?
      instructions:
      - text: Log incident {name} of type {incidentTypeName} for org group {orgGroupId}.
        slots:
          name: requestBody.name
          incidentTypeName: requestBody.incidentTypeName
          orgGroupId: requestBody.orgGroupId
      - text: Create a {incidentTypeName} incident {name} in org group {orgGroupId}, discovered on {dateDiscovered}.
        slots:
          incidentTypeName: requestBody.incidentTypeName
          name: requestBody.name
          orgGroupId: requestBody.orgGroupId
          dateDiscovered: requestBody.dateDiscovered
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incident/v1/incidents/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search incidents by keyword and filters
      effect: read
      questions:
      - Which incidents mention a particular system or keyword?
      - Can I filter the incident register and sort the results?
      instructions:
      - text: Search incidents for {fullText}.
        slots:
          fullText: requestBody.fullText
      - text: Find incidents matching filters {filters}, sorted by {sort}.
        slots:
          filters: requestBody.filters
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incident/v1/incidents/{incidentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incident with its assessments and status
      effect: read
      questions:
      - What is the current status of a given incident and which assessments are linked to it?
      - Can I see all the attributes recorded on one incident?
      instructions:
      - text: Show incident {incidentId}.
        slots:
          incidentId: path.incidentId
      - text: Get the linked assessments and status of incident {incidentId}.
        slots:
          incidentId: path.incidentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incident/v1/incidents/{incidentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an incident's details
      effect: write
      questions:
      - How do I record the root cause on an incident after investigation?
      - Can I change an incident's deadline or jurisdictions later?
      instructions:
      - text: 'Update incident {incidentId}: name {name}, type {incidentTypeName}, org group {orgGroupId}.'
        slots:
          incidentId: path.incidentId
          name: requestBody.name
          incidentTypeName: requestBody.incidentTypeName
          orgGroupId: requestBody.orgGroupId
      - text: Set the root cause of incident {incidentId} to {rootCause}.
        slots:
          incidentId: path.incidentId
          rootCause: requestBody.rootCause
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incident/v1/incidents/{incidentId}/inventory-links/{inventoryType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Link an incident to inventory records
      effect: write
      questions:
      - How do I record which assets were affected by an incident?
      - Can I link an incident to inventories by their external IDs?
      instructions:
      - text: Link incident {incidentId} to {inventoryType} inventories {inventoryIds}.
        slots:
          incidentId: path.incidentId
          inventoryType: path.inventoryType
          inventoryIds: requestBody.inventoryIds
      - text: Attach {inventoryType} records with external IDs {externalIds} to incident {incidentId}.
        slots:
          inventoryType: path.inventoryType
          externalIds: requestBody.externalIds
          incidentId: path.incidentId
      method: generated
      generated: '2026-09-26'