Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Schema Registry Mixins (deprecated) API

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

$.info
$.paths['/{CONTAINER_ID}/mixins'].get
$.paths['/{CONTAINER_ID}/mixins/{MIXIN_ID}'].get
$.paths['/tenant/mixins'].post
$.paths['/tenant/mixins/{MIXIN_ID}'].put
$.paths['/tenant/mixins/{MIXIN_ID}'].delete
$.paths['/tenant/mixins/{MIXIN_ID}'].patch

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 Schema Registry Mixins (deprecated) API
  version: 1.0.0
extends: openapi/adobe-suite-mixins-deprecated-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}/mixins'].get
  update:
    x-apievangelist-phrasing:
      intent: List mixins in a container (deprecated)
      effect: read
      questions:
      - How do I list the mixins in the schema registry's tenant or global container?
      - Can I sort and page through the deprecated mixins listing?
      instructions:
      - text: List mixins in container {CONTAINER_ID}.
        slots:
          CONTAINER_ID: path.CONTAINER_ID
      - text: List mixins in {CONTAINER_ID} ordered by {orderby}, {limit} at a time.
        slots:
          CONTAINER_ID: path.CONTAINER_ID
          orderby: query.orderby
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{CONTAINER_ID}/mixins/{MIXIN_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one mixin (deprecated)
      effect: read
      questions:
      - How do I look up a single mixin by its ID in the schema registry?
      - Can I retrieve a mixin from the global container instead of my tenant?
      instructions:
      - text: Get mixin {MIXIN_ID} from container {CONTAINER_ID}.
        slots:
          MIXIN_ID: path.MIXIN_ID
          CONTAINER_ID: path.CONTAINER_ID
      - text: Look up the definition of mixin {MIXIN_ID} in {CONTAINER_ID}.
        slots:
          MIXIN_ID: path.MIXIN_ID
          CONTAINER_ID: path.CONTAINER_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/mixins'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom mixin (deprecated)
      effect: write
      questions:
      - How do I create a custom mixin that extends an XDM class?
      - What must the payload include when creating a mixin in my tenant?
      instructions:
      - text: 'Create a custom mixin from this definition: {body}.'
        slots:
          body: body.body
      - text: Create a tenant mixin in sandbox {sandbox} using payload {body}.
        slots:
          sandbox: header.x-sandbox-name
          body: body.body
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/mixins/{MIXIN_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a custom mixin (deprecated)
      effect: write
      questions:
      - Can I overwrite a custom mixin with a whole new definition?
      - Can I fully replace a mixin rather than patching it?
      instructions:
      - text: Replace mixin {MIXIN_ID} with the full definition {body}.
        slots:
          MIXIN_ID: path.MIXIN_ID
          body: body.body
      - text: PUT a complete new version of custom mixin {MIXIN_ID}.
        slots:
          MIXIN_ID: path.MIXIN_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/mixins/{MIXIN_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom mixin (deprecated)
      effect: destructive
      questions:
      - What's the way to delete a custom mixin from my tenant?
      - Can I remove a mixin that's no longer used by any schema?
      instructions:
      - text: Delete mixin {MIXIN_ID}.
        slots:
          MIXIN_ID: path.MIXIN_ID
      - text: Remove custom mixin {MIXIN_ID} from sandbox {sandbox}.
        slots:
          MIXIN_ID: path.MIXIN_ID
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/mixins/{MIXIN_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a custom mixin (deprecated)
      effect: write
      questions:
      - Can I change part of a custom mixin with a JSON Patch?
      - What's the way to add a field to an existing mixin without resending all of it?
      instructions:
      - text: Apply JSON Patch {body} to mixin {MIXIN_ID}.
        slots:
          body: body.body
          MIXIN_ID: path.MIXIN_ID
      - text: Patch custom mixin {MIXIN_ID} to change just the fields I specify.
        slots:
          MIXIN_ID: path.MIXIN_ID
      method: generated
      generated: '2026-09-26'