Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Data Job Status API

9 actions 9 updates phrasing extends openapi/harness-data-job-status-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 9

$.info
$.paths['/ccm/api/data-job-status/job-statuses'].get
$.paths['/ccm/api/data-job-status/history/billing-periods'].get
$.paths['/ccm/api/data-job-status/history/execution-months'].get
$.paths['/ccm/api/data-job-status/job-kinds'].get
$.paths['/ccm/api/data-job-status/history'].get
$.paths['/ccm/api/data-job-status/details/{jobId}'].get
$.paths['/ccm/api/data-job-status/overview'].get
$.paths['/ccm/api/data-job-status/list'].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 Data Job Status API
  version: 1.0.0
extends: openapi/harness-data-job-status-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: 8
- target: $.paths['/ccm/api/data-job-status/job-statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List possible data job statuses
      effect: read
      questions:
      - What status values can a cloud cost data job have?
      - Which states does a cost ingestion job move through?
      instructions:
      - text: List every possible data job status.
      - text: Show the status values used for cost data jobs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/data-job-status/history/billing-periods'].get
  update:
    x-apievangelist-phrasing:
      intent: List billing periods processed for a connector
      effect: read
      questions:
      - Which billing months have data jobs run for a given cost connector?
      - Can I see billing periods for one job kind on a connector?
      instructions:
      - text: List billing periods for connector {connector} and job kind {kind}.
        slots:
          connector: query.connectorId
          kind: query.jobKind
      - text: Show billing months processed by {kind} jobs on connector {connector} for Azure cost type {cost_type}.
        slots:
          kind: query.jobKind
          connector: query.connectorId
          cost_type: query.azureCostType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/data-job-status/history/execution-months'].get
  update:
    x-apievangelist-phrasing:
      intent: List months a connector's data jobs ran
      effect: read
      questions:
      - In which months did data jobs actually execute for a connector?
      - Can I get the execution months for one job kind, newest first?
      instructions:
      - text: List execution months for connector {connector} and job kind {kind}.
        slots:
          connector: query.connectorId
          kind: query.jobKind
      - text: Show when {kind} jobs ran on connector {connector}, by month.
        slots:
          kind: query.jobKind
          connector: query.connectorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/data-job-status/job-kinds'].get
  update:
    x-apievangelist-phrasing:
      intent: List data job kinds on the account
      effect: read
      questions:
      - What kinds of cost data jobs run on my account?
      - Which job kinds can I filter the data job history by?
      instructions:
      - text: List the distinct data job kinds for my account.
      - text: Show which types of cost data jobs exist.
      - text: List data job kinds for account {account}.
        slots:
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/data-job-status/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connector's data job execution history
      effect: read
      questions:
      - What happened in each run of a connector's data job during a month?
      - Can I narrow a job's run history to a single billing period?
      instructions:
      - text: Show {kind} job history for connector {connector} executed in {month}.
        slots:
          kind: query.jobKind
          connector: query.connectorId
          month: query.executionMonth
      - text: Get runs of {kind} on connector {connector} in {month} for billing period {period}.
        slots:
          kind: query.jobKind
          connector: query.connectorId
          month: query.executionMonth
          period: query.billingPeriodMonth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/data-job-status/details/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data job's latest run details
      effect: read
      questions:
      - What were the state transitions in the latest attempt of a data job?
      - How do I see why one specific data job failed?
      instructions:
      - text: Get the details of data job {job_id}.
        slots:
          job_id: path.jobId
      - text: Show the latest attempt and its state changes for job {job_id}.
        slots:
          job_id: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/data-job-status/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the data jobs dashboard summary
      effect: read
      questions:
      - How many cost data jobs are active or need attention right now?
      - What is the average duration of data jobs completed today?
      instructions:
      - text: Show the data jobs dashboard stats.
      - text: Summarize active, failing and completed data jobs for today.
      - text: Show today's data job dashboard for account {account}.
        slots:
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/data-job-status/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List data jobs with filters
      effect: read
      questions:
      - Which cost data jobs are currently failing?
      - Can I list data jobs for one connector and job kind?
      instructions:
      - text: List data jobs with status {status}.
        slots:
          status: requestBody.status
      - text: List {kind} data jobs for connector {connector}, page {page}.
        slots:
          kind: requestBody.jobKind
          connector: requestBody.connectorName
          page: requestBody.page
      method: generated
      generated: '2026-09-26'