Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Summary Groups API

5 actions 5 updates phrasing extends openapi/conga-summarygroups-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}/summarygroups'].get
$.paths['/api/cart/v1/carts/{cartId}/summarygroups'].put
$.paths['/api/cart/v1/carts/{cartId}/summarygroups'].post
$.paths['/api/cart/v1/carts/{cartId}/summarygroups/adhoc'].put

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 Summary Groups API
  version: 1.0.0
extends: openapi/conga-summarygroups-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}/summarygroups'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cart's summary groups
      effect: read
      questions:
      - What summary groups and subtotals does a cart have?
      - Can I see how a quote cart's lines roll up into summary groups?
      instructions:
      - text: Get the summary groups for cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show cart {cartId}'s summary group totals.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/summarygroups'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a cart's summary groups
      effect: write
      questions:
      - How do I apply adjustments to a cart's summary groups?
      - Can I change summary group values after the user adjusts them?
      instructions:
      - text: Update the summary groups in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Save my summary group adjustments for cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/summarygroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Add summary groups to a cart
      effect: write
      questions:
      - Can I add new summary group records to a cart?
      - Can I add summary groups to reconfigure an existing cart?
      instructions:
      - text: Add summary groups to cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Create summary group records for cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/summarygroups/adhoc'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a cart's ad hoc summary groups
      effect: write
      questions:
      - How do I save changes to ad hoc summary groups in a cart?
      - Can I update a single field on the ad hoc summary groups?
      instructions:
      - text: Update the ad hoc summary groups in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Change field {fieldName} on cart {cartId}'s ad hoc summary groups.
        slots:
          fieldName: requestBody.fieldName
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'