OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ESG Program Reporting & Disclosures Metric Details API

2 actions 2 updates phrasing extends openapi/onetrust-metric-details-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for OneTrust's API. It is a proposal applied on top of the contract, not a document OneTrust publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/v1/metrics/metric-details'].post

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 ESG Program Reporting & Disclosures Metric Details API
  version: 1.0.0
extends: openapi/onetrust-metric-details-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: 1
- target: $.paths['/v1/metrics/metric-details'].post
  update:
    x-apievangelist-phrasing:
      intent: Get ESG metric details for a period
      effect: read
      questions:
      - What are the latest ESG metric values for a reporting period?
      - Can I fetch metrics across all time instead of a date range?
      instructions:
      - text: Get ESG metric details from {startDate} to {endDate}.
        slots:
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Get ESG metric details with all-time option {allTimeOption}.
        slots:
          allTimeOption: requestBody.allTimeOption
      method: generated
      generated: '2026-09-26'