# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure MicrosoftScanningClient System Scan…
  version: 1.0.0
extends: openapi/microsoft-azure-systemscanrulesets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/systemScanRulesets'].get
  update:
    x-apievangelist-phrasing:
      intent: List all system scan rulesets
      effect: read
      questions:
      - Which built-in system scan rulesets does my Purview account have?
      - Can I see every system scan ruleset across all data source types?
      instructions:
      - text: List all system scan rulesets for my scanning account.
      - text: Show every built-in scan ruleset using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/systemScanRulesets/datasources/{dataSourceType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the system scan ruleset for a data source
      effect: read
      questions:
      - What classification rules does the system ruleset apply when scanning a given data source type?
      - How do I view the default scan ruleset for Azure SQL or blob storage sources?
      instructions:
      - text: Get the system scan ruleset for data source type {type}.
        slots:
          type: path.dataSourceType
      - text: Show the built-in ruleset Purview uses to scan {type} sources.
        slots:
          type: path.dataSourceType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/systemScanRulesets/versions/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a system scan ruleset by version
      effect: read
      questions:
      - How do I retrieve an older version of a system scan ruleset?
      - Can I pin a scan to a specific numbered ruleset version for a data source?
      instructions:
      - text: Get system scan ruleset version {version}.
        slots:
          version: path.version
      - text: Show ruleset version {version} for data source type {type}.
        slots:
          version: path.version
          type: query.dataSourceType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/systemScanRulesets/versions/latest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest system scan ruleset version
      effect: read
      questions:
      - What is the newest system scan ruleset available?
      - Has the latest built-in ruleset for my data source type changed?
      instructions:
      - text: Fetch the newest version of the built-in ruleset, filtered to {type}.
        slots:
          type: query.dataSourceType
      - text: Show the most recent built-in ruleset version for {type} sources.
        slots:
          type: query.dataSourceType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/systemScanRulesets/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List system scan ruleset versions
      effect: read
      questions:
      - Which versions of the system scan ruleset exist in my Data catalog?
      - Can I list the version history of rulesets for one data source type?
      instructions:
      - text: List system scan ruleset versions for data source type {type}.
        slots:
          type: query.dataSourceType
      - text: Show the version history of built-in rulesets in the Data catalog.
      method: generated
      generated: '2026-09-26'