# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Purview eDiscovery Cases API
  version: 1.0.0
extends: openapi/microsoft-purview-cases-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/security/cases/ediscoveryCases'].get
  update:
    x-apievangelist-phrasing:
      intent: List eDiscovery cases
      effect: read
      questions:
      - What eDiscovery cases are open in our organization?
      - Can I filter eDiscovery cases by status or sort them by date?
      instructions:
      - text: List all eDiscovery cases.
      - text: Show eDiscovery cases matching {filter}.
        slots:
          filter: query.$filter
      - text: List the top {top} eDiscovery cases ordered by {order}.
        slots:
          top: query.$top
          order: query.$orderby
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/cases/ediscoveryCases'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a new eDiscovery case
      effect: write
      questions:
      - How do I start a new eDiscovery case for a litigation matter?
      - Can I attach our external matter number to a new case?
      instructions:
      - text: Create an eDiscovery case named {name}.
        slots:
          name: requestBody.displayName
      - text: Open eDiscovery case {name} with external ID {external}.
        slots:
          name: requestBody.displayName
          external: requestBody.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/cases/ediscoveryCases/{ediscoveryCaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an eDiscovery case
      effect: read
      questions:
      - Where can I check the status and closing details of a single eDiscovery case?
      - Who last modified a particular eDiscovery case?
      instructions:
      - text: Show me eDiscovery case {case}.
        slots:
          case: path.ediscoveryCaseId
      - text: Get the details of case {case}.
        slots:
          case: path.ediscoveryCaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/cases/ediscoveryCases/{ediscoveryCaseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an eDiscovery case and its data
      effect: destructive
      questions:
      - Can I delete an eDiscovery case along with everything collected in it?
      - What gets removed when an eDiscovery case is deleted?
      instructions:
      - text: Delete eDiscovery case {case}.
        slots:
          case: path.ediscoveryCaseId
      - text: Permanently remove case {case} and its associated data.
        slots:
          case: path.ediscoveryCaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/cases/ediscoveryCases/{ediscoveryCaseId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an eDiscovery case
      effect: write
      questions:
      - How do I rename an eDiscovery case or change its description?
      - Can I change the status of an existing eDiscovery case?
      instructions:
      - text: Rename eDiscovery case {case} to {name}.
        slots:
          case: path.ediscoveryCaseId
          name: requestBody.displayName
      - text: Set the status of case {case} to {status}.
        slots:
          case: path.ediscoveryCaseId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'