Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Triggers Events API

7 actions 7 updates phrasing extends openapi/harness-triggersevents-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 7

$.info
$.paths['/pipeline/api/triggers/eventHistory/polledResponse/{triggerIdentifier}'].get
$.paths['/pipeline/api/triggers/eventHistory/{triggerIdentifier}'].get
$.paths['/pipeline/api/triggers/eventHistory/events'].get
$.paths['/pipeline/api/triggers/eventHistory/eventCorrelation/{eventCorrelationId}'].get
$.paths['/pipeline/api/triggers/eventHistory/v2/eventCorrelation/{eventCorrelationId}'].get
$.paths['/pipeline/api/triggers/eventHistory/artifact-manifest-info'].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 Triggers Events API
  version: 1.0.0
extends: openapi/harness-triggersevents-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['/pipeline/api/triggers/eventHistory/polledResponse/{triggerIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get polled responses for a trigger
      effect: read
      questions:
      - What did a polling trigger see the last times it checked for new artifacts or manifests?
      - Can I inspect the polled responses behind one pipeline trigger?
      instructions:
      - text: Get polled responses for trigger {trigger} on pipeline {pipeline}.
        slots:
          trigger: path.triggerIdentifier
          pipeline: query.targetIdentifier
      - text: Show what polling trigger {trigger} found for pipeline {pipeline} in project {project}.
        slots:
          trigger: path.triggerIdentifier
          pipeline: query.targetIdentifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/triggers/eventHistory/{triggerIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get event history for a trigger
      effect: read
      questions:
      - Why didn't my pipeline trigger fire, and what events did it receive?
      - Can I include the incoming payload when viewing one trigger's event history?
      instructions:
      - text: Show event history for trigger {trigger} on pipeline {pipeline}.
        slots:
          trigger: path.triggerIdentifier
          pipeline: query.targetIdentifier
      - text: 'List events for trigger {trigger} matching {term}, with payloads: {payload}.'
        slots:
          trigger: path.triggerIdentifier
          term: query.searchTerm
          payload: query.shouldSendTriggerPayload
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/triggers/eventHistory/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Filter trigger events by status and type
      effect: read
      questions:
      - Which trigger events for a pipeline failed, filtered by status?
      - Can I filter a pipeline's trigger events by trigger type?
      instructions:
      - text: List trigger events for pipeline {pipeline} with status {status}.
        slots:
          pipeline: query.targetIdentifier
          status: query.status
      - text: Filter pipeline {pipeline} trigger events to type {type}.
        slots:
          pipeline: query.targetIdentifier
          type: query.triggerType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/triggers/eventHistory/eventCorrelation/{eventCorrelationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get trigger events by correlation ID
      effect: read
      questions:
      - Which trigger events share one event correlation ID?
      - Can I trace a single incoming webhook across the triggers it hit?
      instructions:
      - text: Get trigger history for event correlation {correlation}.
        slots:
          correlation: path.eventCorrelationId
      - text: Trace all trigger events tied to correlation ID {correlation}.
        slots:
          correlation: path.eventCorrelationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/triggers/eventHistory/v2/eventCorrelation/{eventCorrelationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get trigger events by correlation ID (v2)
      effect: read
      questions:
      - Is there a v2 endpoint for looking up trigger history by correlation ID?
      - What does the newer version of the event correlation lookup return?
      instructions:
      - text: Look up correlation {correlation} through the v2 event correlation endpoint.
        slots:
          correlation: path.eventCorrelationId
      - text: Use the v2 correlation lookup for {correlation}, page {page}.
        slots:
          correlation: path.eventCorrelationId
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/triggers/eventHistory/artifact-manifest-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get artifact and manifest trigger history
      effect: read
      questions:
      - What events did my artifact and manifest triggers receive, by build source type?
      - Can I filter artifact trigger history to one artifact type such as a Docker registry?
      instructions:
      - text: Show artifact and manifest trigger history for artifact type {type}.
        slots:
          type: query.artifactType
      - text: List artifact trigger events in account {account} matching {term}.
        slots:
          account: query.accountIdentifier
          term: query.searchTerm
      method: generated
      generated: '2026-09-26'