Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2. Order Actions API

3 actions 3 updates phrasing extends openapi/conga-2-order-actions-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 3

$.info
$.paths['/orders/{Id}/accept-change'].post
$.paths['/orders/{Id}/revert-change'].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 2. Order Actions API
  version: 1.0.0
extends: openapi/conga-2-order-actions-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: 2
- target: $.paths['/orders/{Id}/accept-change'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept the changes on an amended order
      effect: destructive
      questions:
      - How do I finalize the amendments I made to an order?
      - Are accepted order changes permanent once applied?
      instructions:
      - text: Accept the changes on change order {Id}.
        slots:
          Id: path.Id
      - text: Finalize and apply the amendment for order {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{Id}/revert-change'].post
  update:
    x-apievangelist-phrasing:
      intent: Discard the changes on an amended order
      effect: destructive
      questions:
      - Can I throw away an order amendment and go back to the original order?
      - What happens to my pending order modifications if I revert them?
      instructions:
      - text: Revert the pending changes on change order {Id}.
        slots:
          Id: path.Id
      - text: Discard the amendment and restore order {Id} to how it was.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'