Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Scanning Scan Rulesets API

5 actions 5 updates phrasing extends openapi/microsoft-purview-scan-rulesets-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 5

$.info
$.paths['/scan/scanrulesets/{scanRulesetName}'].get
$.paths['/scan/scanrulesets/{scanRulesetName}'].put
$.paths['/scan/scanrulesets/{scanRulesetName}'].delete
$.paths['/scan/scanrulesets'].get

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 Scanning Scan Rulesets API
  version: 1.0.0
extends: openapi/microsoft-purview-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['/scan/scanrulesets/{scanRulesetName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan rule set
      effect: read
      questions:
      - Which file types and classifications does a scan rule set include?
      - Can I see one scan rule set by name?
      instructions:
      - text: Show me scan rule set {ruleset}.
        slots:
          ruleset: path.scanRulesetName
      - text: Get the definition of scan ruleset {ruleset}.
        slots:
          ruleset: path.scanRulesetName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/scanrulesets/{scanRulesetName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a scan rule set
      effect: write
      questions:
      - How do I create a custom scan rule set?
      - Can I overwrite an existing scan rule set's properties?
      instructions:
      - text: Create scan rule set {ruleset} of kind {kind}.
        slots:
          ruleset: path.scanRulesetName
          kind: requestBody.kind
      - text: Replace scan ruleset {ruleset} with properties {props}.
        slots:
          ruleset: path.scanRulesetName
          props: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/scanrulesets/{scanRulesetName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan rule set
      effect: destructive
      questions:
      - Can I delete a custom scan rule set?
      - What is the way to remove an unused scan ruleset?
      instructions:
      - text: Delete scan rule set {ruleset}.
        slots:
          ruleset: path.scanRulesetName
      - text: Remove the {ruleset} scan ruleset.
        slots:
          ruleset: path.scanRulesetName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/scanrulesets'].get
  update:
    x-apievangelist-phrasing:
      intent: List scan rule sets
      effect: read
      questions:
      - Which scan rule sets are available in my account?
      - What custom rule sets can my scans use?
      instructions:
      - text: List all scan rule sets.
      - text: List scan rulesets using API version {version}.
        slots:
          version: query.api-version
      method: generated
      generated: '2026-10-01'