Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for calculator Scope3 Carbon Calculator Measure API

2 actions 2 updates phrasing extends openapi/scope3-measure-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['/measure'].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 Measure API
  version: 1.0.0
extends: openapi/scope3-measure-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['/measure'].post
  update:
    x-apievangelist-phrasing:
      intent: Measure the carbon footprint of ad media delivery
      effect: read
      questions:
      - What is the carbon footprint of my media delivery by domain or app?
      - Can I limit which fields come back for each row in a media emissions measurement?
      - Does media emissions measurement support using the latest available data?
      instructions:
      - text: 'Measure media emissions for these delivery rows: {rows}.'
        slots:
          rows: requestBody.rows
      - text: Calculate media carbon for {rows} and return only the {fields} fields per row.
        slots:
          rows: requestBody.rows
          fields: query.fields
      method: generated
      generated: '2026-10-01'