Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conversion Management Frequency Conversion Runtime API

4 actions 4 updates phrasing extends openapi/conga-frequency-conversion-runtime-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/conversion-management/v1/query/frequency-conversion'].post
$.paths['/api/conversion-management/v1/query/frequency-conversion-rates'].post
$.paths['/api/conversion-management/v1/query/frequency-conversion-rates/bulk'].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 Conversion Management Frequency Conversion Runtime API
  version: 1.0.0
extends: openapi/conga-frequency-conversion-runtime-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/conversion-management/v1/query/frequency-conversion'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a value between frequencies
      effect: read
      questions:
      - What is a monthly amount worth when converted to yearly?
      - Can I convert a value using a product's own rate?
      instructions:
      - text: Convert {value} from {from} to {to}.
        slots:
          value: requestBody.Value
          from: requestBody.FromFrequency
          to: requestBody.ToFrequency
      - text: Convert {value} from {from} to {to} for product {product}.
        slots:
          value: requestBody.Value
          from: requestBody.FromFrequency
          to: requestBody.ToFrequency
          product: requestBody.ProductId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/query/frequency-conversion-rates'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up the effective conversion rate
      effect: read
      questions:
      - Which conversion rate applies between two frequencies right now?
      - Is there a product-specific effective rate?
      instructions:
      - text: Get the effective rate from {from} to {to}.
        slots:
          from: requestBody.FromFrequency
          to: requestBody.ToFrequency
      - text: Find the effective {from}-to-{to} rate for product family {family}.
        slots:
          from: requestBody.FromFrequency
          to: requestBody.ToFrequency
          family: requestBody.ProductFamily
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/query/frequency-conversion-rates/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up effective conversion rates in bulk
      effect: read
      questions:
      - Can I look up many effective conversion rates at once?
      - How do I fetch effective rates for several frequency pairs?
      instructions:
      - text: Look up effective conversion rates for several frequency pairs.
      - text: Fetch a batch of effective frequency rates.
      method: generated
      generated: '2026-10-01'