# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mailosaur Servers API
  version: 1.0.0
extends: openapi/mailosaur-servers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/api/servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List inboxes
      effect: read
      questions:
      - Which test inboxes do I have on my account?
      - Can I see all my servers in alphabetical order?
      instructions:
      - text: List all my inboxes.
      - text: Show every server on my account with its ID.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/servers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new inbox
      effect: write
      questions:
      - How do I set up a new test inbox for my QA team?
      - Can I give a new server a name when I create it?
      instructions:
      - text: Create a new inbox called {name}.
        slots:
          name: requestBody.name
      - text: Set up a fresh server for staging tests.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/servers/{serverId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inbox's details
      effect: read
      questions:
      - What settings and user access does a specific inbox have?
      - How many messages are sitting in one of my servers right now?
      instructions:
      - text: Show the details of inbox {serverId}.
        slots:
          serverId: path.serverId
      - text: Look up server {serverId} and tell me its name.
        slots:
          serverId: path.serverId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/servers/{serverId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an inbox or change its users
      effect: write
      questions:
      - How do I rename an existing inbox?
      - Can I change which users have access to a restricted server?
      instructions:
      - text: Rename inbox {serverId} to {name}.
        slots:
          serverId: path.serverId
          name: requestBody.name
      - text: Set the users with access to server {serverId} to {users}.
        slots:
          serverId: path.serverId
          users: requestBody.users
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/servers/{serverId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an inbox and all its messages
      effect: destructive
      questions:
      - How do I permanently delete a test inbox I no longer use?
      - Does removing a server also wipe its messages and attachments?
      instructions:
      - text: Delete inbox {serverId} permanently.
        slots:
          serverId: path.serverId
      - text: Remove server {serverId} along with everything stored in it.
        slots:
          serverId: path.serverId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/servers/{serverId}/password'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inbox's SMTP/POP3/IMAP password
      effect: read
      questions:
      - Where do I find the password to connect to my inbox over SMTP?
      - What credentials do I use for POP3 or IMAP access to a test server?
      instructions:
      - text: Get the password for inbox {serverId}.
        slots:
          serverId: path.serverId
      - text: Fetch the SMTP and IMAP password for server {serverId}.
        slots:
          serverId: path.serverId
      method: generated
      generated: '2026-10-01'