# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gainsight CS Custom Object Custom Objects API
  version: 1.0.0
extends: openapi/gainsight-custom-objects-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: 5
- target: $.paths['/data/objects/{objectName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update custom object records
      effect: write
      questions:
      - How do I update existing rows in a custom object matched on key fields?
      - What is the per-call record limit when updating a custom object?
      instructions:
      - text: 'Update records in custom object {objectName} matched on {keys}: {records}.'
        slots:
          objectName: path.objectName
          keys: query.keys
          records: requestBody.records
      - text: Edit these rows {records} in {objectName}, matching on {keys}.
        slots:
          records: requestBody.records
          objectName: path.objectName
          keys: query.keys
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/objects/{objectName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Insert custom object records
      effect: write
      questions:
      - Can I add new rows to one of my custom objects?
      - How many custom object records can I insert per call?
      instructions:
      - text: 'Insert these records into custom object {objectName}: {records}.'
        slots:
          objectName: path.objectName
          records: requestBody.records
      - text: Add a batch of new rows {records} to {objectName}.
        slots:
          records: requestBody.records
          objectName: path.objectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/objects/{objectName}/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search custom object records
      effect: read
      questions:
      - Which rows in a custom object match my filter?
      - Can I query a custom object with ordering and up to 5000 results?
      instructions:
      - text: Search custom object {objectName} where {where}.
        slots:
          objectName: path.objectName
          where: requestBody.where
      - text: Find records in {objectName} matching {where}, ordered by {orderBy}.
        slots:
          objectName: path.objectName
          where: requestBody.where
          orderBy: requestBody.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/objects/{objectName}/{recordId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom object record
      effect: read
      questions:
      - How do I read one record from a custom object by ID?
      - Can I fetch a single custom object row by its record ID?
      instructions:
      - text: Get record {recordId} from custom object {objectName}.
        slots:
          recordId: path.recordId
          objectName: path.objectName
      - text: Show row {recordId} in {objectName}.
        slots:
          recordId: path.recordId
          objectName: path.objectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/objects/{objectName}/{recordId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object record
      effect: destructive
      questions:
      - Can I delete one row from a custom object?
      - How is a custom object record removed by ID?
      instructions:
      - text: Delete record {recordId} from custom object {objectName}.
        slots:
          recordId: path.recordId
          objectName: path.objectName
      - text: Remove row {recordId} in {objectName}.
        slots:
          recordId: path.recordId
          objectName: path.objectName
      method: generated
      generated: '2026-09-26'