Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Real-time Customer Profile Computed attributes API

6 actions 6 updates phrasing extends openapi/adobe-suite-computed-attributes-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 6

$.info
$.paths['/ca/attributes'].get
$.paths['/ca/attributes'].post
$.paths['/ca/attributes/{ATTRIBUTE_ID}'].get
$.paths['/ca/attributes/{ATTRIBUTE_ID}'].delete
$.paths['/ca/attributes/{ATTRIBUTE_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 Real-time Customer Profile Computed attributes API
  version: 1.0.0
extends: openapi/adobe-suite-computed-attributes-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: 5
- target: $.paths['/ca/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List computed attributes
      effect: read
      questions:
      - Which computed profile attributes are defined in my sandbox?
      - Can I page and sort the computed attributes list?
      instructions:
      - text: List all computed attributes.
      - text: List computed attributes sorted by {sortBy}, {limit} at a time.
        slots:
          sortBy: query.sortBy
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ca/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a computed attribute
      effect: write
      questions:
      - How do I define a new computed attribute on customer profiles?
      - What lookback duration and expression does a computed attribute need?
      instructions:
      - text: Create computed attribute {name} using expression {expression} over {duration}.
        slots:
          name: requestBody.name
          expression: requestBody.expression
          duration: requestBody.duration
      - text: Add a computed attribute {displayName} described as {description} with status {status}.
        slots:
          displayName: requestBody.displayName
          description: requestBody.description
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ca/attributes/{ATTRIBUTE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one computed attribute
      effect: read
      questions:
      - How do I see the definition of a specific computed attribute?
      - What expression and status does a given computed attribute have?
      instructions:
      - text: Show computed attribute {ATTRIBUTE_ID}.
        slots:
          ATTRIBUTE_ID: path.ATTRIBUTE_ID
      - text: Get the definition of computed attribute {ATTRIBUTE_ID}.
        slots:
          ATTRIBUTE_ID: path.ATTRIBUTE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ca/attributes/{ATTRIBUTE_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a computed attribute
      effect: destructive
      questions:
      - How do I remove a computed attribute I no longer need?
      - Can I delete a computed attribute by its ID?
      instructions:
      - text: Delete computed attribute {ATTRIBUTE_ID}.
        slots:
          ATTRIBUTE_ID: path.ATTRIBUTE_ID
      - text: Remove the computed attribute {ATTRIBUTE_ID} from my sandbox.
        slots:
          ATTRIBUTE_ID: path.ATTRIBUTE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ca/attributes/{ATTRIBUTE_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a computed attribute's status
      effect: write
      questions:
      - How do I switch a computed attribute from draft to active?
      - Can I disable a computed attribute without deleting it?
      instructions:
      - text: Set the status of computed attribute {ATTRIBUTE_ID} to {status}.
        slots:
          ATTRIBUTE_ID: path.ATTRIBUTE_ID
          status: requestBody.status
      - text: Update computed attribute {ATTRIBUTE_ID}.
        slots:
          ATTRIBUTE_ID: path.ATTRIBUTE_ID
      method: generated
      generated: '2026-09-26'