Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Ad Hoc Groups API

8 actions 8 updates phrasing extends openapi/conga-adhocgroups-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}/adhoc-groups'].get
$.paths['/api/cart/v1/carts/{cartId}/adhoc-groups'].post
$.paths['/api/cart/v1/carts/{cartId}/adhoc-groups'].delete
$.paths['/api/cart/v1/carts/{cartId}/adhoc-groups'].patch
$.paths['/api/cart/v1/carts/{cartId}/adhoc-groups/{adhocGroupId}'].get
$.paths['/api/cart/v1/carts/{cartId}/adhoc-groups/{adhocGroupId}'].delete
$.paths['/api/cart/v1/carts/{cartId}/adhoc-groups/{adhocGroupId}'].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 Ad Hoc Groups API
  version: 1.0.0
extends: openapi/conga-adhocgroups-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}/adhoc-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List a cart's ad hoc groups
      effect: read
      questions:
      - Which ad hoc groups have been set up in a quote cart?
      - Can I filter and page through the ad hoc groups on a cart?
      instructions:
      - text: List the ad hoc groups in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show ad hoc groups in cart {cartId} matching {filter}, page {page}.
        slots:
          cartId: path.cartId
          filter: query.filter
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adhoc-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create ad hoc groups in a cart
      effect: write
      questions:
      - How do I group cart line items into custom ad hoc groups?
      - Will creating ad hoc groups fail if a name or sequence is duplicated in the cart?
      instructions:
      - text: Create these ad hoc groups in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Add new ad hoc line item groups to cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adhoc-groups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several ad hoc groups from a cart
      effect: destructive
      questions:
      - Can I remove a batch of ad hoc groups from a cart at once?
      - How do I clear out multiple ad hoc groupings in a quote cart?
      instructions:
      - text: Delete this list of ad hoc groups from cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Remove several ad hoc groups at once in cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adhoc-groups'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several ad hoc groups in a cart
      effect: write
      questions:
      - How do I rename or resequence multiple ad hoc groups together?
      - Can I bulk-edit the ad hoc groups on a cart?
      instructions:
      - text: Update this collection of ad hoc groups in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Bulk-edit the ad hoc groups on cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adhoc-groups/{adhocGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one ad hoc group in a cart
      effect: read
      questions:
      - What does a specific ad hoc group in my cart contain?
      - Can I include related records when fetching a single ad hoc group?
      instructions:
      - text: Get ad hoc group {adhocGroupId} in cart {cartId}.
        slots:
          adhocGroupId: path.adhocGroupId
          cartId: path.cartId
      - text: Show ad hoc group {adhocGroupId} from cart {cartId} including {includes}.
        slots:
          adhocGroupId: path.adhocGroupId
          cartId: path.cartId
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adhoc-groups/{adhocGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one ad hoc group from a cart
      effect: destructive
      questions:
      - How do I remove a single ad hoc group I no longer need?
      - Can I delete just one ad hoc group by its ID?
      instructions:
      - text: Delete ad hoc group {adhocGroupId} from cart {cartId}.
        slots:
          adhocGroupId: path.adhocGroupId
          cartId: path.cartId
      - text: Remove only ad hoc group {adhocGroupId} in cart {cartId}.
        slots:
          adhocGroupId: path.adhocGroupId
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/adhoc-groups/{adhocGroupId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one ad hoc group in a cart
      effect: write
      questions:
      - How do I change the name or sequence of one ad hoc group?
      - Can I edit a single ad hoc group without touching the others?
      instructions:
      - text: Update ad hoc group {adhocGroupId} in cart {cartId}.
        slots:
          adhocGroupId: path.adhocGroupId
          cartId: path.cartId
      - text: Edit just ad hoc group {adhocGroupId} on cart {cartId}.
        slots:
          adhocGroupId: path.adhocGroupId
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'