Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Lock API

3 actions 3 updates phrasing extends openapi/conga-lock-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 3

$.info
$.paths['/api/cart/v1/carts/{cartId}/lock'].post
$.paths['/api/cart/v1/carts/{cartId}/unlock'].delete

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 Lock API
  version: 1.0.0
extends: openapi/conga-lock-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: 2
- target: $.paths['/api/cart/v1/carts/{cartId}/lock'].post
  update:
    x-apievangelist-phrasing:
      intent: Lock a cart for editing
      effect: write
      questions:
      - How do I get edit access to a shared cart?
      - Can I queue for a cart lock if someone else holds it?
      instructions:
      - text: Lock cart {cart} for editing.
        slots:
          cart: path.cartId
      - text: Request edit access to cart {cart} and wait in the queue.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/unlock'].delete
  update:
    x-apievangelist-phrasing:
      intent: Release a cart lock
      effect: destructive
      questions:
      - How do I release my edit lock on a cart?
      - Can I unlock a cart so others can edit it?
      instructions:
      - text: Unlock cart {cart}.
        slots:
          cart: path.cartId
      - text: Release the edit lock on cart {cart}.
        slots:
          cart: path.cartId
      method: generated
      generated: '2026-10-01'