Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Schema Registry Data types API

7 actions 7 updates phrasing extends openapi/adobe-suite-data-types-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}/datatypes'].get
$.paths['/{CONTAINER_ID}/datatypes/{DATA_TYPE_ID}'].get
$.paths['/tenant/datatypes'].post
$.paths['/tenant/datatypes/{DATA_TYPE_ID}'].put
$.paths['/tenant/datatypes/{DATA_TYPE_ID}'].delete
$.paths['/tenant/datatypes/{DATA_TYPE_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 Data types API
  version: 1.0.0
extends: openapi/adobe-suite-data-types-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}/datatypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List XDM data types
      effect: read
      questions:
      - Which XDM data types are available in the Schema Registry?
      - Can I list only my tenant's custom data types, paged and sorted?
      instructions:
      - text: List data types in the {container} container.
        slots:
          container: path.CONTAINER_ID
      - text: Show {limit} data types 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}/datatypes/{DATA_TYPE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an XDM data type
      effect: read
      questions:
      - How do I look up the fields of one XDM data type?
      - Can I fetch a standard or custom data type by its ID?
      instructions:
      - text: Show data type {dataType} from the {container} container.
        slots:
          dataType: path.DATA_TYPE_ID
          container: path.CONTAINER_ID
      - text: Get the definition of data type {dataType} in {container}.
        slots:
          dataType: path.DATA_TYPE_ID
          container: path.CONTAINER_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/datatypes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom XDM data type
      effect: write
      questions:
      - How do I define a new reusable data type for my schemas?
      - Can I create a custom data type in a specific sandbox?
      instructions:
      - text: Create custom data type {definition}.
        slots:
          definition: body.body
      - text: Create a new data type in sandbox {sandbox} from {definition}.
        slots:
          sandbox: header.x-sandbox-name
          definition: body.body
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/datatypes/{DATA_TYPE_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a custom data type entirely
      effect: write
      questions:
      - Can I rewrite a whole custom data type in one request?
      - Does a full data type update need every field required at creation?
      instructions:
      - text: Replace data type {dataType} with {definition}.
        slots:
          dataType: path.DATA_TYPE_ID
          definition: body.body
      - text: Overwrite the full definition of data type {dataType}.
        slots:
          dataType: path.DATA_TYPE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/datatypes/{DATA_TYPE_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom data type
      effect: destructive
      questions:
      - How do I remove a custom data type I no longer need?
      - What comes back when a data type is deleted successfully?
      instructions:
      - text: Delete data type {dataType}.
        slots:
          dataType: path.DATA_TYPE_ID
      - text: Remove custom data type {dataType} from sandbox {sandbox}.
        slots:
          dataType: path.DATA_TYPE_ID
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenant/datatypes/{DATA_TYPE_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch attributes of a custom data type
      effect: write
      questions:
      - Can I change just one field of a custom data type with JSON Patch?
      - 'Which patch operations can I use on a data type: add, remove, replace?'
      instructions:
      - text: Apply JSON Patch {patch} to data type {dataType}.
        slots:
          patch: body.body
          dataType: path.DATA_TYPE_ID
      - text: Patch only the title of data type {dataType}.
        slots:
          dataType: path.DATA_TYPE_ID
      method: generated
      generated: '2026-09-26'