Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Evaluations API

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

$.info
$.paths['/pm/api/v1/evaluations'].get
$.paths['/pm/api/v1/evaluations/evaluation-input-signed-url/{evaluation_id}'].get
$.paths['/pm/api/v1/evaluations/getYaml'].get
$.paths['/pm/api/v1/evaluations/{id}'].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 Evaluations API
  version: 1.0.0
extends: openapi/harness-evaluations-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: 4
- target: $.paths['/pm/api/v1/evaluations'].get
  update:
    x-apievangelist-phrasing:
      intent: List policy evaluations
      effect: read
      questions:
      - Which policy evaluations failed in my project recently?
      - Can I list policy evaluations for one pipeline execution?
      - What policy checks ran against an entity within a date range?
      instructions:
      - text: List policy evaluations with status {status}.
        slots:
          status: query.status
      - text: Show policy evaluations for execution {execution_id}.
        slots:
          execution_id: query.execution_id
      - text: List evaluations created between {from} and {to}.
        slots:
          from: query.created_date_from
          to: query.created_date_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pm/api/v1/evaluations/evaluation-input-signed-url/{evaluation_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download link for an evaluation's input
      effect: read
      questions:
      - How do I download the input that was evaluated when it was offloaded to storage?
      - Can I get a signed URL for a policy evaluation's input payload?
      instructions:
      - text: Get a signed URL for the input of evaluation {evaluation_id}.
        slots:
          evaluation_id: path.evaluation_id
      - text: Give me a download link for the policy input of evaluation {evaluation_id}.
        slots:
          evaluation_id: path.evaluation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pm/api/v1/evaluations/getYaml'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an entity's YAML for policy evaluation
      effect: read
      questions:
      - Can I fetch the YAML of a pipeline or other entity that policies are evaluated against?
      - How do I get an entity's YAML from a specific Git branch for policy checks?
      instructions:
      - text: Get the YAML for {entity_type} {entity_id}.
        slots:
          entity_type: query.entityType
          entity_id: query.entityIdentifier
      - text: Fetch the {entity_type} {entity_id} YAML from branch {branch}.
        slots:
          entity_type: query.entityType
          entity_id: query.entityIdentifier
          branch: query.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pm/api/v1/evaluations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a policy evaluation by ID
      effect: read
      questions:
      - Which policies passed or failed in one specific evaluation?
      - How do I open a single policy evaluation's result?
      instructions:
      - text: Get policy evaluation {evaluation_id}.
        slots:
          evaluation_id: path.id
      - text: Show the result of evaluation {evaluation_id} in project {project}.
        slots:
          evaluation_id: path.id
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'