Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Deployed State API

2 actions 2 updates phrasing extends openapi/harness-deployed-state-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 2

$.info

$.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}/deployedState'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Deployed State API
  version: 1.0.0
extends: openapi/harness-deployed-state-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: 1
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}/deployedState'].post
  update:
    x-apievangelist-phrasing:
      intent: Get deployed database changeset state
      effect: read
      questions:
      - Which database changesets did a pipeline execution deploy to a schema instance?
      - Can I compare a DB schema's deployed state with its earlier state?
      instructions:
      - text: Get deployed state of schema {schema} on instance {instance} for execution {execution}.
        slots:
          schema: path.dbschema
          instance: path.dbinstance
          execution: requestBody.planExecutionId
      - text: Show changeset status for pipeline {pipeline} stage {stage} step type {step} on {schema}/{instance} in project {project}, org {org}.
        slots:
          pipeline: requestBody.pipeline
          stage: requestBody.stageExecutionId
          step: requestBody.stepType
          schema: path.dbschema
          instance: path.dbinstance
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'