Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness AutoStopping Rules API

14 actions 14 updates phrasing extends openapi/harness-autostopping-rules-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['/gateway/lw/api/accounts/{account_id}/autostopping/rules'].get
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules'].post
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}'].get
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}'].delete
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/health'].get
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/savings'].get
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/resources'].get
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/diagnostics'].get
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/warmup'].post
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown'].post
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown_meta'].get
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/savings/cumulative'].get
$.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/toggle_state'].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 AutoStopping Rules API
  version: 1.0.0
extends: openapi/harness-autostopping-rules-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['/gateway/lw/api/accounts/{account_id}/autostopping/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List AutoStopping rules
      effect: read
      questions:
      - Which AutoStopping rules do I have set up to shut down idle cloud resources?
      - Can I list only the rules running in dry-run mode?
      instructions:
      - text: List the AutoStopping rules in account {account}.
        slots:
          account: path.account_id
      - text: Show dry-run AutoStopping rules in account {account}.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AutoStopping rule
      effect: write
      questions:
      - How do I create a rule that stops idle cloud VMs automatically?
      - Can a new AutoStopping rule be applied immediately and depend on other rules?
      instructions:
      - text: Create an AutoStopping rule in account {account} for service {service}.
        slots:
          account: path.account_id
          service: requestBody.service
      - text: Add a new AutoStopping rule in {account} with dependencies {deps} and apply it now.
        slots:
          account: path.account_id
          deps: requestBody.deps
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AutoStopping rule's configuration
      effect: read
      questions:
      - What idle time and resources are configured on a particular AutoStopping rule?
      - Can I see the full setup of one AutoStopping rule?
      instructions:
      - text: Get AutoStopping rule {rule} in account {account}.
        slots:
          rule: path.rule_id
          account: path.account_id
      - text: Show the configuration of AutoStopping rule {rule}.
        slots:
          rule: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AutoStopping rule
      effect: destructive
      questions:
      - How do I permanently remove an AutoStopping rule?
      - Can a deleted AutoStopping rule be recovered afterwards?
      instructions:
      - text: Delete AutoStopping rule {rule} from account {account}.
        slots:
          rule: path.rule_id
          account: path.account_id
      - text: Permanently remove AutoStopping rule {rule}.
        slots:
          rule: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an AutoStopping rule's health
      effect: read
      questions:
      - Is my AutoStopping rule healthy and operating right now?
      - What is the current operational status of an AutoStopping rule?
      instructions:
      - text: Check the health of AutoStopping rule {rule} in account {account}.
        slots:
          rule: path.rule_id
          account: path.account_id
      - text: Report whether AutoStopping rule {rule} is healthy.
        slots:
          rule: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/savings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get daily savings from one AutoStopping rule
      effect: read
      questions:
      - How much money has one AutoStopping rule saved each day?
      - What were the savings from a specific rule over last month?
      instructions:
      - text: Show daily savings for AutoStopping rule {rule} in account {account}.
        slots:
          rule: path.rule_id
          account: path.account_id
      - text: Get savings for rule {rule} from {from} to {to}.
        slots:
          rule: path.rule_id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List resources managed by an AutoStopping rule
      effect: read
      questions:
      - Which cloud resources does this AutoStopping rule control?
      - Can I see a rule's managed instances in one region of a cloud account?
      instructions:
      - text: List resources for AutoStopping rule {rule} in cloud account {cloud_account} region {region}.
        slots:
          rule: path.rule_id
          cloud_account: query.cloud_account_id
          region: query.region
      - text: Show what AutoStopping rule {rule} in account {account} manages in {region}.
        slots:
          rule: path.rule_id
          account: path.account_id
          region: query.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/diagnostics'].get
  update:
    x-apievangelist-phrasing:
      intent: Run diagnostics on an AutoStopping rule
      effect: read
      questions:
      - Why isn't my AutoStopping rule stopping resources as expected?
      - Can I get diagnostic results to troubleshoot an AutoStopping rule?
      instructions:
      - text: Get diagnostics for AutoStopping rule {rule} in account {account}.
        slots:
          rule: path.rule_id
          account: path.account_id
      - text: Troubleshoot AutoStopping rule {rule} with its diagnostics.
        slots:
          rule: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/warmup'].post
  update:
    x-apievangelist-phrasing:
      intent: Start resources behind an AutoStopping rule
      effect: write
      questions:
      - How do I bring idle resources back online immediately without waiting for traffic?
      - Can I warm up a rule's resources and set a custom idle time?
      instructions:
      - text: Warm up AutoStopping rule {rule} in account {account}.
        slots:
          rule: path.rule_id
          account: path.account_id
      - text: Start the resources of rule {rule} with an idle time of {minutes} minutes.
        slots:
          rule: path.rule_id
          minutes: requestBody.idle_time_mins
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop resources behind an AutoStopping rule now
      effect: write
      questions:
      - How do I shut down a rule's resources right away to save cost?
      - Can I force a cool down on an AutoStopping rule?
      instructions:
      - text: Cool down AutoStopping rule {rule} in account {account}.
        slots:
          rule: path.rule_id
          account: path.account_id
      - text: Force-stop the resources managed by rule {rule} immediately.
        slots:
          rule: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown_meta'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cool down status of an AutoStopping rule
      effect: read
      questions:
      - What is the cool down configuration and status of this AutoStopping rule?
      - When did an AutoStopping rule last cool down its resources?
      instructions:
      - text: Get cool down metadata for AutoStopping rule {rule} in account {account}.
        slots:
          rule: path.rule_id
          account: path.account_id
      - text: Show the cool down status of rule {rule}.
        slots:
          rule: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/savings/cumulative'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total savings across AutoStopping rules
      effect: read
      questions:
      - How much have all my AutoStopping rules saved in total?
      - What are the cumulative savings from AutoStopping for the account?
      instructions:
      - text: Show cumulative AutoStopping savings for account {account}.
        slots:
          account: path.account_id
      - text: Total up the savings from every AutoStopping rule in {account}.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/toggle_state'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable an AutoStopping rule
      effect: write
      questions:
      - How do I temporarily turn off an AutoStopping rule without deleting it?
      - Can I re-enable an AutoStopping rule I disabled?
      instructions:
      - text: Set disable to {disable} on AutoStopping rule {rule} in account {account}.
        slots:
          disable: query.disable
          rule: path.rule_id
          account: path.account_id
      - text: Disable AutoStopping rule {rule} in {account}.
        slots:
          rule: path.rule_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'