Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Field Mark API

3 actions 3 updates phrasing extends openapi/conga-fieldmark-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 3

$.info
$.paths['/api/xauthor/v1/fields/mark-content'].post
$.paths['/api/xauthor/v1/fields/mark-content/2'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for X-Author Field Mark API
  version: 1.0.0
extends: openapi/conga-fieldmark-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: 2
- target: $.paths['/api/xauthor/v1/fields/mark-content'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark document content as a field
      effect: write
      questions:
      - How do I tag text in a contract document as a field?
      - Can I mark content as a picklist field with its values?
      instructions:
      - text: Mark content as field {field} on {type} record {id}.
        slots:
          field: requestBody.field
          type: requestBody.objectType
          id: requestBody.objectId
      - text: Mark the extracted value {value} as field {field}.
        slots:
          value: requestBody.extractedValue
          field: requestBody.field
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/fields/mark-content/2'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark text as a field (v2 metadata)
      effect: write
      questions:
      - Is there a newer way to mark selected text as a field using document metadata?
      - Can I mark text with field metadata in the second version of the endpoint?
      instructions:
      - text: Mark text {text} as a field using metadata {meta}.
        slots:
          text: requestBody.markedText
          meta: requestBody.fieldMetadata
      - text: Use the v2 marker to tag {text} in document {doc}.
        slots:
          text: requestBody.markedText
          doc: requestBody.documentMetadata
      method: generated
      generated: '2026-10-01'