Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Rule Enforcement API

10 actions 10 updates phrasing extends openapi/harness-ruleenforcement-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 10

$.info
$.paths['/ccm/api/governance/enforcement'].put
$.paths['/ccm/api/governance/enforcement'].post
$.paths['/ccm/api/governance/enforcement/{enforcementID}'].delete
$.paths['/ccm/api/governance/enforcement/count'].post
$.paths['/ccm/api/governance/enforcement/details'].get
$.paths['/ccm/api/governance/enforcement/savings'].post
$.paths['/ccm/api/governance/enforcement/list'].get
$.paths['/ccm/api/governance/enforcement/list'].post
$.paths['/ccm/api/governance/enforcement/toggle'].put

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 Enforcement API
  version: 1.0.0
extends: openapi/harness-ruleenforcement-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: 9
- target: $.paths['/ccm/api/governance/enforcement'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a cloud governance rule enforcement
      effect: write
      questions:
      - How do I change the schedule or targets of an existing cloud governance enforcement?
      - Can I edit which rules an enforcement runs after it is created?
      instructions:
      - text: Update the rule enforcement in account {account} with {enforcement}.
        slots:
          account: query.accountIdentifier
          enforcement: requestBody.ruleEnforcement
      - text: 'Apply these changes to the existing enforcement: {enforcement}.'
        slots:
          enforcement: requestBody.ruleEnforcement
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/enforcement'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cloud governance rule enforcement
      effect: write
      questions:
      - How do I schedule a cloud asset governance rule to run automatically against my accounts?
      - Can I set up a new enforcement for a rule set in Harness CCM?
      instructions:
      - text: Create a new rule enforcement in account {account} defined as {enforcement}.
        slots:
          account: query.accountIdentifier
          enforcement: requestBody.ruleEnforcement
      - text: 'Add a scheduled governance enforcement: {enforcement}.'
        slots:
          enforcement: requestBody.ruleEnforcement
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/enforcement/{enforcementID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rule enforcement
      effect: destructive
      questions:
      - How do I permanently remove a governance enforcement?
      - Can I delete an enforcement rather than just disabling it?
      instructions:
      - text: Delete rule enforcement {enforcement}.
        slots:
          enforcement: path.enforcementID
      - text: Remove enforcement {enforcement} from account {account}.
        slots:
          enforcement: path.enforcementID
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/enforcement/count'].post
  update:
    x-apievangelist-phrasing:
      intent: Find enforcements that use given rules or rule sets
      effect: read
      questions:
      - Which enforcements use a given governance rule before I edit or delete it?
      - How many enforcements reference a particular rule set?
      instructions:
      - text: 'Find the enforcements that reference these rules or rule sets: {rules}.'
        slots:
          rules: requestBody.enforcementCount
      - text: Count enforcements per rule ID in account {account} for {rules}.
        slots:
          account: query.accountIdentifier
          rules: requestBody.enforcementCount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/enforcement/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a rule enforcement
      effect: read
      questions:
      - What rules, schedule and target accounts does a particular enforcement have?
      - Can I see the full configuration of one governance enforcement?
      instructions:
      - text: Show the details of enforcement {enforcement}.
        slots:
          enforcement: query.enforcementId
      - text: Get the configuration of rule enforcement {enforcement} in account {account}.
        slots:
          enforcement: query.enforcementId
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/enforcement/savings'].post
  update:
    x-apievangelist-phrasing:
      intent: Get savings produced by a rule enforcement
      effect: read
      questions:
      - How much money has a specific governance enforcement saved us?
      - Can I measure cost savings attributed to one enforcement?
      instructions:
      - text: Show the savings realised by enforcement {enforcement}.
        slots:
          enforcement: query.enforcementId
      - text: Get cost savings for rule enforcement {enforcement} in account {account}.
        slots:
          enforcement: query.enforcementId
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/enforcement/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List rule enforcements by keyword
      effect: read
      questions:
      - What governance enforcements exist in my account?
      - Can I search enforcements by keyword and sort the list?
      instructions:
      - text: List the rule enforcements in account {account}.
        slots:
          account: query.accountIdentifier
      - text: Search enforcements by keyword {keyword}.
        slots:
          keyword: query.searchKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/enforcement/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter rule enforcements by rule, region or status
      effect: read
      questions:
      - Which enforcements are enabled and running in dry-run mode?
      - Can I filter enforcements by target cloud accounts or regions?
      instructions:
      - text: List enforcements that target region {region}.
        slots:
          region: requestBody.targetRegions
      - text: Show enforcements that run rules {rules} against cloud accounts {accounts}.
        slots:
          rules: requestBody.ruleIds
          accounts: requestBody.targetAccounts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/enforcement/toggle'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a rule enforcement
      effect: write
      questions:
      - How do I pause a governance enforcement without deleting it?
      - Can I turn a disabled enforcement back on?
      instructions:
      - text: Disable enforcement {enforcement}.
        slots:
          enforcement: query.enforcementId
      - text: Set enforcement {enforcement} enabled to {enabled}.
        slots:
          enforcement: query.enforcementId
          enabled: query.enableEnforcement
      method: generated
      generated: '2026-09-26'