# 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 Scan Rulesets API
  version: 1.0.0
extends: openapi/microsoft-azure-scan-rulesets-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['/scanrulesets/{scanRulesetName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan rule set
      effect: read
      questions:
      - How do I view the settings of one Purview scan rule set?
      - Which file types and classifications does a given scan rule set include?
      instructions:
      - text: Show scan rule set {name}.
        slots:
          name: path.scanRulesetName
      - text: Get the definition of scan rule set {name}.
        slots:
          name: path.scanRulesetName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanrulesets/{scanRulesetName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a scan rule set
      effect: write
      questions:
      - How do I create a custom scan rule set for a data source type?
      - Can I change the status of an existing scan rule set?
      instructions:
      - text: Create scan rule set {name} for data source kind {kind}.
        slots:
          name: path.scanRulesetName
          kind: requestBody.kind
      - text: Set the status of scan rule set {name} to {status}.
        slots:
          name: path.scanRulesetName
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanrulesets/{scanRulesetName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan rule set
      effect: destructive
      questions:
      - How do I remove a custom scan rule set I no longer use?
      - Can I delete a scan rule set from the data catalog?
      instructions:
      - text: Delete scan rule set {name}.
        slots:
          name: path.scanRulesetName
      - text: Remove the custom scan rule set {name}.
        slots:
          name: path.scanRulesetName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanrulesets'].get
  update:
    x-apievangelist-phrasing:
      intent: List scan rule sets
      effect: read
      questions:
      - What scan rule sets are defined in my data catalog?
      - Which custom rule sets can I pick from when setting up a scan?
      instructions:
      - text: List all scan rule sets.
      - text: Show every scan rule set in the catalog using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-10-01'