# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Search API
  version: 1.0.0
extends: openapi/salesforce-search-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: 3
- target: $.paths['/data/v64.0/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a SOSL search across objects
      effect: read
      questions:
      - How do I search for a name across Accounts, Contacts and Leads at once?
      - Does a SOSL search string need to be URL-encoded?
      instructions:
      - text: Run the SOSL search {sosl}.
        slots:
          sosl: query.q
      - text: Search all objects with the SOSL clause {sosl}.
        slots:
          sosl: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/parameterizedSearch'].get
  update:
    x-apievangelist-phrasing:
      intent: Search records with simple parameters
      effect: read
      questions:
      - Can I search Salesforce without writing a SOSL clause?
      - What's the simplest way to do a keyword search over records?
      instructions:
      - text: Do a parameterized search for {term}.
        slots:
          term: query.q
      - text: Find records matching the keyword {term} without SOSL.
        slots:
          term: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Tooling API metadata with SOSL
      effect: read
      questions:
      - Can I search Apex classes and other metadata by keyword?
      - Which Tooling API resource runs a SOSL search over code?
      instructions:
      - text: Search Tooling API metadata with {sosl}.
        slots:
          sosl: query.q
      - text: Run a Tooling SOSL search {sosl} across Apex and metadata.
        slots:
          sosl: query.q
      method: generated
      generated: '2026-09-26'