Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview eDiscovery Custodians API

3 actions 3 updates phrasing extends openapi/microsoft-purview-custodians-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Purview's API. It is a proposal applied on top of the contract, not a document Microsoft Purview publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/security/cases/ediscoveryCases/{ediscoveryCaseId}/custodians'].get
$.paths['/security/cases/ediscoveryCases/{ediscoveryCaseId}/custodians'].post

OpenAPI Overlay

Raw ↑ 
# 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 Custodians API
  version: 1.0.0
extends: openapi/microsoft-purview-custodians-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: 2
- target: $.paths['/security/cases/ediscoveryCases/{ediscoveryCaseId}/custodians'].get
  update:
    x-apievangelist-phrasing:
      intent: List custodians in an eDiscovery case
      effect: read
      questions:
      - Who are the custodians attached to an eDiscovery case?
      - Can I see each custodian's hold status for a case?
      instructions:
      - text: List the custodians in eDiscovery case {case}.
        slots:
          case: path.ediscoveryCaseId
      - text: Show custodian hold status for case {case}.
        slots:
          case: path.ediscoveryCaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/cases/ediscoveryCases/{ediscoveryCaseId}/custodians'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custodian to an eDiscovery case
      effect: write
      questions:
      - How do I add a person as a custodian to an eDiscovery case?
      - Can I add a custodian by email address?
      instructions:
      - text: Add custodian {email} to eDiscovery case {case}.
        slots:
          email: requestBody.email
          case: path.ediscoveryCaseId
      - text: Add {name} as a custodian on case {case}.
        slots:
          name: requestBody.displayName
          case: path.ediscoveryCaseId
      method: generated
      generated: '2026-10-01'