Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Orchestration Activities API

10 actions 10 updates phrasing extends openapi/harness-orchestration-activities-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 10

$.info
$.paths['/rmg/api/orchestration/activity'].post
$.paths['/rmg/api/orchestration/activity/summary'].get
$.paths['/rmg/api/orchestration/activity/{identifier}'].get
$.paths['/rmg/api/orchestration/activity/{identifier}'].put
$.paths['/rmg/api/orchestration/activity/{identifier}'].delete
$.paths['/rmg/api/orchestration/activity/{activityRef}/inputs'].get
$.paths['/rmg/api/orchestration/activity/{activityExecutionId}/onhold/action'].post
$.paths['/rmg/api/orchestration/activity/processIdentifier/{identifier}'].get
$.paths['/rmg/api/orchestration/activity/list'].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 Activities API
  version: 1.0.0
extends: openapi/harness-orchestration-activities-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: 9
- target: $.paths['/rmg/api/orchestration/activity'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a release orchestration activity
      effect: write
      questions:
      - How do I define a new orchestration activity for release management?
      - Can I create an orchestration activity from YAML?
      instructions:
      - text: Create an orchestration activity from YAML {yaml}.
        slots:
          yaml: requestBody.yaml
      - text: Add orchestration activity {yaml} to project {project}.
        slots:
          yaml: requestBody.yaml
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/activity/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: List orchestration activities
      effect: read
      questions:
      - What orchestration activities exist in my project?
      - Can I search orchestration activities by name and page through them?
      instructions:
      - text: List orchestration activities in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Search orchestration activities for {term}.
        slots:
          term: query.searchTerm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/activity/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an orchestration activity
      effect: read
      questions:
      - What is configured in a specific orchestration activity?
      - Can I look up one orchestration activity by identifier?
      instructions:
      - text: Get orchestration activity {activity}.
        slots:
          activity: path.identifier
      - text: Show the definition of orchestration activity {activity}.
        slots:
          activity: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/activity/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an orchestration activity
      effect: write
      questions:
      - How do I change the YAML of an existing orchestration activity?
      - Can I edit an orchestration activity after it's created?
      instructions:
      - text: Update orchestration activity {activity} with YAML {yaml}.
        slots:
          activity: path.identifier
          yaml: requestBody.yaml
      - text: Replace the configuration of orchestration activity {activity}.
        slots:
          activity: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/activity/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an orchestration activity
      effect: destructive
      questions:
      - How do I remove an orchestration activity I no longer need?
      - Can I delete an orchestration activity by its identifier?
      instructions:
      - text: Delete orchestration activity {activity}.
        slots:
          activity: path.identifier
      - text: Remove orchestration activity {activity} from project {project}.
        slots:
          activity: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/activity/{activityRef}/inputs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get input definitions for an activity
      effect: read
      questions:
      - What inputs does a given activity take within a process input configuration?
      - Can I see the input definitions and current values for an activity?
      instructions:
      - text: Show the inputs for activity ref {activity_ref}.
        slots:
          activity_ref: path.activityRef
      - text: Get input definitions and values of activity {activity_ref}.
        slots:
          activity_ref: path.activityRef
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/activity/{activityExecutionId}/onhold/action'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry or ignore an on-hold activity
      effect: write
      questions:
      - How do I resume an activity that is stuck on hold?
      - Can I retry an on-hold activity with different inputs, or skip it?
      instructions:
      - text: Apply action {action} to on-hold activity execution {execution}.
        slots:
          action: requestBody.action
          execution: path.activityExecutionId
      - text: Retry on-hold activity execution {execution} with inputs {inputs}.
        slots:
          execution: path.activityExecutionId
          inputs: requestBody.inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/activity/processIdentifier/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: List activities in an orchestration process
      effect: read
      questions:
      - Which activities belong to a particular release process?
      - Can I list only the activities for one phase of a process?
      instructions:
      - text: List activities for process {process}.
        slots:
          process: path.identifier
      - text: List activities in phase {phase} of process {process}.
        slots:
          phase: query.phaseIdentifier
          process: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/activity/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch orchestration activities by refs
      effect: read
      questions:
      - Can I fetch several orchestration activities at once by their refs?
      - How do I look up a batch of activities when I already know their references?
      instructions:
      - text: Get the orchestration activities with refs {refs}.
        slots:
          refs: requestBody.activityRefs
      - text: Fetch up to {limit} activities matching refs {refs}.
        slots:
          limit: query.limit
          refs: requestBody.activityRefs
      method: generated
      generated: '2026-09-26'