Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Rule Executions API

14 actions 14 updates phrasing extends openapi/harness-rule-executions-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 14

$.info
$.paths['/ccm/api/governance/execution/export'].post
$.paths['/ccm/api/governance/execution/list'].post
$.paths['/ccm/api/governance/execution/filter-value'].get
$.paths['/ccm/api/governance/execution/{ruleExecutionId}'].get
$.paths['/ccm/api/governance/actionedResources/{ruleExecutionId}'].get
$.paths['/ccm/api/governance/execution/details/{ruleExecutionId}'].get
$.paths['/ccm/api/governance/granularStatus/{ruleExecutionId}'].get
$.paths['/ccm/api/governance/logs/{ruleExecutionId}'].get
$.paths['/ccm/api/governance/ruleYaml/{ruleExecutionId}'].get
$.paths['/ccm/api/governance/status/{ruleExecutionId}'].get
$.paths['/ccm/api/governance/execution/ruleLastExecution'].post
$.paths['/ccm/api/governance/execution/refreshCost/{ruleExecutionId}'].get
$.paths['/ccm/api/governance/execution/filter-value/tags'].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 Rule Executions API
  version: 1.0.0
extends: openapi/harness-rule-executions-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: 13
- target: $.paths['/ccm/api/governance/execution/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export governance rule evaluation data
      effect: read
      questions:
      - Can I export my cloud governance rule evaluations for offline analysis?
      - Is it possible to include resource files, logs and rule YAML in an evaluations export?
      - Can the evaluations export come out in CSV format?
      instructions:
      - text: Export governance evaluations for account {account} matching filter {filter}.
        slots:
          account: query.accountIdentifier
          filter: requestBody.ruleExecutionFilter
      - text: Export evaluations for account {account} matching {filter} as CSV, including logs and rule YAML.
        slots:
          account: query.accountIdentifier
          filter: requestBody.ruleExecutionFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/execution/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List governance rule executions
      effect: read
      questions:
      - Which cloud governance rules have run in my Harness account recently?
      - Can I filter the list of rule executions by policy execution criteria?
      instructions:
      - text: List governance rule executions for account {account}.
        slots:
          account: query.accountIdentifier
      - text: Fetch rule executions in account {account} matching filter {filter}.
        slots:
          account: query.accountIdentifier
          filter: requestBody.policyExecutionFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/execution/filter-value'].get
  update:
    x-apievangelist-phrasing:
      intent: Get filter options for rule executions
      effect: read
      questions:
      - What values can I filter governance rule executions by?
      - Which filter choices are available for the rule execution list?
      instructions:
      - text: Get the available rule execution filter values for account {account}.
        slots:
          account: query.accountIdentifier
      - text: Show which filter options I can use on rule executions in account {account}.
        slots:
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/execution/{ruleExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one governance rule execution
      effect: read
      questions:
      - What was the outcome of a specific governance rule execution?
      - Can I look up a single rule execution by its ID?
      instructions:
      - text: Get rule execution {execution} in account {account}.
        slots:
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      - text: Show the summary of governance run {execution} of type {type} in account {account}.
        slots:
          execution: path.ruleExecutionId
          type: query.executionType
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/actionedResources/{ruleExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List resources a rule execution acted on
      effect: read
      questions:
      - Which cloud resources did a governance rule actually take action on?
      - Can I see what a rule execution changed, not just what it evaluated?
      instructions:
      - text: List the actioned resources for rule execution {execution} in account {account}.
        slots:
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      - text: Show which resources governance run {execution} took action on in account {account}.
        slots:
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/execution/details/{ruleExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get resource files or logs for a rule execution
      effect: read
      questions:
      - Can I pull the resource file for one resource in a governance run?
      - Where do I get detail files for a sub-rule within a rule execution?
      instructions:
      - text: Get the {file_type} file for rule execution {execution} in account {account}.
        slots:
          file_type: query.fileType
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      - text: Get details for resource {resource} under sub-rule {sub_rule} in rule execution {execution}, account {account}.
        slots:
          resource: query.resourceId
          sub_rule: query.subRuleName
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/granularStatus/{ruleExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-resource status for a rule execution
      effect: read
      questions:
      - What is the granular status of each resource in a governance rule run?
      - Did a particular resource pass or fail within a rule execution?
      instructions:
      - text: Get the granular status of rule execution {execution} in account {account}.
        slots:
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      - text: Show the granular status of resource {resource} in rule execution {execution}, account {account}.
        slots:
          resource: query.resourceId
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/logs/{ruleExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get logs for a rule execution
      effect: read
      questions:
      - Where can I read the logs from a governance rule execution?
      - Can I debug a failed rule run by looking at its logs?
      instructions:
      - text: Get the logs for rule execution {execution} in account {account}.
        slots:
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      - text: Show me why governance run {execution} failed by fetching its logs in account {account}.
        slots:
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/ruleYaml/{ruleExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the rule YAML used by an execution
      effect: read
      questions:
      - Which exact governance rule YAML was evaluated in a given run?
      - Can I see the policy definition that a past rule execution used?
      instructions:
      - text: Get the governance rule YAML for rule execution {execution} in account {account}.
        slots:
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      - text: Show the policy YAML that run {execution} evaluated in account {account}.
        slots:
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/status/{ruleExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the resources evaluated by a rule execution
      effect: read
      questions:
      - Which resources did a governance rule execution evaluate?
      - Can I get the status output listing resources for one rule run?
      instructions:
      - text: Get the status and evaluated resources for rule execution {execution} in account {account}.
        slots:
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      - text: List the resources evaluated in governance run {execution} of type {type} for account {account}.
        slots:
          execution: path.ruleExecutionId
          type: query.executionType
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/execution/ruleLastExecution'].post
  update:
    x-apievangelist-phrasing:
      intent: Find the last execution of given rules
      effect: read
      questions:
      - When did each of my governance rules last run?
      - Can I get the most recent execution for a list of rules at once?
      instructions:
      - text: Find the last execution for my governance rules in account {account}.
        slots:
          account: query.accountIdentifier
      - text: Show the most recent run of each rule in my list for account {account}.
        slots:
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/execution/refreshCost/{ruleExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Refresh cost figures for a rule execution
      effect: read
      questions:
      - Can I recalculate the cost impact of a governance rule execution?
      - What do I call to refresh potential savings on one rule run?
      instructions:
      - text: Refresh the cost for rule execution {execution} in account {account}.
        slots:
          execution: path.ruleExecutionId
          account: query.accountIdentifier
      - text: Recompute the savings figures for governance run {execution} of type {type} in account {account}.
        slots:
          execution: path.ruleExecutionId
          type: query.executionType
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/execution/filter-value/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Get tag values for filtering rule executions
      effect: read
      questions:
      - Which cloud resource tag values show up across my governance runs for a given tag key?
      - Can I search the values of a specific tag key across rule executions?
      instructions:
      - text: List values of tag {tag_key} for rule executions in account {account}.
        slots:
          tag_key: requestBody.tagKey
          account: query.accountIdentifier
      - text: Search tag {tag_key} values matching {search} on rule executions in account {account}.
        slots:
          tag_key: requestBody.tagKey
          search: requestBody.search
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'