Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog Data Ingestion Product Metadata API

4 actions 4 updates phrasing extends openapi/adobe-suite-productmetadata-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/metadata'].post

$.paths['/v1/catalog/products/metadata'].patch

$.paths['/v1/catalog/products/metadata/delete'].post

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 Catalog Data Ingestion Product Metadata API
  version: 1.0.0
extends: openapi/adobe-suite-productmetadata-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/metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Create product attribute metadata
      effect: write
      questions:
      - What product attribute metadata do I have to define before loading products into the Commerce catalog?
      - Where do I set the data type and visibility for each product attribute?
      instructions:
      - text: Create attribute metadata for sku, name, description, shortDescription and price.
      - text: Create or replace the product attribute metadata I provide for each locale.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/products/metadata'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update existing product attribute metadata
      effect: write
      questions:
      - How do I change metadata for a product attribute that already exists?
      - Are array fields merged or replaced when I update attribute metadata?
      instructions:
      - text: Update the existing attribute metadata with the changes I give you.
      - text: Patch the metadata for the price attribute with my new settings.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/products/metadata/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete product attribute metadata
      effect: destructive
      questions:
      - How do I remove product attribute metadata from the catalog?
      - Can I delete metadata for a custom attribute I no longer use?
      instructions:
      - text: Delete the attribute metadata for the codes I list.
      - text: Remove product attribute metadata for my custom attribute.
      method: generated
      generated: '2026-09-26'