Appwrite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Appwrite Usage API

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

$.info
$.paths['/usage/events'].get
$.paths['/usage/gauges'].get

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 Usage API
  version: 1.0.0
extends: openapi/appwrite-usage-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: 2
- target: $.paths['/usage/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Aggregate usage event metrics over time
      effect: read
      questions:
      - What were my top paths by bandwidth over the last 7 days?
      - How can I chart request or execution counts per hour, broken down by country or status?
      - Can I get up to ten event metrics like executions in a single Appwrite usage call?
      instructions:
      - text: Show {metrics} event totals from {startAt} to {endAt}.
        slots:
          metrics: query.metrics
          startAt: query.startAt
          endAt: query.endAt
      - text: Chart {metrics} events per {interval} broken down by {dimensions}.
        slots:
          metrics: query.metrics
          interval: query.interval
          dimensions: query.dimensions
      - text: Give me the top {limit} rows of {metrics} events grouped by {dimensions}.
        slots:
          limit: query.limit
          metrics: query.metrics
          dimensions: query.dimensions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usage/gauges'].get
  update:
    x-apievangelist-phrasing:
      intent: Aggregate point-in-time usage gauges
      effect: read
      questions:
      - How much file storage is my project holding right now, and how has that snapshot changed?
      - Can I see resource counts over time as the peak rather than the latest reading in each bucket?
      - Which teams or resources hold the most storage according to the usage gauges?
      instructions:
      - text: Show the {metrics} gauge snapshot per {interval} from {startAt} to {endAt}.
        slots:
          metrics: query.metrics
          interval: query.interval
          startAt: query.startAt
          endAt: query.endAt
      - text: Get the {metrics} gauge combined with {aggregate} in each bucket.
        slots:
          metrics: query.metrics
          aggregate: query.aggregate
      - text: Break down the {metrics} gauge by {dimensions}.
        slots:
          metrics: query.metrics
          dimensions: query.dimensions
      method: generated
      generated: '2026-09-26'