Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog Data Ingestion Price Books API

4 actions 4 updates phrasing extends openapi/adobe-suite-price-books-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 4

$.info
$.paths['/v1/catalog/price-books'].post
$.paths['/v1/catalog/price-books'].patch
$.paths['/v1/catalog/price-books/delete'].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 Catalog Data Ingestion Price Books API
  version: 1.0.0
extends: openapi/adobe-suite-price-books-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: 3
- target: $.paths['/v1/catalog/price-books'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or replace price books
      effect: write
      questions:
      - How do I set up a base price book with its currency for my Commerce catalog?
      - Can I create child price books that inherit from a base price book?
      instructions:
      - text: Create a base price book with the ID, name and currency I give you.
      - text: Create child price books under my base price book to build a pricing hierarchy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/price-books'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update existing price books
      effect: write
      questions:
      - How do I rename a price book that already exists?
      - Can I change the currency on a child price book, or only on the base one?
      instructions:
      - text: Rename my existing price books to the new names I provide.
      - text: Change the currency of my base price book, updating its whole hierarchy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/price-books/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete price books and their pricing
      effect: destructive
      questions:
      - What happens to child price books when I delete their parent?
      - How do I remove price books and all the prices attached to them?
      instructions:
      - text: Delete the price books I list, along with their child books and prices.
      - text: Remove my unused price books from the catalog.
      method: generated
      generated: '2026-09-26'