Appwrite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Appwrite Functions API

29 actions 29 updates phrasing extends openapi/appwrite-functions-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 29 · first 16 shown; the file carries all of them

$.info
$.paths['/functions'].get
$.paths['/functions'].post
$.paths['/functions/runtimes'].get
$.paths['/functions/specifications'].get
$.paths['/functions/templates'].get
$.paths['/functions/templates/{templateId}'].get
$.paths['/functions/{functionId}'].get
$.paths['/functions/{functionId}'].put
$.paths['/functions/{functionId}'].delete
$.paths['/functions/{functionId}/deployment'].patch
$.paths['/functions/{functionId}/deployments'].get
$.paths['/functions/{functionId}/deployments'].post
$.paths['/functions/{functionId}/deployments/duplicate'].post
$.paths['/functions/{functionId}/deployments/template'].post
$.paths['/functions/{functionId}/deployments/vcs'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Appwrite Functions API
  version: 1.0.0
extends: openapi/appwrite-functions-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: 28
- target: $.paths['/functions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the project's functions
      effect: read
      questions:
      - What serverless functions are defined in my Appwrite project?
      - Can I search my functions by name?
      instructions:
      - text: List all functions in this project.
      - text: Search my functions for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a serverless function
      effect: write
      questions:
      - How do I create a new cloud function with a chosen runtime?
      - Can a new function be triggered by events or a cron schedule?
      - Is it possible to link a function to a Git repository when I create it?
      instructions:
      - text: Create function {name} with ID {functionId} on the {runtime} runtime.
        slots:
          name: requestBody.name
          functionId: requestBody.functionId
          runtime: requestBody.runtime
      - text: Create function {functionId} named {name} using {runtime} that runs on the cron {schedule}.
        slots:
          functionId: requestBody.functionId
          name: requestBody.name
          runtime: requestBody.runtime
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/runtimes'].get
  update:
    x-apievangelist-phrasing:
      intent: List available function runtimes
      effect: read
      questions:
      - Which languages and runtime versions can my functions use?
      - What runtimes are currently active on this instance?
      instructions:
      - text: List the function runtimes available on this instance.
      - text: Show me every active runtime I can pick for a function.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/specifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List allowed function compute specs
      effect: read
      questions:
      - What CPU and memory sizes can I give a function?
      - Which function specifications are allowed on this instance?
      instructions:
      - text: List the allowed function specifications.
      - text: List function specifications of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse function templates
      effect: read
      questions:
      - Are there ready-made function templates I can start from?
      - Can I filter function templates by runtime or use case?
      instructions:
      - text: List the available function templates.
      - text: Show function templates for the {runtimes} runtime covering {useCases}.
        slots:
          runtimes: query.runtimes
          useCases: query.useCases
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/templates/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one function template
      effect: read
      questions:
      - What does a specific function template include before I use it?
      - How do I read the details of one template by its ID?
      instructions:
      - text: Show function template {templateId}.
        slots:
          templateId: path.templateId
      - text: Get the runtimes and settings of template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a function's configuration
      effect: read
      questions:
      - How do I view the settings of one function, like its runtime and timeout?
      - Which deployment is a given function currently running?
      instructions:
      - text: Show function {functionId}.
        slots:
          functionId: path.functionId
      - text: Get the runtime, schedule and events of function {functionId}.
        slots:
          functionId: path.functionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a function's settings
      effect: write
      questions:
      - Can I change the timeout or schedule of an existing function?
      - How do I switch an existing function to a different runtime?
      instructions:
      - text: 'Update function {functionId}: keep the name {name} and set the timeout to {timeout} seconds.'
        slots:
          functionId: path.functionId
          name: requestBody.name
          timeout: requestBody.timeout
      - text: Change function {functionId} (name {name}) to run on the cron {schedule}.
        slots:
          functionId: path.functionId
          name: requestBody.name
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a function
      effect: destructive
      questions:
      - How do I permanently remove a function from my project?
      - Can I delete a function I no longer use?
      instructions:
      - text: Delete function {functionId}.
        slots:
          functionId: path.functionId
      - text: Remove the function {functionId} from this project.
        slots:
          functionId: path.functionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/deployment'].patch
  update:
    x-apievangelist-phrasing:
      intent: Switch a function's active deployment
      effect: write
      questions:
      - How do I roll a function back to an earlier deployment?
      - Can I choose which code deployment a function serves?
      instructions:
      - text: Make deployment {deploymentId} the active one for function {functionId}.
        slots:
          deploymentId: requestBody.deploymentId
          functionId: path.functionId
      - text: Roll function {functionId} back to deployment {deploymentId}.
        slots:
          functionId: path.functionId
          deploymentId: requestBody.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a function's deployments
      effect: read
      questions:
      - What code deployments exist for one of my functions?
      - Can I search a function's deployment history?
      instructions:
      - text: List the deployments of function {functionId}.
        slots:
          functionId: path.functionId
      - text: List deployments of function {functionId} matching {queries}.
        slots:
          functionId: path.functionId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload new function code
      effect: write
      questions:
      - How do I upload a tar.gz of my code as a new function deployment?
      - Can a code upload go live immediately instead of waiting for manual activation?
      instructions:
      - text: 'Upload {code} as a new deployment of function {functionId}, activate: {activate}.'
        slots:
          code: requestBody.code
          functionId: path.functionId
          activate: requestBody.activate
      - text: 'Deploy the archive {code} to function {functionId} with entrypoint {entrypoint}, activate: {activate}.'
        slots:
          code: requestBody.code
          functionId: path.functionId
          entrypoint: requestBody.entrypoint
          activate: requestBody.activate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/deployments/duplicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rebuild an existing function deployment
      effect: write
      questions:
      - After changing build commands, can I rebuild an old deployment without re-uploading code?
      - What call queues a fresh build of an existing deployment?
      instructions:
      - text: Rebuild deployment {deploymentId} of function {functionId} with the current settings.
        slots:
          deploymentId: requestBody.deploymentId
          functionId: path.functionId
      - text: Duplicate deployment {deploymentId} on function {functionId} from build {buildId}.
        slots:
          deploymentId: requestBody.deploymentId
          functionId: path.functionId
          buildId: requestBody.buildId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/deployments/template'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a function from a template
      effect: write
      questions:
      - Can I deploy a function straight from one of the starter templates?
      - What do I need to supply to deploy template code from a repository?
      instructions:
      - text: Deploy template repo {owner}/{repository} from {rootDirectory} at {type} {reference} to function {functionId}.
        slots:
          owner: requestBody.owner
          repository: requestBody.repository
          rootDirectory: requestBody.rootDirectory
          type: requestBody.type
          reference: requestBody.reference
          functionId: path.functionId
      - text: Create a template deployment on function {functionId} using {owner}/{repository}, folder {rootDirectory}, {type} {reference}, and activate it.
        slots:
          functionId: path.functionId
          owner: requestBody.owner
          repository: requestBody.repository
          rootDirectory: requestBody.rootDirectory
          type: requestBody.type
          reference: requestBody.reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/deployments/vcs'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a function from its connected repo
      effect: write
      questions:
      - How do I deploy a Git-connected function from a specific branch, commit or tag?
      - Can I redeploy from the latest commit on the linked repository?
      instructions:
      - text: Deploy function {functionId} from {type} {reference} of its connected repository.
        slots:
          functionId: path.functionId
          type: requestBody.type
          reference: requestBody.reference
      - text: Build function {functionId} from the Git {type} {reference} and set activate to {activate}.
        slots:
          functionId: path.functionId
          type: requestBody.type
          reference: requestBody.reference
          activate: requestBody.activate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/deployments/{deploymentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one function deployment
      effect: read
      questions:
      - Did my latest function deployment build successfully?
      - How do I check the build status of a particular deployment?
      instructions:
      - text: Show deployment {deploymentId} of function {functionId}.
        slots:
          deploymentId: path.deploymentId
          functionId: path.functionId
      - text: Get the build status of deployment {deploymentId} on function {functionId}.
        slots:
          deploymentId: path.deploymentId
          functionId: path.functionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/deployments/{deploymentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a function deployment
      effect: destructive
      questions:
      - Can I clean up old code deployments of a function?
      - How do I remove one deployment I no longer need?
      instructions:
      - text: Delete deployment {deploymentId} from function {functionId}.
        slots:
          deploymentId: path.deploymentId
          functionId: path.functionId
      - text: Remove the old deployment {deploymentId} of function {functionId}.
        slots:
          deploymentId: path.deploymentId
          functionId: path.functionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/deployments/{deploymentId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a function deployment's code
      effect: read
      questions:
      - Can I download the source code that was deployed to a function?
      - Is it possible to download the built output rather than the source of a deployment?
      instructions:
      - text: Download the code of deployment {deploymentId} for function {functionId}.
        slots:
          deploymentId: path.deploymentId
          functionId: path.functionId
      - text: Download the {type} package of deployment {deploymentId} on function {functionId}.
        slots:
          type: query.type
          deploymentId: path.deploymentId
          functionId: path.functionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/deployments/{deploymentId}/status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Cancel a function deployment build
      effect: destructive
      questions:
      - How do I stop a function build that is still running?
      - Can I cancel a deployment build that has already finished?
      instructions:
      - text: Cancel the build of deployment {deploymentId} on function {functionId}.
        slots:
          deploymentId: path.deploymentId
          functionId: path.functionId
      - text: Stop the in-progress build for function {functionId} deployment {deploymentId}.
        slots:
          functionId: path.functionId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a function's execution logs
      effect: read
      questions:
      - Where can I see the recent runs and logs of a function?
      - Can I filter function executions to only failed ones?
      instructions:
      - text: List the executions of function {functionId}.
        slots:
          functionId: path.functionId
      - text: List executions of function {functionId} matching {queries}.
        slots:
          functionId: path.functionId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/executions'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a function
      effect: write
      questions:
      - How do I trigger a function and pass it a request body?
      - Can I execute a function asynchronously or schedule it for later?
      - Which HTTP method and path can I send when invoking a function?
      instructions:
      - text: Execute function {functionId} with body {body}.
        slots:
          functionId: path.functionId
          body: requestBody.body
      - text: Run function {functionId} asynchronously at {scheduledAt}.
        slots:
          functionId: path.functionId
          scheduledAt: requestBody.scheduledAt
      - text: Invoke function {functionId} as a {method} request to {path}.
        slots:
          functionId: path.functionId
          method: requestBody.method
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/executions/{executionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one function execution
      effect: read
      questions:
      - Has my function execution finished, and what did it return?
      - How do I read the log of a single function run?
      instructions:
      - text: Show execution {executionId} of function {functionId}.
        slots:
          executionId: path.executionId
          functionId: path.functionId
      - text: Get the status and output of run {executionId} on function {functionId}.
        slots:
          executionId: path.executionId
          functionId: path.functionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/executions/{executionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a function execution log
      effect: destructive
      questions:
      - Can I delete the record of a single function run?
      - How do I remove an execution log that contains sensitive output?
      instructions:
      - text: Delete execution {executionId} of function {functionId}.
        slots:
          executionId: path.executionId
          functionId: path.functionId
      - text: Remove the execution log {executionId} from function {functionId}.
        slots:
          executionId: path.executionId
          functionId: path.functionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List a function's environment variables
      effect: read
      questions:
      - Which environment variables are set on my function?
      - Can I filter a function's variables with queries?
      instructions:
      - text: List the environment variables of function {functionId}.
        slots:
          functionId: path.functionId
      - text: List variables on function {functionId} matching {queries}.
        slots:
          functionId: path.functionId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an environment variable to a function
      effect: write
      questions:
      - How do I give my function an API key as an environment variable?
      - Can I mark a new function variable as secret so its value is hidden?
      instructions:
      - text: Add variable {key} = {value} to function {functionId} with ID {variableId}.
        slots:
          key: requestBody.key
          value: requestBody.value
          functionId: path.functionId
          variableId: requestBody.variableId
      - text: 'Create variable {variableId} named {key} with value {value} on function {functionId}, secret: {secret}.'
        slots:
          variableId: requestBody.variableId
          key: requestBody.key
          value: requestBody.value
          functionId: path.functionId
          secret: requestBody.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/variables/{variableId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one function variable
      effect: read
      questions:
      - What is the current value of one of my function's variables?
      - How do I look up a single environment variable by its ID?
      instructions:
      - text: Show variable {variableId} of function {functionId}.
        slots:
          variableId: path.variableId
          functionId: path.functionId
      - text: Get the key and value of variable {variableId} on function {functionId}.
        slots:
          variableId: path.variableId
          functionId: path.functionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/variables/{variableId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a function variable
      effect: write
      questions:
      - How do I rotate the value of an existing function variable?
      - Can I rename a function variable's key after creating it?
      instructions:
      - text: Set variable {variableId} on function {functionId} to {value}.
        slots:
          variableId: path.variableId
          functionId: path.functionId
          value: requestBody.value
      - text: Rename variable {variableId} of function {functionId} to {key}.
        slots:
          variableId: path.variableId
          functionId: path.functionId
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions/{functionId}/variables/{variableId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a function variable
      effect: destructive
      questions:
      - How do I remove an environment variable from a function?
      - Can I clear out a stale variable from one function's environment?
      instructions:
      - text: Delete variable {variableId} from function {functionId}.
        slots:
          variableId: path.variableId
          functionId: path.functionId
      - text: Remove the environment variable {variableId} on function {functionId}.
        slots:
          variableId: path.variableId
          functionId: path.functionId
      method: generated
      generated: '2026-09-26'