Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure SearchServiceClient Indexers API

9 actions 9 updates phrasing extends openapi/microsoft-azure-indexers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/indexers(\'{indexerName}\')/search.reset'].post
$.paths['/indexers(\'{indexerName}\')/search.run'].post
$.paths['/indexers(\'{indexerName}\')'].get
$.paths['/indexers(\'{indexerName}\')'].put
$.paths['/indexers(\'{indexerName}\')'].delete
$.paths['/indexers'].get
$.paths['/indexers'].post
$.paths['/indexers(\'{indexerName}\')/search.status'].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 Azure SearchServiceClient Indexers API
  version: 1.0.0
extends: openapi/microsoft-azure-indexers-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: 8
- target: $.paths['/indexers(\'{indexerName}\')/search.reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset an indexer's change tracking
      effect: write
      questions:
      - How do I make a search indexer reprocess all documents from scratch?
      - Can I clear an indexer's change tracking state so it does a full reindex?
      instructions:
      - text: Reset indexer {indexer}.
        slots:
          indexer: path.indexerName
      - text: Clear the change tracking state of indexer {indexer} so the next run is a full crawl.
        slots:
          indexer: path.indexerName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/indexers(\'{indexerName}\')/search.run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an indexer on demand
      effect: write
      questions:
      - Can I trigger a search indexer right now instead of waiting for its schedule?
      - How do I kick off an indexer run manually?
      instructions:
      - text: Run indexer {indexer} now.
        slots:
          indexer: path.indexerName
      - text: Trigger an on-demand run of indexer {indexer}.
        slots:
          indexer: path.indexerName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/indexers(\'{indexerName}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an indexer definition
      effect: read
      questions:
      - How is a particular search indexer configured, such as its data source and target index?
      - Can I read the field mappings and schedule of an existing indexer?
      instructions:
      - text: Get the definition of indexer {indexer}.
        slots:
          indexer: path.indexerName
      - text: Show the data source, target index and schedule of indexer {indexer}.
        slots:
          indexer: path.indexerName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/indexers(\'{indexerName}\')'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a named indexer
      effect: write
      questions:
      - How do I update an existing indexer's schedule or field mappings?
      - Can I only overwrite an indexer if its ETag still matches?
      instructions:
      - text: Create or update indexer {indexer} reading from {data_source} into index {target_index}.
        slots:
          indexer: path.indexerName
          data_source: requestBody.dataSourceName
          target_index: requestBody.targetIndexName
      - text: Change the schedule of existing indexer {indexer} to {schedule}.
        slots:
          indexer: path.indexerName
          schedule: requestBody.schedule
      - text: Disable indexer {indexer} by setting disabled to {disabled}.
        slots:
          indexer: path.indexerName
          disabled: requestBody.disabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/indexers(\'{indexerName}\')'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an indexer
      effect: destructive
      questions:
      - How do I remove a search indexer I no longer need?
      - Does deleting an indexer support an If-Match condition?
      instructions:
      - text: Delete indexer {indexer}.
        slots:
          indexer: path.indexerName
      - text: Delete indexer {indexer} only if its ETag is {etag}.
        slots:
          indexer: path.indexerName
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/indexers'].get
  update:
    x-apievangelist-phrasing:
      intent: List indexers on a search service
      effect: read
      questions:
      - Which indexers are defined on my search service?
      - Can I list indexers but return only a few properties like name?
      instructions:
      - text: List all indexers on my search service.
      - text: List indexers returning only {fields}.
        slots:
          fields: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/indexers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new indexer
      effect: write
      questions:
      - How do I set up a new indexer that pulls a data source into a search index?
      - Can I attach a skillset when creating a new indexer?
      instructions:
      - text: Create a new indexer {name} that loads {data_source} into index {target_index}.
        slots:
          name: requestBody.name
          data_source: requestBody.dataSourceName
          target_index: requestBody.targetIndexName
      - text: Add indexer {name} using skillset {skillset} to enrich {data_source} into {target_index}.
        slots:
          name: requestBody.name
          skillset: requestBody.skillsetName
          data_source: requestBody.dataSourceName
          target_index: requestBody.targetIndexName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/indexers(\'{indexerName}\')/search.status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an indexer's status and run history
      effect: read
      questions:
      - Did my indexer's last run succeed, and how many documents failed?
      - Where can I see the execution history of a search indexer?
      instructions:
      - text: Get the status of indexer {indexer}.
        slots:
          indexer: path.indexerName
      - text: Show the execution history and errors for indexer {indexer}.
        slots:
          indexer: path.indexerName
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-indexers-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.