API Evangelist conversational phrasing for Salesforce Data API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Data API
  version: 1.0.0
extends: openapi/salesforce-data-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: 15
- target: $.paths['/data/v64.0/jobs/ingest//batches'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a CSV file to a Bulk API 2.0 ingest job
      effect: write
      questions:
      - How do I send the CSV file for a Bulk API 2.0 ingest job?
      - Can I upload record data as a file to an ingest job batch?
      instructions:
      - text: Upload file {file} as the data for my ingest job.
        slots:
          file: requestBody.File
      - text: Send the CSV {file} to the ingest job batches endpoint.
        slots:
          file: requestBody.File
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/actions/custom/runExpressionSet/{expressionSetAPIName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an active expression set
      effect: read
      questions:
      - How do I invoke an expression set and get its output for my inputs?
      - Can I evaluate business rules defined in an expression set over REST?
      instructions:
      - text: Run expression set {expression_set} with inputs {inputs}.
        slots:
          expression_set: path.expressionSetAPIName
          inputs: requestBody.inputs
      - text: 'Evaluate the {expression_set} expression set for these inputs: {inputs}.'
        slots:
          expression_set: path.expressionSetAPIName
          inputs: requestBody.inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/actions/custom/runDecisionMatrix/{UniqueName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up an output from a decision matrix action
      effect: read
      questions:
      - How can I look up a value in a decision matrix from a flow action?
      - Can I check a candidate's eligibility by running a decision matrix with inputs?
      instructions:
      - text: Run decision matrix {matrix} as an invocable action with inputs {inputs}.
        slots:
          matrix: path.UniqueName
          inputs: requestBody.inputs
      - text: Invoke the runDecisionMatrix action for {matrix} using {inputs}.
        slots:
          matrix: path.UniqueName
          inputs: requestBody.inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}/describe/approvalLayouts/{APPROVAL_PROCESS_NAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object's approval layout
      effect: read
      questions:
      - Which fields show on the approval page for a given approval process?
      - Can I get the approval layout for one specific approval process on an object?
      instructions:
      - text: Get the approval layout for process {approval_process} on {sobject}.
        slots:
          approval_process: path.APPROVAL_PROCESS_NAME
          sobject: path.SOBJECT_API_NAME
      - text: Show approval layout fields of {approval_process} for object {sobject}.
        slots:
          approval_process: path.APPROVAL_PROCESS_NAME
          sobject: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}/describe/describe/compactLayouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List an object's compact layouts
      effect: read
      questions:
      - What compact layouts are defined for an object?
      - Which key fields show in the highlights panel for Account records?
      instructions:
      - text: List compact layouts for {sobject}.
        slots:
          sobject: path.SOBJECT_API_NAME
      - text: Get the compact layout definitions of the {sobject} object.
        slots:
          sobject: path.SOBJECT_API_NAME
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/PlatformAction'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the PlatformAction object
      effect: read
      questions:
      - What is the PlatformAction object and which UI actions does it expose?
      - How can I query buttons and quick actions shown for a user, context and device?
      instructions:
      - text: Get the PlatformAction sObject resource.
      - text: Show me the PlatformAction virtual object details.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/support/dataCategoryGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List data category groups for an object
      effect: read
      questions:
      - Which data category groups are available for knowledge articles?
      - Can I list data category groups for a specific sObject?
      instructions:
      - text: List the data category groups for {sobject_name}.
        slots:
          sobject_name: query.sObjectName
      - text: Get support data category groups tied to {sobject_name}.
        slots:
          sobject_name: query.sObjectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/support/dataCategoryGroups/{GROUP}/dataCategories/{CATEGORY}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data category and its children
      effect: read
      questions:
      - How do I see a data category's details and its child categories?
      - What child categories sit under a given category in a category group?
      instructions:
      - text: Get data category {category} in group {group} with its children.
        slots:
          category: path.CATEGORY
          group: path.GROUP
      - text: Show the child categories of {category} within {group}.
        slots:
          category: path.CATEGORY
          group: path.GROUP
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/support/knowledgeArticles/{ARTICLE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an online knowledge article's fields
      effect: read
      questions:
      - How do I read the full content of one published knowledge article?
      - Which fields of an online article can the current user access?
      instructions:
      - text: Get knowledge article {article_id}.
        slots:
          article_id: path.ARTICLE_ID
      - text: Show all accessible fields of online article {article_id}.
        slots:
          article_id: path.ARTICLE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/limits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check org limits and remaining allocations
      effect: read
      questions:
      - How many API requests do I have left today in my org?
      - What is the maximum and remaining allocation for each org limit?
      - Am I close to my data or file storage limit?
      instructions:
      - text: Show my org's limits with remaining allocation.
      - text: Check how much of the daily API request limit is used.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/appMenu'].get
  update:
    x-apievangelist-phrasing:
      intent: List items in the app menu
      effect: read
      questions:
      - Which apps appear in the Salesforce app drop-down menu?
      - What items are in the mobile navigation menu?
      instructions:
      - text: List the items in the app menu.
      - text: Show the mobile navigation menu entries.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/queryAll'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a SOQL query including deleted records
      effect: read
      questions:
      - How do I query records that were deleted or merged and sit in the Recycle Bin?
      - Can a SOQL query return archived Task and Event records?
      instructions:
      - text: Run SOQL {soql} including deleted and archived records.
        slots:
          soql: query.q
      - text: Query all rows, even deleted ones, with {soql}.
        slots:
          soql: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/actions/standard/createOrUpdateAssetFromOrder'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update assets from an order
      effect: write
      questions:
      - How do I turn order products into assets after an order is placed?
      - Can I update existing assets from an order instead of creating new ones?
      instructions:
      - text: Create or update assets from order inputs {inputs}.
        slots:
          inputs: requestBody.inputs
      - text: Generate assets for the order described in {inputs}.
        slots:
          inputs: requestBody.inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/executeAnonymous'].get
  update:
    x-apievangelist-phrasing:
      intent: Execute anonymous Apex code
      effect: write
      questions:
      - How do I run a snippet of Apex without deploying a class?
      - Can I execute anonymous Apex through the Tooling API?
      instructions:
      - text: 'Execute this anonymous Apex: {apex}.'
        slots:
          apex: query.anonymousBody
      - text: Run {apex} as anonymous Apex in my org.
        slots:
          apex: query.anonymousBody
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/record-ui/{RECORD_IDS}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get record data, layout and object metadata
      effect: read
      questions:
      - 'How do I get everything needed to render a record page: layout, metadata and data?'
      - Can I fetch record UI layout and data for several records together?
      instructions:
      - text: Get record UI data and layouts for {record_ids}.
        slots:
          record_ids: path.RECORD_IDS
      - text: Fetch layout, object info and field values to build UI for {record_ids}.
        slots:
          record_ids: path.RECORD_IDS
      method: generated
      generated: '2026-09-26'