Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Audit Field History Tracking Config API

4 actions 4 updates phrasing extends openapi/conga-field-history-tracking-config-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 4

$.info

$.paths['/api/audit/v1/field-history-tracking-config'].get

$.paths['/api/audit/v1/objects/{objectName}/field-history-tracking-config'].put

$.paths['/api/audit/v1/objects/{objectName}/field-history-tracking-config'].delete

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 Config API
  version: 1.0.0
extends: openapi/conga-field-history-tracking-config-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: 3
- target: $.paths['/api/audit/v1/field-history-tracking-config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get field history tracking configuration
      effect: read
      questions:
      - Which objects and fields are tracked for history?
      - What is the current field audit configuration?
      instructions:
      - text: Show the field history tracking configuration.
      - text: List the tracked objects and fields.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/audit/v1/objects/{objectName}/field-history-tracking-config'].put
  update:
    x-apievangelist-phrasing:
      intent: Track fields for history on an object
      effect: write
      questions:
      - How do I start tracking field changes on an object?
      - Can I add more fields to an object's history tracking?
      instructions:
      - text: Add fields of object {object} to history tracking.
        slots:
          object: path.objectName
      - text: Start tracking field changes on {object}.
        slots:
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/audit/v1/objects/{objectName}/field-history-tracking-config'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop tracking history on an object
      effect: destructive
      questions:
      - Can I turn off field history tracking for an object?
      - How do I remove an object from audit tracking?
      instructions:
      - text: Remove object {object} from field history tracking.
        slots:
          object: path.objectName
      - text: Stop auditing field changes on {object}.
        slots:
          object: path.objectName
      method: generated
      generated: '2026-10-01'