# 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 Data Sources API
  version: 1.0.0
extends: openapi/microsoft-azure-data-sources-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: 8
- target: $.paths['/datasources/{dataSourceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registered Purview data source
      effect: read
      questions:
      - How do I look up a data source registered in Microsoft Purview scanning?
      - What kind and scans does a registered Purview data source have?
      instructions:
      - text: Get Purview data source {dataSourceName}.
        slots:
          dataSourceName: path.dataSourceName
      - text: Show the registration details of scanning data source {dataSourceName}.
        slots:
          dataSourceName: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/datasources/{dataSourceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Register or update a Purview data source
      effect: write
      questions:
      - Can I register a new data source for Purview scanning?
      - Which kind must I specify when registering a data source in the data catalog?
      instructions:
      - text: Register Purview data source {dataSourceName} of kind {kind}.
        slots:
          dataSourceName: path.dataSourceName
          kind: requestBody.kind
      - text: Update the registered scanning source {dataSourceName} with scans {scans}.
        slots:
          dataSourceName: path.dataSourceName
          scans: requestBody.scans
      method: generated
      generated: '2026-10-01'
- target: $.paths['/datasources/{dataSourceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unregister a Purview data source
      effect: destructive
      questions:
      - How do I remove a data source from Purview scanning?
      - Does deleting a registered Purview source also drop its scans?
      instructions:
      - text: Delete Purview data source {dataSourceName}.
        slots:
          dataSourceName: path.dataSourceName
      - text: Unregister scanning source {dataSourceName} from the data catalog.
        slots:
          dataSourceName: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/datasources'].get
  update:
    x-apievangelist-phrasing:
      intent: List data sources registered in Purview
      effect: read
      questions:
      - Which data sources are registered in my Purview data catalog?
      - Can I see every scanning source the catalog knows about?
      instructions:
      - text: List all data sources registered in the Purview data catalog.
      - text: Show the Purview scanning sources using API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/datasources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a search indexer data source
      effect: write
      questions:
      - How do I create a data source for an Azure AI Search indexer?
      - What credentials and container does a new search datasource need?
      instructions:
      - text: Create search datasource {name} of type {type} pointing at container {container}.
        slots:
          name: requestBody.name
          type: requestBody.type
          container: requestBody.container
      - text: Add an indexer datasource {name} using connection credentials {credentials}.
        slots:
          name: requestBody.name
          credentials: requestBody.credentials
      method: generated
      generated: '2026-10-01'
- target: $.paths['/datasources(\'{dataSourceName}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a search indexer data source definition
      effect: read
      questions:
      - Can I retrieve the definition of an existing search indexer datasource?
      - What change detection policy is set on a search datasource?
      instructions:
      - text: Get the search datasource definition for {dataSourceName}.
        slots:
          dataSourceName: path.dataSourceName
      - text: Show indexer datasource {dataSourceName} and its connection container.
        slots:
          dataSourceName: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/datasources(\'{dataSourceName}\')'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a search indexer data source
      effect: write
      questions:
      - Can I overwrite an existing search indexer datasource only if its ETag matches?
      - How do I upsert a datasource definition used by a search indexer?
      instructions:
      - text: Create or update search datasource {dataSourceName} of type {type} on container {container}.
        slots:
          dataSourceName: path.dataSourceName
          type: requestBody.type
          container: requestBody.container
      - text: Replace indexer datasource {dataSourceName} only if ETag {ifMatch} still matches.
        slots:
          dataSourceName: path.dataSourceName
          ifMatch: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/datasources(\'{dataSourceName}\')'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a search indexer data source
      effect: destructive
      questions:
      - How do I delete a datasource used by a search indexer?
      - Can I make deleting a search datasource conditional on its ETag?
      instructions:
      - text: Delete search datasource {dataSourceName}.
        slots:
          dataSourceName: path.dataSourceName
      - text: Delete indexer datasource {dataSourceName} if its ETag is {ifMatch}.
        slots:
          dataSourceName: path.dataSourceName
          ifMatch: header.If-Match
      method: generated
      generated: '2026-10-01'