Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Billing Management Product Configurations API

5 actions 5 updates phrasing extends openapi/conga-product-configurations-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 5

$.info
$.paths['/product-configurations'].get
$.paths['/product-configurations'].post
$.paths['/product-configurations'].patch
$.paths['/product-configurations/{productConfigurationId}'].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 Product Configurations API
  version: 1.0.0
extends: openapi/conga-product-configurations-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: 4
- target: $.paths['/product-configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List product billing configurations
      effect: read
      questions:
      - How do I see the billing configuration records linked to my products?
      - Can I filter or sort product billing configurations in Conga Billing?
      - Which products already have a billing configuration record?
      instructions:
      - text: List all product billing configuration records.
      - text: Show product billing configurations matching {filter}.
        slots:
          filter: query.filter
      - text: Get page {page} of product billing configurations, {limit} per page, returning only {fields}.
        slots:
          page: query.page
          limit: query.limit
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-configurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create product billing configurations
      effect: write
      questions:
      - What's the way to link billing configuration settings to several products at once?
      - Can I create multiple product billing configuration records in one request?
      instructions:
      - text: Create a batch of new product billing configuration records.
      - text: Set up billing configurations for several products in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-configurations'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several product billing configurations
      effect: write
      questions:
      - Can I change billing settings on many product configurations in one bulk update?
      - Does a bulk update of product billing configurations return the updated IDs?
      instructions:
      - text: Bulk update several product billing configuration records.
      - text: Apply billing configuration changes to multiple products at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-configurations/{productConfigurationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product billing configuration
      effect: read
      questions:
      - How do I look up a single product billing configuration by its ID?
      - Can I include related records when fetching one product configuration?
      instructions:
      - text: Get product billing configuration {productConfigurationId}.
        slots:
          productConfigurationId: path.productConfigurationId
      - text: Show product configuration {productConfigurationId} including {includes}.
        slots:
          productConfigurationId: path.productConfigurationId
          includes: query.includes
      method: generated
      generated: '2026-10-01'