# 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 Executions API
  version: 1.0.0
extends: openapi/harness-orchestration-executions-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: 19
- target: $.paths['/rmg/api/orchestration/execution/startRelease/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start executing a release
      effect: write
      questions:
      - How do I kick off a release in Harness release orchestration?
      - Can I pass release input YAML when starting a release execution?
      instructions:
      - text: Start release {id} with input YAML {input_yaml}.
        slots:
          id: path.id
          input_yaml: requestBody.releaseInputYaml
      - text: Begin executing release {id} in project {project}.
        slots:
          id: path.id
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/{releaseId}/phases'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the phases of a release
      effect: read
      questions:
      - What phases make up a release and what YAML configures each one?
      - Can I filter a release's phases by status?
      instructions:
      - text: List the phases of release {release_id}.
        slots:
          release_id: path.releaseId
      - text: Show release {release_id}'s phases with status {status}.
        slots:
          release_id: path.releaseId
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/{releaseId}/phase/{phaseIdentifier}/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the activities in a release phase
      effect: read
      questions:
      - Which activities run inside a given phase of my release?
      - Can I narrow a phase's activity list to only failed ones?
      instructions:
      - text: List the activities in phase {phase} of release {release_id}.
        slots:
          phase: path.phaseIdentifier
          release_id: path.releaseId
      - text: Show activities with status {status} in phase {phase} of release {release_id}.
        slots:
          status: query.status
          phase: path.phaseIdentifier
          release_id: path.releaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tasks of a release activity
      effect: read
      questions:
      - What tasks sit under a particular activity in a release phase?
      - Can I see the individual tasks a release activity broke into?
      instructions:
      - text: List the tasks for activity {activity} in phase {phase} of release {release_id}.
        slots:
          activity: path.activityIdentifier
          phase: path.phaseIdentifier
          release_id: path.releaseId
      - text: Show tasks of activity execution {activity_execution_id} under activity {activity}, phase {phase}, release {release_id}.
        slots:
          activity_execution_id: query.activityExecutionId
          activity: path.activityIdentifier
          phase: path.phaseIdentifier
          release_id: path.releaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/release/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}/retry-history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the retry history of a release activity
      effect: read
      questions:
      - How many times was a release activity retried, and what happened each time?
      - Can I page through the retry attempts of one activity in a release?
      instructions:
      - text: Show the retry history of activity {activity} in phase {phase} of release {release_id}.
        slots:
          activity: path.activityIdentifier
          phase: path.phaseIdentifier
          release_id: path.releaseId
      - text: List retries up to index {max_retry} for activity {activity}, phase {phase}, release {release_id}.
        slots:
          max_retry: query.maxRetryIndex
          activity: path.activityIdentifier
          phase: path.phaseIdentifier
          release_id: path.releaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/activity/{activityId}/input'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the input values of an activity execution
      effect: read
      questions:
      - What inputs were given to a specific activity execution?
      - Where can I check the values an activity execution started with?
      instructions:
      - text: Show the inputs for activity execution {activity_id}.
        slots:
          activity_id: path.activityId
      - text: Get input values used by activity run {activity_id}.
        slots:
          activity_id: path.activityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/release/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full details of a release activity execution
      effect: read
      questions:
      - Can I see the YAML and pipeline execution details behind one release activity?
      - What details are recorded for a specific retry of a release activity?
      instructions:
      - text: Get details of activity {activity} in phase {phase} of release {release_id}.
        slots:
          activity: path.activityIdentifier
          phase: path.phaseIdentifier
          release_id: path.releaseId
      - text: Show retry {retry_index} of activity {activity}, phase {phase}, release {release_id}.
        slots:
          retry_index: query.retryIndex
          activity: path.activityIdentifier
          phase: path.phaseIdentifier
          release_id: path.releaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/release/{releaseId}/phase/{phaseIdentifier}/output'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the outputs of a release phase
      effect: read
      questions:
      - What output values did a release phase produce?
      - Can I read the outputs of one particular phase execution?
      instructions:
      - text: Show the outputs of phase {phase} in release {release_id}.
        slots:
          phase: path.phaseIdentifier
          release_id: path.releaseId
      - text: Get outputs from phase execution {phase_execution_id} of phase {phase}, release {release_id}.
        slots:
          phase_execution_id: query.phaseExecutionId
          phase: path.phaseIdentifier
          release_id: path.releaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/release/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}/output'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the outputs of a release activity
      effect: read
      questions:
      - Which output values did an individual release activity emit?
      - Can I fetch outputs for one activity rather than the whole phase?
      instructions:
      - text: Read what single activity {activity} emitted as output under phase {phase}, release {release_id}.
        slots:
          activity: path.activityIdentifier
          phase: path.phaseIdentifier
          release_id: path.releaseId
      - text: Get activity outputs for execution {activity_execution_id} of {activity} in phase {phase}, release {release_id}.
        slots:
          activity_execution_id: query.activityExecutionId
          activity: path.activityIdentifier
          phase: path.phaseIdentifier
          release_id: path.releaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/activity/{activityId}/output'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit outputs for a manual activity
      effect: write
      questions:
      - How do I unblock a manual release activity that's waiting for outputs?
      - Can I provide the output values for a manual step by API?
      instructions:
      - text: Submit outputs {outputs} for manual activity {activity_id}.
        slots:
          outputs: requestBody.outputs
          activity_id: path.activityId
      - text: Complete waiting activity {activity_id} by posting its outputs {outputs}.
        slots:
          activity_id: path.activityId
          outputs: requestBody.outputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/task/{taskExecutionId}/comment'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a release execution task
      effect: write
      questions:
      - Can I leave a note on a task while a release is running?
      - Is there a way to add a comment to an execution task?
      instructions:
      - text: Add comment {comment} to task {task_execution_id}.
        slots:
          comment: requestBody.comment
          task_execution_id: path.taskExecutionId
      - text: Post a new comment on execution task {task_execution_id} saying {comment}.
        slots:
          task_execution_id: path.taskExecutionId
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/task/comment/{commentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a release task
      effect: write
      questions:
      - Can I edit a comment I already posted on a release task?
      - How would I correct a typo in an existing task comment?
      instructions:
      - text: Change task comment {comment_id} to read {comment}.
        slots:
          comment_id: path.commentId
          comment: requestBody.comment
      - text: Edit existing comment {comment_id} with the text {comment}.
        slots:
          comment_id: path.commentId
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/task/comment/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment from a release task
      effect: destructive
      questions:
      - Can I remove a comment that was posted on an execution task?
      - Is deleting a task comment permanent?
      instructions:
      - text: Delete task comment {comment_id}.
        slots:
          comment_id: path.commentId
      - text: Remove comment {comment_id} from its execution task.
        slots:
          comment_id: path.commentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/task/{taskExecutionId}/comment/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: List the comments on a release task
      effect: read
      questions:
      - What comments have people left on an execution task?
      - Can I page through a task's comments with a cursor?
      instructions:
      - text: List the comments on task {task_execution_id}.
        slots:
          task_execution_id: path.taskExecutionId
      - text: Show the next {limit} comments on task {task_execution_id} after cursor {cursor}.
        slots:
          limit: query.limit
          task_execution_id: path.taskExecutionId
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/task/{taskExecutionId}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the status of a release task
      effect: write
      questions:
      - Can I mark a release execution task as done by API?
      - What status values can I set on an execution task?
      instructions:
      - text: Set the status of task {task_execution_id} to {status}.
        slots:
          task_execution_id: path.taskExecutionId
          status: requestBody.status
      - text: Mark execution task {task_execution_id} as {status}.
        slots:
          task_execution_id: path.taskExecutionId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/task/{taskExecutionId}/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or re-describe a release task
      effect: write
      questions:
      - Can I change the name of an execution task after the release has started?
      - Is it possible to update a task's description during a release?
      instructions:
      - text: Rename task {task_execution_id} to {name}.
        slots:
          task_execution_id: path.taskExecutionId
          name: requestBody.name
      - text: Set the description of execution task {task_execution_id} to {description}.
        slots:
          task_execution_id: path.taskExecutionId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/{entityType}/events/{entityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List events for a release entity
      effect: read
      questions:
      - What events have been recorded for a given release, phase or task?
      - Can I filter an entity's event history by event type?
      instructions:
      - text: Show the latest events for {entity_type} {entity_id}.
        slots:
          entity_type: path.entityType
          entity_id: path.entityId
      - text: List {event_type} events on {entity_type} {entity_id}.
        slots:
          event_type: query.eventType
          entity_type: path.entityType
          entity_id: path.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/release/{releaseId}/execution/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a release's activities with filters
      effect: read
      questions:
      - Can I page through every activity in a release sorted by start time?
      - Which activities in a release are assigned to a particular user?
      - Is there a way to filter release activities by type and time window?
      instructions:
      - text: Page through all activities of release {release_id} with status {status}.
        slots:
          release_id: path.releaseId
          status: query.status
      - text: Find activities in release {release_id} assigned to user {user}.
        slots:
          release_id: path.releaseId
          user: query.taskUserReferenceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/orchestration/execution/releaseInput/{releaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest input for a release
      effect: read
      questions:
      - What input YAML was most recently supplied for a release?
      - Where do I see the current release input values?
      instructions:
      - text: Show the latest release input for release {release_id}.
        slots:
          release_id: path.releaseId
      - text: Get the current input YAML of release {release_id}.
        slots:
          release_id: path.releaseId
      method: generated
      generated: '2026-09-26'