# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Search Admin API
  version: 1.0.0
extends: openapi/conga-search-admin-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: 12
- target: $.paths['/api/search/v1/datasyncstatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get search data sync status for all objects
      effect: read
      questions:
      - Are the search index and database in sync for every object?
      - Which objects have a mismatch between Elasticsearch and the database?
      instructions:
      - text: Show the search sync status of all objects.
      - text: List every object's index-versus-database sync state.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/datasyncstatus/{trackingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a search sync job by tracking ID
      effect: read
      questions:
      - Has the data sync I started finished yet?
      - What's the status of a specific search resync job?
      instructions:
      - text: Check sync status for tracking ID {trackingId}.
        slots:
          trackingId: path.trackingId
      - text: Show progress of search sync {trackingId}.
        slots:
          trackingId: path.trackingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/document/index'].post
  update:
    x-apievangelist-phrasing:
      intent: Index a document for search
      effect: write
      questions:
      - How do I make a document searchable?
      - Can I index a particular version of a document?
      instructions:
      - text: Index document {DocumentId} for search.
        slots:
          DocumentId: requestBody.DocumentId
      - text: Index version {Version} of document {DocumentId}.
        slots:
          Version: requestBody.Version
          DocumentId: requestBody.DocumentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/global-search-data-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List field types allowed in global search
      effect: read
      questions:
      - Which field data types can be used in global search configuration?
      - What kinds of fields are supported for global search?
      instructions:
      - text: List the data types supported in global search.
      - text: Show field types I can add to global search.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/rbac-migrate'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate search RBAC settings
      effect: write
      questions:
      - How do I add missing RBAC fields to existing search settings?
      - Can I migrate search role-based access settings and update them in one step?
      instructions:
      - text: Migrate search RBAC settings.
      - text: Run the search RBAC migration with update setting {updateSearchSetting}.
        slots:
          updateSearchSetting: query.updateSearchSetting
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/resyncdata'].post
  update:
    x-apievangelist-phrasing:
      intent: Resync search data for all non-document objects
      effect: write
      questions:
      - Can I resync every object whose search count doesn't match the database?
      - Why aren't documents included in the bulk search resync?
      instructions:
      - text: Resync search data for all mismatched objects.
      - text: Start a full search resync, excluding documents.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/setting'].get
  update:
    x-apievangelist-phrasing:
      intent: List all objects' search settings
      effect: read
      questions:
      - What search settings are configured across objects?
      - Can I see every object's search configuration together?
      instructions:
      - text: List all search settings.
      - text: Show search configuration for every object.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/setting'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a search setting for an object
      effect: write
      questions:
      - How do I enable search on a new object?
      - Can I choose typeahead and priority fields when setting up search?
      instructions:
      - text: Create a search setting for {ObjectName}.
        slots:
          ObjectName: requestBody.ObjectName
      - text: Set up search on {ObjectName} with search fields {SearchFields}.
        slots:
          ObjectName: requestBody.ObjectName
          SearchFields: requestBody.SearchFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/setting/{objectName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an object's search setting
      effect: write
      questions:
      - Can I change which fields are searchable on an object?
      - How do I force-update an object's search setting?
      instructions:
      - text: Update the search setting for {objectName}.
        slots:
          objectName: path.objectName
      - text: Change {objectName}'s typeahead fields to {TypeAheadFields}.
        slots:
          objectName: path.objectName
          TypeAheadFields: requestBody.TypeAheadFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/setting/{objectName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object's search setting
      effect: destructive
      questions:
      - How do I remove search configuration from an object?
      - Can I delete the search setting for one object?
      instructions:
      - text: Delete the search setting for {objectName}.
        slots:
          objectName: path.objectName
      - text: Remove search config from object {objectName}.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/{objectName}/datasyncstatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one object's search sync status
      effect: read
      questions:
      - Is one object's search index in sync with the database?
      - Can I check index-versus-database counts for a single object?
      instructions:
      - text: Show search sync status of {objectName}.
        slots:
          objectName: path.objectName
      - text: Check whether {objectName}'s index matches the database.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/{objectName}/resyncdata'].post
  update:
    x-apievangelist-phrasing:
      intent: Resync search data for one object
      effect: write
      questions:
      - How do I resync search data for just one object?
      - Can I force a resync even if counts match?
      instructions:
      - text: Resync search data for {objectName}.
        slots:
          objectName: path.objectName
      - text: Resync {objectName} with force sync set to {forceToSyncData}.
        slots:
          objectName: path.objectName
          forceToSyncData: query.forceToSyncData
      method: generated
      generated: '2026-10-01'