Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for calculator Scope3 Carbon Calculator Data API

3 actions 3 updates phrasing extends openapi/scope3-data-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['/data/upload'].post
$.paths['/data/upload/{uploadId}'].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 calculator Scope3 Carbon Calculator Data API
  version: 1.0.0
extends: openapi/scope3-data-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['/data/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a data file
      effect: write
      questions:
      - Can I upload my own data file and map its columns to the expected fields?
      - What kinds of data files can I send for processing, and can I tag the data source?
      instructions:
      - text: Upload data file {file} as type {type}.
        slots:
          file: requestBody.file
          type: requestBody.type
      - text: Upload {file} from source {data_source} using field mapping {field_mapping}.
        slots:
          file: requestBody.file
          data_source: requestBody.dataSource
          field_mapping: requestBody.fieldMapping
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/upload/{uploadId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a data file upload
      effect: read
      questions:
      - Has the data file I uploaded finished processing?
      - Can I look up an earlier file upload by its id?
      instructions:
      - text: Get the status of data upload {upload_id}.
        slots:
          upload_id: path.uploadId
      - text: Show me what happened with file upload {upload_id}.
        slots:
          upload_id: path.uploadId
      method: generated
      generated: '2026-10-01'