Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Storefront Storefront Activity API

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

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 Activity API
  version: 1.0.0
extends: openapi/scope3-storefront-activity-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 storefront configuration changes
      effect: read
      questions:
      - What changed on my storefront recently and who changed it?
      - Can I see changes to one inventory source only?
      instructions:
      - text: List storefront activity for inventory source {inventorySourceId}.
        slots:
          inventorySourceId: query.inventorySourceId
      - text: Show storefront changes by {actorUserEmail} from {startDate} to {endDate}.
        slots:
          actorUserEmail: query.actorUserEmail
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'