Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Cart Items API

8 actions 8 updates phrasing extends openapi/conga-cart-items-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['/api/cart/v1/carts/{cartId}/items'].get

$.paths['/api/cart/v1/carts/{cartId}/items'].post

$.paths['/api/cart/v1/carts/{cartId}/items'].delete

$.paths['/api/cart/v1/carts/{cartId}/items'].patch

$.paths['/api/cart/v1/carts/{cartId}/items/clone'].post

$.paths['/api/cart/v1/carts/{cartId}/items/errors'].get

$.paths['/api/cart/v1/carts/{cartId}/reprice'].post

OpenAPI Overlay

# 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 Cart Items API
  version: 1.0.0
extends: openapi/conga-cart-items-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['/api/cart/v1/carts/{cartId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the line items in a cart
      effect: read
      questions:
      - What products and line items are in my cart right now?
      - Can I filter and group the line items of a cart?
      instructions:
      - text: List the line items in cart {cart}.
        slots:
          cart: path.cartId
      - text: Show {limit} line items of cart {cart} matching {filter}.
        slots:
          limit: query.limit
          cart: path.cartId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add products to a cart
      effect: write
      questions:
      - How do I add a bundle or standalone product to a cart?
      - Can I add items to a cart without pricing them yet?
      instructions:
      - text: Add these products to cart {cart}.
        slots:
          cart: path.cartId
      - text: 'Add items to cart {cart} and skip pricing: {skip}.'
        slots:
          cart: path.cartId
          skip: query.skipPricing
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove line items from a cart
      effect: destructive
      questions:
      - Can I take products back out of a cart?
      - Which line items can't be removed from a cart?
      instructions:
      - text: Remove the specified line items from cart {cart}.
        slots:
          cart: path.cartId
      - text: Delete products from cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update line items in a cart
      effect: write
      questions:
      - How do I change quantities or fields on several cart line items?
      - Can I update cart lines without re-running configuration?
      instructions:
      - text: Update the line items in cart {cart}.
        slots:
          cart: path.cartId
      - text: 'Edit cart {cart} lines and skip config: {skip}.'
        slots:
          cart: path.cartId
          skip: query.skipConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate line items within a cart
      effect: write
      questions:
      - Can I make an exact copy of a line item inside the same cart?
      - How do I duplicate bundle lines by primary line number?
      instructions:
      - text: Duplicate the given primary lines within cart {cart}.
        slots:
          cart: path.cartId
      - text: Clone these line items inside cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/errors'].get
  update:
    x-apievangelist-phrasing:
      intent: Get line item persistence errors for a cart
      effect: read
      questions:
      - Why did some of my cart line items fail to save?
      - Where can I see persistence errors for cart line items?
      instructions:
      - text: Show line item save errors for cart {cart}.
        slots:
          cart: path.cartId
      - text: Get persistence failures on cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/reprice'].post
  update:
    x-apievangelist-phrasing:
      intent: Reprice cart line items
      effect: write
      questions:
      - What do I call to reprice items after changing a cart?
      - Can I reprice only certain primary lines of a cart?
      instructions:
      - text: Reprice the line items in cart {cart}.
        slots:
          cart: path.cartId
      - text: Recalculate prices for selected lines of cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'