Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview eDiscovery Review Sets API

3 actions 3 updates phrasing extends openapi/microsoft-purview-review-sets-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}/reviewSets'].get
$.paths['/security/cases/ediscoveryCases/{ediscoveryCaseId}/reviewSets'].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 Review Sets API
  version: 1.0.0
extends: openapi/microsoft-purview-review-sets-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}/reviewSets'].get
  update:
    x-apievangelist-phrasing:
      intent: List review sets in an eDiscovery case
      effect: read
      questions:
      - What review sets have been created in an eDiscovery case?
      - Where can I find the review sets for a case?
      instructions:
      - text: List review sets in eDiscovery case {case}.
        slots:
          case: path.ediscoveryCaseId
      - text: Show every review set for case {case}.
        slots:
          case: path.ediscoveryCaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/cases/ediscoveryCases/{ediscoveryCaseId}/reviewSets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a review set in an eDiscovery case
      effect: write
      questions:
      - How do I create a review set to examine collected evidence?
      - Can I name a review set when I add it to a case?
      instructions:
      - text: Create a review set named {name} in case {case}.
        slots:
          name: requestBody.displayName
          case: path.ediscoveryCaseId
      - text: Add review set {name} to eDiscovery case {case}.
        slots:
          name: requestBody.displayName
          case: path.ediscoveryCaseId
      method: generated
      generated: '2026-10-01'