Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Carts API

8 actions 8 updates phrasing extends openapi/conga-carts-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'].get

$.paths['/api/cart/v1/carts'].post

$.paths['/api/cart/v1/carts'].delete

$.paths['/api/cart/v1/carts'].patch

$.paths['/api/cart/v1/carts/{Id}'].get

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

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

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 Carts API
  version: 1.0.0
extends: openapi/conga-carts-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List carts
      effect: read
      questions:
      - Which shopping carts exist in Conga CPQ right now?
      - Can I filter and page through all carts?
      - How do I list carts sorted a particular way?
      instructions:
      - text: List all carts.
      - text: Show carts matching {filter}, {limit} per page.
        slots:
          filter: query.filter
          limit: query.limit
      - text: List carts sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create carts in bulk
      effect: write
      questions:
      - Can I create several carts at once from a list?
      - What's the way to open multiple new quoting carts in a single request?
      instructions:
      - text: Create these carts from the list in one request.
      - text: Open a batch of new carts with the details I give you.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete carts in bulk
      effect: destructive
      questions:
      - Is there a way to delete many carts at once?
      - Can I remove a submitted list of carts in one call?
      instructions:
      - text: Delete every cart in this list.
      - text: Bulk-remove the carts I listed.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update carts in bulk
      effect: write
      questions:
      - Can I update multiple carts together?
      - Which request edits a list of carts in one go?
      instructions:
      - text: Bulk-update these carts with the changes in the list.
      - text: Apply the new details to all the carts I listed.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one cart
      effect: read
      questions:
      - What's in a specific cart when I know its ID?
      - Can I include related records when fetching a single cart?
      instructions:
      - text: Show cart {cart_id}.
        slots:
          cart_id: path.Id
      - text: Fetch cart {cart_id} including {includes}.
        slots:
          cart_id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one cart
      effect: destructive
      questions:
      - How do I delete a single cart by its identifier?
      - Does removing one cart by ID affect any other carts?
      instructions:
      - text: Delete cart {cart_id}.
        slots:
          cart_id: path.Id
      - text: Remove only the cart with ID {cart_id}.
        slots:
          cart_id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one cart
      effect: write
      questions:
      - Can I change fields on one particular cart by ID?
      - Which call edits a single cart rather than a list of carts?
      instructions:
      - text: Update cart {cart_id} with these changes.
        slots:
          cart_id: path.Id
      - text: Edit just cart {cart_id}.
        slots:
          cart_id: path.Id
      method: generated
      generated: '2026-10-01'