Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Pipeline Input Set API

15 actions 15 updates phrasing extends openapi/harness-pipeline-input-set-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 15

$.info
$.paths['/pipeline/api/inputSets'].get
$.paths['/pipeline/api/inputSets'].post
$.paths['/pipeline/api/inputSets/overlay'].post
$.paths['/pipeline/api/inputSets/{inputSetIdentifier}'].get
$.paths['/pipeline/api/inputSets/{inputSetIdentifier}'].put
$.paths['/pipeline/api/inputSets/{inputSetIdentifier}'].delete
$.paths['/pipeline/api/inputSets/get/batch-input-sets-metadata'].post
$.paths['/pipeline/api/inputSets/get/bulk'].post
$.paths['/pipeline/api/inputSets/merge'].post
$.paths['/pipeline/api/inputSets/overlay/{inputSetIdentifier}'].get
$.paths['/pipeline/api/inputSets/overlay/{inputSetIdentifier}'].put
$.paths['/pipeline/api/inputSets/template'].post
$.paths['/pipeline/api/inputSets/refresh-and-get/{inputSetIdentifier}'].get
$.paths['/pipeline/api/inputSets/{inputSetIdentifier}/update-git-metadata'].put

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 Pipeline Input Set API
  version: 1.0.0
extends: openapi/harness-pipeline-input-set-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: 14
- target: $.paths['/pipeline/api/inputSets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a pipeline's input sets
      effect: read
      questions:
      - What input sets have been saved for a pipeline?
      - Can I list only overlay input sets, or search input sets by name?
      instructions:
      - text: List the input sets for pipeline {pipelineIdentifier} in project {projectIdentifier}.
        slots:
          pipelineIdentifier: query.pipelineIdentifier
          projectIdentifier: query.projectIdentifier
      - text: Show {inputSetType} input sets of pipeline {pipelineIdentifier}.
        slots:
          inputSetType: query.inputSetType
          pipelineIdentifier: query.pipelineIdentifier
      - text: Search pipeline {pipelineIdentifier}'s input sets for {searchTerm}.
        slots:
          pipelineIdentifier: query.pipelineIdentifier
          searchTerm: query.searchTerm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an input set for a pipeline
      effect: write
      questions:
      - How do I save a reusable set of runtime inputs for a pipeline?
      - Can a new input set be stored in a Git repo on a new branch?
      instructions:
      - text: Create an input set for pipeline {pipelineIdentifier} in project {projectIdentifier}.
        slots:
          pipelineIdentifier: query.pipelineIdentifier
          projectIdentifier: query.projectIdentifier
      - text: Save a new input set for pipeline {pipelineIdentifier} to {filePath} on branch {branch}.
        slots:
          pipelineIdentifier: query.pipelineIdentifier
          filePath: query.filePath
          branch: query.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/overlay'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an overlay input set
      effect: write
      questions:
      - Can I combine several input sets into one overlay input set?
      - Where would a new overlay input set be committed if I keep it in Git?
      instructions:
      - text: Create an overlay input set for pipeline {pipelineIdentifier}.
        slots:
          pipelineIdentifier: query.pipelineIdentifier
      - text: Add an overlay input set to pipeline {pipelineIdentifier} with commit message {commitMsg}.
        slots:
          pipelineIdentifier: query.pipelineIdentifier
          commitMsg: query.commitMsg
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/{inputSetIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a regular input set
      effect: read
      questions:
      - What values are stored in a particular input set?
      - Can I read an input set from a specific Git branch?
      instructions:
      - text: Show input set {inputSetIdentifier} of pipeline {pipelineIdentifier}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          pipelineIdentifier: query.pipelineIdentifier
      - text: Fetch input set {inputSetIdentifier} from branch {branch}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          branch: query.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/{inputSetIdentifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a regular input set
      effect: write
      questions:
      - How do I change the values in an existing input set?
      - Can I commit an input set update to Git with my own message?
      instructions:
      - text: Update input set {inputSetIdentifier} for pipeline {pipelineIdentifier}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          pipelineIdentifier: query.pipelineIdentifier
      - text: Save changes to input set {inputSetIdentifier} on branch {branch} with message {commitMsg}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          branch: query.branch
          commitMsg: query.commitMsg
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/{inputSetIdentifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an input set
      effect: destructive
      questions:
      - How do I delete an input set I no longer use?
      - Does deleting a Git-backed input set create a commit?
      instructions:
      - text: Delete input set {inputSetIdentifier} from pipeline {pipelineIdentifier}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          pipelineIdentifier: query.pipelineIdentifier
      - text: Remove input set {inputSetIdentifier} with commit message {commitMsg}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          commitMsg: query.commitMsg
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/get/batch-input-sets-metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: List input sets across several pipelines
      effect: read
      questions:
      - Can I see the regular input sets for many pipelines in one call?
      - Are overlay input sets included when listing input sets across pipelines?
      instructions:
      - text: List regular input sets for pipelines {pipelineIdentifiers}.
        slots:
          pipelineIdentifiers: requestBody.pipelineIdentifiers
      - text: Show every accessible input set in project {projectIdentifier}, across all pipelines.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/get/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several input sets by id
      effect: read
      questions:
      - Can I fetch a handful of input sets by their identifiers at once?
      - Will a bulk input set lookup return ones that were deleted?
      instructions:
      - text: Get input sets {inputSetIdentifiers} of pipeline {pipelineIdentifier} in one call.
        slots:
          inputSetIdentifiers: requestBody.inputSetIdentifiers
          pipelineIdentifier: query.pipelineIdentifier
      - text: Bulk fetch input sets {inputSetIdentifiers}.
        slots:
          inputSetIdentifiers: requestBody.inputSetIdentifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge input sets into one runtime YAML
      effect: read
      questions:
      - What runtime input YAML results from combining several input sets?
      - Can I preview merged input sets alongside the merged pipeline YAML?
      instructions:
      - text: Merge input sets {inputSetReferences} for pipeline {pipelineIdentifier} into one runtime input YAML.
        slots:
          inputSetReferences: requestBody.inputSetReferences
          pipelineIdentifier: query.pipelineIdentifier
      - text: Combine input sets {inputSetReferences} for stages {stageIdentifiers} only.
        slots:
          inputSetReferences: requestBody.inputSetReferences
          stageIdentifiers: requestBody.stageIdentifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/overlay/{inputSetIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an overlay input set
      effect: read
      questions:
      - Which input sets does a given overlay input set reference?
      - Can I read an overlay input set from a fallback branch?
      instructions:
      - text: Show overlay input set {inputSetIdentifier} for pipeline {pipelineIdentifier}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          pipelineIdentifier: query.pipelineIdentifier
      - text: Get overlay input set {inputSetIdentifier} from branch {branch}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          branch: query.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/overlay/{inputSetIdentifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an overlay input set
      effect: write
      questions:
      - How do I change which input sets an overlay combines?
      - Can an overlay input set edit go to a new Git branch?
      instructions:
      - text: Update overlay input set {inputSetIdentifier} of pipeline {pipelineIdentifier}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          pipelineIdentifier: query.pipelineIdentifier
      - text: Commit my overlay input set {inputSetIdentifier} changes to branch {branch}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          branch: query.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/template'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline's runtime input template
      effect: read
      questions:
      - Which runtime inputs does a pipeline expect before it can run?
      - Can I get the input template for just certain stages?
      instructions:
      - text: Get the runtime input template for pipeline {pipelineIdentifier}.
        slots:
          pipelineIdentifier: query.pipelineIdentifier
      - text: Show the runtime inputs needed by stages {stageIdentifiers} of pipeline {pipelineIdentifier}.
        slots:
          stageIdentifiers: requestBody.stageIdentifiers
          pipelineIdentifier: query.pipelineIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/refresh-and-get/{inputSetIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Refresh a remote input set from Git
      effect: read
      questions:
      - How do I force Harness to reload a Git-stored input set instead of using its cache?
      - Is a branch required when refreshing a remote input set?
      instructions:
      - text: Refresh the Git cache for input set {inputSetIdentifier} on branch {branch} and return it.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          branch: query.branch
      - text: Re-pull remote input set {inputSetIdentifier} of pipeline {pipelineIdentifier} from branch {branch}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          pipelineIdentifier: query.pipelineIdentifier
          branch: query.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/inputSets/{inputSetIdentifier}/update-git-metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a remote input set's Git location
      effect: write
      questions:
      - Can I point a remote input set at a different repo or file path?
      - What Git metadata of an input set can be changed?
      instructions:
      - text: Move input set {inputSetIdentifier}'s Git file path to {filePath}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          filePath: query.filePath
      - text: Point input set {inputSetIdentifier} at repo {repoName} via connector {connectorRef}.
        slots:
          inputSetIdentifier: path.inputSetIdentifier
          repoName: query.repoName
          connectorRef: query.connectorRef
      method: generated
      generated: '2026-09-26'