# 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 Synonym Maps API
  version: 1.0.0
extends: openapi/microsoft-azure-synonymmaps-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['/synonymmaps(\'{synonymMapName}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a search synonym map
      effect: read
      questions:
      - How do I view the synonym rules in one of my search service's synonym maps?
      - What synonyms are defined in a named synonym map?
      instructions:
      - text: Get synonym map {synonymMapName}.
        slots:
          synonymMapName: path.synonymMapName
      - text: Show the rules in synonym map {synonymMapName}.
        slots:
          synonymMapName: path.synonymMapName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/synonymmaps(\'{synonymMapName}\')'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a named synonym map
      effect: write
      questions:
      - How do I update the synonym rules of an existing synonym map in place?
      - Can I upsert a synonym map by name only if its ETag hasn't changed?
      instructions:
      - text: Upsert synonym map {synonymMapName} with {format} rules {synonyms}, name {name}, returning {Prefer}.
        slots:
          synonymMapName: path.synonymMapName
          format: requestBody.format
          synonyms: requestBody.synonyms
          name: requestBody.name
          Prefer: header.Prefer
      - text: Replace the rules in synonym map {synonymMapName} only if its ETag is {If-Match}.
        slots:
          synonymMapName: path.synonymMapName
          If-Match: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/synonymmaps(\'{synonymMapName}\')'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a synonym map
      effect: destructive
      questions:
      - How do I delete a synonym map from my search service?
      - Can I make the delete conditional on the synonym map's current ETag?
      instructions:
      - text: Delete synonym map {synonymMapName}.
        slots:
          synonymMapName: path.synonymMapName
      - text: Remove synonym map {synonymMapName} only if its ETag matches {If-Match}.
        slots:
          synonymMapName: path.synonymMapName
          If-Match: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/synonymmaps'].get
  update:
    x-apievangelist-phrasing:
      intent: List synonym maps on a search service
      effect: read
      questions:
      - Which synonym maps exist on my search service?
      - Can I return only certain properties, like names, when listing synonym maps?
      instructions:
      - text: List all synonym maps on the search service.
      - text: List synonym maps returning only {select}.
        slots:
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/synonymmaps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new synonym map
      effect: write
      questions:
      - How do I add a brand-new synonym map so searches for one term match another?
      - What format do synonym rules need when I create a synonym map?
      instructions:
      - text: Create a new synonym map {name} in {format} format with rules {synonyms}.
        slots:
          name: requestBody.name
          format: requestBody.format
          synonyms: requestBody.synonyms
      - text: Add synonym map {name} using solr rules {synonyms} and format {format}, encrypted with {encryptionKey}.
        slots:
          name: requestBody.name
          synonyms: requestBody.synonyms
          format: requestBody.format
          encryptionKey: requestBody.encryptionKey
      method: generated
      generated: '2026-09-26'