Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Activity API

3 actions 3 updates phrasing extends openapi/scope3-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 3

$.info
$.paths['/activity/calls'].get
$.paths['/activity/calls/{activityUid}'].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 Activity API
  version: 1.0.0
extends: openapi/scope3-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: 2
- target: $.paths['/activity/calls'].get
  update:
    x-apievangelist-phrasing:
      intent: List my API call activity
      effect: read
      questions:
      - Which API calls did my integration make and which ones failed?
      - Can I trace all calls from one run or workload?
      instructions:
      - text: List my API calls with outcome {outcome}.
        slots:
          outcome: query.outcome
      - text: Show API calls for run {runUid} between {startTime} and {endTime}.
        slots:
          runUid: query.runUid
          startTime: query.startTime
          endTime: query.endTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activity/calls/{activityUid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one API call's detail
      effect: read
      questions:
      - What timing and diagnostics were captured for a specific API call?
      - Can I inspect a single call I made by its activity ID?
      instructions:
      - text: Get API call {activityUid}.
        slots:
          activityUid: path.activityUid
      - text: Show diagnostics for call {activityUid}.
        slots:
          activityUid: path.activityUid
      method: generated
      generated: '2026-10-01'