# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Prisma Databases API
  version: 1.0.0
extends: openapi/prisma-databases-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: 11
- target: $.paths['/v1/databases'].get
  update:
    x-apievangelist-phrasing:
      intent: List databases my token can access
      effect: read
      questions:
      - Which databases can my token access across all projects?
      - Can I filter the database list by project or git branch?
      instructions:
      - text: List all my databases.
      - text: List databases filtered to project {projectId}.
        slots:
          projectId: query.projectId
      - text: Show databases attached to git branch {branchGitName}.
        slots:
          branchGitName: query.branchGitName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/databases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database by passing its project
      effect: write
      questions:
      - Can I create a database and attach it to a git branch in one call?
      - How do I create a database by passing the project ID in the body?
      instructions:
      - text: Create a database named {name} with project ID {projectId} in the request body.
        slots:
          name: requestBody.name
          projectId: requestBody.projectId
      - text: Create a database in {projectId} on branch {branchGitName} in region {region}.
        slots:
          projectId: requestBody.projectId
          branchGitName: requestBody.branchGitName
          region: requestBody.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/databases/{databaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database by ID (v1)
      effect: read
      questions:
      - What does the v1 API return for a single database?
      - Can I look up one database by ID with the v1 endpoint?
      instructions:
      - text: Get database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Fetch database {databaseId} from the v1 API.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/databases/{databaseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database (v1)
      effect: destructive
      questions:
      - Can I delete a database by ID with the v1 API?
      - Is deleting a database through the v1 endpoint permanent?
      instructions:
      - text: Delete database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Remove database {databaseId} using the v1 endpoint.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/databases/{databaseId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a database or move it to a branch
      effect: write
      questions:
      - Can I rename an existing database?
      - How do I move a database to a different git branch?
      instructions:
      - text: Rename database {databaseId} to {name}.
        slots:
          databaseId: path.databaseId
          name: requestBody.name
      - text: Move database {databaseId} to git branch {branchGitName}.
        slots:
          databaseId: path.databaseId
          branchGitName: requestBody.branchGitName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/databases/{targetDatabaseId}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Overwrite a database with backup contents
      effect: destructive
      questions:
      - Are connections and credentials kept when I restore data into an existing database?
      - Will data written since the backup be lost if I restore over my database?
      instructions:
      - text: Overwrite database {targetDatabaseId} with the data from {source}.
        slots:
          targetDatabaseId: path.targetDatabaseId
          source: requestBody.source
      - text: Replace the data in {targetDatabaseId} from backup source {source}.
        slots:
          targetDatabaseId: path.targetDatabaseId
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/projects/{projectId}/databases'].get
  update:
    x-apievangelist-phrasing:
      intent: List the databases in a project
      effect: read
      questions:
      - Which databases belong to one specific project?
      - Can I paginate through a project's databases?
      instructions:
      - text: List the databases in project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show {limit} databases from project {projectId}.
        slots:
          limit: query.limit
          projectId: path.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/projects/{projectId}/databases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database under a project path
      effect: write
      questions:
      - Can I create a new database in a project from an existing source?
      - Is there a way to make a new database the project's default?
      instructions:
      - text: Create a database named {name} under project {projectId}.
        slots:
          name: requestBody.name
          projectId: path.projectId
      - text: Add a default database to project {projectId} with isDefault {isDefault}.
        slots:
          projectId: path.projectId
          isDefault: requestBody.isDefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectId}/databases'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a Prisma Postgres database
      effect: write
      questions:
      - How do I provision a Prisma Postgres database in a chosen region?
      - Which PostgreSQL version does a newly provisioned database run?
      instructions:
      - text: Provision a Prisma Postgres database in project {projectId} in region {region}.
        slots:
          projectId: path.projectId
          region: requestBody.region
      - text: Spin up a Postgres database called {name} in {region} for {projectId}.
        slots:
          name: requestBody.name
          region: requestBody.region
          projectId: path.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/databases/{databaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database's status and region
      effect: read
      questions:
      - What region and status is my Prisma Postgres database in?
      - Where can I see a database's connection details and status together?
      instructions:
      - text: Show status, region and connection details for database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Check whether Prisma Postgres database {databaseId} is ready.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/databases/{databaseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database with its backups
      effect: destructive
      questions:
      - Does deleting a Prisma Postgres database also remove its backups and connection strings?
      - Can a deleted Postgres database be undone?
      instructions:
      - text: Permanently delete Prisma Postgres database {databaseId} and its backups.
        slots:
          databaseId: path.databaseId
      - text: Destroy {databaseId} along with all its connection strings.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'