Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Billing Management Consumption Billing API

9 actions 9 updates phrasing extends openapi/conga-consumption-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 9

$.info
$.paths['/usage-inputs'].get
$.paths['/usage-inputs'].post
$.paths['/usage-inputs'].delete
$.paths['/usage-inputs'].patch
$.paths['/usage-inputs/estimate'].post
$.paths['/usage-inputs/rate'].post
$.paths['/usage-inputs/unrate'].post
$.paths['/usage-inputs/{usageInputId}'].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 Consumption Billing API
  version: 1.0.0
extends: openapi/conga-consumption-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: 8
- target: $.paths['/usage-inputs'].get
  update:
    x-apievangelist-phrasing:
      intent: List usage input records
      effect: read
      questions:
      - Where can I see all the usage inputs loaded for consumption billing?
      - Can I filter and sort usage input records or page through them?
      instructions:
      - text: List all usage input records.
      - text: Show usage inputs matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      - text: Get page {page} of usage inputs, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usage-inputs'].post
  update:
    x-apievangelist-phrasing:
      intent: Load usage input records
      effect: write
      questions:
      - How do I add usage records so Conga can bill customers for consumption?
      - Can I load many usage input records in one request?
      instructions:
      - text: Create these usage input records for billing.
      - text: Load a new batch of consumption usage inputs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usage-inputs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete usage input records
      effect: destructive
      questions:
      - How do I remove usage input records I loaded by mistake?
      - Can I bulk-delete consumption usage inputs?
      instructions:
      - text: Delete the usage input records in this request.
      - text: Bulk-remove these consumption usage inputs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usage-inputs'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update usage input records
      effect: write
      questions:
      - Can I correct fields on several usage inputs at once?
      - What does the bulk usage input update return?
      instructions:
      - text: Update these usage input records and return their IDs.
      - text: Apply corrections to multiple consumption usage inputs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usage-inputs/estimate'].post
  update:
    x-apievangelist-phrasing:
      intent: Estimate ratings for usage inputs
      effect: read
      questions:
      - Can I preview what usage inputs would be rated at without saving anything?
      - How do I get draft rating estimates for every loaded usage input asynchronously?
      instructions:
      - text: Estimate draft ratings for usage inputs {UsageInputIds}.
        slots:
          UsageInputIds: requestBody.UsageInputIds
      - text: Preview ratings across all loaded usage inputs with process-all set to {ProcessAllUsageInputs}.
        slots:
          ProcessAllUsageInputs: requestBody.ProcessAllUsageInputs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usage-inputs/rate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rate usage input records
      effect: write
      questions:
      - How do I rate usage inputs so they're ready to bill?
      - Can I rate all pending usage inputs in an asynchronous run?
      instructions:
      - text: Rate usage inputs {UsageInputIds} and save the results.
        slots:
          UsageInputIds: requestBody.UsageInputIds
      - text: Run rating on every usage input with process-all {ProcessAllUsageInputs}.
        slots:
          ProcessAllUsageInputs: requestBody.ProcessAllUsageInputs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usage-inputs/unrate'].post
  update:
    x-apievangelist-phrasing:
      intent: Reverse ratings on usage inputs
      effect: write
      questions:
      - How do I undo the rating on usage inputs that were rated incorrectly?
      - Can I unrate specific usage input records?
      instructions:
      - text: Unrate usage inputs {UsageInputIds}.
        slots:
          UsageInputIds: requestBody.UsageInputIds
      - text: Reverse the ratings applied to usage records {UsageInputIds}.
        slots:
          UsageInputIds: requestBody.UsageInputIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usage-inputs/{usageInputId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a usage input record
      effect: read
      questions:
      - How do I look up one usage input by its ID?
      - Can I see a single usage record with its related data included?
      instructions:
      - text: Show usage input {usageInputId}.
        slots:
          usageInputId: path.usageInputId
      - text: Get usage input {usageInputId} including {includes}.
        slots:
          usageInputId: path.usageInputId
          includes: query.includes
      method: generated
      generated: '2026-10-01'