# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Commitment Orchestrator Setup APIs API
  version: 1.0.0
extends: openapi/harness-commitment-orchestrator-setup-apis-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: 11
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/setup'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up commitment orchestration for a cloud account
      effect: write
      questions:
      - How do I turn on commitment orchestration for one of my cloud accounts?
      - Can I start commitment orchestration in dry-run mode with approvals required?
      instructions:
      - text: Set up commitment orchestration for cloud account {cloudAccount} on service {service}.
        slots:
          cloudAccount: requestBody.cloud_account_id
          service: requestBody.service
      - text: Create an orchestration setup for {cloudAccount} with dry run {dryRun} and approval mode {approval}.
        slots:
          cloudAccount: requestBody.cloud_account_id
          dryRun: requestBody.dry_run_mode
          approval: requestBody.approval_mode
      - text: Enable commitment orchestration in Harness account {account} for cloud account {cloudAccount}.
        slots:
          account: path.account_id
          cloudAccount: requestBody.cloud_account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/setup/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a Savings Plans coverage target
      effect: read
      questions:
      - What are the maximum Savings Plans settings allowed for a target total coverage?
      - Can I check whether a coverage percentage is valid before saving my commitment setup?
      instructions:
      - text: Validate a total coverage of {coverage} for cloud account {cloudAccount} in account {account}.
        slots:
          coverage: requestBody.total_coverage
          cloudAccount: query.cloud_account_id
          account: path.account_id
      - text: Work out the max hourly Savings Plan commitment allowed at {coverage} coverage for {cloudAccount}.
        slots:
          coverage: requestBody.total_coverage
          cloudAccount: query.cloud_account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/setup/{cloud_account_id}/instance_types'].post
  update:
    x-apievangelist-phrasing:
      intent: List instance types in use for exclusions
      effect: read
      questions:
      - Which instance types are in use by region under my master account, so I can exclude some?
      - Can I see instance families in use across certain regions before configuring exclusions?
      instructions:
      - text: List instance types in use for master account {cloudAccount} in Harness account {account}.
        slots:
          cloudAccount: path.cloud_account_id
          account: path.account_id
      - text: Show instance types used in regions {regions} under {cloudAccount}.
        slots:
          regions: requestBody.regions
          cloudAccount: path.cloud_account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/setup/{cloudAccountID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a commitment orchestration setup
      effect: read
      questions:
      - What commitment orchestration settings are saved for a cloud account?
      - Can I see the notification settings on my orchestration setup?
      instructions:
      - text: Show the commitment orchestration setup for cloud account {cloudAccount} in account {account}.
        slots:
          cloudAccount: path.cloudAccountID
          account: path.account_id
      - text: Get the {service} orchestration setup for {cloudAccount}.
        slots:
          service: query.service
          cloudAccount: path.cloudAccountID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/setup/{cloudAccountID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a commitment orchestration setup
      effect: write
      questions:
      - Can I switch an existing commitment orchestration setup out of dry-run mode?
      - How do I change the notification settings on an orchestration setup I already have?
      instructions:
      - text: Update the orchestration setup for {cloudAccount} in account {account} to dry run {dryRun}.
        slots:
          cloudAccount: path.cloudAccountID
          account: path.account_id
          dryRun: requestBody.dry_run_mode
      - text: Change the approval mode of the existing {service} setup on {cloudAccount} to {approval}.
        slots:
          service: requestBody.service
          cloudAccount: path.cloudAccountID
          approval: requestBody.approval_mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/setup/{cloudAccountID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a commitment orchestration setup
      effect: destructive
      questions:
      - How do I turn off commitment orchestration completely for a cloud account?
      - Does removing an orchestration setup also delete its notification settings?
      instructions:
      - text: Delete the commitment orchestration setup for cloud account {cloudAccount} in account {account}.
        slots:
          cloudAccount: path.cloudAccountID
          account: path.account_id
      - text: Remove the {service} orchestration setup from {cloudAccount}.
        slots:
          service: query.service
          cloudAccount: path.cloudAccountID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v2/setup/{cloudAccountID}/estimated_savings'].post
  update:
    x-apievangelist-phrasing:
      intent: Estimate savings for a target coverage
      effect: read
      questions:
      - How much would I save if I raised commitment coverage to a target percentage?
      - Can I estimate savings for specific regions and instance types at a given coverage?
      instructions:
      - text: Estimate savings at {coverage} target coverage for cloud account {cloudAccount} in account {account}.
        slots:
          coverage: requestBody.target_coverage
          cloudAccount: path.cloudAccountID
          account: path.account_id
      - text: Project savings for {cloudAccount} at {coverage} coverage in regions {regions}.
        slots:
          cloudAccount: path.cloudAccountID
          coverage: requestBody.target_coverage
          regions: requestBody.regions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v2/setup/{cloudAccountID}/cost_coverage'].post
  update:
    x-apievangelist-phrasing:
      intent: Get EC2 cost and coverage breakdown
      effect: read
      questions:
      - How much of my EC2 spend is already covered by commitments, by instance type or region?
      - What does current commitment coverage look like across my linked accounts?
      instructions:
      - text: Break down EC2 cost coverage for cloud account {cloudAccount} in account {account}.
        slots:
          cloudAccount: path.cloudAccountID
          account: path.account_id
      - text: Show current coverage for {cloudAccount} limited to linked accounts {linked}.
        slots:
          cloudAccount: path.cloudAccountID
          linked: requestBody.linked_accounts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/setup/listMasterAccounts'].post
  update:
    x-apievangelist-phrasing:
      intent: List master accounts eligible for setup
      effect: read
      questions:
      - Which master cloud accounts can I use for commitment orchestration?
      - What payer accounts are available to configure a commitment setup on?
      instructions:
      - text: List master accounts available for commitment setup in account {account}.
        slots:
          account: path.account_id
      - text: Show the payer accounts I can orchestrate commitments for in {account}.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/setup/{cloud_account_id}/child_accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List child accounts under a master account
      effect: read
      questions:
      - Which child accounts sit under a given master cloud account?
      - Can I get the names and IDs of linked accounts for one master account?
      instructions:
      - text: List child accounts of master account {cloudAccount} in Harness account {account}.
        slots:
          cloudAccount: path.cloud_account_id
          account: path.account_id
      - text: Show the linked accounts under {cloudAccount}.
        slots:
          cloudAccount: path.cloud_account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/v1/setup/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List commitment orchestration setups
      effect: read
      questions:
      - What commitment orchestration setups exist in my account?
      - Which cloud accounts already have commitment orchestration configured?
      instructions:
      - text: List all commitment orchestration setups in account {account}.
        slots:
          account: path.account_id
      - text: Show every cloud account with an orchestration setup in {account}.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-09-26'