# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Schema Registry Classes API
  version: 1.0.0
extends: openapi/adobe-suite-classes-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: 6
- target: $.paths['/{CONTAINER_ID}/classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List XDM classes
      effect: read
      questions:
      - How do I see all the XDM classes available in the Schema Registry?
      - Can I list only my tenant's custom classes rather than the global ones?
      instructions:
      - text: List XDM classes in the {CONTAINER_ID} container.
        slots:
          CONTAINER_ID: path.CONTAINER_ID
      - text: Show {limit} classes from container {CONTAINER_ID} sorted by {orderby}.
        slots:
          limit: query.limit
          CONTAINER_ID: path.CONTAINER_ID
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{CONTAINER_ID}/classes/{CLASS_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an XDM class
      effect: read
      questions:
      - How can I look up one XDM class definition by its ID?
      - What fields does a particular schema class define?
      instructions:
      - text: Get class {CLASS_ID} from container {CONTAINER_ID}.
        slots:
          CLASS_ID: path.CLASS_ID
          CONTAINER_ID: path.CONTAINER_ID
      - text: Show the definition of XDM class {CLASS_ID} in {CONTAINER_ID}.
        slots:
          CLASS_ID: path.CLASS_ID
          CONTAINER_ID: path.CONTAINER_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/classes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom XDM class
      effect: write
      questions:
      - How do I define my own XDM class in the Schema Registry?
      - Can I create a custom class for data that no standard class models?
      instructions:
      - text: Create a custom XDM class in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Add a new tenant class to the schema registry of sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/classes/{CLASS_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a custom class definition
      effect: write
      questions:
      - Can I rewrite a custom class entirely with a new definition?
      - What must a full replacement of a custom class include?
      instructions:
      - text: Replace custom class {CLASS_ID} with a complete new definition.
        slots:
          CLASS_ID: path.CLASS_ID
      - text: Overwrite all of tenant class {CLASS_ID}.
        slots:
          CLASS_ID: path.CLASS_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/classes/{CLASS_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom XDM class
      effect: destructive
      questions:
      - How do I delete a custom class I created?
      - What does a successful custom class deletion return?
      instructions:
      - text: Delete custom class {CLASS_ID}.
        slots:
          CLASS_ID: path.CLASS_ID
      - text: Remove tenant class {CLASS_ID} from the schema registry.
        slots:
          CLASS_ID: path.CLASS_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/classes/{CLASS_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch attributes of a custom class
      effect: write
      questions:
      - Can I change just the title or description of a custom class without rewriting it?
      - Which JSON Patch operations are supported on a custom class?
      instructions:
      - text: Patch the description of custom class {CLASS_ID}.
        slots:
          CLASS_ID: path.CLASS_ID
      - text: Apply JSON Patch add, remove or replace operations to class {CLASS_ID}.
        slots:
          CLASS_ID: path.CLASS_ID
      method: generated
      generated: '2026-09-26'