# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Appwrite Proxy API
  version: 1.0.0
extends: openapi/appwrite-proxy-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: 9
- target: $.paths['/proxy/invalidations'].post
  update:
    x-apievangelist-phrasing:
      intent: Purge CDN cache for a domain
      effect: write
      questions:
      - How do I clear the CDN cache for my custom domain?
      - Can I purge just one URL path or cache tag instead of everything?
      instructions:
      - text: Purge all cached content for {domain} using invalidation type {type}.
        slots:
          domain: requestBody.domain
          type: requestBody.type
      - text: Invalidate the {type} {reference} in the CDN cache for {domain}.
        slots:
          type: requestBody.type
          reference: requestBody.reference
          domain: requestBody.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proxy/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List proxy rules
      effect: read
      questions:
      - Which custom domains have proxy rules in my project?
      - Can I filter my proxy rules with queries?
      instructions:
      - text: List all proxy rules in this project.
      - text: List proxy rules matching {queries}.
        slots:
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proxy/rules/api'].post
  update:
    x-apievangelist-phrasing:
      intent: Serve the Appwrite API on a custom domain
      effect: write
      questions:
      - Can I serve the Appwrite API from my own domain?
      - How is the rule ID generated for an API proxy rule?
      instructions:
      - text: Serve the Appwrite API on {domain}.
        slots:
          domain: requestBody.domain
      - text: Create an API proxy rule for {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proxy/rules/function'].post
  update:
    x-apievangelist-phrasing:
      intent: Point a custom domain at a function
      effect: write
      questions:
      - How do I run an Appwrite Function on a custom domain?
      - Can a function domain rule target a specific branch?
      instructions:
      - text: Point {domain} at function {functionId}.
        slots:
          domain: requestBody.domain
          functionId: requestBody.functionId
      - text: Route {domain} to function {functionId} on branch {branch}.
        slots:
          domain: requestBody.domain
          functionId: requestBody.functionId
          branch: requestBody.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proxy/rules/redirect'].post
  update:
    x-apievangelist-phrasing:
      intent: Redirect a custom domain to another URL
      effect: write
      questions:
      - How do I redirect one of my domains to another address?
      - Can I choose the HTTP status code a domain redirect uses?
      instructions:
      - text: Redirect {domain} to {url} with status {statusCode}, attached to {resourceType} {resourceId}.
        slots:
          domain: requestBody.domain
          url: requestBody.url
          statusCode: requestBody.statusCode
          resourceType: requestBody.resourceType
          resourceId: requestBody.resourceId
      - text: Create a {statusCode} redirect from {domain} to {url} for {resourceType} {resourceId}.
        slots:
          statusCode: requestBody.statusCode
          domain: requestBody.domain
          url: requestBody.url
          resourceType: requestBody.resourceType
          resourceId: requestBody.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proxy/rules/site'].post
  update:
    x-apievangelist-phrasing:
      intent: Serve an Appwrite Site on a custom domain
      effect: write
      questions:
      - How do I connect my own domain to an Appwrite Site?
      - Can I serve a specific branch of my site on a domain?
      instructions:
      - text: Serve site {siteId} on {domain}.
        slots:
          siteId: requestBody.siteId
          domain: requestBody.domain
      - text: Point {domain} at site {siteId} using branch {branch}.
        slots:
          domain: requestBody.domain
          siteId: requestBody.siteId
          branch: requestBody.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proxy/rules/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a proxy rule
      effect: read
      questions:
      - What is a specific proxy rule pointing at?
      - Can I look up one domain rule by its ID?
      instructions:
      - text: Get proxy rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Show the details of domain rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proxy/rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a proxy rule
      effect: destructive
      questions:
      - How do I disconnect a custom domain from my project?
      - Can I delete a proxy rule I set up by mistake?
      instructions:
      - text: Delete proxy rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Remove the custom domain rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proxy/rules/{ruleId}/status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Retry domain verification for a proxy rule
      effect: write
      questions:
      - How do I re-check DNS for a custom domain that failed verification?
      - When does a TLS certificate get issued for my custom domain?
      instructions:
      - text: Retry DNS verification for proxy rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Re-verify the domain on rule {ruleId} and provision its certificate.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-09-26'