Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Commerce Customer REST endpoints - All inclusive Guest…

3 actions 3 updates phrasing extends openapi/adobe-suite-guest-carts-cartid-gift-message-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/V1/guest-carts/{cartId}/gift-message'].get
$.paths['/V1/guest-carts/{cartId}/gift-message'].post

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 Commerce Customer REST endpoints - All inclusive Guest…
  version: 1.0.0
extends: openapi/adobe-suite-guest-carts-cartid-gift-message-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/V1/guest-carts/{cartId}/gift-message'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the gift message on a guest cart
      effect: read
      questions:
      - What gift message has a guest shopper added to their order?
      - Can I read the order-level gift message from a guest cart?
      instructions:
      - text: Show the gift message on guest cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Read the gift note for guest cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/V1/guest-carts/{cartId}/gift-message'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the gift message on a guest cart
      effect: write
      questions:
      - How do I add a gift message to a guest checkout order?
      - Can a guest set one gift message for the whole order?
      instructions:
      - text: Set the gift message on guest cart {cartId} to {giftMessage}.
        slots:
          cartId: path.cartId
          giftMessage: requestBody.giftMessage
      - text: Add gift note {giftMessage} to the whole order in guest cart {cartId}.
        slots:
          cartId: path.cartId
          giftMessage: requestBody.giftMessage
      method: generated
      generated: '2026-09-26'