Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Suite Tags API

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

$.info
$.paths['/tags/{tagNamespace}'].get
$.paths['/unifiedtags/tags'].get
$.paths['/unifiedtags/tags'].post
$.paths['/unifiedtags/tags/{TAG_ID}'].get
$.paths['/unifiedtags/tags/{TAG_ID}'].delete
$.paths['/unifiedtags/tags/{TAG_ID}'].patch
$.paths['/unifiedtags/tags/validate'].post

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 Adobe Suite Tags API
  version: 1.0.0
extends: openapi/adobe-suite-tags-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: 7
- target: $.paths['/tags/{tagNamespace}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated tag values in a namespace (legacy)
      effect: read
      questions:
      - What aggregated values exist for all tags in one namespace across my organization?
      - Is the older namespace-based tag aggregation endpoint still usable now that it's deprecated?
      instructions:
      - text: Get aggregated tag values for namespace {tagNamespace} using the deprecated endpoint.
        slots:
          tagNamespace: path.tagNamespace
      - text: Aggregate the legacy tag values in the {tagNamespace} namespace.
        slots:
          tagNamespace: path.tagNamespace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/unifiedtags/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List unified tags
      effect: read
      questions:
      - How do I list all the unified tags in Adobe Experience Platform?
      - Can I sort and page through the unified tags list?
      instructions:
      - text: List my unified tags.
      - text: List unified tags sorted by {sortBy} {sortOrder}, {limit} at a time.
        slots:
          sortBy: query.sortBy
          sortOrder: query.sortOrder
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/unifiedtags/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a unified tag
      effect: write
      questions:
      - How do I create a new tag to label objects in Experience Platform?
      - Can I put a new tag straight into a tag category when creating it?
      instructions:
      - text: Create a tag named {name}.
        slots:
          name: requestBody.name
      - text: Create tag {name} in category {tagCategoryId}.
        slots:
          name: requestBody.name
          tagCategoryId: requestBody.tagCategoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/unifiedtags/tags/{TAG_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one unified tag
      effect: read
      questions:
      - What are the details of a specific unified tag?
      - Can I look up a single tag by its tag ID?
      instructions:
      - text: Show me tag {TAG_ID}.
        slots:
          TAG_ID: path.TAG_ID
      - text: Retrieve the details of unified tag {TAG_ID}.
        slots:
          TAG_ID: path.TAG_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/unifiedtags/tags/{TAG_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a unified tag
      effect: destructive
      questions:
      - How do I permanently remove a tag I no longer need?
      - What happens when I delete a unified tag by ID?
      instructions:
      - text: Delete tag {TAG_ID}.
        slots:
          TAG_ID: path.TAG_ID
      - text: Remove unified tag {TAG_ID} permanently.
        slots:
          TAG_ID: path.TAG_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/unifiedtags/tags/{TAG_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a unified tag
      effect: write
      questions:
      - How can I rename an existing tag?
      - Does tag update use JSON Patch operations?
      instructions:
      - text: Update tag {TAG_ID}.
        slots:
          TAG_ID: path.TAG_ID
      - text: Patch tag {TAG_ID} with {op} on {path} set to {value}.
        slots:
          TAG_ID: path.TAG_ID
          op: requestBody.op
          path: requestBody.path
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/unifiedtags/tags/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether tags are valid
      effect: read
      questions:
      - Can I check that a list of tag IDs is valid before applying them?
      - Which of these tags are allowed on a given entity?
      instructions:
      - text: Validate tags {ids}.
        slots:
          ids: requestBody.ids
      - text: Check whether tags {ids} are valid for {entity}.
        slots:
          ids: requestBody.ids
          entity: requestBody.entity
      method: generated
      generated: '2026-09-26'