Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Commitment Orchestrator Events APIs API

4 actions 4 updates phrasing extends openapi/harness-commitment-orchestrator-events-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 4

$.info
$.paths['/gateway/lw/api/accounts/{account_id}/v1/events/chart'].post
$.paths['/gateway/lw/api/accounts/{account_id}/v1/events/renewal_events'].post
$.paths['/gateway/lw/api/accounts/{account_id}/v1/events/ri_recommendation_schedule'].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 Harness Commitment Orchestrator Events APIs API
  version: 1.0.0
extends: openapi/harness-commitment-orchestrator-events-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: 3
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/events/chart'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart commitment orchestrator events by date
      effect: read
      questions:
      - How many commitment events happened each day over a date range?
      - Can I group commitment orchestrator event counts by type for one service?
      instructions:
      - text: Chart commitment events for account {account_id} from {start} to {end}.
        slots:
          account_id: path.account_id
          start: query.start_date
          end: query.end_date
      - text: Count events {events} for account {account_id} grouped by {group_by}.
        slots:
          events: requestBody.events
          account_id: path.account_id
          group_by: requestBody.group_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/events/renewal_events'].post
  update:
    x-apievangelist-phrasing:
      intent: List RI and Savings Plan auto-renewal events
      effect: read
      questions:
      - Which reserved instance or savings plan renewals are coming up or already done?
      - Did a coverage dip line up with an auto-renewal in a particular region?
      instructions:
      - text: List auto-renewal events for account {account_id} between {start} and {end}.
        slots:
          account_id: path.account_id
          start: requestBody.start_date
          end: requestBody.end_date
      - text: Show auto-renewals for account {account_id} in regions {regions}.
        slots:
          account_id: path.account_id
          regions: requestBody.regions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/events/ri_recommendation_schedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the RI recommendation cooldown schedule
      effect: read
      questions:
      - When will the next reserved instance recommendation run become eligible?
      - What minimum interval is set between RI recommendation engine runs?
      instructions:
      - text: Show the RI recommendation cooldown schedule for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Get the next eligible RI recommendation run for account {account_id} and service {service}.
        slots:
          account_id: path.account_id
          service: query.service
      method: generated
      generated: '2026-09-26'