Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Target Variants API

6 actions 6 updates phrasing extends openapi/harness-target-variants-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 6

$.info
$.paths['/sto/api/v2/targets/{targetId}/variants'].get
$.paths['/sto/api/v2/targets/{targetId}/variants'].post
$.paths['/sto/api/v2/targets/{targetId}/variants/{id}'].get
$.paths['/sto/api/v2/targets/{targetId}/variants/{id}'].put
$.paths['/sto/api/v2/targets/{targetId}/variants/{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 Target Variants API
  version: 1.0.0
extends: openapi/harness-target-variants-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: 5
- target: $.paths['/sto/api/v2/targets/{targetId}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List variants of a scan target
      effect: read
      questions:
      - Which variants, like branches or tags, exist for a security scan target?
      - Can I filter a scan target's variants by name?
      instructions:
      - text: List variants of scan target {target} in account {account}.
        slots:
          target: path.targetId
          account: query.accountId
      - text: Find variants named {name} on scan target {target} in account {account}.
        slots:
          name: query.name
          target: path.targetId
          account: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/targets/{targetId}/variants'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scan target variant
      effect: write
      questions:
      - How do I add a new variant to a security scan target?
      - What parameters define a scan target variant?
      instructions:
      - text: Create a variant of scan target {target} with parameters {parameters} in account {account}.
        slots:
          target: path.targetId
          parameters: requestBody.parameters
          account: query.accountId
      - text: Add variant with hash {hash} and parameters {parameters} to scan target {target}, account {account}.
        slots:
          hash: requestBody.hash
          parameters: requestBody.parameters
          target: path.targetId
          account: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/targets/{targetId}/variants/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scan target variant
      effect: read
      questions:
      - What parameters does a specific scan target variant have?
      - Can I look up a target variant by its ID?
      instructions:
      - text: Get variant {id} of scan target {target} in account {account}.
        slots:
          id: path.id
          target: path.targetId
          account: query.accountId
      - text: Show the parameters of target variant {id} on {target} for account {account}.
        slots:
          id: path.id
          target: path.targetId
          account: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/targets/{targetId}/variants/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a scan target variant
      effect: write
      questions:
      - How do I change the parameters of an existing target variant?
      - Can I update a variant's hash?
      instructions:
      - text: Update variant {id} of scan target {target} with parameters {parameters} in account {account}.
        slots:
          id: path.id
          target: path.targetId
          parameters: requestBody.parameters
          account: query.accountId
      - text: Set hash {hash} and parameters {parameters} on existing variant {id} of target {target}, account {account}.
        slots:
          hash: requestBody.hash
          parameters: requestBody.parameters
          id: path.id
          target: path.targetId
          account: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/targets/{targetId}/variants/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan target variant
      effect: destructive
      questions:
      - How do I remove a variant from a scan target?
      - Can a target variant be deleted by its ID?
      instructions:
      - text: Delete variant {id} of scan target {target} in account {account}.
        slots:
          id: path.id
          target: path.targetId
          account: query.accountId
      - text: Remove the old variant {id} from scan target {target}, account {account}.
        slots:
          id: path.id
          target: path.targetId
          account: query.accountId
      method: generated
      generated: '2026-09-26'