Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Database Instance API

6 actions 6 updates phrasing extends openapi/harness-database-instance-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 6

$.info

$.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/default-authoring-instance'].get

$.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance'].post

$.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}'].get

$.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}'].delete

$.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instancelist'].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 Database Instance API
  version: 1.0.0
extends: openapi/harness-database-instance-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: 5
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/default-authoring-instance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default instance for authoring DB changes
      effect: read
      questions:
      - Which database instance should an LLM use to author schema changes?
      - How is the default authoring instance for a schema chosen?
      instructions:
      - text: Get the default authoring instance for schema {dbschema} in {org}/{project}.
        slots:
          dbschema: path.dbschema
          org: path.org
          project: path.project
      - text: Pick the best instance with a metadata snapshot for schema {dbschema} in project {project} of org {org}.
        slots:
          dbschema: path.dbschema
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database instance for a schema
      effect: write
      questions:
      - How do I add a database instance to a schema?
      - Can a new DB instance track a specific branch or Git tag?
      instructions:
      - text: Create DB instance {identifier} for schema {dbschema} in {org}/{project} using connector {connector}.
        slots:
          identifier: requestBody.identifier
          dbschema: path.dbschema
          org: path.org
          project: path.project
          connector: requestBody.connector
      - text: Add instance {identifier} on branch {branch} to schema {dbschema} in project {project} of org {org}.
        slots:
          identifier: requestBody.identifier
          branch: requestBody.branch
          dbschema: path.dbschema
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database instance
      effect: read
      questions:
      - What is configured on a specific database instance?
      - Which connector and branch does a DB instance use?
      instructions:
      - text: Get DB instance {dbinstance} of schema {dbschema} in {org}/{project}.
        slots:
          dbinstance: path.dbinstance
          dbschema: path.dbschema
          org: path.org
          project: path.project
      - text: Show database instance {dbinstance} for schema {dbschema} in project {project} of org {org}.
        slots:
          dbinstance: path.dbinstance
          dbschema: path.dbschema
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database instance
      effect: destructive
      questions:
      - How do I remove a database instance from a schema?
      - Can I delete a DB instance that is no longer used?
      instructions:
      - text: Delete DB instance {dbinstance} from schema {dbschema} in {org}/{project}.
        slots:
          dbinstance: path.dbinstance
          dbschema: path.dbschema
          org: path.org
          project: path.project
      - text: Remove database instance {dbinstance} of schema {dbschema} in project {project} of org {org}.
        slots:
          dbinstance: path.dbinstance
          dbschema: path.dbschema
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instancelist'].post
  update:
    x-apievangelist-phrasing:
      intent: List database instances of a schema
      effect: read
      questions:
      - What database instances belong to a schema?
      - Can I filter a schema's instances by tag?
      instructions:
      - text: List DB instances of schema {dbschema} in {org}/{project}.
        slots:
          dbschema: path.dbschema
          org: path.org
          project: path.project
      - text: Show instances of schema {dbschema} in project {project} of org {org} tagged {instanceTags}.
        slots:
          dbschema: path.dbschema
          project: path.project
          org: path.org
          instanceTags: requestBody.instanceTags
      method: generated
      generated: '2026-09-26'