Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Custom Deployment API

6 actions 6 updates phrasing extends openapi/harness-customdeployment-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['/ng/api/customDeployment/get-references'].post
$.paths['/ng/api/customDeployment/expression-variables'].post
$.paths['/ng/api/customDeployment/variables/{templateIdentifier}'].get
$.paths['/ng/api/customDeployment/get-updated-Yaml/{infraIdentifier}'].post
$.paths['/ng/api/customDeployment/validate-infrastructure/{infraIdentifier}'].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 Custom Deployment API
  version: 1.0.0
extends: openapi/harness-customdeployment-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['/ng/api/customDeployment/get-references'].post
  update:
    x-apievangelist-phrasing:
      intent: Find references in a custom deployment
      effect: read
      questions:
      - Which entities does my custom deployment template reference?
      - Can I check what connectors or secrets a deployment template YAML points to?
      instructions:
      - text: Get the entity references in custom deployment YAML {yaml}.
        slots:
          yaml: requestBody.entityYaml
      - text: List references from template YAML {yaml} in project {project}.
        slots:
          yaml: requestBody.entityYaml
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/customDeployment/expression-variables'].post
  update:
    x-apievangelist-phrasing:
      intent: List expression variables in a custom deployment
      effect: read
      questions:
      - What expression variables can I use in a custom deployment template?
      - Which variables does a deployment template YAML expose?
      instructions:
      - text: List expression variables for custom deployment YAML {yaml}.
        slots:
          yaml: requestBody.entityYaml
      - text: Show usable expressions from deployment template {yaml}.
        slots:
          yaml: requestBody.entityYaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/customDeployment/variables/{templateIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get infrastructure variables from a template
      effect: read
      questions:
      - What infrastructure variables does a custom deployment template define?
      - Can I read infra variables from a specific template version?
      instructions:
      - text: Get infra variables from deployment template {template}.
        slots:
          template: path.templateIdentifier
      - text: Show infra variables of template {template} version {version}.
        slots:
          template: path.templateIdentifier
          version: query.versionLabel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/customDeployment/get-updated-Yaml/{infraIdentifier}'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh infrastructure YAML from its template
      effect: read
      questions:
      - How do I bring an infrastructure definition in line with a changed deployment template?
      - Can I get updated YAML for infrastructure after the template changed?
      instructions:
      - text: Get updated YAML for infrastructure {infra} from current YAML {yaml}.
        slots:
          infra: path.infraIdentifier
          yaml: requestBody.yaml
      - text: Regenerate infrastructure {infra} YAML against its template.
        slots:
          infra: path.infraIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/customDeployment/validate-infrastructure/{infraIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Validate infrastructure against its template
      effect: read
      questions:
      - Is my infrastructure definition still valid for its deployment template?
      - Can I check an infrastructure in a given environment for template drift?
      instructions:
      - text: Validate infrastructure {infra}.
        slots:
          infra: path.infraIdentifier
      - text: Check infrastructure {infra} in environment {env} is valid.
        slots:
          infra: path.infraIdentifier
          env: query.envIdentifier
      method: generated
      generated: '2026-09-26'