Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Account Template API

11 actions 11 updates phrasing extends openapi/harness-account-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/templates'].get
$.paths['/v1/templates'].post
$.paths['/v1/templates/git-metadata/{template}'].put
$.paths['/v1/templates/{template}'].get
$.paths['/v1/templates/{template}/versions/{version}'].get
$.paths['/v1/templates/{template}/versions/{version}'].put
$.paths['/v1/templates/{template}/versions/{version}'].delete
$.paths['/v1/templates/{template}/versions/{version}/stable'].put
$.paths['/v1/templates/{template}/import'].post
$.paths['/v1/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 Account Template API
  version: 1.0.0
extends: openapi/harness-account-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/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level templates
      effect: read
      questions:
      - What templates are defined at the account level?
      - Can I filter account templates by entity type or search by name?
      instructions:
      - text: List account templates matching {search_term}.
        slots:
          search_term: query.search_term
      - text: Show account-scope templates of entity type {entity_types}.
        slots:
          entity_types: query.entity_types
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level template
      effect: write
      questions:
      - How do I publish a reusable pipeline or step template for the whole account?
      - Can I mark a new account template version as stable when I create it?
      instructions:
      - text: Create an account template from YAML {template_yaml}.
        slots:
          template_yaml: requestBody.template_yaml
      - text: Create account template {name} with version label {label} and mark it stable {is_stable}.
        slots:
          name: requestBody.name
          label: requestBody.label
          is_stable: requestBody.is_stable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/git-metadata/{template}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update Git details for a template's versions
      effect: write
      questions:
      - Can I update the Git metadata for all versions of a template at once?
      - How do I fix a template's Git details after its repo moved?
      instructions:
      - text: Update Git details across versions of template {template}.
        slots:
          template: path.template
      - text: Refresh the Git metadata stored for account template {template}.
        slots:
          template: path.template
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/{template}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the stable version of a template
      effect: read
      questions:
      - Which version of an account template is currently marked stable?
      - Can I get the stable template's YAML from a specific Git branch?
      instructions:
      - text: Get the stable version of account template {template}.
        slots:
          template: path.template
      - text: Fetch stable template {template} with YAML from branch {branch_name}.
        slots:
          template: path.template
          branch_name: query.branch_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/{template}/versions/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific template version
      effect: read
      questions:
      - How do I retrieve a particular version label of an account template?
      - Can I include the YAML when fetching one template version?
      instructions:
      - text: Get version {version} of account template {template}.
        slots:
          version: path.version
          template: path.template
      - text: Show template {template} at version {version} including YAML.
        slots:
          template: path.template
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/{template}/versions/{version}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a template version
      effect: write
      questions:
      - Can I edit the YAML of one existing template version?
      - How do I add a change comment when updating an account template?
      instructions:
      - text: Update version {version} of template {template} with YAML {template_yaml}.
        slots:
          version: path.version
          template: path.template
          template_yaml: requestBody.template_yaml
      - text: Change the description of template {template} version {version} to {description}.
        slots:
          template: path.template
          version: path.version
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/{template}/versions/{version}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a template version
      effect: destructive
      questions:
      - How do I delete one version of an account template?
      - Can I force-delete a template version that pipelines still reference?
      instructions:
      - text: Delete version {version} of account template {template}.
        slots:
          version: path.version
          template: path.template
      - text: Force-delete template {template} version {version} with comment {comments}.
        slots:
          template: path.template
          version: path.version
          comments: query.comments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/{template}/versions/{version}/stable'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a template version as stable
      effect: write
      questions:
      - How do I promote a template version to be the stable one?
      - Which version do pipelines pick up after I change the stable template?
      instructions:
      - text: Make version {version} the stable version of template {template}.
        slots:
          version: path.version
          template: path.template
      - text: Promote template {template} version {version} to stable with note {comments}.
        slots:
          template: path.template
          version: path.version
          comments: requestBody.comments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/{template}/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an account template from Git
      effect: write
      questions:
      - Can I import a template that already lives in a Git repo into my account?
      - What Git details do I need to import a template?
      instructions:
      - text: Import template {template} into the account from Git using {git_import_details}.
        slots:
          template: path.template
          git_import_details: requestBody.git_import_details
      - text: Pull account template {template} in from its repository.
        slots:
          template: path.template
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/{template}/versions/{version}/inputs-schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the inputs schema of a template
      effect: read
      questions:
      - What runtime inputs does an account template version expect?
      - Is there a schema describing an account template's inputs?
      instructions:
      - text: Get the inputs schema for template {template} version {version}.
        slots:
          template: path.template
          version: path.version
      - text: Show which inputs account template {template} at {version} requires.
        slots:
          template: path.template
          version: path.version
      method: generated
      generated: '2026-09-26'