Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Audit Field History Tracking API

2 actions 2 updates phrasing extends openapi/conga-field-history-tracking-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/api/audit/v1/objects/{objectName}/records/{recordId}/field-history-tracking'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Audit Field History Tracking API
  version: 1.0.0
extends: openapi/conga-field-history-tracking-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/api/audit/v1/objects/{objectName}/records/{recordId}/field-history-tracking'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a record's field change history
      effect: read
      questions:
      - Who changed fields on a record and when?
      - Can I limit a record's audit history to a date range?
      instructions:
      - text: Show the field history of {object} record {record}.
        slots:
          object: path.objectName
          record: path.recordId
      - text: Get changes to {object} record {record} made by {user} since {start}.
        slots:
          object: path.objectName
          record: path.recordId
          user: query.modifiedByName
          start: query.startDate
      method: generated
      generated: '2026-10-01'