Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog Data Ingestion Categories API

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

$.paths['/v1/catalog/categories'].patch

$.paths['/v1/catalog/categories/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 Categories API
  version: 1.0.0
extends: openapi/adobe-suite-categories-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/categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create product catalog categories
      effect: write
      questions:
      - How do I create nested product categories like men/clothing/pants?
      - What makes a category slug valid when adding categories to the catalog?
      instructions:
      - text: Create the product categories I list, with their slugs and names.
      - text: Add a category hierarchy for men, clothing and pants to the catalog.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/categories'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update product catalog categories
      effect: write
      questions:
      - Can I change the display name of existing catalog categories?
      - What happens if I update a category that does not exist?
      instructions:
      - text: Update the catalog categories I list with the new values.
      - text: Rename existing product categories as I describe.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalog/categories/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete catalog categories and children
      effect: destructive
      questions:
      - Does deleting a category also remove its child categories?
      - Can I restore a product category I deleted by mistake?
      instructions:
      - text: Delete the catalog categories I list, including their children.
      - text: Remove the category branch I name from the product catalog.
      method: generated
      generated: '2026-09-26'