Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Ramps API

5 actions 5 updates phrasing extends openapi/conga-ramps-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 5

$.info
$.paths['/api/cart/v1/carts/{cartId}/items/ramps'].put
$.paths['/api/cart/v1/carts/{cartId}/items/ramps'].post
$.paths['/api/cart/v1/carts/{cartId}/items/ramps'].delete
$.paths['/api/cart/v1/carts/{cartId}/items/ramps'].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 Cart - V1 Ramps API
  version: 1.0.0
extends: openapi/conga-ramps-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: 4
- target: $.paths['/api/cart/v1/carts/{cartId}/items/ramps'].put
  update:
    x-apievangelist-phrasing:
      intent: Add ramp lines to already ramped items
      effect: write
      questions:
      - How do I add more ramp periods to a cart line item that is already ramped?
      - Can I extend an existing ramp schedule with additional ramp lines?
      instructions:
      - text: Add ramp lines to the already ramped items in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Extend the existing ramp schedule with new ramp lines in cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/ramps'].post
  update:
    x-apievangelist-phrasing:
      intent: Ramp cart line items
      effect: write
      questions:
      - How do I set up a ramp for a line item in a Conga cart for the first time?
      - Can I ramp several cart line items at once?
      instructions:
      - text: Create ramp lines for these line items in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Turn the selected line items in cart {cartId} into ramped items.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/ramps'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete ramp lines from a cart
      effect: destructive
      questions:
      - What's the way to remove ramp lines from a cart?
      - Can I delete a ramp I added to a cart line item?
      instructions:
      - text: Delete the ramp lines in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Remove these ramp line items from cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/ramps'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update existing ramp lines
      effect: write
      questions:
      - Where do I change the details of ramp lines already in a cart?
      - Can I edit an existing ramp line without recreating it?
      instructions:
      - text: Update the existing ramp lines in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Edit these ramp lines in cart {cartId} with the new values.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'