Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for calculator Scope3 Carbon Calculator Segment API

3 actions 3 updates phrasing extends openapi/scope3-segment-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['/segment/list'].get
$.paths['/segment/data'].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 Segment API
  version: 1.0.0
extends: openapi/scope3-segment-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['/segment/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List my organization's segments
      effect: read
      questions:
      - Which audience segments does my organization have?
      - Can I include deactivated segments when listing them?
      instructions:
      - text: List all of my organization's segments.
      - text: List my segments including deactivated ones, page {page}.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segment/data'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the data behind one segment
      effect: read
      questions:
      - What data is stored in a particular segment of mine?
      - Can I pull the contents of a segment rather than just its summary?
      instructions:
      - text: Get the data for segment {segment_id}.
        slots:
          segment_id: query.segmentId
      - text: Show me the records inside segment {segment_id}.
        slots:
          segment_id: query.segmentId
      method: generated
      generated: '2026-10-01'