Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Delegate Setup Resource API

9 actions 9 updates phrasing extends openapi/harness-delegate-setup-resource-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 9

$.info
$.paths['/ng/api/delegate-setup/delegate/{delegateIdentifier}'].delete
$.paths['/ng/api/delegate-setup/delete-delegate-override'].delete
$.paths['/ng/api/delegate-setup/delegate-terraform-module-file'].get
$.paths['/ng/api/delegate-setup/generate-helm-values'].post
$.paths['/ng/api/delegate-setup/override-delegate-tag'].get
$.paths['/ng/api/delegate-setup/override-delegate-tag'].put
$.paths['/ng/api/delegate-setup/listDelegates'].post
$.paths['/ng/api/delegate-setup/latest-supported-version'].get

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 Delegate Setup Resource API
  version: 1.0.0
extends: openapi/harness-delegate-setup-resource-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: 8
- target: $.paths['/ng/api/delegate-setup/delegate/{delegateIdentifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a delegate
      effect: destructive
      questions:
      - How do I remove a delegate we've decommissioned?
      - Can I delete a delegate that belongs to a specific project?
      instructions:
      - text: Delete delegate {delegateIdentifier}.
        slots:
          delegateIdentifier: path.delegateIdentifier
      - text: Remove delegate {delegateIdentifier} from project {projectIdentifier}.
        slots:
          delegateIdentifier: path.delegateIdentifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/delegate-setup/delete-delegate-override'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a delegate image tag override
      effect: destructive
      questions:
      - Can I drop the pinned image tag so delegates go back to the default version?
      - Is it possible to clear an image override only for delegates with certain tags?
      instructions:
      - text: Delete the delegate image tag override for my account.
      - text: Remove the image tag override for delegates tagged {tags}.
        slots:
          tags: query.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/delegate-setup/delegate-terraform-module-file'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Terraform example for installing delegates
      effect: read
      questions:
      - Is there a Terraform module example I can use to install a delegate?
      - Can I download delegate install Terraform for a specific project?
      instructions:
      - text: Generate the delegate Terraform example module for my account.
      - text: Get the delegate Terraform module file for project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/delegate-setup/generate-helm-values'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate Helm values for a delegate install
      effect: read
      questions:
      - What Helm values file do I need to install a delegate on Kubernetes?
      - Can Harness produce a values.yaml for a delegate of a given size?
      instructions:
      - text: Generate a Helm values file for delegate {name} of type {delegateType}.
        slots:
          name: requestBody.name
          delegateType: requestBody.delegateType
      - text: Create Helm values for {delegateType} delegate {name} sized {size} using token {tokenName}.
        slots:
          delegateType: requestBody.delegateType
          name: requestBody.name
          size: requestBody.size
          tokenName: requestBody.tokenName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/delegate-setup/override-delegate-tag'].get
  update:
    x-apievangelist-phrasing:
      intent: List delegate image tag overrides
      effect: read
      questions:
      - Are any delegate image versions pinned with overrides right now?
      - Which delegate image overrides apply in this org?
      instructions:
      - text: List the delegate image tag overrides in my account.
      - text: Show delegate image overrides for org {orgIdentifier}.
        slots:
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/delegate-setup/override-delegate-tag'].put
  update:
    x-apievangelist-phrasing:
      intent: Pin delegates to a specific image tag
      effect: write
      questions:
      - How can I pin delegates to a particular image version for a while?
      - Can an image override expire after a number of days or at the next release?
      instructions:
      - text: Override the delegate image tag to {delegateTag}.
        slots:
          delegateTag: query.delegateTag
      - text: Pin delegates tagged {tags} to image {delegateTag} for {validForDays} days.
        slots:
          tags: query.tags
          delegateTag: query.delegateTag
          validForDays: query.validForDays
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/delegate-setup/listDelegates'].post
  update:
    x-apievangelist-phrasing:
      intent: Search and filter delegates
      effect: read
      questions:
      - Which delegates are connected, and can I filter them by status or tag?
      - Can I find delegates whose version is out of date?
      instructions:
      - text: List delegates using filter type {filterType} with status {status}.
        slots:
          filterType: requestBody.filterType
          status: requestBody.status
      - text: Find delegates named {delegateName} with filter type {filterType}.
        slots:
          delegateName: requestBody.delegateName
          filterType: requestBody.filterType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/delegate-setup/latest-supported-version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest supported delegate version
      effect: read
      questions:
      - What is the newest delegate version I should be running?
      - How old can a delegate version be and still be supported?
      instructions:
      - text: Tell me the latest supported delegate version.
      - text: Get the newest supported delegate version for project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'