Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Commitment Orchestrator User Approval APIs API

5 actions 5 updates phrasing extends openapi/harness-commitment-orchestrator-user-approval-apis-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/gateway/lw/api/accounts/{account_id}/v2/approvals/list'].post
$.paths['/gateway/lw/api/accounts/{account_id}/v1/approvals/list'].post
$.paths['/gateway/lw/api/accounts/{account_id}/v1/approvals/update'].post
$.paths['/gateway/lw/api/accounts/{account_id}/v2/approvals/overview'].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 Harness Commitment Orchestrator User Approval APIs API
  version: 1.0.0
extends: openapi/harness-commitment-orchestrator-user-approval-apis-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['/gateway/lw/api/accounts/{account_id}/v2/approvals/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search commitment transactions with filters
      effect: read
      questions:
      - Which Savings Plan or reserved instance transactions happened in a given date range and region?
      - Can I filter commitment transactions by status, event type and cloud account?
      instructions:
      - text: List commitment transactions for account {account_id} from {start} to {end}.
        slots:
          account_id: path.account_id
          start: query.start_date
          end: query.end_date
      - text: Filter commitment transactions in {account_id} by statuses {statuses} and regions {regions}.
        slots:
          account_id: path.account_id
          statuses: requestBody.statuses
          regions: requestBody.regions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/approvals/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List commitment transactions awaiting approval
      effect: read
      questions:
      - Which commitment purchases are waiting for me to approve?
      - What pending approvals does the commitment orchestrator have queued?
      instructions:
      - text: List commitment transactions awaiting my approval for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show page {page} of pending commitment approvals in {account_id}.
        slots:
          page: requestBody.page
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/approvals/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject commitment transactions
      effect: write
      questions:
      - How do I approve a pending reserved instance purchase the orchestrator proposed?
      - Can I reject several commitment transactions at once?
      instructions:
      - text: Apply approval actions {actions} to commitment transactions in account {account_id}.
        slots:
          actions: requestBody.actions
          account_id: path.account_id
      - text: Reject the pending commitment transactions listed in {actions} for {account_id}.
        slots:
          actions: requestBody.actions
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v2/approvals/overview'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize commitment approvals and savings
      effect: read
      questions:
      - How much could I save if I approved the pending commitment events?
      - What's the status breakdown of approval events by type?
      instructions:
      - text: Get the approvals overview with potential savings for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Summarize approval event types and savings for {service} in regions {regions} ({account_id}).
        slots:
          service: requestBody.service
          regions: requestBody.regions
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'