Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Annotations API

6 actions 6 updates phrasing extends openapi/adobe-suite-annotations-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['/{globalCompanyId}/annotations'].get

$.paths['/{globalCompanyId}/annotations'].post

$.paths['/{globalCompanyId}/annotations/{id}'].get

$.paths['/{globalCompanyId}/annotations/{id}'].put

$.paths['/{globalCompanyId}/annotations/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Analytics Annotations API
  version: 1.0.0
extends: openapi/adobe-suite-annotations-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['/{globalCompanyId}/annotations'].get
  update:
    x-apievangelist-phrasing:
      intent: List Analytics annotations
      effect: read
      questions:
      - How do I list all the annotations in my Adobe Analytics company?
      - Can I filter annotations to those modified after a certain date?
      - Which annotations fall within a specific date range?
      instructions:
      - text: List annotations for company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: List annotations in company {globalCompanyId} within {filterByDateRange}.
        slots:
          globalCompanyId: path.globalCompanyId
          filterByDateRange: query.filterByDateRange
      - text: Show annotations in {globalCompanyId} modified after {filterByModifiedAfter}.
        slots:
          globalCompanyId: path.globalCompanyId
          filterByModifiedAfter: query.filterByModifiedAfter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/annotations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Analytics annotation
      effect: write
      questions:
      - How do I add an annotation to mark an event on my reports?
      - Can I create an annotation that applies to all reports?
      instructions:
      - text: Create annotation {name} for {dateRange} in company {globalCompanyId}.
        slots:
          name: requestBody.name
          dateRange: requestBody.dateRange
          globalCompanyId: path.globalCompanyId
      - text: Add a {color} annotation {name} described as {description} in {globalCompanyId}.
        slots:
          color: requestBody.color
          name: requestBody.name
          description: requestBody.description
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/annotations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Analytics annotation
      effect: read
      questions:
      - What are the details of a specific annotation?
      - Can I expand extra fields like tags when fetching one annotation?
      instructions:
      - text: Show me annotation {id} in company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Get annotation {id} from {globalCompanyId} expanded with {expansion}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          expansion: query.expansion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/annotations/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing Analytics annotation
      effect: write
      questions:
      - How do I change the name or dates on an annotation I already made?
      - Can I edit an existing annotation's color or description?
      instructions:
      - text: Update annotation {id} in company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Rename annotation {id} in {globalCompanyId} to {name}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/annotations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Analytics annotation
      effect: destructive
      questions:
      - How do I delete an annotation that is no longer relevant?
      - Is removing an annotation permanent?
      instructions:
      - text: Delete annotation {id} in company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Remove annotation {id} from {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'