Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog Data Ingestion Products API

4 actions 4 updates phrasing extends openapi/adobe-suite-products-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/products'].post
$.paths['/v1/catalog/products'].patch
$.paths['/v1/catalog/products/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 Products API
  version: 1.0.0
extends: openapi/adobe-suite-products-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/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or replace catalog products
      effect: write
      questions:
      - How do I load new products, including configurable ones, into the Commerce catalog service?
      - What fields does each product need, like SKU, name, slug and status?
      - Can I create many products in a single ingestion request?
      instructions:
      - text: Create these products in the catalog with their SKUs, names, slugs and statuses.
      - text: Upload this gzip-compressed product batch with Content-Encoding {Content-Encoding}.
        slots:
          Content-Encoding: header.Content-Encoding
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/products'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on existing catalog products
      effect: write
      questions:
      - Can I change just some attributes of products that are already in the catalog?
      - How are image and attribute lists merged when I update a product by SKU?
      instructions:
      - text: Update the price attribute on the existing products with these SKUs and source.
      - text: Patch existing catalog products from this compressed payload with Content-Encoding {Content-Encoding}.
        slots:
          Content-Encoding: header.Content-Encoding
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/products/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete catalog products by SKU
      effect: destructive
      questions:
      - How do I remove discontinued products from the catalog service?
      - Which values identify the products to delete?
      instructions:
      - text: Delete the products with these SKUs and source from the catalog.
      - text: Remove products listed in this compressed request, Content-Encoding {Content-Encoding}.
        slots:
          Content-Encoding: header.Content-Encoding
      method: generated
      generated: '2026-09-26'