Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Audit YAML API

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

$.info
$.paths['/audit/api/auditYaml'].get
$.paths['/audit/api/auditYaml/diffs'].post

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 Audit YAML API
  version: 1.0.0
extends: openapi/harness-audityaml-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: 2
- target: $.paths['/audit/api/auditYaml'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the YAML diff of one audit event
      effect: read
      questions:
      - What changed in the YAML for a single audit trail entry?
      - Can I see the before and after YAML of one audit event?
      instructions:
      - text: Get the YAML diff for audit {audit} in account {account}.
        slots:
          audit: query.auditId
          account: query.accountIdentifier
      - text: Show the before and after YAML of audit event {audit} for account {account}.
        slots:
          audit: query.auditId
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audit/api/auditYaml/diffs'].post
  update:
    x-apievangelist-phrasing:
      intent: Compute JSON Patch diffs for audit events
      effect: read
      questions:
      - Can I get field-level diffs for several audit events at once?
      - How many audit event IDs can I request YAML diffs for in one call?
      instructions:
      - text: Compute JSON Patch diffs for audit events {events} in account {account}.
        slots:
          events: requestBody.auditEventIds
          account: query.accountIdentifier
      - text: Get RFC 6902 field-level changes for up to 20 audit events {events}, account {account}.
        slots:
          events: requestBody.auditEventIds
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'