Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Users API

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

$.info
$.paths['/{globalCompanyId}/users'].get
$.paths['/{globalCompanyId}/users/me'].get

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 Analytics Users API
  version: 1.0.0
extends: openapi/adobe-suite-users-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/{globalCompanyId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List all users in the company
      effect: read
      questions:
      - Who are all the Analytics users in my company?
      - Can I page through the company's user list a set number at a time?
      instructions:
      - text: List every user in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Show {limit} users per page from company {globalCompanyId}, page {page}.
        slots:
          limit: query.limit
          globalCompanyId: path.globalCompanyId
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/users/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current Analytics user
      effect: read
      questions:
      - Which Adobe Analytics user am I authenticated as?
      - How do I look up my own user profile in a company?
      instructions:
      - text: Show my Analytics user profile in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Tell me who I am signed in as.
      method: generated
      generated: '2026-10-01'