# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Field API
  version: 1.0.0
extends: openapi/salesforce-field-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/ui-api/object-info/{SOBJECT_API_NAME}/picklist-values/{RECORD_TYPE_ID}/{FIELD_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get picklist values for a field
      effect: read
      questions:
      - What values can a picklist field take for a given record type?
      - How do I get the allowed Stage values for Opportunity picklists?
      instructions:
      - text: Get picklist values of {field} on {sobject} for record type {record_type_id}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
          record_type_id: path.RECORD_TYPE_ID
      - text: List allowed values for picklist {field} in record type {record_type_id} of {sobject}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
          record_type_id: path.RECORD_TYPE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/lookups/{SOBJECT_API_NAME}/{FIELD_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lookup field suggestions
      effect: read
      questions:
      - How do I show suggestions when a user types into a lookup field?
      - Can lookup suggestions return recently used matches?
      instructions:
      - text: Get lookup suggestions for field {field} on {sobject}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
      - text: Suggest matching records for the {field} lookup of {sobject}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/lookups/{SOBJECT_API_NAME}/{FIELD_API_NAME}/{TARGET_API_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lookup suggestions for one target object
      effect: read
      questions:
      - For a polymorphic lookup, how do I get suggestions from just one target object?
      - Can I restrict lookup suggestions on the Owner field to users only?
      instructions:
      - text: Get {field} lookup suggestions on {sobject} limited to target {target}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
          target: path.TARGET_API_NAME
      - text: Suggest {target} records for lookup {field} on {sobject}.
        slots:
          field: path.FIELD_API_NAME
          sobject: path.SOBJECT_API_NAME
          target: path.TARGET_API_NAME
      method: generated
      generated: '2026-09-26'