# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Pipeline Step API
  version: 1.0.0
extends: openapi/harness-pipeline-step-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: 12
- target: $.paths['/v1/dbops/custom-operations'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a custom operation for a database step
      effect: write
      questions:
      - How does a database DevOps step run a custom command against a schema?
      - What does a db step need to execute a custom operation on a database instance?
      instructions:
      - text: Run custom command {command} on schema {schema} for instance {instance}.
        slots:
          command: requestBody.command
          schema: requestBody.dbSchema
          instance: requestBody.dbInstance
      - text: Execute custom db operation {command} for schema {schema} in project {project}.
        slots:
          command: requestBody.command
          schema: requestBody.dbSchema
          project: requestBody.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dbops/failure-interrupt'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a failure interrupt for a DB step
      effect: write
      questions:
      - How does a failed database step tell the pipeline which failure strategy to apply?
      - What gets sent when a db schema step hits a failure interrupt?
      instructions:
      - text: Record a {type} failure interrupt for schema {schema} in execution {execution}.
        slots:
          type: requestBody.interruptType
          schema: requestBody.schemaIdentifier
          execution: requestBody.pipelineExecutionId
      - text: Send the failure interrupt for instance {instance} in stage execution {stage}.
        slots:
          instance: requestBody.instanceIdentifier
          stage: requestBody.stageExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dbops/flyway/custom-operations'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a custom Flyway operation for a DB step
      effect: write
      questions:
      - Can a Flyway database step run a custom command?
      - What does a Flyway step need to execute a custom operation on a schema?
      instructions:
      - text: Run Flyway command {command} on schema {schema} for instance {instance}.
        slots:
          command: requestBody.command
          schema: requestBody.dbSchema
          instance: requestBody.dbInstance
      - text: Execute a custom Flyway operation {command} against database schema {schema}.
        slots:
          command: requestBody.command
          schema: requestBody.dbSchema
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dbops/flyway/failure-interrupt'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a failure interrupt for a Flyway step
      effect: write
      questions:
      - How does a failed Flyway step report a failure interrupt back to the pipeline?
      - Which identifiers does a Flyway failure interrupt require?
      instructions:
      - text: Tell the pipeline a Flyway migration on {schema} failed with interrupt {type} during run {execution}.
        slots:
          type: requestBody.interruptType
          schema: requestBody.schemaIdentifier
          execution: requestBody.pipelineExecutionId
      - text: Send the Flyway failure interrupt for instance {instance} under parent {parent}.
        slots:
          instance: requestBody.instanceIdentifier
          parent: requestBody.parentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dbops/flyway/plugin-output-response'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit Flyway plugin output for a step
      effect: write
      questions:
      - How does the Flyway plugin send its step output back in chunks?
      - What marks the final chunk of Flyway plugin output?
      instructions:
      - text: Submit Flyway plugin output for schema {schema} in execution {execution}.
        slots:
          schema: requestBody.schemaIdentifier
          execution: requestBody.pipelineExecutionId
      - text: Post the last Flyway output chunk for stage execution {stage}.
        slots:
          stage: requestBody.stageExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dbops/plugin-capability'].get
  update:
    x-apievangelist-phrasing:
      intent: Check DB plugin consolidated-execution support
      effect: read
      questions:
      - Does the database DevOps plugin support consolidated execution?
      - Which plugin capability is available for db step execution?
      instructions:
      - text: Check the DB plugin's capability for consolidated execution.
      - text: Tell me whether db steps can run in consolidated mode.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dbops/plugin-output-response'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit database plugin output for a step
      effect: write
      questions:
      - How does a database step plugin page its output back to the pipeline?
      - What's the difference between the first and last page of plugin output?
      instructions:
      - text: Submit plugin output for schema {schema} in pipeline execution {execution}.
        slots:
          schema: requestBody.schemaIdentifier
          execution: requestBody.pipelineExecutionId
      - text: Post a page of db step output for instance {instance} in project {project}.
        slots:
          instance: requestBody.instanceIdentifier
          project: requestBody.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dbops/schema-instance-metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Get metadata and images for a DB schema instance
      effect: read
      questions:
      - Which container images and metadata apply to a database schema instance?
      - What does a db step look up about a schema before running?
      instructions:
      - text: Get metadata for schema {schema} on instance {instance}.
        slots:
          schema: requestBody.dbSchema
          instance: requestBody.dbInstance
      - text: Look up the images for db schema {schema} in project {project}.
        slots:
          schema: requestBody.dbSchema
          project: requestBody.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipeline/{pipelineIdentifier}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline execution's status
      effect: read
      questions:
      - Is my pipeline run still going, or did it succeed or fail?
      - Can I check the status of one stage in a pipeline execution?
      instructions:
      - text: Get the status of execution {execution} of pipeline {pipeline} in {org}/{project}.
        slots:
          execution: query.pipelineExecutionId
          pipeline: path.pipelineIdentifier
          org: path.org
          project: path.project
      - text: Check stage {stage} in run {execution} of pipeline {pipeline} in org {org}, project {project}.
        slots:
          stage: query.stageNodeId
          execution: query.pipelineExecutionId
          pipeline: path.pipelineIdentifier
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/step/flyway/plugin-inputs'].post
  update:
    x-apievangelist-phrasing:
      intent: Build Flyway plugin inputs from step inputs
      effect: write
      questions:
      - How are a Flyway step's inputs turned into plugin inputs?
      - Can Flyway plugin inputs include JWT auth?
      instructions:
      - text: Create Flyway plugin inputs for command {command} on schema {schema}.
        slots:
          command: requestBody.command
          schema: requestBody.dbSchema
      - text: Generate Flyway inputs for instance {instance} under parent {parent}.
        slots:
          instance: requestBody.dbInstance
          parent: requestBody.parentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/step/plugin-inputs'].post
  update:
    x-apievangelist-phrasing:
      intent: Build DB step plugin inputs from step inputs
      effect: write
      questions:
      - How are a database step's inputs converted into plugin inputs?
      - Can I exclude the changelog file when generating db plugin inputs?
      instructions:
      - text: Convert step inputs into standard (non-Flyway) plugin inputs to run {command} against {schema}.
        slots:
          command: requestBody.command
          schema: requestBody.dbSchema
      - text: Generate db step plugin inputs for instance {instance} with directory {directory}.
        slots:
          instance: requestBody.dbInstance
          directory: requestBody.directory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/step/plugin-response'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a DB plugin's execution result
      effect: write
      questions:
      - How does a database plugin report its final execution status and logs?
      - What does a db step plugin send when it finishes running?
      instructions:
      - text: Submit the plugin result with status {status} for plan execution {plan}.
        slots:
          status: requestBody.status
          plan: requestBody.planExecutionId
      - text: Report execution logs for schema {schema} in pipeline {pipeline}.
        slots:
          schema: requestBody.dbSchema
          pipeline: requestBody.pipeline
      method: generated
      generated: '2026-09-26'