Appwrite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Appwrite Backups API
13 actions
13 updates
phrasing
extends
openapi/appwrite-backups-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Appwrite's API. It is a proposal applied on top of the contract, not a document Appwrite publishes.
What the actions change
x-apievangelist-phrasing
Targets 13
$.info
$.paths['/backups/archives'].get
$.paths['/backups/archives'].post
$.paths['/backups/archives/{archiveId}'].get
$.paths['/backups/archives/{archiveId}'].delete
$.paths['/backups/policies'].get
$.paths['/backups/policies'].post
$.paths['/backups/policies/{policyId}'].get
$.paths['/backups/policies/{policyId}'].delete
$.paths['/backups/policies/{policyId}'].patch
$.paths['/backups/restoration'].post
$.paths['/backups/restorations'].get
$.paths['/backups/restorations/{restorationId}'].get
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 Appwrite Backups API
version: 1.0.0
extends: openapi/appwrite-backups-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: 12
- target: $.paths['/backups/archives'].get
update:
x-apievangelist-phrasing:
intent: List the project's backup archives
effect: read
questions:
- Which backup archives exist for my project?
- Can I filter the list of backup archives with queries?
instructions:
- text: List all backup archives in this project.
- text: List backup archives matching {queries}.
slots:
queries: query.queries
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/archives'].post
update:
x-apievangelist-phrasing:
intent: Take an on-demand backup archive
effect: write
questions:
- How do I take a one-off backup of my project right now?
- Can I archive just one database instead of every service?
instructions:
- text: Create a backup archive of {services} now.
slots:
services: requestBody.services
- text: Archive {services} for resource {resourceId} immediately.
slots:
services: requestBody.services
resourceId: requestBody.resourceId
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/archives/{archiveId}'].get
update:
x-apievangelist-phrasing:
intent: Get a backup archive's details
effect: read
questions:
- What's the status and size of one specific backup archive?
- Is a particular archive finished and ready to restore from?
instructions:
- text: Show backup archive {archiveId}.
slots:
archiveId: path.archiveId
- text: Check whether archive {archiveId} has completed.
slots:
archiveId: path.archiveId
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/archives/{archiveId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a backup archive
effect: destructive
questions:
- Can I remove an old backup archive to free up space?
- What's the way to get rid of one backup archive permanently?
instructions:
- text: Delete backup archive {archiveId}.
slots:
archiveId: path.archiveId
- text: Permanently remove archive {archiveId} from this project.
slots:
archiveId: path.archiveId
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/policies'].get
update:
x-apievangelist-phrasing:
intent: List scheduled backup policies
effect: read
questions:
- Which scheduled backup policies are set up on my project?
- Can I search my backup policies with a query filter?
instructions:
- text: List every backup policy in this project.
- text: List backup policies matching {queries}.
slots:
queries: query.queries
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/policies'].post
update:
x-apievangelist-phrasing:
intent: Schedule automatic backups with a retention
effect: write
questions:
- How do I schedule automatic daily backups of my databases?
- How long can I keep backups, and can I set a retention period on a schedule?
instructions:
- text: Create backup policy {policyId} for {services} on schedule {schedule}, keeping them {retention} days.
slots:
policyId: requestBody.policyId
services: requestBody.services
schedule: requestBody.schedule
retention: requestBody.retention
- text: Set up a backup policy named {name} that backs up resource {resourceId} on {schedule} with {retention} days retention, id {policyId}, services {services}.
slots:
name: requestBody.name
resourceId: requestBody.resourceId
schedule: requestBody.schedule
retention: requestBody.retention
policyId: requestBody.policyId
services: requestBody.services
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/policies/{policyId}'].get
update:
x-apievangelist-phrasing:
intent: Get a backup policy's configuration
effect: read
questions:
- What schedule and retention does one of my backup policies use?
- Is a specific backup policy currently enabled?
instructions:
- text: Show backup policy {policyId}.
slots:
policyId: path.policyId
- text: Tell me the schedule and retention of policy {policyId}.
slots:
policyId: path.policyId
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/policies/{policyId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a backup policy
effect: destructive
questions:
- How do I stop and remove a scheduled backup policy entirely?
- Can I delete a backup policy I no longer want?
instructions:
- text: Delete backup policy {policyId}.
slots:
policyId: path.policyId
- text: Remove the scheduled backups defined by policy {policyId}.
slots:
policyId: path.policyId
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/policies/{policyId}'].patch
update:
x-apievangelist-phrasing:
intent: Change a backup policy's schedule or retention
effect: write
questions:
- Can I change how often an existing backup policy runs?
- Is it possible to pause an existing backup policy without deleting it?
instructions:
- text: Change backup policy {policyId} to run on {schedule}.
slots:
policyId: path.policyId
schedule: requestBody.schedule
- text: Set retention on existing policy {policyId} to {retention} days.
slots:
policyId: path.policyId
retention: requestBody.retention
- text: Set enabled to {enabled} on backup policy {policyId}.
slots:
enabled: requestBody.enabled
policyId: path.policyId
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/restoration'].post
update:
x-apievangelist-phrasing:
intent: Restore a backup archive
effect: write
questions:
- How do I restore my database from a backup archive?
- Can I restore a backup as a new database instead of overwriting the original?
instructions:
- text: Restore {services} from archive {archiveId} in place.
slots:
services: requestBody.services
archiveId: requestBody.archiveId
- text: Restore archive {archiveId} ({services}) as a new database {newResourceId} named {newResourceName}.
slots:
archiveId: requestBody.archiveId
services: requestBody.services
newResourceId: requestBody.newResourceId
newResourceName: requestBody.newResourceName
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/restorations'].get
update:
x-apievangelist-phrasing:
intent: List backup restorations
effect: read
questions:
- Which restorations have been run on my project?
- Can I filter past backup restorations with queries?
instructions:
- text: List all backup restorations for this project.
- text: List restorations matching {queries}.
slots:
queries: query.queries
method: generated
generated: '2026-09-26'
- target: $.paths['/backups/restorations/{restorationId}'].get
update:
x-apievangelist-phrasing:
intent: Check a restoration's status
effect: read
questions:
- Has my backup restore finished yet?
- What's the current status of one specific restoration?
instructions:
- text: Check the status of restoration {restorationId}.
slots:
restorationId: path.restorationId
- text: Show restoration {restorationId}.
slots:
restorationId: path.restorationId
method: generated
generated: '2026-09-26'