Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Cart Analyzers API

7 actions 7 updates phrasing extends openapi/conga-cart-analyzers-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 7

$.info

$.paths['/api/cart/v1/carts/{cartId}/applicable-attribute-rules'].get

$.paths['/api/cart/v1/carts/{cartId}/applicable-field-expression'].get

$.paths['/api/cart/v1/carts/{cartId}/applicable-rules'].get

$.paths['/api/cart/v1/carts/{cartId}/applied-attribute-rules'].get

$.paths['/api/cart/v1/carts/{cartId}/applied-field-expression'].get

$.paths['/api/cart/v1/carts/{cartId}/applied-rules'].get

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 Analyzers API
  version: 1.0.0
extends: openapi/conga-cart-analyzers-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: 6
- target: $.paths['/api/cart/v1/carts/{cartId}/applicable-attribute-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List attribute rules that could apply to a cart
      effect: read
      questions:
      - Which product attribute rules are applicable to my cart's line items?
      - Can I see the attribute rules that are eligible for a cart before they fire?
      instructions:
      - text: List applicable product attribute rules for cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show applicable attribute rules for line item {lineItemId} in cart {cartId}.
        slots:
          lineItemId: query.lineItemId
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/applicable-field-expression'].get
  update:
    x-apievangelist-phrasing:
      intent: List field expressions that could apply to a cart
      effect: read
      questions:
      - What field expressions are applicable to a given cart?
      - Can I check which field expressions are eligible for one primary line number?
      instructions:
      - text: List applicable field expressions for cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show applicable field expressions on primary line {primaryLineNumber} of cart {cartId}.
        slots:
          primaryLineNumber: query.primaryLineNumber
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/applicable-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List constraint rules that could apply to a cart
      effect: read
      questions:
      - Which rules are applicable to my cart overall, not just attribute rules?
      - How do I page through every rule eligible to run on a cart?
      instructions:
      - text: List all applicable rules for cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show page {pageNumber} of applicable rules for cart {cartId}, {pageSize} per page.
        slots:
          pageNumber: query.pageNumber
          cartId: path.cartId
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/applied-attribute-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List attribute rules already applied to a cart
      effect: read
      questions:
      - Which product attribute rules were actually applied to my cart?
      - Can I see the attribute rules that already fired on a specific line item?
      instructions:
      - text: List product attribute rules applied to cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show attribute rules applied to line item {lineItemId} in cart {cartId}.
        slots:
          lineItemId: query.lineItemId
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/applied-field-expression'].get
  update:
    x-apievangelist-phrasing:
      intent: List field expressions already applied to a cart
      effect: read
      questions:
      - Which field expressions have been applied to my cart so far?
      - Can I see the applied field expressions for one primary line number?
      instructions:
      - text: List field expressions applied to cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show applied field expressions on primary line {primaryLineNumber} of cart {cartId}.
        slots:
          primaryLineNumber: query.primaryLineNumber
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/applied-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List rules already applied to a cart
      effect: read
      questions:
      - What rules have already been applied to a cart in total?
      - How can I filter the full list of rules that ran on my cart?
      instructions:
      - text: List every rule applied to cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show applied rules on cart {cartId} matching {filter}.
        slots:
          cartId: path.cartId
          filter: query.filter
      method: generated
      generated: '2026-10-01'