Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Buyer Audit Logs API

2 actions 2 updates phrasing extends openapi/scope3-audit-logs-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 2

$.info

$.paths['/audit-logs'].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 Scope3 Buyer Audit Logs API
  version: 1.0.0
extends: openapi/scope3-audit-logs-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: 1
- target: $.paths['/audit-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List buyer audit log entries
      effect: read
      questions:
      - Who changed my campaign and when?
      - Can I filter the audit log by the person who made the change?
      instructions:
      - text: List audit logs for campaign {campaignId}.
        slots:
          campaignId: query.campaignId
      - text: Show changes made by {actorUserEmail} between {startDate} and {endDate}.
        slots:
          actorUserEmail: query.actorUserEmail
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'