Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conversion Management UOM Conversion Runtime API

4 actions 4 updates phrasing extends openapi/conga-uom-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/uom-conversion'].post

$.paths['/api/conversion-management/v1/query/uom-conversion-rates'].post

$.paths['/api/conversion-management/v1/query/uom-conversion-rates/bulk'].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 Conversion Management UOM Conversion Runtime API
  version: 1.0.0
extends: openapi/conga-uom-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/uom-conversion'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a quantity between units of measure
      effect: read
      questions:
      - How many Each is 12 Box for this product?
      - Can I convert an actual quantity from one unit of measure to another for a product?
      instructions:
      - text: Convert {Value} {FromUOM} to {ToUOM}.
        slots:
          Value: requestBody.Value
          FromUOM: requestBody.FromUOM
          ToUOM: requestBody.ToUOM
      - text: Convert a quantity of {Value} from {FromUOM} to {ToUOM} for product {ProductId}.
        slots:
          Value: requestBody.Value
          FromUOM: requestBody.FromUOM
          ToUOM: requestBody.ToUOM
          ProductId: requestBody.ProductId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/query/uom-conversion-rates'].post
  update:
    x-apievangelist-phrasing:
      intent: Find the effective rate between two units
      effect: read
      questions:
      - What conversion rate currently applies between two units for a given product?
      - Which rate is effective from Box to Each for a product family?
      instructions:
      - text: Get the effective conversion rate from {FromUOM} to {ToUOM}.
        slots:
          FromUOM: requestBody.FromUOM
          ToUOM: requestBody.ToUOM
      - text: Find the rate in effect from {FromUOM} to {ToUOM} for product family {ProductFamily}.
        slots:
          FromUOM: requestBody.FromUOM
          ToUOM: requestBody.ToUOM
          ProductFamily: requestBody.ProductFamily
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/query/uom-conversion-rates/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up effective rates for many unit pairs
      effect: read
      questions:
      - Can I get the effective conversion rates for many unit pairs in one request?
      - Is there a bulk lookup of effective UOM rates for many products at once?
      instructions:
      - text: Look up effective conversion rates for this list of unit pairs.
      - text: Get the rates in effect for every product and unit combination I send.
      method: generated
      generated: '2026-10-01'