# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Experience Platform Schemas API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-schemas-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/data/foundation/schemaregistry/tenant/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List XDM schemas
      effect: read
      questions:
      - Which XDM schemas are defined in our tenant?
      - Can I page through schemas with a start offset?
      instructions:
      - text: List XDM schemas in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show {limit} schemas starting at {start}.
        slots:
          limit: query.limit
          start: query.start
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/foundation/schemaregistry/tenant/schemas'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an XDM schema
      effect: write
      questions:
      - How do I create a schema based on an XDM class and field groups?
      - What is required to define a new tenant schema?
      instructions:
      - text: Create XDM schema {title} of type {type} extending {allOf}.
        slots:
          title: requestBody.title
          type: requestBody.type
          allOf: requestBody.allOf
      - text: Create schema {title} in sandbox {sandbox} composed of {allOf} with type {type}.
        slots:
          title: requestBody.title
          sandbox: header.x-sandbox-name
          allOf: requestBody.allOf
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/foundation/schemaregistry/tenant/schemas/{schemaId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an XDM schema's definition
      effect: read
      questions:
      - What fields and field groups does a specific schema contain?
      - Which class is a particular XDM schema built on?
      instructions:
      - text: Show schema {schemaId}.
        slots:
          schemaId: path.schemaId
      - text: Get the full field definitions of schema {schemaId} in sandbox {sandbox}.
        slots:
          schemaId: path.schemaId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/foundation/schemaregistry/tenant/schemas/{schemaId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an XDM schema
      effect: write
      questions:
      - Can I replace an existing schema's whole definition?
      - Is it possible to retitle a schema that already exists?
      instructions:
      - text: Replace schema {schemaId} with title {title}, type {type} and composition {allOf}.
        slots:
          schemaId: path.schemaId
          title: requestBody.title
          type: requestBody.type
          allOf: requestBody.allOf
      - text: Update the description of schema {schemaId} to {description}.
        slots:
          schemaId: path.schemaId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/foundation/schemaregistry/tenant/schemas/{schemaId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an unused XDM schema
      effect: destructive
      questions:
      - Why can't I delete a schema that a dataset uses?
      - Can tenant schemas be removed once they're unused?
      instructions:
      - text: Delete schema {schemaId}.
        slots:
          schemaId: path.schemaId
      - text: Remove XDM schema {schemaId} from sandbox {sandbox}.
        slots:
          schemaId: path.schemaId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'