# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce UI Records API
  version: 1.0.0
extends: openapi/salesforce-records-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: 4
- target: $.paths['/records/{recordId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a record with its field values
      effect: read
      questions:
      - What are the field values on a given record?
      - Can I return only certain fields or the compact layout for a record?
      instructions:
      - text: Get record {recordId}.
        slots:
          recordId: path.recordId
      - text: Get record {recordId} with fields {fields}.
        slots:
          recordId: path.recordId
          fields: query.fields
      - text: Show record {recordId} using the {layoutTypes} layout.
        slots:
          recordId: path.recordId
          layoutTypes: query.layoutTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/records/{recordId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a record
      effect: destructive
      questions:
      - How do I delete a record by its ID?
      - Can I remove a single record I no longer need?
      instructions:
      - text: Delete record {recordId}.
        slots:
          recordId: path.recordId
      - text: Remove the record with ID {recordId}.
        slots:
          recordId: path.recordId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/records/{recordId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on a record
      effect: write
      questions:
      - Can I change just a few fields on an existing record?
      - Is there a way to update a record only if it hasn't changed since I loaded it?
      instructions:
      - text: Update record {recordId} with {fields}.
        slots:
          recordId: path.recordId
          fields: requestBody.fields
      - text: Set fields {fields} on {apiName} record {recordId}.
        slots:
          fields: requestBody.fields
          apiName: requestBody.apiName
          recordId: path.recordId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/records'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new record
      effect: write
      questions:
      - What's needed to create a new record of a given object type?
      - Can I create a custom object record by passing its API name and fields?
      instructions:
      - text: Create a {apiName} record with {fields}.
        slots:
          apiName: requestBody.apiName
          fields: requestBody.fields
      - text: Add a new {apiName} with field values {fields}.
        slots:
          apiName: requestBody.apiName
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'