Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Streaming Destinations API

9 actions 9 updates phrasing extends openapi/harness-streaming-destinations-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 9

$.info
$.paths['/v1/streaming-destinations'].get
$.paths['/v1/streaming-destinations'].post
$.paths['/v1/streaming-destinations/aggregate'].get
$.paths['/v1/streaming-destinations/{streaming-destination}'].get
$.paths['/v1/streaming-destinations/{streaming-destination}'].put
$.paths['/v1/streaming-destinations/{streaming-destination}'].delete
$.paths['/v1/streaming-destinations/{streaming-destination}/validate-unique-identifier'].get
$.paths['/v1/streaming-destinations/cards'].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 Streaming Destinations API
  version: 1.0.0
extends: openapi/harness-streaming-destinations-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: 8
- target: $.paths['/v1/streaming-destinations'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit streaming destinations
      effect: read
      questions:
      - Where are my audit logs being streamed to?
      - Can I list only the streaming destinations that are active?
      instructions:
      - text: List my streaming destinations.
      - text: Show streaming destinations with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/streaming-destinations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an audit streaming destination
      effect: write
      questions:
      - How do I start streaming Harness audit events to my own storage?
      - Which connector does a new streaming destination need?
      instructions:
      - text: Create streaming destination {name} with id {identifier} using connector {connector_ref}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          connector_ref: requestBody.connector_ref
      - text: Add a streaming destination {identifier} with status {status} and spec {spec}.
        slots:
          identifier: requestBody.identifier
          status: requestBody.status
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/streaming-destinations/aggregate'].get
  update:
    x-apievangelist-phrasing:
      intent: List streaming destinations with aggregates
      effect: read
      questions:
      - Is there an aggregated view of my streaming destinations and their streaming state?
      - Can I search the aggregated streaming destination list by name?
      instructions:
      - text: Show the aggregated streaming destination list.
      - text: Search aggregated streaming destinations for {search_term}.
        slots:
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/streaming-destinations/{streaming-destination}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a streaming destination
      effect: read
      questions:
      - What connector and spec does one streaming destination use?
      - Can I look up a single streaming destination by identifier?
      instructions:
      - text: Show streaming destination {destination}.
        slots:
          destination: path.streaming-destination
      - text: Get the connector used by streaming destination {destination}.
        slots:
          destination: path.streaming-destination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/streaming-destinations/{streaming-destination}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a streaming destination
      effect: write
      questions:
      - How do I disable a streaming destination before deleting it?
      - Can I switch an existing streaming destination to another connector?
      instructions:
      - text: Set streaming destination {destination} status to {status}.
        slots:
          destination: path.streaming-destination
          status: requestBody.status
      - text: Point streaming destination {destination} at connector {connector_ref}.
        slots:
          destination: path.streaming-destination
          connector_ref: requestBody.connector_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/streaming-destinations/{streaming-destination}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a disabled streaming destination
      effect: destructive
      questions:
      - Can I delete a streaming destination that's still active?
      - How do I remove a streaming destination I've disabled?
      instructions:
      - text: Delete disabled streaming destination {destination}.
        slots:
          destination: path.streaming-destination
      - text: Remove streaming destination {destination} now that it is disabled.
        slots:
          destination: path.streaming-destination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/streaming-destinations/{streaming-destination}/validate-unique-identifier'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a streaming destination id is unique
      effect: read
      questions:
      - Is a streaming destination identifier already in use?
      - Can I validate a destination id before creating it?
      instructions:
      - text: Check whether streaming destination id {destination} is unique.
        slots:
          destination: path.streaming-destination
      - text: Validate {destination} as a new streaming destination identifier.
        slots:
          destination: path.streaming-destination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/streaming-destinations/cards'].get
  update:
    x-apievangelist-phrasing:
      intent: Get streaming destination summary cards
      effect: read
      questions:
      - What summary counts appear on the streaming destinations page?
      - Where do I get the overview cards for audit streaming?
      instructions:
      - text: Get the summary cards for my streaming destinations page.
      - text: Show the streaming destination overview card data.
      method: generated
      generated: '2026-09-26'