# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ESG Program Reporting & Disclosures Carbon Management API
  version: 1.0.0
extends: openapi/onetrust-carbon-management-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v1/emission-factors'].get
  update:
    x-apievangelist-phrasing:
      intent: List emission factors
      effect: read
      questions:
      - Which emission factors are set up for carbon accounting?
      - Where do I find emission factor IDs to use on a transaction?
      instructions:
      - text: List all emission factors.
      - text: Show emission factor names and IDs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-types/emission-factors/entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an emission factor
      effect: write
      questions:
      - How do I add a new emission factor?
      - What details does an emission factor need?
      instructions:
      - text: Create emission factor {name} for organization {organization} with details {entityDetail}.
        slots:
          name: requestBody.name
          organization: requestBody.organization
          entityDetail: requestBody.entityDetail
      - text: Add emission factor {name} to org {organization} using entity details {entityDetail} and attributes {attributes}.
        slots:
          name: requestBody.name
          organization: requestBody.organization
          entityDetail: requestBody.entityDetail
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-types/emission-transactions/entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an emission transaction
      effect: write
      questions:
      - Can I log an emissions activity against an emission factor?
      - What organization and details does an emission transaction require?
      instructions:
      - text: Record an emission transaction for organization {organization} with details {entityDetail}.
        slots:
          organization: requestBody.organization
          entityDetail: requestBody.entityDetail
      - text: Log emission transaction {name} for {organization} with details {entityDetail}.
        slots:
          name: requestBody.name
          organization: requestBody.organization
          entityDetail: requestBody.entityDetail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-types/names/{entityTypeName}/entities/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: List emission records by type
      effect: read
      questions:
      - Can I filter emission records by criteria?
      - How do I list all emission transactions or factors of one type?
      instructions:
      - text: List emission details of type {entityTypeName}.
        slots:
          entityTypeName: path.entityTypeName
      - text: Find {entityTypeName} records matching {queryRequest}.
        slots:
          entityTypeName: path.entityTypeName
          queryRequest: requestBody.queryRequest
      method: generated
      generated: '2026-09-26'