Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Billing Management Forecast Billing API

4 actions 4 updates phrasing extends openapi/conga-forecast-billing-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['/forecast'].post
$.paths['/forecast/regenerate-forecast-summary'].post
$.paths['/forecast/{businessObjectType}/{businessObjectId}'].get

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 Billing Management Forecast Billing API
  version: 1.0.0
extends: openapi/conga-forecast-billing-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['/forecast'].post
  update:
    x-apievangelist-phrasing:
      intent: Create billing forecast data
      effect: write
      questions:
      - How do I generate a billing forecast?
      - Can I create forecast data from a specific transaction source?
      instructions:
      - text: Create forecast data from source {source}.
        slots:
          source: requestBody.TransactionSource
      - text: Generate billing forecasts for requests {requests}.
        slots:
          requests: requestBody.ForecastBillingRequests
      method: generated
      generated: '2026-10-01'
- target: $.paths['/forecast/regenerate-forecast-summary'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a forecast summary
      effect: write
      questions:
      - Can I rebuild the forecast summary after changes?
      - How do I refresh summarized billing forecasts?
      instructions:
      - text: Regenerate the forecast summary for {requests}.
        slots:
          requests: requestBody.ForecastBillingSummaryRequests
      - text: Rebuild the billing forecast summary using criterion {criterion}.
        slots:
          criterion: requestBody.SummaryCriterion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/forecast/{businessObjectType}/{businessObjectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get forecast data for a business object
      effect: read
      questions:
      - What billing is forecast for a specific order or agreement?
      - Can I see the forecast for one business object?
      instructions:
      - text: Get the forecast for {type} {id}.
        slots:
          type: path.businessObjectType
          id: path.businessObjectId
      - text: Show billing forecast data of {type} record {id}.
        slots:
          type: path.businessObjectType
          id: path.businessObjectId
      method: generated
      generated: '2026-10-01'