# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Appwrite Console API
  version: 1.0.0
extends: openapi/appwrite-console-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: 19
- target: $.paths['/console/campaigns/{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a marketing campaign's details
      effect: read
      questions:
      - What does a particular console campaign offer?
      - Can I look up a campaign by its ID?
      instructions:
      - text: Show the details of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Get campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/coupons/{couponId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a coupon code in the console
      effect: read
      questions:
      - Is a coupon code valid, and what credit does it give?
      - Can the console look up any coupon by its code?
      instructions:
      - text: Look up console coupon {couponId}.
        slots:
          couponId: path.couponId
      - text: Check the console details of coupon code {couponId}.
        slots:
          couponId: path.couponId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/databases'].get
  update:
    x-apievangelist-phrasing:
      intent: List every database in the project
      effect: read
      questions:
      - Can I see all my project's databases across every type in one call?
      - Can I search the project's databases by name?
      instructions:
      - text: List every database in my project across all types.
      - text: Search my project's databases for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/oauth2-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported OAuth2 login providers
      effect: read
      questions:
      - Which OAuth2 providers can I enable for sign-in?
      - What settings does each OAuth2 provider need to be configured?
      instructions:
      - text: List the OAuth2 providers the server supports.
      - text: Show the configuration parameters required for each OAuth2 provider.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List available billing plans
      effect: read
      questions:
      - What billing plans are available?
      - Can I list plans for a specific platform only?
      instructions:
      - text: List all available billing plans.
      - text: List plans for platform {platform}.
        slots:
          platform: query.platform
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/plans/{planId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one billing plan's details
      effect: read
      questions:
      - What limits and pricing come with a specific plan?
      - Can I fetch a single plan by its ID?
      instructions:
      - text: Show the details of plan {planId}.
        slots:
          planId: path.planId
      - text: Get pricing and limits for plan {planId}.
        slots:
          planId: path.planId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/postgres-extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List installable Postgres extensions
      effect: read
      questions:
      - Which Postgres extensions can I install on a dedicated database?
      - Is pgvector in the catalog of available Postgres extensions?
      instructions:
      - text: List the Postgres extensions available for dedicated databases.
      - text: Show the catalog of installable Postgres extensions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/programs/{programId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a program's details
      effect: read
      questions:
      - What does a console program such as a startup program include?
      - Can I look up a program by its ID?
      instructions:
      - text: Show the details of program {programId}.
        slots:
          programId: path.programId
      - text: Get program {programId}.
        slots:
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/programs/{programId}/memberships'].post
  update:
    x-apievangelist-phrasing:
      intent: Join a program
      effect: write
      questions:
      - How do I enroll my account in a program?
      - Can I sign up for a console program from the API?
      instructions:
      - text: Enroll my account in program {programId}.
        slots:
          programId: path.programId
      - text: Create a membership for me in program {programId}.
        slots:
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List regions available in the console
      effect: read
      questions:
      - Which regions can I create a project in?
      - What cloud regions does the console offer?
      instructions:
      - text: List the regions available in the console.
      - text: Show me where I can host a new project.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a resource ID is available
      effect: read
      questions:
      - Is a project or resource ID I want still free to use?
      - Can I check whether a custom ID is already taken before creating something?
      instructions:
      - text: Check whether {type} ID {value} is available.
        slots:
          type: query.type
          value: query.value
      - text: See if {value} is free as a {type} identifier.
        slots:
          value: query.value
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/scopes/organization'].get
  update:
    x-apievangelist-phrasing:
      intent: List scopes for organization API keys
      effect: read
      questions:
      - Which permission scopes can an organization API key have?
      - What does each organization key scope allow?
      instructions:
      - text: List all scopes available for organization API keys.
      - text: Describe each organization key scope.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/scopes/project'].get
  update:
    x-apievangelist-phrasing:
      intent: List scopes for project API keys
      effect: read
      questions:
      - Which permission scopes can a project API key be given?
      - What does each project key scope grant access to?
      instructions:
      - text: List all scopes available for project API keys.
      - text: Describe each project API key scope.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Record where a sign-up came from
      effect: write
      questions:
      - How do I record the UTM source and campaign for a new console sign-up?
      - Can I track the referrer that brought a user to the console?
      instructions:
      - text: Record a source with UTM source {utmSource}, campaign {utmCampaign} and medium {utmMedium}.
        slots:
          utmSource: requestBody.utmSource
          utmCampaign: requestBody.utmCampaign
          utmMedium: requestBody.utmMedium
      - text: Create a source for referrer {referrer} with ref code {ref}.
        slots:
          referrer: requestBody.referrer
          ref: requestBody.ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/suggestions/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest columns for a table
      effect: read
      questions:
      - Can Appwrite suggest column names and sizes for a new table?
      - Can I give extra context to get better column suggestions?
      instructions:
      - text: Suggest columns for table {tableId} in database {databaseId}.
        slots:
          tableId: query.tableId
          databaseId: query.databaseId
      - text: Suggest columns for {tableId} in {databaseId} given the context {context}.
        slots:
          tableId: query.tableId
          databaseId: query.databaseId
          context: query.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/suggestions/indexes'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest indexes for a table
      effect: read
      questions:
      - Which indexes would speed up queries on my table?
      - Can I get index recommendations based on my table's columns?
      instructions:
      - text: Suggest indexes for table {tableId} in database {databaseId}.
        slots:
          tableId: query.tableId
          databaseId: query.databaseId
      - text: Recommend between {min} and {max} indexes for {tableId} in {databaseId}.
        slots:
          min: query.min
          max: query.max
          tableId: query.tableId
          databaseId: query.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/suggestions/queries'].get
  update:
    x-apievangelist-phrasing:
      intent: Turn plain text into Appwrite list queries
      effect: read
      questions:
      - Can I describe a filter in plain English and get valid query JSON back?
      - Which list resources support query suggestions from free text?
      instructions:
      - text: Suggest queries for {resource} from the request {input}.
        slots:
          resource: query.resource
          input: query.input
      - text: Turn {input} into query JSON for rows in table {tableId} of database {databaseId}, resource {resource}.
        slots:
          input: query.input
          tableId: query.tableId
          databaseId: query.databaseId
          resource: query.resource
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/templates/email/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a built-in default email template
      effect: read
      questions:
      - What does the default verification or recovery email template look like?
      - Can I get the built-in email template in another locale?
      instructions:
      - text: Show the default {templateId} email template.
        slots:
          templateId: path.templateId
      - text: Get the built-in {templateId} email template in locale {locale}.
        slots:
          templateId: path.templateId
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the console's environment variables
      effect: read
      questions:
      - Which environment variables does the console rely on?
      - Can I read the console-relevant configuration of this server?
      instructions:
      - text: Show the environment variables relevant to the console.
      - text: Get the console configuration variables.
      method: generated
      generated: '2026-09-26'