# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Migration State API
  version: 1.0.0
extends: openapi/harness-migration-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: 6
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/changeset/sql'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the SQL of changesets deployed to a DB instance
      effect: read
      questions:
      - What SQL actually ran when a changeset was deployed to my database instance?
      - Can I see the generated SQL for a specific changeset on one DB instance?
      instructions:
      - text: Show the SQL for changeset {changesetFQN} on instance {dbinstance} of schema {dbschema}.
        slots:
          changesetFQN: requestBody.changesetFQN
          dbinstance: path.dbinstance
          dbschema: path.dbschema
      - text: Fetch deployed changeset SQL for {dbinstance} in project {project} of org {org}, changeset {changesetFQN}.
        slots:
          dbinstance: path.dbinstance
          project: path.project
          org: path.org
          changesetFQN: requestBody.changesetFQN
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/changeset/yaml'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the deployment YAML for a changeset on an instance
      effect: read
      questions:
      - Where can I get the YAML definition of a changeset as deployed to one database instance?
      - Can I view a Liquibase changeset's YAML for a given DB instance?
      instructions:
      - text: Get the YAML of changeset {changeSet} on instance {dbinstance} of schema {dbschema}.
        slots:
          changeSet: query.changeSet
          dbinstance: path.dbinstance
          dbschema: path.dbschema
      - text: Show changeset {changeSet} deployment YAML for {dbinstance} in org {org} project {project}.
        slots:
          changeSet: query.changeSet
          dbinstance: path.dbinstance
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/flyway/migrationstate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Flyway migration state of a DB instance
      effect: read
      questions:
      - Which Flyway migrations have been applied to one database instance?
      - Is a particular Flyway migration pending on my DB instance?
      instructions:
      - text: Show the Flyway migration state of instance {dbinstance} in schema {dbschema}.
        slots:
          dbinstance: path.dbinstance
          dbschema: path.dbschema
      - text: Search Flyway migrations on {dbinstance} in project {project} of org {org} for {search_term}.
        slots:
          dbinstance: path.dbinstance
          project: path.project
          org: path.org
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/migrationstate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get migration state of a DB instance
      effect: read
      questions:
      - Which changesets have been deployed to a single database instance so far?
      - Can I search the Liquibase migration state of one DB instance?
      instructions:
      - text: Show the migration state of DB instance {dbinstance} in schema {dbschema}.
        slots:
          dbinstance: path.dbinstance
          dbschema: path.dbschema
      - text: List changesets applied to instance {dbinstance} in org {org} project {project}.
        slots:
          dbinstance: path.dbinstance
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/flyway/migrationstate'].post
  update:
    x-apievangelist-phrasing:
      intent: Get Flyway migration state across a schema
      effect: read
      questions:
      - How far along are Flyway migrations across all instances of one DB schema?
      - Can I compare Flyway migration state across several instances of a schema?
      instructions:
      - text: Show the Flyway migration state across all instances of schema {dbschema}.
        slots:
          dbschema: path.dbschema
      - text: Get Flyway migration state for schema {dbschema} in org {org} project {project}, filtered to instances {instanceFilter}.
        slots:
          dbschema: path.dbschema
          org: path.org
          project: path.project
          instanceFilter: requestBody.instanceFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/migrationstate'].post
  update:
    x-apievangelist-phrasing:
      intent: Get migration state across a DB schema
      effect: read
      questions:
      - Which changesets are deployed to which instances of my database schema?
      - Are all instances of a schema at the same migration level?
      instructions:
      - text: Show the changeset migration state of schema {dbschema} across its instances.
        slots:
          dbschema: path.dbschema
      - text: Get migration state of schema {dbschema} in org {org} project {project} for instances {instanceFilter}.
        slots:
          dbschema: path.dbschema
          org: path.org
          project: path.project
          instanceFilter: requestBody.instanceFilter
      method: generated
      generated: '2026-09-26'