Appwrite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Appwrite Tokens API

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

$.info
$.paths['/tokens/buckets/{bucketId}/files/{fileId}'].get
$.paths['/tokens/buckets/{bucketId}/files/{fileId}'].post
$.paths['/tokens/{tokenId}'].get
$.paths['/tokens/{tokenId}'].delete
$.paths['/tokens/{tokenId}'].patch

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 Tokens API
  version: 1.0.0
extends: openapi/appwrite-tokens-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: 5
- target: $.paths['/tokens/buckets/{bucketId}/files/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List access tokens issued for a stored file
      effect: read
      questions:
      - Which share tokens have already been created for a file in my Appwrite storage bucket?
      - Can I filter the list of tokens that exist for one stored file?
      instructions:
      - text: List every token issued for file {fileId} in bucket {bucketId}.
        slots:
          fileId: path.fileId
          bucketId: path.bucketId
      - text: Show the tokens on file {fileId} in bucket {bucketId} matching {queries}.
        slots:
          fileId: path.fileId
          bucketId: path.bucketId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tokens/buckets/{bucketId}/files/{fileId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shareable access token for a file
      effect: write
      questions:
      - How do I generate a token so someone can open a stored file through a URL parameter?
      - Can a file access token be set to expire at a specific date?
      instructions:
      - text: Create a new access token for file {fileId} in bucket {bucketId}.
        slots:
          fileId: path.fileId
          bucketId: path.bucketId
      - text: Issue a token for file {fileId} in bucket {bucketId} that expires at {expire}.
        slots:
          fileId: path.fileId
          bucketId: path.bucketId
          expire: requestBody.expire
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tokens/{tokenId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single file token by ID
      effect: read
      questions:
      - What are the details and expiry of a specific file token?
      - Can I fetch one token by its ID without knowing its file?
      instructions:
      - text: Get the details of token {tokenId}.
        slots:
          tokenId: path.tokenId
      - text: Show me when token {tokenId} expires.
        slots:
          tokenId: path.tokenId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tokens/{tokenId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file access token
      effect: destructive
      questions:
      - How do I stop a file token from granting access by removing it entirely?
      - Is deleting a file token permanent?
      instructions:
      - text: Delete token {tokenId}.
        slots:
          tokenId: path.tokenId
      - text: Remove file token {tokenId} so the shared link no longer works.
        slots:
          tokenId: path.tokenId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tokens/{tokenId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the expiry date of a file token
      effect: write
      questions:
      - Can I extend the expiry of a file token I already created?
      - What field do I change to make an existing file token expire sooner?
      instructions:
      - text: Set the expiry of token {tokenId} to {expire}.
        slots:
          tokenId: path.tokenId
          expire: requestBody.expire
      - text: Extend existing token {tokenId} so it now expires at {expire}.
        slots:
          tokenId: path.tokenId
          expire: requestBody.expire
      method: generated
      generated: '2026-09-26'