Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Provisioner Activities API

3 actions 3 updates phrasing extends openapi/harness-provisioner-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 3

$.info

$.paths['/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/provisioner-activities/{activity_id}/complete'].post

$.paths['/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/provisioner-activities/start'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Provisioner Activities API
  version: 1.0.0
extends: openapi/harness-provisioner-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: 2
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/provisioner-activities/{activity_id}/complete'].post
  update:
    x-apievangelist-phrasing:
      intent: Finish a provisioner activity with its result
      effect: write
      questions:
      - How does a pipeline report that a provisioning activity succeeded or failed?
      - Can I attach an error message when completing a provisioner activity?
      instructions:
      - text: Complete activity {activity_id} on workspace {workspace} in {org}/{project} with status {status}.
        slots:
          activity_id: path.activity_id
          workspace: path.workspace
          org: path.org
          project: path.project
          status: requestBody.status
      - text: Mark provisioner activity {activity_id} as {status} with error {error_message}.
        slots:
          activity_id: path.activity_id
          status: requestBody.status
          error_message: requestBody.error_message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/provisioner-activities/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a provisioner activity on a workspace
      effect: write
      questions:
      - How do I register the start of a provisioning run on an infrastructure workspace?
      - Why is the activity ID generated by the client when starting an activity?
      instructions:
      - text: Start {activity_type} activity {activity_id} with {provisioner_type} on workspace {workspace} in {org}/{project}.
        slots:
          activity_type: requestBody.activity_type
          activity_id: requestBody.activity_id
          provisioner_type: requestBody.provisioner_type
          workspace: path.workspace
          org: path.org
          project: path.project
      - text: Begin a provisioner activity {activity_id} for pipeline run {pipeline_execution_id} using {provisioner_type} {provisioner_version}.
        slots:
          activity_id: requestBody.activity_id
          pipeline_execution_id: requestBody.pipeline_execution_id
          provisioner_type: requestBody.provisioner_type
          provisioner_version: requestBody.provisioner_version
      method: generated
      generated: '2026-09-26'