Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Cost Details API

6 actions 6 updates phrasing extends openapi/harness-cost-details-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 6

$.info
$.paths['/ccm/api/costdetails/overview/iacm'].post
$.paths['/ccm/api/costdetails/overview'].post
$.paths['/ccm/api/costdetails/clusterData'].post
$.paths['/ccm/api/costdetails/tabularformat'].post
$.paths['/ccm/api/costdetails/timeseriesformat'].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 Cost Details API
  version: 1.0.0
extends: openapi/harness-cost-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: 5
- target: $.paths['/ccm/api/costdetails/overview/iacm'].post
  update:
    x-apievangelist-phrasing:
      intent: Get cloud costs for Terraform-managed resources
      effect: read
      questions:
      - How much do the resources my Terraform workspace manages actually cost?
      - Can I look up cost by cloud resource ID and Terraform resource type?
      instructions:
      - text: 'Get the cost overview for these IaCM resources: {resources}.'
        slots:
          resources: requestBody.resources
      - text: Show what Terraform-managed resources {resources} cost in account {account}.
        slots:
          resources: requestBody.resources
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/costdetails/overview'].post
  update:
    x-apievangelist-phrasing:
      intent: Get total cost and trend for a perspective
      effect: read
      questions:
      - What is my total cloud spend and trend for a perspective this month?
      - Is cost going up or down compared with the previous period?
      instructions:
      - text: Get the cost overview for perspective {perspective} from {start} to {end}.
        slots:
          perspective: query.perspectiveId
          start: query.startTime
          end: query.endTime
      - text: Show total cost and trend for perspective {perspective}.
        slots:
          perspective: query.perspectiveId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/costdetails/clusterData'].post
  update:
    x-apievangelist-phrasing:
      intent: Get Kubernetes cluster cost data as a table
      effect: read
      questions:
      - Which Kubernetes workloads cost the most in my clusters?
      - Can I break cluster cost down by selected labels?
      instructions:
      - text: Show cluster cost data from {start} to {end} grouped by {group_by}.
        slots:
          start: query.startTime
          end: query.endTime
          group_by: requestBody.groupBy
      - text: Tabulate cluster costs for labels {labels} in account {account}.
        slots:
          labels: requestBody.selectedLabels
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/costdetails/tabularformat'].post
  update:
    x-apievangelist-phrasing:
      intent: Get perspective cost details as a table
      effect: read
      questions:
      - Can I get a table of costs per service or account for a perspective?
      - Which cost entries top the list when sorted by spend?
      instructions:
      - text: Get a cost table for perspective {perspective} grouped by {group_by}.
        slots:
          perspective: query.perspectiveId
          group_by: requestBody.groupBy
      - text: List the top {limit} cost rows for perspective {perspective} from {start} to {end}.
        slots:
          limit: requestBody.limit
          perspective: query.perspectiveId
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/costdetails/timeseriesformat'].post
  update:
    x-apievangelist-phrasing:
      intent: Get perspective costs as a time series
      effect: read
      questions:
      - How has cost for a perspective changed day by day?
      - Can I chart perspective spend over time at a weekly or monthly resolution?
      instructions:
      - text: Get a cost time series for perspective {perspective} at {resolution} resolution.
        slots:
          perspective: query.perspectiveId
          resolution: requestBody.timeResolution
      - text: Plot perspective {perspective} spend over time from {start} to {end}, grouped by {group_by}.
        slots:
          perspective: query.perspectiveId
          start: query.startTime
          end: query.endTime
          group_by: requestBody.groupBy
      method: generated
      generated: '2026-09-26'