Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog Service Batched requests API

3 actions 3 updates phrasing extends openapi/adobe-suite-batched-requests-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['/'].get

$.paths['/'].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 Service Batched requests API
  version: 1.0.0
extends: openapi/adobe-suite-batched-requests-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['/'].get
  update:
    x-apievangelist-phrasing:
      intent: List Catalog batched requests
      effect: read
      questions:
      - Can I see the batched requests previously sent to Catalog Service?
      - How do I sort batched requests by creation date?
      instructions:
      - text: List Catalog batched requests ordered by {orderBy}.
        slots:
          orderBy: query.orderBy
      - text: Show {limit} batched requests returning only {properties}.
        slots:
          limit: query.limit
          properties: query.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/'].post
  update:
    x-apievangelist-phrasing:
      intent: Send several Catalog requests in one batch
      effect: write
      questions:
      - Can I bundle multiple Catalog Service calls into a single request?
      - Is the Catalog batch endpoint still supported or deprecated?
      instructions:
      - text: Submit these Catalog operations as one batched request.
      - text: Run my array of Catalog calls together through the deprecated batch endpoint.
      method: generated
      generated: '2026-09-26'