Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Projects API

7 actions 7 updates phrasing extends openapi/adobe-suite-projects-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['/{globalCompanyId}/projects/{id}'].get
$.paths['/{globalCompanyId}/projects/{id}'].put
$.paths['/{globalCompanyId}/projects/{id}'].delete
$.paths['/{globalCompanyId}/projects/validate'].post
$.paths['/{globalCompanyId}/projects'].get
$.paths['/{globalCompanyId}/projects'].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 Analytics Projects API
  version: 1.0.0
extends: openapi/adobe-suite-projects-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['/{globalCompanyId}/projects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Analytics project's configuration
      effect: read
      questions:
      - How do I retrieve the configuration of one Analytics Workspace project?
      - Can I expand extra details like tags or owner when fetching a project?
      instructions:
      - text: Get project {id} for company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Show project {id} in company {globalCompanyId} expanded with {expansion}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          expansion: query.expansion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/projects/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Analytics project
      effect: write
      questions:
      - How do I rename or change the definition of an existing Analytics project?
      - Can I update a project's description or tags?
      instructions:
      - text: Rename project {id} in company {globalCompanyId} to {name}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          name: requestBody.name
      - text: Update the description of project {id} for {globalCompanyId} to {description}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/projects/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Analytics project
      effect: destructive
      questions:
      - How do I delete an Analytics Workspace project?
      - Can I remove a project I own by its ID?
      instructions:
      - text: Delete project {id} in company {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      - text: Remove Analytics project {id} from {globalCompanyId}.
        slots:
          id: path.id
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/projects/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a project definition
      effect: read
      questions:
      - Can I check that a project definition is valid before saving it?
      - What does the validate call return for a draft Analytics project?
      instructions:
      - text: Validate this project definition for company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: Check that project definition {definition} is valid in {globalCompanyId}.
        slots:
          definition: requestBody.definition
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's Analytics projects
      effect: read
      questions:
      - Which Analytics Workspace projects do I have access to?
      - Can I list only the projects owned by a particular user?
      instructions:
      - text: List projects for company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: List projects in {globalCompanyId} owned by {ownerId}, {limit} per page.
        slots:
          globalCompanyId: path.globalCompanyId
          ownerId: query.ownerId
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Analytics project
      effect: write
      questions:
      - How do I create a new Analytics Workspace project through the API?
      - Which report suite does a new project need?
      instructions:
      - text: Create a project named {name} in company {globalCompanyId}.
        slots:
          name: requestBody.name
          globalCompanyId: path.globalCompanyId
      - text: Create project {name} on report suite {rsid} for {globalCompanyId}.
        slots:
          name: requestBody.name
          rsid: requestBody.rsid
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'