Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Buyer Tasks API

2 actions 2 updates phrasing extends openapi/scope3-tasks-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['/tasks/{taskId}'].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 Buyer Tasks API
  version: 1.0.0
extends: openapi/scope3-tasks-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['/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an async task
      effect: read
      questions:
      - How can I tell whether a long-running buyer task has finished?
      - Is there a polling option if I can't receive webhooks for async tasks?
      instructions:
      - text: Check the status of task {task_id}.
        slots:
          task_id: path.taskId
      - text: Poll async task {task_id} until it completes.
        slots:
          task_id: path.taskId
      method: generated
      generated: '2026-10-01'