Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Billing Management Custom Plans API

4 actions 4 updates phrasing extends openapi/conga-custom-plans-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['/custom-plans'].delete
$.paths['/custom-plans/search'].post
$.paths['/custom-plans/{customPlanId}'].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 Custom Plans API
  version: 1.0.0
extends: openapi/conga-custom-plans-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['/custom-plans'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete custom plans
      effect: destructive
      questions:
      - Can I delete several custom billing plans along with their line items?
      - What happens to plan line items when a custom plan is deleted?
      instructions:
      - text: Delete these custom plans and their plan line items.
      - text: Bulk-remove the listed custom billing plans.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-plans/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search custom plans and their line items
      effect: read
      questions:
      - How do I find custom billing plans tied to an order or proposal?
      - Can I search custom plans by part of their name?
      instructions:
      - text: Find custom plans for order {order_id}.
        slots:
          order_id: requestBody.OrderId
      - text: Search custom plans whose name contains {name}.
        slots:
          name: requestBody.NameContaining
      - text: Show custom plans and line items for proposal {proposal_id}.
        slots:
          proposal_id: requestBody.ProposalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-plans/{customPlanId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom plan
      effect: read
      questions:
      - What are the details of one custom billing plan?
      - Can I include related data when fetching a single custom plan by ID?
      instructions:
      - text: Show custom plan {plan_id}.
        slots:
          plan_id: path.customPlanId
      - text: Get custom plan {plan_id} including {includes}.
        slots:
          plan_id: path.customPlanId
          includes: query.includes
      method: generated
      generated: '2026-10-01'