Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Aida API

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

$.info
$.paths['/pm/api/v1/aida/accept'].post
$.paths['/pm/api/v1/aida/analyze'].post
$.paths['/pm/api/v1/aida/generate'].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 Aida API
  version: 1.0.0
extends: openapi/harness-aida-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: 3
- target: $.paths['/pm/api/v1/aida/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Record acceptance of an AI-generated policy
      effect: write
      questions:
      - How do I log that a user accepted the AI's suggested policy?
      - Can I record the prompt and output a user explicitly accepted?
      instructions:
      - text: Record acceptance of AI output {output} for prompt {prompt}.
        slots:
          output: requestBody.output
          prompt: requestBody.prompt
      - text: Log that the user accepted the generated policy for project {project}.
        slots:
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pm/api/v1/aida/analyze'].post
  update:
    x-apievangelist-phrasing:
      intent: Explain a Rego policy in plain language
      effect: read
      questions:
      - Can AI explain what a Rego policy does?
      - What does this governance policy check for, in plain English?
      instructions:
      - text: 'Describe this Rego policy: {rego}.'
        slots:
          rego: requestBody.rego
      - text: Explain Rego {rego} as it applies to entity type {entity_type}.
        slots:
          rego: requestBody.rego
          entity_type: requestBody.entityType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pm/api/v1/aida/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a policy from a text description
      effect: read
      questions:
      - Can AI write a governance policy from a plain-language description?
      - Is there a way to turn a written requirement into a policy automatically?
      instructions:
      - text: Generate a policy that {query}.
        slots:
          query: requestBody.query
      - text: 'Write a Rego policy from this description: {query}.'
        slots:
          query: requestBody.query
      method: generated
      generated: '2026-09-26'