# 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 Schemas API
  version: 1.0.0
extends: openapi/adobe-suite-schemas-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}/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List XDM schemas in a container
      effect: read
      questions:
      - Which XDM schemas exist in my tenant container?
      - Can I list only the core Adobe schemas from the global container?
      - Is there a way to sort schemas by title and page through them?
      instructions:
      - text: List the schemas in the {container} container.
        slots:
          container: path.CONTAINER_ID
      - text: Show {limit} schemas from {container} ordered by {orderby}.
        slots:
          limit: query.limit
          container: path.CONTAINER_ID
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{CONTAINER_ID}/schemas/{SCHEMA_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an XDM schema
      effect: read
      questions:
      - What fields and class does a particular XDM schema have?
      - Can I look up a schema by its meta:altId?
      instructions:
      - text: Show schema {schemaId} from the {container} container.
        slots:
          schemaId: path.SCHEMA_ID
          container: path.CONTAINER_ID
      - text: Get the full definition of XDM schema {schemaId} in {container}.
        slots:
          schemaId: path.SCHEMA_ID
          container: path.CONTAINER_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/schemas'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom XDM schema
      effect: write
      questions:
      - How do I create my own XDM schema based on a class like XDM Individual Profile?
      - What must the payload reference when creating a tenant schema?
      instructions:
      - text: 'Create a custom schema from this definition: {body}.'
        slots:
          body: body.body
      - text: Create a new tenant schema that extends a base class.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/schemas/{SCHEMA_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a custom XDM schema
      effect: write
      questions:
      - Can I rewrite an entire custom schema in one request?
      - What fields must I resend when replacing a schema with PUT?
      instructions:
      - text: Replace schema {schemaId} with {body}.
        slots:
          schemaId: path.SCHEMA_ID
          body: body.body
      - text: Overwrite the whole definition of custom schema {schemaId}.
        slots:
          schemaId: path.SCHEMA_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/schemas/{SCHEMA_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom XDM schema
      effect: destructive
      questions:
      - How do I delete a custom schema I created?
      - Can I remove a tenant schema from the Schema Registry?
      instructions:
      - text: Delete schema {schemaId}.
        slots:
          schemaId: path.SCHEMA_ID
      - text: Remove custom XDM schema {schemaId} from the registry.
        slots:
          schemaId: path.SCHEMA_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/schemas/{SCHEMA_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch attributes of a custom XDM schema
      effect: write
      questions:
      - Can I add a field group or change one attribute of a schema without rewriting it?
      - Which JSON Patch operations does the Schema Registry accept on schemas?
      instructions:
      - text: Apply JSON Patch {body} to schema {schemaId}.
        slots:
          body: body.body
          schemaId: path.SCHEMA_ID
      - text: Change just the title of custom schema {schemaId} with a JSON Patch.
        slots:
          schemaId: path.SCHEMA_ID
      method: generated
      generated: '2026-09-26'