# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Appwrite Mongo API
  version: 1.0.0
extends: openapi/appwrite-mongo-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: 31
- target: $.paths['/mongo'].get
  update:
    x-apievangelist-phrasing:
      intent: List dedicated Mongo databases
      effect: read
      questions:
      - Which dedicated Mongo databases do I have in Appwrite?
      - Can I page through my dedicated Mongo databases?
      instructions:
      - text: List all my dedicated Mongo databases.
      - text: List dedicated Mongo databases matching {queries}.
        slots:
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a dedicated Mongo database
      effect: write
      questions:
      - How do I spin up a dedicated Mongo database?
      - Can I turn on point-in-time recovery and storage autoscaling when provisioning a Mongo database?
      instructions:
      - text: Create a dedicated Mongo database {name} with ID {databaseId}.
        slots:
          name: requestBody.name
          databaseId: requestBody.databaseId
      - text: Provision Mongo database {databaseId} named {name} on version {version} with specification {specification}.
        slots:
          databaseId: requestBody.databaseId
          name: requestBody.name
          version: requestBody.version
          specification: requestBody.specification
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/specifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List dedicated Mongo compute specifications
      effect: read
      questions:
      - What Mongo database sizes can I choose on my current plan?
      - How much does each dedicated Mongo specification cost, including overage?
      instructions:
      - text: Show the dedicated Mongo specifications available on my plan.
      - text: List Mongo compute sizes with their resource limits and prices.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dedicated Mongo database
      effect: read
      questions:
      - What is the configuration and status of my Mongo database?
      - Has my new Mongo database finished provisioning?
      instructions:
      - text: Get dedicated Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Show the configuration of Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dedicated Mongo database
      effect: destructive
      questions:
      - How do I permanently delete a dedicated Mongo database?
      - Can I re-run cleanup on a Mongo database stuck in deleting?
      instructions:
      - text: Delete dedicated Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Tear down Mongo database {databaseId} and clean up its resources.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a dedicated Mongo database's configuration
      effect: write
      questions:
      - Can I pause a Mongo database and resume it later?
      - How do I change the IP allowlist or replica count on a Mongo database without downtime?
      - What SQL API limits can I set on a dedicated Mongo database?
      instructions:
      - text: Pause Mongo database {databaseId} by setting status to {status}.
        slots:
          databaseId: path.databaseId
          status: requestBody.status
      - text: Resize Mongo database {databaseId} to specification {specification}.
        slots:
          databaseId: path.databaseId
          specification: requestBody.specification
      - text: Restrict connections to Mongo database {databaseId} to {networkIPAllowlist}.
        slots:
          databaseId: path.databaseId
          networkIPAllowlist: requestBody.networkIPAllowlist
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/backups'].get
  update:
    x-apievangelist-phrasing:
      intent: List backups of a Mongo database
      effect: read
      questions:
      - Which backups exist for my Mongo database?
      - Can I filter a Mongo database's backups by status or type?
      instructions:
      - text: List backups for Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: List backups of {databaseId} matching {queries}.
        slots:
          databaseId: path.databaseId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/backups'].post
  update:
    x-apievangelist-phrasing:
      intent: Take a manual backup of a Mongo database
      effect: write
      questions:
      - How do I take an on-demand backup of my Mongo database right now?
      - Can I choose between a full and an incremental manual backup?
      instructions:
      - text: Back up Mongo database {databaseId} now.
        slots:
          databaseId: path.databaseId
      - text: Take a {type} backup of Mongo database {databaseId}.
        slots:
          type: requestBody.type
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/backups/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled backup policies
      effect: read
      questions:
      - What scheduled backup policies are set on my Mongo database?
      - Are automatic backups configured for this Mongo database?
      instructions:
      - text: List backup schedules for Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Show the backup policies on {databaseId} matching {queries}.
        slots:
          databaseId: path.databaseId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/backups/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule recurring Mongo backups
      effect: write
      questions:
      - How do I schedule automatic backups for a Mongo database?
      - Can I set how long scheduled Mongo backups are retained?
      instructions:
      - text: Create backup policy {name} on Mongo database {databaseId} with schedule {schedule} and retention {retention}.
        slots:
          name: requestBody.name
          databaseId: path.databaseId
          schedule: requestBody.schedule
          retention: requestBody.retention
      - text: Add policy {policyId} to back up {databaseId} on {schedule}, keeping each for {retention}, named {name}.
        slots:
          policyId: requestBody.policyId
          databaseId: path.databaseId
          schedule: requestBody.schedule
          retention: requestBody.retention
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/backups/policies/{policyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scheduled backup policy
      effect: read
      questions:
      - What schedule and retention does a specific Mongo backup policy use?
      - Is a given Mongo backup policy currently enabled?
      instructions:
      - text: Get backup policy {policyId} on Mongo database {databaseId}.
        slots:
          policyId: path.policyId
          databaseId: path.databaseId
      - text: Show the details of backup policy {policyId}.
        slots:
          policyId: path.policyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/backups/policies/{policyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduled backup policy
      effect: destructive
      questions:
      - How do I stop scheduled backups on a Mongo database?
      - Are backups already taken kept after I delete their policy?
      instructions:
      - text: Delete backup policy {policyId} from Mongo database {databaseId}.
        slots:
          policyId: path.policyId
          databaseId: path.databaseId
      - text: Remove the backup schedule {policyId} on {databaseId}.
        slots:
          policyId: path.policyId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/backups/policies/{policyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a scheduled backup policy
      effect: write
      questions:
      - Can I change the schedule of an existing Mongo backup policy?
      - Is it possible to temporarily disable a backup policy without deleting it?
      instructions:
      - text: Change backup policy {policyId} on {databaseId} to run on {schedule}.
        slots:
          policyId: path.policyId
          databaseId: path.databaseId
          schedule: requestBody.schedule
      - text: Set enabled to {enabled} on backup policy {policyId} for {databaseId}.
        slots:
          enabled: requestBody.enabled
          policyId: path.policyId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/backups/storage'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure off-cluster backup storage
      effect: write
      questions:
      - Can I send my Mongo backups to my own S3, GCS or Azure bucket?
      - Does the Mongo backup storage setting support S3-compatible endpoints like MinIO?
      instructions:
      - text: Store Mongo database {databaseId} backups in {provider} bucket {bucket} using key {accessKey} and secret {secretKey}.
        slots:
          databaseId: path.databaseId
          provider: requestBody.provider
          bucket: requestBody.bucket
          accessKey: requestBody.accessKey
          secretKey: requestBody.secretKey
      - text: Send {databaseId} backups to {provider} bucket {bucket} at endpoint {endpoint} with prefix {prefix}, key {accessKey}, secret {secretKey}.
        slots:
          databaseId: path.databaseId
          provider: requestBody.provider
          bucket: requestBody.bucket
          endpoint: requestBody.endpoint
          prefix: requestBody.prefix
          accessKey: requestBody.accessKey
          secretKey: requestBody.secretKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/backups/{backupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Mongo backup's details
      effect: read
      questions:
      - Has my Mongo backup finished and how big is it?
      - When was a specific Mongo backup taken?
      instructions:
      - text: Get backup {backupId} of Mongo database {databaseId}.
        slots:
          backupId: path.backupId
          databaseId: path.databaseId
      - text: Check the status of backup {backupId}.
        slots:
          backupId: path.backupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/backups/{backupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Mongo backup
      effect: destructive
      questions:
      - How do I permanently remove an old Mongo backup?
      - Can a deleted Mongo backup be recovered?
      instructions:
      - text: Delete backup {backupId} of Mongo database {databaseId}.
        slots:
          backupId: path.backupId
          databaseId: path.databaseId
      - text: Permanently remove backup {backupId} from storage for {databaseId}.
        slots:
          backupId: path.backupId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/branches'].get
  update:
    x-apievangelist-phrasing:
      intent: List ephemeral branches of a Mongo database
      effect: read
      questions:
      - What test branches exist for my Mongo database?
      - When do my Mongo database branches expire?
      instructions:
      - text: List branches of Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Show ephemeral branches and their expiry for {databaseId}.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/branches'].post
  update:
    x-apievangelist-phrasing:
      intent: Branch a Mongo database for testing
      effect: write
      questions:
      - Can I make a throwaway copy of my Mongo database to test a schema migration?
      - How long can an ephemeral Mongo branch live before it expires?
      instructions:
      - text: Create a branch of Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Branch {databaseId} as {branchId} with a TTL of {ttl} seconds.
        slots:
          databaseId: path.databaseId
          branchId: requestBody.branchId
          ttl: requestBody.ttl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/branches/{branchId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an ephemeral Mongo branch
      effect: destructive
      questions:
      - How do I delete a test branch of my Mongo database before it expires?
      - Is deleting a Mongo branch reversible?
      instructions:
      - text: Delete branch {branchId} of Mongo database {databaseId}.
        slots:
          branchId: path.branchId
          databaseId: path.databaseId
      - text: Remove the ephemeral branch {branchId} now.
        slots:
          branchId: path.branchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/credentials'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rotate a Mongo database's connection credentials
      effect: write
      questions:
      - How do I rotate the primary connection password for my Mongo database?
      - Where do I get the new connection string after rotating Mongo credentials?
      instructions:
      - text: Rotate the connection credentials for Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Queue a credential rotation on {databaseId}.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/failovers'].post
  update:
    x-apievangelist-phrasing:
      intent: Fail over a Mongo database to a replica
      effect: write
      questions:
      - How do I promote a replica to primary on my Mongo database?
      - Can I repair a stuck Mongo upgrade by failing over to a named replica?
      instructions:
      - text: Trigger a failover on Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Fail over Mongo database {databaseId} to replica {targetReplicaId}.
        slots:
          databaseId: path.databaseId
          targetReplicaId: requestBody.targetReplicaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/maintenance'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set a Mongo database's maintenance window
      effect: write
      questions:
      - When do minor version upgrades happen on my Mongo database?
      - Can I move the Mongo maintenance window to a quiet hour?
      instructions:
      - text: Set the maintenance window for Mongo database {databaseId} to {day} at {hourUtc} UTC.
        slots:
          databaseId: path.databaseId
          day: requestBody.day
          hourUtc: requestBody.hourUtc
      - text: Schedule maintenance on {databaseId} every {day} at hour {hourUtc}.
        slots:
          databaseId: path.databaseId
          day: requestBody.day
          hourUtc: requestBody.hourUtc
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/migrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a Mongo database between shared and dedicated
      effect: write
      questions:
      - Can I convert my Mongo database from shared serverless to dedicated always-on?
      - What happens when I move a dedicated Mongo database back to shared?
      instructions:
      - text: Migrate Mongo database {databaseId} to {targetType}.
        slots:
          databaseId: path.databaseId
          targetType: requestBody.targetType
      - text: Move {databaseId} to {targetType} on specification {specification}.
        slots:
          databaseId: path.databaseId
          targetType: requestBody.targetType
          specification: requestBody.specification
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List lifecycle operations on a Mongo database
      effect: read
      questions:
      - What provisioning, backup and replication actions have run on my Mongo database?
      - Has my Mongo credential rotation reached a final status yet?
      instructions:
      - text: List lifecycle operations for Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Show the last {limit} Mongo operations on {databaseId} with status {status}.
        slots:
          limit: query.limit
          databaseId: path.databaseId
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/pitr'].get
  update:
    x-apievangelist-phrasing:
      intent: Get point-in-time recovery windows
      effect: read
      questions:
      - How far back can I restore my Mongo database to a point in time?
      - What are the earliest and latest recovery points for this Mongo database?
      instructions:
      - text: Get the PITR recovery window for Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Show the earliest and latest restore points for {databaseId}.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/replicas'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Mongo replica and HA status
      effect: read
      questions:
      - How much replication lag do my Mongo replicas have?
      - Are all replicas of my Mongo database healthy?
      instructions:
      - text: Get replica status for Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Show Mongo replication lag and sync mode for {databaseId}.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/restorations'].get
  update:
    x-apievangelist-phrasing:
      intent: List restorations of a Mongo database
      effect: read
      questions:
      - What restores have been run on my Mongo database?
      - Can I filter Mongo restorations to only point-in-time ones?
      instructions:
      - text: List restorations for Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: List {type} restorations on {databaseId} with status {status}.
        slots:
          type: query.type
          databaseId: path.databaseId
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/restorations'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a Mongo database from backup or PITR
      effect: write
      questions:
      - How do I restore my Mongo database from a backup?
      - Can I roll a Mongo database back to a specific moment in time?
      instructions:
      - text: Restore Mongo database {databaseId} from backup {backupId}.
        slots:
          databaseId: path.databaseId
          backupId: requestBody.backupId
      - text: Restore {databaseId} to {targetTime} using point-in-time recovery into {targetDatabaseId}.
        slots:
          databaseId: path.databaseId
          targetTime: requestBody.targetTime
          targetDatabaseId: requestBody.targetDatabaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/restorations/{restorationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Mongo restoration's status
      effect: read
      questions:
      - Has my Mongo restore finished?
      - What type and timestamps does a specific Mongo restoration have?
      instructions:
      - text: Get restoration {restorationId} for Mongo database {databaseId}.
        slots:
          restorationId: path.restorationId
          databaseId: path.databaseId
      - text: Check progress of restore {restorationId}.
        slots:
          restorationId: path.restorationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get health of a Mongo database
      effect: read
      questions:
      - Is my Mongo database healthy and accepting connections?
      - Where can I see uptime and volume usage for a Mongo database?
      instructions:
      - text: Check the health of Mongo database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Get real-time Mongo status and connection info for {databaseId}.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mongo/{databaseId}/upgrades'].post
  update:
    x-apievangelist-phrasing:
      intent: Upgrade a Mongo database's engine version
      effect: write
      questions:
      - How do I upgrade my Mongo database to a newer engine version?
      - Does a Mongo version upgrade cause downtime?
      instructions:
      - text: Upgrade Mongo database {databaseId} to version {targetVersion}.
        slots:
          databaseId: path.databaseId
          targetVersion: requestBody.targetVersion
      - text: Run a blue-green upgrade of {databaseId} to {targetVersion}.
        slots:
          databaseId: path.databaseId
          targetVersion: requestBody.targetVersion
      method: generated
      generated: '2026-09-26'