Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Price Escalator API

8 actions 8 updates phrasing extends openapi/conga-priceescalator-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['/price-list-items/{ParentId}/price-escalators'].get
$.paths['/price-list-items/{ParentId}/price-escalators'].post
$.paths['/price-list-items/{ParentId}/price-escalators'].delete
$.paths['/price-list-items/{ParentId}/price-escalators'].patch
$.paths['/price-list-items/{ParentId}/price-escalators/{Id}'].get
$.paths['/price-list-items/{ParentId}/price-escalators/{Id}'].delete
$.paths['/price-list-items/{ParentId}/price-escalators/{Id}'].patch

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 Administration Price Escalator API
  version: 1.0.0
extends: openapi/conga-priceescalator-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['/price-list-items/{ParentId}/price-escalators'].get
  update:
    x-apievangelist-phrasing:
      intent: List the price escalators on a price list item
      effect: read
      questions:
      - How do I see the price escalators set up for a price list item?
      - Can I filter or sort the escalators attached to one price list item?
      - Which price escalators apply to a given Conga price list item?
      instructions:
      - text: List all price escalators on price list item {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show escalators for price list item {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      - text: Get the first {limit} price escalators of price list item {ParentId}, sorted by {sort}.
        slots:
          limit: query.limit
          ParentId: path.ParentId
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/price-escalators'].post
  update:
    x-apievangelist-phrasing:
      intent: Add price escalators to a price list item
      effect: write
      questions:
      - What's the way to add several price escalators to a price list item at once?
      - Is the parent price list item filled in automatically when I create escalators?
      instructions:
      - text: Create a batch of new price escalators on price list item {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add new escalators to price list item {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/price-escalators'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several price escalators from a price list item
      effect: destructive
      questions:
      - How can I bulk remove many price escalators from a price list item?
      - Can I delete multiple escalators in one request instead of one at a time?
      instructions:
      - text: Bulk delete several price escalators from price list item {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove a set of escalators from price list item {ParentId} in one call.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/price-escalators'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several price escalators on a price list item
      effect: write
      questions:
      - Can I edit many price escalators on a price list item in one bulk update?
      - Is it possible to move escalators to a different price list item during a bulk update?
      instructions:
      - text: Bulk update several price escalators on price list item {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply changes to multiple escalators of price list item {ParentId} together.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/price-escalators/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one price escalator
      effect: read
      questions:
      - How do I look up a single price escalator by its ID?
      - What details are stored on one specific escalator of a price list item?
      instructions:
      - text: Get price escalator {Id} from price list item {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show the details of escalator {Id} on price list item {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/price-escalators/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one price escalator
      effect: destructive
      questions:
      - How do I delete just one price escalator from a price list item?
      - Can I remove a single escalator by its ID without touching the others?
      instructions:
      - text: Delete price escalator {Id} from price list item {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove only escalator {Id} on price list item {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/price-escalators/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one price escalator
      effect: write
      questions:
      - What do I call to change a single price escalator?
      - Can I edit one specific escalator on a price list item by its ID?
      instructions:
      - text: Update price escalator {Id} on price list item {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit just escalator {Id} of price list item {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'