Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Flyway API

3 actions 3 updates phrasing extends openapi/harness-flyway-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['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/migration/scripts'].get

$.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}/flyway/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 Flyway API
  version: 1.0.0
extends: openapi/harness-flyway-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['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/migration/scripts'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch Flyway migration script SQL for a database
      effect: read
      questions:
      - Can I see the SQL of the Flyway migration scripts for a database instance?
      - How do I fetch migration scripts for a specific Flyway version?
      instructions:
      - text: Fetch Flyway migration SQL for version {flywayVersion} on schema {dbschema}, instance {dbinstance}, in project {project} of org {org}.
        slots:
          flywayVersion: query.flywayVersion
          dbschema: path.dbschema
          dbinstance: path.dbinstance
          project: path.project
          org: path.org
      - text: Show the migration scripts run for instance {dbinstance} in pipeline execution {pipelineExecutionId}.
        slots:
          dbinstance: path.dbinstance
          pipelineExecutionId: query.pipelineExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}/flyway/deployedState'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the Flyway deployed state for an execution
      effect: read
      questions:
      - Which Flyway migrations were deployed in a pipeline run, compared with before?
      - How do I check the migration deployment status for one database instance?
      instructions:
      - text: Get the Flyway deployed state for schema {dbschema}, instance {dbinstance}, in project {project} of org {org} for execution {planExecutionId}.
        slots:
          dbschema: path.dbschema
          dbinstance: path.dbinstance
          project: path.project
          org: path.org
          planExecutionId: requestBody.planExecutionId
      - text: Compare deployed migrations on {dbinstance} for pipeline {pipeline}, stage execution {stageExecutionId}.
        slots:
          dbinstance: path.dbinstance
          pipeline: requestBody.pipeline
          stageExecutionId: requestBody.stageExecutionId
      method: generated
      generated: '2026-09-26'