Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Suite Events API

7 actions 7 updates phrasing extends openapi/adobe-suite-events-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}/bulk_data_insertion/events'].post

$.paths['/{globalCompanyId}/bulk_data_insertion/events/validate'].post

$.paths['/api/v1/events'].get

$.paths['/api/v1/events/incidents'].get

$.paths['/api/v1/events/maintenance'].get

$.paths['/api/v1/events/scheduled'].get

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 Suite Events API
  version: 1.0.0
extends: openapi/adobe-suite-events-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}/bulk_data_insertion/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a bulk data insertion file to Analytics
      effect: write
      questions:
      - How do I send a gzipped CSV of hits to Adobe Analytics for processing?
      - What's the size limit on a bulk data insertion file?
      - Can I capture debug info for the first hits of an uploaded file?
      instructions:
      - text: Upload {file} for processing to company {globalCompanyId} under visitor group {x-adobe-vgid}.
        slots:
          file: requestBody.file
          globalCompanyId: path.globalCompanyId
          x-adobe-vgid: header.x-adobe-vgid
      - text: Ingest the batch file {file} into Analytics for {globalCompanyId} with debug set to {debug}.
        slots:
          file: requestBody.file
          globalCompanyId: path.globalCompanyId
          debug: query.debug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/bulk_data_insertion/events/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a bulk data insertion file
      effect: read
      questions:
      - Can I check my bulk insertion CSV format without it being processed?
      - Is there a dry run that tests a batch file but doesn't store it?
      instructions:
      - text: Validate file {file} for company {globalCompanyId} without ingesting it.
        slots:
          file: requestBody.file
          globalCompanyId: path.globalCompanyId
      - text: Test the format of batch file {file} against {globalCompanyId}.
        slots:
          file: requestBody.file
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List all current issues and maintenances
      effect: read
      questions:
      - What issues and maintenance windows are affecting Adobe services right now?
      - Can I see every status event for a date range and product together?
      instructions:
      - text: List all status events for products {productIds}.
        slots:
          productIds: query.productIds
      - text: Show every issue and maintenance from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/events/incidents'].get
  update:
    x-apievangelist-phrasing:
      intent: List ongoing service issues
      effect: read
      questions:
      - Are there any ongoing incidents impacting a product I use?
      - Which outages are currently open in a specific region?
      instructions:
      - text: List current incidents for products {productIds}.
        slots:
          productIds: query.productIds
      - text: Show open outages in regions {regionIds}.
        slots:
          regionIds: query.regionIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/events/maintenance'].get
  update:
    x-apievangelist-phrasing:
      intent: List ongoing maintenances
      effect: read
      questions:
      - What maintenance is in progress right now for a given service?
      - Can I filter active maintenance windows by environment?
      instructions:
      - text: List maintenances underway for services {serviceIds}.
        slots:
          serviceIds: query.serviceIds
      - text: Show ongoing maintenance affecting environments {environmentIds}.
        slots:
          environmentIds: query.environmentIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/events/scheduled'].get
  update:
    x-apievangelist-phrasing:
      intent: List upcoming scheduled maintenances
      effect: read
      questions:
      - When is the next planned maintenance for a product I depend on?
      - Can I see upcoming scheduled maintenance for one cloud?
      instructions:
      - text: List upcoming scheduled maintenance for clouds {cloudIds}.
        slots:
          cloudIds: query.cloudIds
      - text: Show maintenance planned between {from} and {to} for products {productIds}.
        slots:
          from: query.from
          to: query.to
          productIds: query.productIds
      method: generated
      generated: '2026-09-26'