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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Harness Dbops API
version: 1.0.0
extends: openapi/harness-dbops-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/dbops/db-metadata/{snapshotId}'].post
update:
x-apievangelist-phrasing:
intent: Record database snapshot metadata
effect: write
questions:
- How does the DB DevOps plugin send snapshot metadata to capture a database's current state?
- Which pipeline and schema details must accompany database snapshot metadata?
instructions:
- text: Send metadata for snapshot {snapshot} of schema {schema} on {instance}, pipeline {pipeline} run {execution}, stage {stage}, command {command}, parent {parent}.
slots:
snapshot: path.snapshotId
schema: query.dbSchema
instance: query.dbInstance
pipeline: query.pipelineIdentifier
execution: query.pipelineExecutionId
stage: query.stageExecutionId
command: query.harnessCommand
parent: query.parentId
- text: Capture DB state metadata for snapshot {snapshot} of schema {schema} on {instance}.
slots:
snapshot: path.snapshotId
schema: query.dbSchema
instance: query.dbInstance
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/dbops/dbschema'].delete
update:
x-apievangelist-phrasing:
intent: Delete database schemas for a scope
effect: destructive
questions:
- Can I delete all database schemas under a parent in a project?
- How do I clean up DB schemas for an org and project scope?
instructions:
- text: Delete DB schemas for parent {parent} in org {org}, project {project}.
slots:
parent: query.parent_id
org: query.orgIdentifier
project: query.projectIdentifier
- text: Remove every database schema under parent {parent} in project {project} of org {org}.
slots:
parent: query.parent_id
project: query.projectIdentifier
org: query.orgIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/dbops/metadata-snapshot/{snapshotId}'].post
update:
x-apievangelist-phrasing:
intent: Upload a database snapshot file
effect: write
questions:
- How does the plugin upload the actual snapshot file of a database?
- Can a DB snapshot file upload carry a SHA-256 checksum?
instructions:
- text: Upload snapshot file {snapshot} of schema {schema} on {instance}, pipeline {pipeline} run {execution}, stage {stage}, command {command}, parent {parent}.
slots:
snapshot: path.snapshotId
schema: query.dbSchema
instance: query.dbInstance
pipeline: query.pipelineIdentifier
execution: query.pipelineExecutionId
stage: query.stageExecutionId
command: query.harnessCommand
parent: query.parentId
- text: Upload DB snapshot file {snapshot} with checksum {checksum}.
slots:
snapshot: path.snapshotId
checksum: header.X-Checksum-Sha256
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.