Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Storefront Storefront Ad Server Diagnostics API

3 actions 3 updates phrasing extends openapi/scope3-storefront-ad-server-diagnostics-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Scope3's API. It is a proposal applied on top of the contract, not a document Scope3 publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/esa/{esaId}/media-buys'].get
$.paths['/esa/{esaId}/media-buys/{mediaBuyId}'].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 Scope3 Storefront Storefront Ad Server Diagnostics API
  version: 1.0.0
extends: openapi/scope3-storefront-ad-server-diagnostics-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['/esa/{esaId}/media-buys'].get
  update:
    x-apievangelist-phrasing:
      intent: List upstream media buys on an ad server source
      effect: read
      questions:
      - Which media buys has my ad server source actually received?
      - Can I filter upstream media buys by status or date?
      instructions:
      - text: List upstream media buys on source {esaId}.
        slots:
          esaId: path.esaId
      - text: Show {status} upstream media buys on {esaId} from {fromDate} to {toDate}.
        slots:
          status: query.status
          esaId: path.esaId
          fromDate: query.fromDate
          toDate: query.toDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/esa/{esaId}/media-buys/{mediaBuyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an upstream media buy on an ad server source
      effect: read
      questions:
      - What status history and delivery snapshot does an upstream media buy have?
      - Can I inspect the targeting and creatives that reached the ad server?
      instructions:
      - text: Get upstream media buy {mediaBuyId} on source {esaId}.
        slots:
          mediaBuyId: path.mediaBuyId
          esaId: path.esaId
      - text: Show the status history of upstream buy {mediaBuyId} on {esaId}.
        slots:
          mediaBuyId: path.mediaBuyId
          esaId: path.esaId
      method: generated
      generated: '2026-10-01'