Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Org Template API

11 actions 11 updates phrasing extends openapi/harness-org-template-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 11

$.info
$.paths['/v1/orgs/{org}/templates/git-metadata/{template}'].put
$.paths['/v1/orgs/{org}/templates'].get
$.paths['/v1/orgs/{org}/templates'].post
$.paths['/v1/orgs/{org}/templates/{template}'].get
$.paths['/v1/orgs/{org}/templates/{template}/versions/{version}'].get
$.paths['/v1/orgs/{org}/templates/{template}/versions/{version}'].put
$.paths['/v1/orgs/{org}/templates/{template}/versions/{version}'].delete
$.paths['/v1/orgs/{org}/templates/{template}/versions/{version}/stable'].put
$.paths['/v1/orgs/{org}/templates/{template}/import'].post
$.paths['/v1/orgs/{org}/templates/{template}/versions/{version}/inputs-schema'].get

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 Org Template API
  version: 1.0.0
extends: openapi/harness-org-template-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: 10
- target: $.paths['/v1/orgs/{org}/templates/git-metadata/{template}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update Git details of an org template
      effect: write
      questions:
      - Can I update the Git metadata for all versions of an org-level template?
      - What's the call to change Git details on a template stored in my organization?
      instructions:
      - text: Update the Git details of template {template} in org {org}.
        slots:
          template: path.template
          org: path.org
      - text: Refresh Git metadata across every version of org template {template} in {org}.
        slots:
          template: path.template
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List templates in an organization
      effect: read
      questions:
      - Which pipeline templates exist at my organization level?
      - Can I filter org templates by type or search term?
      instructions:
      - text: List templates in org {org}.
        slots:
          org: path.org
      - text: Search org {org} templates of type {type} for {term}.
        slots:
          org: path.org
          type: query.type
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization-level template
      effect: write
      questions:
      - How do I create a new template shared across an organization?
      - Can I mark a newly created org template as the stable version?
      instructions:
      - text: 'Create template {name} in org {org} from this YAML: {yaml}'
        slots:
          name: requestBody.name
          org: path.org
          yaml: requestBody.template_yaml
      - text: Create org {org} template {identifier} labeled {label} as the stable version.
        slots:
          org: path.org
          identifier: requestBody.identifier
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/templates/{template}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the stable version of an org template
      effect: read
      questions:
      - What is the current stable version of an org template?
      - Can I fetch a stable org template's YAML from a specific Git branch?
      instructions:
      - text: Get the stable version of template {template} in org {org}.
        slots:
          template: path.template
          org: path.org
      - text: Get the stable org template {template} in {org} with YAML from branch {branch}.
        slots:
          template: path.template
          org: path.org
          branch: query.branch_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/templates/{template}/versions/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific version of an org template
      effect: read
      questions:
      - Can I retrieve an older version of an org-level template?
      - What does version label X of my organization template contain?
      instructions:
      - text: Get version {version} of template {template} in org {org}.
        slots:
          version: path.version
          template: path.template
          org: path.org
      - text: Show the YAML of org {org} template {template} at version {version}.
        slots:
          org: path.org
          template: path.template
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/templates/{template}/versions/{version}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a version of an org template
      effect: write
      questions:
      - How do I edit a specific version of an org template?
      - Can I change the YAML of one template version without touching others?
      instructions:
      - text: 'Update version {version} of org template {template} in {org} with this YAML: {yaml}'
        slots:
          version: path.version
          template: path.template
          org: path.org
          yaml: requestBody.template_yaml
      - text: Rename version {version} of template {template} in org {org} to {name}.
        slots:
          version: path.version
          template: path.template
          org: path.org
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/templates/{template}/versions/{version}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a version of an org template
      effect: destructive
      questions:
      - Can I delete one version of an organization template?
      - Is there a force option when deleting an org template version that's in use?
      instructions:
      - text: Delete version {version} of template {template} in org {org}.
        slots:
          version: path.version
          template: path.template
          org: path.org
      - text: Force delete version {version} of org template {template} in {org} with comment {comments}.
        slots:
          version: path.version
          template: path.template
          org: path.org
          comments: query.comments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/templates/{template}/versions/{version}/stable'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the stable version of an org template
      effect: write
      questions:
      - How do I promote a template version to stable at the org level?
      - Can I switch which version of an org template is marked stable?
      instructions:
      - text: Mark version {version} of template {template} in org {org} as stable.
        slots:
          version: path.version
          template: path.template
          org: path.org
      - text: Promote org {org} template {template} version {version} to stable with comment {comments}.
        slots:
          org: path.org
          template: path.template
          version: path.version
          comments: requestBody.comments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/templates/{template}/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an org template from Git
      effect: write
      questions:
      - Can I import a template that already lives in a Git repo into my organization?
      - What details are needed to import a template at the org level?
      instructions:
      - text: Import template {template} into org {org} from Git.
        slots:
          template: path.template
          org: path.org
      - text: Import org template {template} into {org} using Git details {git}.
        slots:
          template: path.template
          org: path.org
          git: requestBody.git_import_details
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/templates/{template}/versions/{version}/inputs-schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the inputs schema of an org template
      effect: read
      questions:
      - Which runtime inputs does an org template version expect?
      - Can I get the input schema for an organization-level template?
      instructions:
      - text: Get the inputs schema for version {version} of template {template} in org {org}.
        slots:
          version: path.version
          template: path.template
          org: path.org
      - text: Show the runtime inputs org {org} template {template} at {version} requires.
        slots:
          org: path.org
          template: path.template
          version: path.version
      method: generated
      generated: '2026-09-26'