Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Log API

3 actions 3 updates phrasing extends openapi/conga-log-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/logs'].post

$.paths['/api/xauthor/v1/logs/customMetrics'].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 X-Author Log API
  version: 1.0.0
extends: openapi/conga-log-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/logs'].post
  update:
    x-apievangelist-phrasing:
      intent: Log application exceptions
      effect: write
      questions:
      - How do I report X-Author application errors?
      - Can I log exceptions for a user and organization?
      instructions:
      - text: Log exceptions {logs} for user {user}.
        slots:
          logs: requestBody.exceptionlogs
          user: requestBody.userName
      - text: 'Record these application errors: {logs}.'
        slots:
          logs: requestBody.exceptionlogs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/logs/customMetrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Log custom metrics
      effect: write
      questions:
      - Can I record custom usage metrics for an X-Author user?
      - How do I log metrics tagged with the add-in version?
      instructions:
      - text: Log custom metrics for X-Author version {version}.
        slots:
          version: requestBody.xaVersion
      - text: Record custom usage metrics for org type {org}.
        slots:
          org: header.OrgType
      method: generated
      generated: '2026-10-01'