Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Workspace Templates API

6 actions 6 updates phrasing extends openapi/harness-workspace-templates-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 6

$.info

$.paths['/iacm/api/orgs/{org}/projects/{project}/workspace/template/{workspace_id}/yaml-diff'].get

$.paths['/iacm/api/orgs/{org}/projects/{project}/workspace/templates'].post

$.paths['/iacm/api/orgs/{org}/projects/{project}/workspace/templates/{template_id}'].get

$.paths['/iacm/api/orgs/{org}/projects/{project}/workspace/templates/{template_id}/{workspace_id}'].put

$.paths['/iacm/api/orgs/{org}/projects/{project}/workspace/templates/{template_id}/{workspace_id}'].delete

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 Workspace Templates API
  version: 1.0.0
extends: openapi/harness-workspace-templates-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: 5
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/workspace/template/{workspace_id}/yaml-diff'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview a workspace's template reconciliation diff
      effect: read
      questions:
      - What would change in my workspace YAML if I reconcile it with its template?
      - Can I see a diff between a workspace and its template before syncing?
      instructions:
      - text: Show the template reconciliation diff for workspace {workspace_id} in project {project} of org {org}.
        slots:
          workspace_id: path.workspace_id
          project: path.project
          org: path.org
      - text: Preview the YAML diff for reconciling workspace {workspace_id} with its template.
        slots:
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/workspace/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a workspace to a template version
      effect: write
      questions:
      - How do I associate a workspace with a workspace template?
      - Can I pin a workspace to a specific template version?
      instructions:
      - text: Link workspace {workspace_id} to template {template_id} version {version} in project {project} of org {org}.
        slots:
          workspace_id: requestBody.workspace_id
          template_id: requestBody.template_id
          version: requestBody.version
          project: path.project
          org: path.org
      - text: Associate template {template_id} at version {version} with workspace {workspace_id}.
        slots:
          template_id: requestBody.template_id
          version: requestBody.version
          workspace_id: requestBody.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/workspace/templates/{template_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's workspaces that use a template
      effect: read
      questions:
      - Which workspaces in this project are linked to a given template?
      - Can I see template usage limited to one org and project?
      instructions:
      - text: List workspaces in project {project} of org {org} linked to template {template_id}.
        slots:
          project: path.project
          org: path.org
          template_id: path.template_id
      - text: Show which workspaces in {project} use template {template_id}.
        slots:
          project: path.project
          template_id: path.template_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/workspace/templates/{template_id}/{workspace_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the template version a workspace uses
      effect: write
      questions:
      - How do I move a workspace to a newer version of its template?
      - Can I change the template version pinned on a workspace?
      instructions:
      - text: Move workspace {workspace_id} to version {version} of template {template_id} in project {project} of org {org}.
        slots:
          workspace_id: path.workspace_id
          version: requestBody.version
          template_id: path.template_id
          project: path.project
          org: path.org
      - text: Upgrade the template link for workspace {workspace_id} to {version}.
        slots:
          workspace_id: path.workspace_id
          version: requestBody.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/workspace/templates/{template_id}/{workspace_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a workspace from its template
      effect: destructive
      questions:
      - How do I detach a workspace from a template?
      - Can I remove the template association without deleting the workspace?
      instructions:
      - text: Remove the link between template {template_id} and workspace {workspace_id} in project {project} of org {org}.
        slots:
          template_id: path.template_id
          workspace_id: path.workspace_id
          project: path.project
          org: path.org
      - text: Detach workspace {workspace_id} from template {template_id}.
        slots:
          workspace_id: path.workspace_id
          template_id: path.template_id
      method: generated
      generated: '2026-09-26'