# 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 Data Quality Data Quality Rules API
  version: 1.0.0
extends: openapi/microsoft-purview-data-quality-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: 5
- target: $.paths['/dataquality/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List data quality rules
      effect: read
      questions:
      - What data quality rules are configured in our Purview account?
      - Can I page through data quality rules with a page size?
      instructions:
      - text: List all data quality rules.
      - text: Show data quality rules {size} per page.
        slots:
          size: query.maxpagesize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dataquality/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data quality rule
      effect: write
      questions:
      - How do I add a rule that checks data assets for quality problems?
      - Can I set the severity and dimension of a new data quality rule?
      instructions:
      - text: Create a data quality rule named {name} with expression {expression}.
        slots:
          name: requestBody.name
          expression: requestBody.expression
      - text: Add data quality rule {name} for dimension {dimension} at severity {severity}.
        slots:
          name: requestBody.name
          dimension: requestBody.dimension
          severity: requestBody.severity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dataquality/rules/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data quality rule
      effect: read
      questions:
      - What expression and targets does a particular data quality rule use?
      - Is a specific data quality rule currently enabled?
      instructions:
      - text: Show me data quality rule {rule}.
        slots:
          rule: path.ruleId
      - text: Get the expression and target assets of rule {rule}.
        slots:
          rule: path.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dataquality/rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data quality rule
      effect: destructive
      questions:
      - Can I delete a data quality rule that no longer applies?
      - What is the way to remove a data quality check permanently?
      instructions:
      - text: Delete data quality rule {rule}.
        slots:
          rule: path.ruleId
      - text: Remove quality rule {rule}.
        slots:
          rule: path.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dataquality/rules/{ruleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a data quality rule
      effect: write
      questions:
      - How do I switch off an existing data quality rule without deleting it?
      - Can I change the expression on a data quality rule I already created?
      instructions:
      - text: Disable data quality rule {rule} by setting enabled to {enabled}.
        slots:
          rule: path.ruleId
          enabled: requestBody.isEnabled
      - text: Change the expression of existing rule {rule} to {expression}.
        slots:
          rule: path.ruleId
          expression: requestBody.expression
      method: generated
      generated: '2026-10-01'