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 Database Snapshot API
version: 1.0.0
extends: openapi/harness-database-snapshot-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}/snapshot-object-names'].get
update:
x-apievangelist-phrasing:
intent: List object names in the latest DB snapshot
effect: read
questions:
- Which tables or other objects of a given type are in my database instance's latest snapshot?
- Can I page through object names captured in a DB snapshot?
instructions:
- text: List {objectType} object names in the latest snapshot of instance {dbinstance} for schema {dbschema} in project {project} of {org}.
slots:
objectType: query.objectType
dbinstance: path.dbinstance
dbschema: path.dbschema
project: path.project
org: path.org
- text: Show snapshot {objectType} names for {dbinstance}, {limit} per page.
slots:
objectType: query.objectType
dbinstance: path.dbinstance
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/snapshot-object-values'].post
update:
x-apievangelist-phrasing:
intent: Get object values from the latest DB snapshot
effect: read
questions:
- What definitions were captured for specific objects in my database's latest snapshot?
- Can I fetch snapshot values for several named objects at once?
instructions:
- text: Get snapshot values for {objectType} objects {objectNames} on instance {dbinstance} of schema {dbschema} in {project} under {org}.
slots:
objectType: requestBody.objectType
objectNames: requestBody.objectNames
dbinstance: path.dbinstance
dbschema: path.dbschema
project: path.project
org: path.org
- text: Show the latest snapshot contents of {objectNames} in {dbinstance}.
slots:
objectNames: requestBody.objectNames
dbinstance: path.dbinstance
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.