Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Suite Search API

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

$.paths['/V1/search'].get

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 Adobe Suite Search API
  version: 1.0.0
extends: openapi/adobe-suite-search-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['/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search tags resources like rules and data elements
      effect: read
      questions:
      - What's the way to search across my tag properties' rules, data elements and extensions?
      - Can I limit a tags search to certain resource types like builds or callbacks?
      instructions:
      - text: Search tags resources with query {query}.
        slots:
          query: requestBody.query
      - text: Search {resource_types} for {query}, returning {size} results.
        slots:
          resource_types: requestBody.resource_types
          query: requestBody.query
          size: requestBody.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/V1/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Full-text search the Commerce store
      effect: read
      questions:
      - Can I run a full-text search for products in the Commerce storefront?
      - Can I sort and paginate storefront search results?
      instructions:
      - text: Run storefront full-text search request {requestName}.
        slots:
          requestName: query.searchCriteria[requestName]
      - text: Storefront search where {field} equals {value}, page size {pageSize}.
        slots:
          field: query.searchCriteria[filterGroups][0][filters][0][field]
          value: query.searchCriteria[filterGroups][0][filters][0][value]
          pageSize: query.searchCriteria[pageSize]
      method: generated
      generated: '2026-09-26'