Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Accounts API

8 actions 8 updates phrasing extends openapi/harness-accounts-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 8

$.info
$.paths['/ng/api/accounts/{accountIdentifier}'].get
$.paths['/ng/api/accounts/feature-flags/{accountIdentifier}'].get
$.paths['/ng/api/accounts/{accountIdentifier}/immutable-delegate-enabled'].get
$.paths['/ng/api/accounts/license/update/{accountIdentifier}'].put
$.paths['/ng/api/accounts/{accountIdentifier}/name'].put
$.paths['/ng/api/accounts/{accountIdentifier}/default-experience'].put
$.paths['/sto/api/v2/accounts/{id}/data'].delete

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 Accounts API
  version: 1.0.0
extends: openapi/harness-accounts-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: 7
- target: $.paths['/ng/api/accounts/{accountIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Harness account
      effect: read
      questions:
      - What company name, edition and status does my Harness account have?
      - Can I fetch the details of an account by its identifier?
      instructions:
      - text: Get account {account}.
        slots:
          account: path.accountIdentifier
      - text: Show the edition and account status for account {account}.
        slots:
          account: path.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/accounts/feature-flags/{accountIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: List feature flags enabled on an account
      effect: read
      questions:
      - Which feature flags are turned on for my Harness account?
      - Is a particular platform feature flag enabled for our account?
      instructions:
      - text: List enabled feature flags for account {account}.
        slots:
          account: path.accountIdentifier
      - text: Check which platform features are switched on in account {account}.
        slots:
          account: path.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/accounts/{accountIdentifier}/immutable-delegate-enabled'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if immutable delegates are enabled
      effect: read
      questions:
      - Does my account use immutable delegates?
      - Can I confirm whether immutable delegate mode is on before installing a delegate?
      instructions:
      - text: Check whether immutable delegate is enabled for account {account}.
        slots:
          account: path.accountIdentifier
      - text: Tell me if account {account} is on immutable delegates.
        slots:
          account: path.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/accounts/license/update/{accountIdentifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account's license status and type
      effect: write
      questions:
      - How do I change an account's license type and status?
      - Can I move an account to a different account type from the UI flow?
      instructions:
      - text: Update the license for account {account} to status {status} and type {type}.
        slots:
          account: path.accountIdentifier
          status: query.accountStatus
          type: query.accountType
      - text: Set account {account} license type to {type} with status {status}.
        slots:
          account: path.accountIdentifier
          type: query.accountType
          status: query.accountStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/accounts/{accountIdentifier}/name'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a Harness account
      effect: write
      questions:
      - Can I change the display name of my Harness account?
      - What's the way to rename our account after a rebrand?
      instructions:
      - text: Rename account {account} to {name}.
        slots:
          account: path.accountIdentifier
          name: requestBody.name
      - text: Change the name of account {account} to {name} after our rebrand.
        slots:
          account: path.accountIdentifier
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/accounts/{accountIdentifier}/default-experience'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an account's default experience
      effect: write
      questions:
      - How do I switch the default experience users land in for my account?
      - Can I set NextGen as the account's default experience?
      instructions:
      - text: Set the default experience of account {account} to {experience}.
        slots:
          account: path.accountIdentifier
          experience: requestBody.defaultExperience
      - text: Make {experience} the landing experience for everyone in account {account}.
        slots:
          experience: requestBody.defaultExperience
          account: path.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/accounts/{id}/data'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all security testing data for an account
      effect: destructive
      questions:
      - Can I wipe all Security Testing Orchestration data for an account?
      - Is there a way to permanently delete every piece of account data from security testing?
      instructions:
      - text: Delete all security testing data for account {id}.
        slots:
          id: path.id
      - text: Wipe every STO record belonging to account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'