# 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 Pipelines API
  version: 1.0.0
extends: openapi/here-pipelines-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: 6
- target: $.paths['/v2/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List data processing pipelines
      effect: read
      questions:
      - What data processing pipelines are defined on the HERE platform for me?
      - Can I see all my pipelines in one list?
      instructions:
      - text: List all my pipelines.
      - text: Show every pipeline currently defined.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/pipelines'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pipeline
      effect: write
      questions:
      - How do I create a new pipeline before adding any versions to it?
      - Can I set a contact email and sharing group on a new pipeline?
      instructions:
      - text: Create a pipeline named {name}.
        slots:
          name: requestBody.name
      - text: Create pipeline {name} in group {groupId} with contact email {contactEmail}.
        slots:
          name: requestBody.name
          groupId: requestBody.groupId
          contactEmail: requestBody.contactEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/pipelines/{pipelineId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a pipeline
      effect: read
      questions:
      - What are the details of one pipeline?
      - Who is the contact for a given pipeline?
      instructions:
      - text: Show pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      - text: Get the details of pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/pipelines/{pipelineId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a pipeline's metadata
      effect: write
      questions:
      - How do I rename a pipeline or change its description?
      - Can I move a pipeline to a different sharing group after creating it?
      instructions:
      - text: Rename pipeline {pipelineId} to {name}.
        slots:
          pipelineId: path.pipelineId
          name: requestBody.name
      - text: Change the contact email of pipeline {pipelineId} to {contactEmail}, keeping name {name}.
        slots:
          pipelineId: path.pipelineId
          contactEmail: requestBody.contactEmail
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/pipelines/{pipelineId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pipeline and its versions
      effect: destructive
      questions:
      - How do I delete a pipeline along with all its versions?
      - Can I delete a pipeline while one of its versions is still running?
      instructions:
      - text: Delete pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      - text: Remove pipeline {pipelineId} and all of its versions.
        slots:
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/pipelines/{pipelineId}/hrn'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline's HRN
      effect: read
      questions:
      - What is the HERE Resource Name of my pipeline?
      - How do I turn a pipeline ID into its HRN?
      instructions:
      - text: Get the HRN of pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      - text: Look up the resource name for pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-09-26'