Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conversion Management Currency Admin API

8 actions 8 updates phrasing extends openapi/conga-currency-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/currency-management/v1/currency-rates'].get

$.paths['/api/currency-management/v1/currency-rates'].post

$.paths['/api/currency-management/v1/currency-rates/bulk'].put

$.paths['/api/currency-management/v1/currency-rates/bulk'].post

$.paths['/api/currency-management/v1/currency-rates/{id}'].get

$.paths['/api/currency-management/v1/currency-rates/{id}'].put

$.paths['/api/currency-management/v1/currency-rates/{id}'].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 Conversion Management Currency Admin API
  version: 1.0.0
extends: openapi/conga-currency-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/currency-management/v1/currency-rates'].get
  update:
    x-apievangelist-phrasing:
      intent: List currency rates
      effect: read
      questions:
      - Which currency conversion rates are configured?
      - Can I filter currency rates and sort them by a field?
      instructions:
      - text: List all currency rates.
      - text: Show currency rates matching {criteria}.
        slots:
          criteria: query.criteria
      - text: Get currency rates sorted by {field}.
        slots:
          field: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/currency-management/v1/currency-rates'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a currency rate
      effect: write
      questions:
      - How do I add a new exchange rate between two currencies?
      - Can I set an effective date range on a new currency rate?
      instructions:
      - text: Add a rate of {rate} from {source} to {target}.
        slots:
          rate: requestBody.ConversionRate
          source: requestBody.SourceCurrency
          target: requestBody.TargetCurrency
      - text: Create a {source} to {target} rate effective from {start}.
        slots:
          source: requestBody.SourceCurrency
          target: requestBody.TargetCurrency
          start: requestBody.EffectiveStartDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/currency-management/v1/currency-rates/bulk'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many currency rates
      effect: write
      questions:
      - Can I update a batch of currency rates at once?
      - Is there a bulk update for exchange rates?
      instructions:
      - text: Bulk-update these currency rates.
      - text: Apply new values to several currency rates together.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/currency-management/v1/currency-rates/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many currency rates
      effect: write
      questions:
      - How do I load a whole set of new exchange rates in one call?
      - Can I create multiple currency rates together?
      instructions:
      - text: Bulk-create these currency rates.
      - text: Add a batch of new exchange rates.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/currency-management/v1/currency-rates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a currency rate
      effect: read
      questions:
      - What is the stored conversion rate for a particular rate record?
      - How do I look up one currency rate by ID?
      instructions:
      - text: Get currency rate {rate}.
        slots:
          rate: path.id
      - text: Show the details of exchange rate record {rate}.
        slots:
          rate: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/currency-management/v1/currency-rates/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a currency rate
      effect: write
      questions:
      - Can I correct a single exchange rate?
      - Can I change one currency rate record by its ID?
      instructions:
      - text: Update currency rate {rate}.
        slots:
          rate: path.id
      - text: Change the values on exchange rate record {rate}.
        slots:
          rate: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/currency-management/v1/currency-rates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a currency rate
      effect: destructive
      questions:
      - How do I delete an exchange rate I no longer use?
      - Is deleting a currency rate record permanent?
      instructions:
      - text: Delete currency rate {rate}.
        slots:
          rate: path.id
      - text: Remove exchange rate record {rate}.
        slots:
          rate: path.id
      method: generated
      generated: '2026-10-01'