# 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 Schema API
  version: 1.0.0
extends: openapi/harness-database-schema-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: 7
- target: $.paths['/v1/dbops/dbschema'].get
  update:
    x-apievangelist-phrasing:
      intent: List database schemas across an account
      effect: read
      questions:
      - Which database schemas exist across all projects in our account?
      - Can I list DB schemas account-wide and optionally narrow to one project?
      instructions:
      - text: List database schemas across all projects in account {account}.
        slots:
          account: header.Harness-Account
      - text: Show account-wide DB schemas filtered to project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema'].get
  update:
    x-apievangelist-phrasing:
      intent: List database schemas in a project
      effect: read
      questions:
      - What database schemas are managed in this project?
      - Can I filter a project's DB schemas by migration type?
      instructions:
      - text: List database schemas in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Show {migrationType} schemas in {org}/{project}.
        slots:
          migrationType: query.migrationType
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database schema
      effect: write
      questions:
      - How do I register a new database schema for DB DevOps?
      - Can I attach a changelog script when creating a schema?
      instructions:
      - text: Create database schema {name} with identifier {identifier} in {org}/{project}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          org: path.org
          project: path.project
      - text: Add schema {identifier} using changelog {changelog} to project {project} of org {org}.
        slots:
          identifier: requestBody.identifier
          changelog: requestBody.changelog
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database schema
      effect: read
      questions:
      - What is configured on a specific database schema?
      - Where does a schema's changelog come from?
      instructions:
      - text: Get database schema {dbschema} in {org}/{project}.
        slots:
          dbschema: path.dbschema
          org: path.org
          project: path.project
      - text: Show schema {dbschema} details 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}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a database schema
      effect: write
      questions:
      - How do I change the changelog or service linked to a schema?
      - Can I set a primary database instance on a schema?
      instructions:
      - text: Update schema {dbschema} in {org}/{project} to use changelog {changelog}.
        slots:
          dbschema: path.dbschema
          org: path.org
          project: path.project
          changelog: requestBody.changelog
      - text: Set primary instance {primaryDbInstanceId} on schema {dbschema} in project {project} of org {org}.
        slots:
          primaryDbInstanceId: requestBody.primaryDbInstanceId
          dbschema: path.dbschema
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database schema
      effect: destructive
      questions:
      - How do I delete a database schema from a project?
      - Can I remove a schema I no longer manage?
      instructions:
      - text: Delete database schema {dbschema} from {org}/{project}.
        slots:
          dbschema: path.dbschema
          org: path.org
          project: path.project
      - text: Remove 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/{dbinstance}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a database instance of a schema
      effect: write
      questions:
      - How do I change the branch or connector of a schema's database instance?
      - Can I pin a database instance to a Git tag or commit?
      instructions:
      - text: Update instance {dbinstance} of schema {dbschema} in {org}/{project} to branch {branch}.
        slots:
          dbinstance: path.dbinstance
          dbschema: path.dbschema
          org: path.org
          project: path.project
          branch: requestBody.branch
      - text: Point DB instance {dbinstance} of schema {dbschema} in project {project} of org {org} at connector {connector}.
        slots:
          dbinstance: path.dbinstance
          dbschema: path.dbschema
          project: path.project
          org: path.org
          connector: requestBody.connector
      method: generated
      generated: '2026-09-26'