Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Change Authoring API

4 actions 4 updates phrasing extends openapi/harness-change-authoring-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['/v1/orgs/{org}/projects/{project}/change-authoring-event'].post
$.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/changesets/existence'].post
$.paths['/v1/orgs/{org}/projects/{project}/llm-authoring/execute-pipeline'].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 Change Authoring API
  version: 1.0.0
extends: openapi/harness-change-authoring-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['/v1/orgs/{org}/projects/{project}/change-authoring-event'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a pipeline run from an AI change chat
      effect: write
      questions:
      - How is a pipeline run from the LLM change authoring chat recorded?
      - Which IDs link a chat conversation to the pipeline execution it triggered?
      instructions:
      - text: Record that chat {conversationId} ran pipeline {pipelineIdentifier} (run {pipelineExecutionId}) on schema {schemaIdentifier} in {org}/{project}.
        slots:
          conversationId: requestBody.conversationId
          pipelineIdentifier: requestBody.pipelineIdentifier
          pipelineExecutionId: requestBody.pipelineExecutionId
          schemaIdentifier: requestBody.schemaIdentifier
          org: path.org
          project: path.project
      - text: Log a change authoring event for chat {conversationId} and execution {pipelineExecutionId}, pipeline {pipelineIdentifier}, schema {schemaIdentifier}.
        slots:
          conversationId: requestBody.conversationId
          pipelineExecutionId: requestBody.pipelineExecutionId
          pipelineIdentifier: requestBody.pipelineIdentifier
          schemaIdentifier: requestBody.schemaIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/changesets/existence'].post
  update:
    x-apievangelist-phrasing:
      intent: Check which Liquibase changesets a schema already has
      effect: read
      questions:
      - Have these Liquibase changeset IDs already been applied to my database schema?
      - Is changeset matching done by ID only?
      instructions:
      - text: Check whether changesets {changeSets} exist for schema {dbschema} in org {org} project {project}.
        slots:
          changeSets: requestBody.changeSets
          dbschema: path.dbschema
          org: path.org
          project: path.project
      - text: Tell me which of {changeSets} are already known for schema {dbschema}.
        slots:
          changeSets: requestBody.changeSets
          dbschema: path.dbschema
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/llm-authoring/execute-pipeline'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a validate-and-preview pipeline for a changeset
      effect: write
      questions:
      - Can I validate and preview a Liquibase changeset from the AI chat before applying it?
      - Is running the LLM authoring pipeline billable?
      instructions:
      - text: Validate and preview changeset {changeset} on schema {schemaId} instance {instanceId} for conversation {conversationId} in org {org} project {project}.
        slots:
          changeset: requestBody.changeset
          schemaId: requestBody.schemaId
          instanceId: requestBody.instanceId
          conversationId: requestBody.conversationId
          org: path.org
          project: path.project
      - text: Run the default preview pipeline for changeset {changeset} on schema {schemaId}, instance {instanceId}, chat {conversationId}.
        slots:
          changeset: requestBody.changeset
          schemaId: requestBody.schemaId
          instanceId: requestBody.instanceId
          conversationId: requestBody.conversationId
      method: generated
      generated: '2026-09-26'