HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pipeline Management API v2 Pipeline Templates API

6 actions 6 updates phrasing extends openapi/here-pipeline-templates-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for HERE's API. It is a proposal applied on top of the contract, not a document HERE publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v2/templates'].get

$.paths['/v2/templates'].post

$.paths['/v2/templates/{templateId}'].get

$.paths['/v2/templates/{templateId}'].delete

$.paths['/v2/templates/{templateId}/hrn'].get

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 Pipeline Management API v2 Pipeline Templates API
  version: 1.0.0
extends: openapi/here-pipeline-templates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v2/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List pipeline templates
      effect: read
      questions:
      - What pipeline templates have been defined?
      - Can I list only templates that are linkable from other projects?
      instructions:
      - text: List all pipeline templates.
      - text: Show pipeline templates where linkable is {linkable}.
        slots:
          linkable: query.linkable
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pipeline template
      effect: write
      questions:
      - How do I create a reusable pipeline template from my uploaded package?
      - What entry point class and cluster configuration does a new pipeline template need?
      instructions:
      - text: Create template {name} from package {pkg}, entry point {entry}, cluster config {cluster}, input catalogs {inputs}.
        slots:
          name: requestBody.name
          pkg: requestBody.packageId
          entry: requestBody.entryPointClassName
          cluster: requestBody.defaultClusterConfiguration
          inputs: requestBody.inputCatalogIds
      - text: Define template {name} for runtime {runtimeEnvironment} using package {packageId}.
        slots:
          name: requestBody.name
          runtimeEnvironment: requestBody.runtimeEnvironment
          packageId: requestBody.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/templates/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline template
      effect: read
      questions:
      - How do I see the package and entry point behind a pipeline template?
      - What default cluster configuration does a template use?
      instructions:
      - text: Get pipeline template {templateId}.
        slots:
          templateId: path.templateId
      - text: Show the details of template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/templates/{templateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pipeline template
      effect: destructive
      questions:
      - How do I delete a pipeline template I don't use anymore?
      - Why can't I delete a template that pipeline versions still reference?
      instructions:
      - text: Delete pipeline template {templateId}.
        slots:
          templateId: path.templateId
      - text: Remove the unused template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/templates/{templateId}/hrn'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline template's HRN
      effect: read
      questions:
      - Where do I find the HRN of a pipeline template?
      - Can I get just the resource name of a template to reference it elsewhere?
      instructions:
      - text: Get the HRN of pipeline template {templateId}.
        slots:
          templateId: path.templateId
      - text: Return only the resource name for template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'