Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Rule API

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

$.info
$.paths['/ccm/api/governance/ruleClone'].post
$.paths['/ccm/api/governance/rule'].put
$.paths['/ccm/api/governance/rule'].post
$.paths['/ccm/api/governance/rule/{ruleID}'].get
$.paths['/ccm/api/governance/rule/{ruleID}'].delete
$.paths['/ccm/api/governance/enqueue'].post
$.paths['/ccm/api/governance/enqueueAdhocV2'].post
$.paths['/ccm/api/governance/rule/costCoRelationSupportedResources'].get
$.paths['/ccm/api/governance/ruleSchema'].get
$.paths['/ccm/api/governance/rule/potentialRulesForRecommendation'].get
$.paths['/ccm/api/governance/rule/list'].post
$.paths['/ccm/api/governance/governanceTargetList'].get
$.paths['/ccm/api/governance/regions'].get
$.paths['/ccm/api/governance/rule/toggleForRecommendation'].put
$.paths['/ccm/api/governance/ruleValidate'].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 API
  version: 1.0.0
extends: openapi/harness-rule-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: 15
- target: $.paths['/ccm/api/governance/ruleClone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a cloud governance rule
      effect: write
      questions:
      - Can I copy an existing governance rule to start a new one from it?
      - How do I duplicate a cloud asset governance rule?
      instructions:
      - text: Clone governance rule using clone request {clone}.
        slots:
          clone: requestBody.ruleClone
      - text: Make a copy of a governance rule in account {account} with {clone}.
        slots:
          account: query.accountIdentifier
          clone: requestBody.ruleClone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/rule'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a cloud governance rule
      effect: write
      questions:
      - How do I change the policy of an existing governance rule?
      - Can I edit a cloud governance rule's definition after creating it?
      instructions:
      - text: Update the governance rule with definition {rule}.
        slots:
          rule: requestBody.rule
      - text: Save changes to governance rule {rule} in account {account}.
        slots:
          rule: requestBody.rule
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/rule'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cloud governance rule
      effect: write
      questions:
      - Can I add a new custom rule to Cloud Asset Governance?
      - What goes into creating a governance rule for my cloud resources?
      instructions:
      - text: Create a new governance rule {rule}.
        slots:
          rule: requestBody.rule
      - text: Add governance rule {rule} to account {account}.
        slots:
          rule: requestBody.rule
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/rule/{ruleID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a governance rule by ID
      effect: read
      questions:
      - What policy does a particular governance rule enforce?
      - Can I pull up one cloud governance rule by its ID?
      instructions:
      - text: Get governance rule {rule_id}.
        slots:
          rule_id: path.ruleID
      - text: Show the definition of governance rule {rule_id}.
        slots:
          rule_id: path.ruleID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/rule/{ruleID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a governance rule
      effect: destructive
      questions:
      - How do I remove a governance rule I no longer need?
      - Can I delete a custom cloud governance rule by ID?
      instructions:
      - text: Delete governance rule {rule_id}.
        slots:
          rule_id: path.ruleID
      - text: Remove governance rule {rule_id} from account {account}.
        slots:
          rule_id: path.ruleID
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/enqueue'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue governance evaluation jobs
      effect: write
      questions:
      - How do I queue a governance rule enforcement to be evaluated against a cloud account?
      - Can I queue a governance evaluation as a dry run in a specific region?
      instructions:
      - text: Enqueue evaluation of rule enforcement {enforcement} in region {region}.
        slots:
          enforcement: requestBody.ruleEnforcementId
          region: requestBody.targetRegion
      - text: Queue rule {rule} for evaluation against {target} as dry run {dry_run}.
        slots:
          rule: requestBody.ruleId
          target: requestBody.targetAccountDetails
          dry_run: requestBody.isDryRun
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/enqueueAdhocV2'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a governance rule ad hoc
      effect: write
      questions:
      - Can I run one governance rule right now against a few cloud accounts?
      - What's the simplest way to trigger an ad hoc rule run across chosen regions?
      instructions:
      - text: Run governance rule {rule} ad hoc against accounts {accounts}.
        slots:
          rule: requestBody.ruleId
          accounts: requestBody.targetAccounts
      - text: Execute rule {rule} on accounts {accounts} in regions {regions} as a dry run {dry_run}.
        slots:
          rule: requestBody.ruleId
          accounts: requestBody.targetAccounts
          regions: requestBody.targetRegions
          dry_run: requestBody.isDryRun
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/rule/costCoRelationSupportedResources'].get
  update:
    x-apievangelist-phrasing:
      intent: List resources that support cost correlation
      effect: read
      questions:
      - Which cloud resource types can governance correlate with cost?
      - For what resources will a governance rule show cost impact?
      instructions:
      - text: List resource types that support governance cost correlation.
      - text: Show cost-correlation supported resources for account {account}.
        slots:
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/ruleSchema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Cloud Custodian rule schema
      effect: read
      questions:
      - What Cloud Custodian schema are governance rules validated against?
      - Where can I see the allowed resources and filters for writing a governance rule?
      instructions:
      - text: Get the custodian schema used for governance rule validation.
      - text: Fetch the governance rule schema for project {project}.
        slots:
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/rule/potentialRulesForRecommendation'].get
  update:
    x-apievangelist-phrasing:
      intent: List rules eligible for recommendations
      effect: read
      questions:
      - Which governance rules could I enable to generate recommendations?
      - Are there rules in my account not yet turned on for recommendations?
      instructions:
      - text: List governance rules that can be enabled for recommendations.
      - text: Show potential recommendation rules for account {account}.
        slots:
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/rule/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search governance rules
      effect: read
      questions:
      - What governance rules exist in my account?
      - Can I find governance rules whose names match a pattern?
      instructions:
      - text: List governance rules with names matching {pattern}.
        slots:
          pattern: query.RuleNamePattern
      - text: Fetch governance rules using query {query}.
        slots:
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/governanceTargetList'].get
  update:
    x-apievangelist-phrasing:
      intent: List governance-enabled cloud targets
      effect: read
      questions:
      - Which cloud accounts have governance enabled with valid permissions?
      - Can I list only the target IDs governance can act on for AWS or Azure?
      instructions:
      - text: List governance targets for cloud provider {provider}.
        slots:
          provider: query.cloudProvider
      - text: Show only target IDs for {provider} governance targets.
        slots:
          provider: query.cloudProvider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List AWS or Azure regions for governance
      effect: read
      questions:
      - Which regions can I filter governance resources by?
      - What AWS or Azure regions are available for rule targeting?
      instructions:
      - text: List governance regions for cloud provider {provider}.
        slots:
          provider: query.cloudProvider
      - text: Show the {provider} regions I can filter governance resources on.
        slots:
          provider: query.cloudProvider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/rule/toggleForRecommendation'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a rule for recommendations
      effect: write
      questions:
      - How do I turn a custom governance rule on or off for recommendations?
      - Can I scope recommendations from a rule to certain cloud accounts?
      instructions:
      - text: Set rule {rule} recommendation enabled to {enabled}.
        slots:
          rule: query.ruleId
          enabled: query.enableRuleForRecommendation
      - text: Enable rule {rule} for recommendations on cloud accounts {accounts}.
        slots:
          rule: query.ruleId
          accounts: requestBody.cloudAccountIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccm/api/governance/ruleValidate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a governance rule's syntax
      effect: read
      questions:
      - Is my governance rule YAML free of syntax errors before I save it?
      - Can I check a rule definition for mistakes without creating it?
      instructions:
      - text: Validate governance rule {rule} for syntax errors.
        slots:
          rule: requestBody.rule
      - text: Check governance rule definition {rule} before saving.
        slots:
          rule: requestBody.rule
      method: generated
      generated: '2026-09-26'