Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conversion Management Frequency Conversion Admin API

8 actions 8 updates phrasing extends openapi/conga-frequency-conversion-admin-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 8

$.info
$.paths['/api/conversion-management/v1/frequency-conversion-rates'].get
$.paths['/api/conversion-management/v1/frequency-conversion-rates'].post
$.paths['/api/conversion-management/v1/frequency-conversion-rates/bulk'].put
$.paths['/api/conversion-management/v1/frequency-conversion-rates/bulk'].post
$.paths['/api/conversion-management/v1/frequency-conversion-rates/{id}'].get
$.paths['/api/conversion-management/v1/frequency-conversion-rates/{id}'].put
$.paths['/api/conversion-management/v1/frequency-conversion-rates/{id}'].delete

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 Admin API
  version: 1.0.0
extends: openapi/conga-frequency-conversion-admin-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: 7
- target: $.paths['/api/conversion-management/v1/frequency-conversion-rates'].get
  update:
    x-apievangelist-phrasing:
      intent: List frequency conversion rates
      effect: read
      questions:
      - What frequency conversion rates are set up?
      - Can I filter conversion rates by criteria?
      instructions:
      - text: List all frequency conversion rates.
      - text: Show frequency conversion rates matching {criteria}.
        slots:
          criteria: query.criteria
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/frequency-conversion-rates'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a frequency conversion rate
      effect: write
      questions:
      - How do I define a rate to convert monthly to yearly?
      - Can a conversion rate apply to only one product family?
      instructions:
      - text: Add a conversion rate of {rate} from {from} to {to}.
        slots:
          rate: requestBody.ConversionRate
          from: requestBody.FromFrequency
          to: requestBody.ToFrequency
      - text: Create a {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/frequency-conversion-rates/bulk'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many frequency conversion rates
      effect: write
      questions:
      - Can I edit several conversion rates in one request?
      - How do I bulk-update frequency conversion rates?
      instructions:
      - text: Bulk update the selected frequency conversion rates.
      - text: Edit many conversion rates at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/frequency-conversion-rates/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many frequency conversion rates
      effect: write
      questions:
      - Can I create several frequency conversion rates in one call?
      - How do I bulk-add conversion rates?
      instructions:
      - text: Bulk add new frequency conversion rates.
      - text: Create a batch of conversion rates.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/frequency-conversion-rates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a frequency conversion rate
      effect: read
      questions:
      - Where do I see one frequency conversion rate?
      - What value does a specific conversion rate hold?
      instructions:
      - text: Get frequency conversion rate {id}.
        slots:
          id: path.id
      - text: Show conversion rate record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/frequency-conversion-rates/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a frequency conversion rate
      effect: write
      questions:
      - How do I change one conversion rate?
      - Can I edit a single frequency conversion rate by ID?
      instructions:
      - text: Update frequency conversion rate {id}.
        slots:
          id: path.id
      - text: Edit only conversion rate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/frequency-conversion-rates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a frequency conversion rate
      effect: destructive
      questions:
      - Can I delete a conversion rate we no longer use?
      - What happens when a frequency conversion rate is removed?
      instructions:
      - text: Delete frequency conversion rate {id}.
        slots:
          id: path.id
      - text: Remove conversion rate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'