Appwrite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Appwrite Regions API

7 actions 7 updates phrasing extends openapi/appwrite-regions-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 7

$.info
$.paths['/regions/cache'].delete
$.paths['/regions/deployments/{deploymentId}/runtime'].get
$.paths['/regions/events'].post
$.paths['/regions/events/execution'].post
$.paths['/regions/project'].delete
$.paths['/regions/usage'].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 Regions API
  version: 1.0.0
extends: openapi/appwrite-regions-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: 6
- target: $.paths['/regions/cache'].delete
  update:
    x-apievangelist-phrasing:
      intent: Purge cached platform data across regions
      effect: destructive
      questions:
      - How do I purge a stale cached document from every network region?
      - Can I clear the whole platform manager cache at once?
      instructions:
      - text: Purge the cache for document {documentId} in collection {collectionId}.
        slots:
          documentId: query.documentId
          collectionId: query.collectionId
      - text: Purge cached data for project {projectId} in region {region}.
        slots:
          projectId: query.projectId
          region: query.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regions/deployments/{deploymentId}/runtime'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's runtime info
      effect: read
      questions:
      - Which runtime is a given function or site deployment using?
      - Can I look up runtime details for a deployment ID?
      instructions:
      - text: Get runtime info for deployment {deploymentId}.
        slots:
          deploymentId: path.deploymentId
      - text: Show the runtime of deployment {deploymentId} in project {projectId}.
        slots:
          deploymentId: path.deploymentId
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regions/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a CloudEvent in a region
      effect: write
      questions:
      - How do I queue an event in a region using the CloudEvents format?
      - Which CloudEvents fields are required to queue a regional event?
      instructions:
      - text: Queue a {type} event about {subject} with data {data}.
        slots:
          type: requestBody.type
          subject: requestBody.subject
          data: requestBody.data
      - text: Queue CloudEvent {type} for subject {subject} from source {source} with payload {data}.
        slots:
          type: requestBody.type
          subject: requestBody.subject
          source: requestBody.source
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regions/events/execution'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a function or site execution
      effect: write
      questions:
      - How is an execution record logged for a function or site request?
      - What request and response details are stored on an execution record?
      instructions:
      - text: 'Record an execution of deployment {deploymentId}: {requestMethod} {requestPath} returned {responseStatusCode} in {duration}.'
        slots:
          deploymentId: requestBody.deploymentId
          requestMethod: requestBody.requestMethod
          requestPath: requestBody.requestPath
          responseStatusCode: requestBody.responseStatusCode
          duration: requestBody.duration
      - text: Log a new execution record for deployment {deploymentId}.
        slots:
          deploymentId: requestBody.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regions/project'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a project from network regions
      effect: destructive
      questions:
      - How do I remove a project from all network regions?
      - What does deleting a project from the regions network require?
      instructions:
      - text: Delete project {projectId} from network regions.
        slots:
          projectId: query.projectId
      - text: Remove {projectId} from every region.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regions/usage'].post
  update:
    x-apievangelist-phrasing:
      intent: Push usage stats to the usage queue
      effect: write
      questions:
      - How are regional usage statistics sent to the stats queue?
      - Can I push a batch of usage metrics in one call?
      instructions:
      - text: Push usage stats {usage} to the stats usage queue.
        slots:
          usage: requestBody.usage
      - text: 'Send these usage metrics to the queue: {usage}.'
        slots:
          usage: requestBody.usage
      method: generated
      generated: '2026-09-26'