Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Billing Management Milestone Schedule API

8 actions 8 updates phrasing extends openapi/conga-milestone-schedule-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 8

$.info
$.paths['/milestone/complete'].put
$.paths['/milestone/header'].post
$.paths['/milestone/header/{billingHeaderId}'].post
$.paths['/milestone/order-line-item'].post
$.paths['/milestone/order-line-item/{orderLineItemId}'].post
$.paths['/milestone/schedule-record'].post
$.paths['/milestone/schedule-record/{scheduleRecordId}'].post

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 Milestone Schedule API
  version: 1.0.0
extends: openapi/conga-milestone-schedule-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: 7
- target: $.paths['/milestone/complete'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark milestone billing details complete
      effect: write
      questions:
      - How do I mark a billing milestone as complete?
      - Can I complete several milestone schedule details at once?
      instructions:
      - text: Mark the selected milestone billing details complete.
      - text: Complete these billing milestones.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/milestone/header'].post
  update:
    x-apievangelist-phrasing:
      intent: Get milestone details for several billing headers
      effect: read
      questions:
      - Can I get milestone billing details for many billing headers at once?
      - How do I list milestone schedules across headers?
      instructions:
      - text: Get milestone billing details for several billing headers.
      - text: Show milestone schedules across these headers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/milestone/header/{billingHeaderId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get milestone details for one billing header
      effect: read
      questions:
      - Which milestones are due on a single billing header?
      - Can I limit one header's milestones to an expected date range?
      instructions:
      - text: Get milestone billing details for header {header}.
        slots:
          header: path.billingHeaderId
      - text: Show milestones on header {header} expected from {from} to {to}.
        slots:
          header: path.billingHeaderId
          from: requestBody.MilestoneExpectedFromDate
          to: requestBody.MilestoneExpectedToDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/milestone/order-line-item'].post
  update:
    x-apievangelist-phrasing:
      intent: Get milestone details for several order line items
      effect: read
      questions:
      - Can I see milestone billing for multiple order line items?
      - How do I pull milestone schedules for a set of order lines?
      instructions:
      - text: Get milestone billing details for several order line items.
      - text: Show milestone schedules for these order lines.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/milestone/order-line-item/{orderLineItemId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get milestone details for one order line item
      effect: read
      questions:
      - What billing milestones exist for one order line?
      - Can I filter one order line's milestones by expected date?
      instructions:
      - text: Get milestone billing details for order line item {line}.
        slots:
          line: path.orderLineItemId
      - text: Show milestones on order line {line} expected after {from}.
        slots:
          line: path.orderLineItemId
          from: requestBody.MilestoneExpectedFromDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/milestone/schedule-record'].post
  update:
    x-apievangelist-phrasing:
      intent: Get milestone schedules by several record IDs
      effect: read
      questions:
      - Can I look up milestone-type schedules for several schedule records?
      - How do I fetch milestone schedules by a list of record IDs?
      instructions:
      - text: Get milestone-type schedule details for several schedule records.
      - text: Look up milestone schedules for these record IDs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/milestone/schedule-record/{scheduleRecordId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get milestone schedule by a record ID
      effect: read
      questions:
      - What milestone schedule details does one schedule record have?
      - Can I filter a single schedule record's milestones by date?
      instructions:
      - text: Get milestone schedule details for record {record}.
        slots:
          record: path.scheduleRecordId
      - text: Show milestones of schedule record {record} expected before {to}.
        slots:
          record: path.scheduleRecordId
          to: requestBody.MilestoneExpectedToDate
      method: generated
      generated: '2026-10-01'