Appwrite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Appwrite Advisor API

6 actions 6 updates phrasing extends openapi/appwrite-advisor-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['/reports'].get

$.paths['/reports/{reportId}'].get

$.paths['/reports/{reportId}'].delete

$.paths['/reports/{reportId}/insights'].get

$.paths['/reports/{reportId}/insights/{insightId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Appwrite Advisor API
  version: 1.0.0
extends: openapi/appwrite-advisor-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['/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List the project's analyzer reports
      effect: read
      questions:
      - Which analyzer reports has Appwrite Advisor produced for my project?
      - Can I filter my project's advisor reports with queries?
      instructions:
      - text: List all analyzer reports for this project.
      - text: List advisor reports matching {queries}.
        slots:
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/{reportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one analyzer report with its insights
      effect: read
      questions:
      - What did a specific analyzer report find, including its nested insights?
      - How do I open a single advisor report by its ID?
      instructions:
      - text: Show me analyzer report {reportId} and its insights.
        slots:
          reportId: path.reportId
      - text: Fetch the metadata for advisor report {reportId}.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/{reportId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an analyzer report
      effect: destructive
      questions:
      - Can I remove an old analyzer report I no longer need?
      - What happens to a report's insights when I delete the report?
      instructions:
      - text: Delete analyzer report {reportId}.
        slots:
          reportId: path.reportId
      - text: Remove advisor report {reportId} along with its insights.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/{reportId}/insights'].get
  update:
    x-apievangelist-phrasing:
      intent: List the insights inside one report
      effect: read
      questions:
      - What insights did one particular analyzer report produce?
      - Is it possible to filter the insights under a report?
      instructions:
      - text: List every insight under report {reportId}.
        slots:
          reportId: path.reportId
      - text: List insights in report {reportId} that match {queries}.
        slots:
          reportId: path.reportId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/{reportId}/insights/{insightId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single insight from a report
      effect: read
      questions:
      - How do I look up the details of one specific advisor insight?
      - What does a single insight inside an analyzer report contain?
      instructions:
      - text: Get insight {insightId} from report {reportId}.
        slots:
          insightId: path.insightId
          reportId: path.reportId
      - text: Show the details of insight {insightId} in analyzer report {reportId}.
        slots:
          insightId: path.insightId
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'