Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Segmentation Service Segment search API

4 actions 4 updates phrasing extends openapi/adobe-suite-segment-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 4

$.info
$.paths['/search/namespaces'].get
$.paths['/search/entities'].get
$.paths['/search/taxonomy'].get

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 Segmentation Service Segment search API
  version: 1.0.0
extends: openapi/adobe-suite-segment-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: 3
- target: $.paths['/search/namespaces'].get
  update:
    x-apievangelist-phrasing:
      intent: Count search hits across namespaces
      effect: read
      questions:
      - How many matches does a search term get in each namespace?
      - Can I see search result counts across all namespaces for a schema?
      instructions:
      - text: Count search hits for {s} across namespaces in schema {schema_name}.
        slots:
          s: query.s
          schema_name: query.schema.name
      - text: Show per-namespace result counts for schema {schema_name}.
        slots:
          schema_name: query.schema.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search/entities'].get
  update:
    x-apievangelist-phrasing:
      intent: List full-text indexed objects in a namespace
      effect: read
      questions:
      - How do I list the segment objects indexed for full-text search in one namespace?
      - Can I page through or text-search the indexed objects in a namespace?
      instructions:
      - text: List indexed objects of class {schemaClass} in namespace {namespace}.
        slots:
          schemaClass: query.schemaClass
          namespace: query.namespace
      - text: Search namespace {namespace} of class {schemaClass} for {s}, {limit} per page.
        slots:
          namespace: query.namespace
          schemaClass: query.schemaClass
          s: query.s
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search/taxonomy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a search object's taxonomy
      effect: read
      questions:
      - Where does a given search object sit in the folder taxonomy?
      - Can I see how one indexed object is organized?
      instructions:
      - text: Show the taxonomy of object {entityId} in namespace {namespace} for schema {schema_name}.
        slots:
          entityId: query.entityId
          namespace: query.namespace
          schema_name: query.schema.name
      - text: Get the organizational structure for search object {entityId} in {namespace} under schema {schema_name}.
        slots:
          entityId: query.entityId
          namespace: query.namespace
          schema_name: query.schema.name
      method: generated
      generated: '2026-09-26'