Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Overrides API

12 actions 12 updates phrasing extends openapi/harness-overrides-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 12

$.info
$.paths['/ng/api/overrides'].put
$.paths['/ng/api/overrides'].post
$.paths['/ng/api/overrides/{identifier}'].get
$.paths['/ng/api/overrides/{identifier}'].delete
$.paths['/ng/api/overrides/move-config'].post
$.paths['/ng/api/overrides/update-git-metadata'].put
$.paths['/sto/api/v2/overrides'].get
$.paths['/sto/api/v2/overrides'].post
$.paths['/sto/api/v2/overrides/{id}'].get
$.paths['/sto/api/v2/overrides/{id}'].put
$.paths['/sto/api/v2/overrides/{id}'].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 Overrides API
  version: 1.0.0
extends: openapi/harness-overrides-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['/ng/api/overrides'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a service or environment override
      effect: write
      questions:
      - How do I change the values in an existing environment or service override?
      - Can I edit the YAML of an infrastructure-specific deployment override?
      instructions:
      - text: 'Update the {type} override for environment {environment} with this YAML: {yaml}.'
        slots:
          type: requestBody.type
          environment: requestBody.environmentRef
          yaml: requestBody.yaml
      - text: Change the existing {type} override on environment {environment} for service {service}.
        slots:
          type: requestBody.type
          environment: requestBody.environmentRef
          service: requestBody.serviceRef
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/overrides'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service or environment override
      effect: write
      questions:
      - How do I override variables or manifests for one service in a specific environment?
      - Can I create a deployment override that applies only to a single infrastructure?
      instructions:
      - text: Create a new {type} override for service {service} in environment {environment}.
        slots:
          type: requestBody.type
          service: requestBody.serviceRef
          environment: requestBody.environmentRef
      - text: Add a {type} override for infrastructure {infra} in environment {environment}.
        slots:
          type: requestBody.type
          infra: requestBody.infraIdentifier
          environment: requestBody.environmentRef
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/overrides/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment override by identifier
      effect: read
      questions:
      - What values does a particular service or environment override set?
      - Can I read a deployment override's YAML by its identifier?
      instructions:
      - text: Get deployment override {identifier} in account {account}.
        slots:
          identifier: path.identifier
          account: query.accountIdentifier
      - text: Show the YAML of environment override {identifier} in project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/overrides/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deployment override
      effect: destructive
      questions:
      - How do I remove a service or environment override so defaults apply again?
      - Can I delete a deployment override at org or project scope?
      instructions:
      - text: Delete deployment override {identifier} in account {account}.
        slots:
          identifier: path.identifier
          account: query.accountIdentifier
      - text: Remove the environment override {identifier} from project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/overrides/move-config'].post
  update:
    x-apievangelist-phrasing:
      intent: Move an override between inline and Git storage
      effect: write
      questions:
      - Can I move an override's YAML out of Harness and into a Git repo?
      - How do I bring a remote override stored in Git back inline?
      instructions:
      - text: Move override {identifier} to remote Git repo {repo} at {file_path} on branch {branch}.
        slots:
          identifier: query.identifier
          repo: query.repoName
          file_path: query.filePath
          branch: query.branch
      - text: Move override {identifier} with move type {move_type}.
        slots:
          identifier: query.identifier
          move_type: query.moveConfigType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/overrides/update-git-metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Update Git metadata of a remote override
      effect: write
      questions:
      - If I moved an override's file in Git, how do I update the path Harness points to?
      - Can I change the connector or repo recorded for a remote override?
      instructions:
      - text: Update remote override {identifier} to point at {file_path} in repo {repo}.
        slots:
          identifier: query.identifier
          file_path: query.filePath
          repo: query.repoName
      - text: Set Git connector {connector} on remote override {identifier}.
        slots:
          connector: query.connectorRef
          identifier: query.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/overrides'].get
  update:
    x-apievangelist-phrasing:
      intent: List security issue overrides
      effect: read
      questions:
      - Which security scan findings have had their severity or status overridden in STO?
      - Can I list security test overrides for one project?
      instructions:
      - text: List STO issue overrides in account {account}.
        slots:
          account: query.accountId
      - text: Show security issue overrides for project {project} in org {org}, account {account}.
        slots:
          project: query.projectId
          org: query.orgId
          account: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/overrides'].post
  update:
    x-apievangelist-phrasing:
      intent: Override a field on a security issue
      effect: write
      questions:
      - How do I change the severity of a security finding STO reported, with a reason?
      - Can a security issue override also apply to future occurrences of the same issue?
      instructions:
      - text: Override {field} to {value} on security issue {issue} because {reason}, requested by {requester}.
        slots:
          field: requestBody.overrideFieldName
          value: requestBody.overrideFieldValue
          issue: requestBody.issueId
          reason: requestBody.reason
          requester: requestBody.requesterId
      - text: In project {project}, set issue {issue}'s {field} to {value} with reason {reason} for requester {requester}.
        slots:
          project: query.projectId
          issue: requestBody.issueId
          field: requestBody.overrideFieldName
          value: requestBody.overrideFieldValue
          reason: requestBody.reason
          requester: requestBody.requesterId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/overrides/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a security issue override
      effect: read
      questions:
      - Who overrode this security finding, and what reason did they give?
      - Can I look up a single STO override by its ID?
      instructions:
      - text: Get security issue override {id} in account {account}.
        slots:
          id: path.id
          account: query.accountId
      - text: Show the reason and requester on STO override {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/overrides/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a security issue override
      effect: write
      questions:
      - Can I change the new severity value on a security override I already made?
      - How do I update the reason on an existing STO override?
      instructions:
      - text: Change STO override {id} so {field} is {value}, reason {reason}, requested by {requester}.
        slots:
          id: path.id
          field: requestBody.overrideFieldName
          value: requestBody.overrideFieldValue
          reason: requestBody.reason
          requester: requestBody.requesterId
      - text: Update the {field} value on security override {id} to {value} because {reason}; requester {requester}.
        slots:
          field: requestBody.overrideFieldName
          id: path.id
          value: requestBody.overrideFieldValue
          reason: requestBody.reason
          requester: requestBody.requesterId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/overrides/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a security issue override
      effect: destructive
      questions:
      - How do I undo a security finding override so the original value shows again?
      - Which field name do I need to supply to delete an STO override?
      instructions:
      - text: Delete STO override {id} for field {field} in account {account}.
        slots:
          id: path.id
          field: requestBody.overrideFieldName
          account: query.accountId
      - text: Remove the {field} override {id} from the security issue.
        slots:
          field: requestBody.overrideFieldName
          id: path.id
      method: generated
      generated: '2026-09-26'