Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Adjustments API

9 actions 9 updates phrasing extends openapi/conga-adjustments-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 9

$.info
$.paths['/api/cart/v1/carts/{cartId}/adjustments'].get
$.paths['/api/cart/v1/carts/{cartId}/adjustments'].post
$.paths['/api/cart/v1/carts/{cartId}/adjustments'].delete
$.paths['/api/cart/v1/carts/{cartId}/adjustments'].patch
$.paths['/api/cart/v1/carts/{cartId}/adjustments/{adjustmentId}'].get
$.paths['/api/cart/v1/carts/{cartId}/adjustments/{adjustmentId}'].delete
$.paths['/api/cart/v1/carts/{cartId}/adjustments/{adjustmentId}'].patch
$.paths['/api/cart/v1/carts/{cartId}/items/{lineItemId}/adjustments'].delete

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 Cart - V1 Adjustments API
  version: 1.0.0
extends: openapi/conga-adjustments-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: 8
- target: $.paths['/api/cart/v1/carts/{cartId}/adjustments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a cart's price adjustments
      effect: read
      questions:
      - What discounts and price adjustments are applied in a cart?
      - Can I filter and page through a cart's adjustments?
      instructions:
      - text: List the price adjustments in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show adjustments in cart {cartId} matching {filter}, page {pageNumber}.
        slots:
          cartId: path.cartId
          filter: query.filter
          pageNumber: query.pageNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adjustments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add price adjustments to a cart
      effect: write
      questions:
      - How do I add a discount adjustment to a quote cart?
      - Can I create several adjustments in one request?
      instructions:
      - text: Create these adjustments in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Add new price adjustments to cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adjustments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several adjustments from a cart
      effect: destructive
      questions:
      - Can I remove multiple adjustments from a cart in one call?
      - How do I strip a batch of discounts off a cart?
      instructions:
      - text: Delete these adjustments from cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Remove a batch of price adjustments from cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adjustments'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several adjustments in a cart
      effect: write
      questions:
      - Is there a way to edit many cart adjustments together?
      - Can I bulk-change the adjustment records on one cart?
      instructions:
      - text: Update these adjustment records in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Bulk-edit the adjustments on cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adjustments/{adjustmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one cart adjustment
      effect: read
      questions:
      - What are the details of a specific adjustment in my cart?
      - Can I look up one adjustment by its ID?
      instructions:
      - text: Get adjustment {adjustmentId} in cart {cartId}.
        slots:
          adjustmentId: path.adjustmentId
          cartId: path.cartId
      - text: Show the details of cart {cartId} adjustment {adjustmentId}.
        slots:
          cartId: path.cartId
          adjustmentId: path.adjustmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adjustments/{adjustmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one cart adjustment
      effect: destructive
      questions:
      - How do I remove a single discount adjustment from a cart?
      - Can I delete one adjustment record by ID?
      instructions:
      - text: Delete adjustment {adjustmentId} from cart {cartId}.
        slots:
          adjustmentId: path.adjustmentId
          cartId: path.cartId
      - text: Remove only adjustment {adjustmentId} in cart {cartId}.
        slots:
          adjustmentId: path.adjustmentId
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adjustments/{adjustmentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change one cart adjustment's amount or type
      effect: write
      questions:
      - How do I change the amount on one adjustment in a cart?
      - Can I switch an adjustment's type, say from percent off to amount off?
      instructions:
      - text: Set adjustment {adjustmentId} in cart {cartId} to amount {adjustmentAmount}.
        slots:
          adjustmentId: path.adjustmentId
          cartId: path.cartId
          adjustmentAmount: requestBody.adjustmentAmount
      - text: Change the type of adjustment {adjustmentId} on cart {cartId} to {adjustmentType}.
        slots:
          adjustmentId: path.adjustmentId
          cartId: path.cartId
          adjustmentType: requestBody.adjustmentType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{lineItemId}/adjustments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove adjustments from one line item
      effect: destructive
      questions:
      - How do I clear all discounts from a single line in the cart?
      - Can I delete adjustments for just one line item?
      instructions:
      - text: Delete adjustments on line item {lineItemId} in cart {cartId}.
        slots:
          lineItemId: path.lineItemId
          cartId: path.cartId
      - text: Clear the discounts from line {lineItemId} of cart {cartId}.
        slots:
          lineItemId: path.lineItemId
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'