# 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 Scanning Classification Rules API
  version: 1.0.0
extends: openapi/microsoft-purview-classification-rules-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: 4
- target: $.paths['/scan/classificationrules/{classificationRuleName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a classification rule
      effect: read
      questions:
      - How is a specific custom classification rule configured?
      - Can I see the kind and properties of one classification rule by name?
      instructions:
      - text: Show me classification rule {rule}.
        slots:
          rule: path.classificationRuleName
      - text: Get the definition of the {rule} classification rule.
        slots:
          rule: path.classificationRuleName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/classificationrules/{classificationRuleName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a classification rule
      effect: write
      questions:
      - How do I define a custom classification rule for scanning?
      - Can I overwrite an existing classification rule with a new definition?
      instructions:
      - text: Create classification rule {rule} of kind {kind}.
        slots:
          rule: path.classificationRuleName
          kind: requestBody.kind
      - text: Replace classification rule {rule} with properties {props}.
        slots:
          rule: path.classificationRuleName
          props: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/classificationrules/{classificationRuleName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a classification rule
      effect: destructive
      questions:
      - Can I remove a custom classification rule I no longer want applied?
      - What is the way to drop a classification rule from my account?
      instructions:
      - text: Delete classification rule {rule}.
        slots:
          rule: path.classificationRuleName
      - text: Remove the {rule} classification rule from the account.
        slots:
          rule: path.classificationRuleName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/classificationrules'].get
  update:
    x-apievangelist-phrasing:
      intent: List classification rules
      effect: read
      questions:
      - Which classification rules are defined in my Purview account?
      - What custom classifications does our scanner know about?
      instructions:
      - text: List all classification rules in the account.
      - text: List classification rules using API version {version}.
        slots:
          version: query.api-version
      method: generated
      generated: '2026-10-01'