Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for calculator Scope3 Carbon Calculator Benchmarks API

2 actions 2 updates phrasing extends openapi/scope3-benchmarks-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['/benchmarks'].post

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 calculator Scope3 Carbon Calculator Benchmarks API
  version: 1.0.0
extends: openapi/scope3-benchmarks-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['/benchmarks'].post
  update:
    x-apievangelist-phrasing:
      intent: Get emissions benchmarks for a country and channel
      effect: read
      questions:
      - What are typical advertising emissions percentiles for a country and channel?
      - How does display in the US compare on carbon emissions benchmarks?
      - Can I pull last month's emissions benchmarks instead of the latest?
      instructions:
      - text: Get emissions benchmarks for {channel} in {country}.
        slots:
          channel: requestBody.channel
          country: requestBody.country
      - text: Show the {month} emissions percentiles for {channel} ads in {country}.
        slots:
          month: requestBody.month
          channel: requestBody.channel
          country: requestBody.country
      method: generated
      generated: '2026-10-01'