Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Orchestration Processes API

12 actions 12 updates phrasing extends openapi/harness-orchestration-processes-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['/rmg/api/orchestration/process'].post
$.paths['/rmg/api/orchestration/process/summary'].get
$.paths['/rmg/api/orchestration/process/{identifier}'].get
$.paths['/rmg/api/orchestration/process/{identifier}'].put
$.paths['/rmg/api/orchestration/process/{identifier}'].delete
$.paths['/rmg/api/orchestration/process/{identifier}/input'].post
$.paths['/rmg/api/orchestration/process/{processIdentifier}/input/{identifier}'].get
$.paths['/rmg/api/orchestration/process/{processIdentifier}/input/{identifier}'].put
$.paths['/rmg/api/orchestration/process/{processIdentifier}/input/{identifier}'].delete
$.paths['/rmg/api/orchestration/process/{processIdentifier}/input/summary'].get
$.paths['/rmg/api/orchestration/process/{identifier}/attachedReleaseGroups'].post

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 Orchestration Processes API
  version: 1.0.0
extends: openapi/harness-orchestration-processes-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['/rmg/api/orchestration/process'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a release orchestration process
      effect: write
      questions:
      - How do I define a new release orchestration process from YAML?
      - Can I create an orchestration process inside a specific project?
      instructions:
      - text: 'Create an orchestration process from this YAML: {yaml}'
        slots:
          yaml: requestBody.yaml
      - text: Add a new orchestration process to project {project} using YAML {yaml}.
        slots:
          project: query.projectIdentifier
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/process/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: List orchestration processes
      effect: read
      questions:
      - Which release orchestration processes exist in my project?
      - Can I search orchestration processes by name and sort the results?
      instructions:
      - text: List orchestration processes in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Find orchestration processes matching {term}.
        slots:
          term: query.searchTerm
      - text: Show every orchestration process for account {account}.
        slots:
          account: header.Harness-Account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/process/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an orchestration process
      effect: read
      questions:
      - What does a particular orchestration process definition look like?
      - Can I fetch one release process by its identifier?
      instructions:
      - text: Get orchestration process {identifier}.
        slots:
          identifier: path.identifier
      - text: Show the YAML of orchestration process {identifier} in project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/process/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an orchestration process
      effect: write
      questions:
      - How do I change the steps of an existing orchestration process?
      - Can I replace a release process definition with new YAML?
      instructions:
      - text: Update orchestration process {identifier} with YAML {yaml}.
        slots:
          identifier: path.identifier
          yaml: requestBody.yaml
      - text: 'Replace the definition of process {identifier} with this YAML: {yaml}'
        slots:
          identifier: path.identifier
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/process/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an orchestration process
      effect: destructive
      questions:
      - How do I remove an orchestration process I no longer need?
      - Can I delete a release process from a specific project?
      instructions:
      - text: Delete orchestration process {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove process {identifier} from project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/process/{identifier}/input'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an input set to an orchestration process
      effect: write
      questions:
      - How do I create an input set for an orchestration process?
      - Can I save reusable inputs for a release process as YAML?
      instructions:
      - text: Create an input for orchestration process {identifier} from YAML {yaml}.
        slots:
          identifier: path.identifier
          yaml: requestBody.yaml
      - text: Save new process inputs {yaml} on process {identifier}.
        slots:
          yaml: requestBody.yaml
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/process/{processIdentifier}/input/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an orchestration process input
      effect: read
      questions:
      - What values are stored in a specific input of an orchestration process?
      - Can I read one saved input set by its identifier?
      instructions:
      - text: Get input {input} of orchestration process {process}.
        slots:
          input: path.identifier
          process: path.processIdentifier
      - text: Show the YAML for process {process} input {input}.
        slots:
          process: path.processIdentifier
          input: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/process/{processIdentifier}/input/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an orchestration process input
      effect: write
      questions:
      - How do I edit the values in an existing process input set?
      - Can I overwrite a saved orchestration input with new YAML?
      instructions:
      - text: Update input {input} of process {process} with YAML {yaml}.
        slots:
          input: path.identifier
          process: path.processIdentifier
          yaml: requestBody.yaml
      - text: Overwrite orchestration input {input} on {process} using {yaml}.
        slots:
          input: path.identifier
          process: path.processIdentifier
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/process/{processIdentifier}/input/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an orchestration process input
      effect: destructive
      questions:
      - How do I delete a saved input set from an orchestration process?
      - Can I remove one process input without touching the process itself?
      instructions:
      - text: Delete input {input} from orchestration process {process}.
        slots:
          input: path.identifier
          process: path.processIdentifier
      - text: Remove saved inputs {input} of process {process}.
        slots:
          input: path.identifier
          process: path.processIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/process/{processIdentifier}/input/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: List inputs of an orchestration process
      effect: read
      questions:
      - Which input sets have been saved for this orchestration process?
      - Can I search a process's inputs and page through them?
      instructions:
      - text: List the inputs of orchestration process {process}.
        slots:
          process: path.processIdentifier
      - text: Find inputs on process {process} matching {term}.
        slots:
          process: path.processIdentifier
          term: query.searchTerm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/process/{identifier}/attachedReleaseGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: List release groups attached to a process
      effect: read
      questions:
      - Which release groups use this orchestration process?
      - Can I filter a process's attached release groups by org or project?
      instructions:
      - text: List release groups attached to orchestration process {identifier}.
        slots:
          identifier: path.identifier
      - text: Show release groups using process {identifier} in project {filter_project}.
        slots:
          identifier: path.identifier
          filter_project: requestBody.filterProjectIdentifier
      method: generated
      generated: '2026-09-26'