# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for IBANforge Account API
  version: 1.0.0
extends: openapi/ibanforge-account-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['/v1/account/code'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a sign-in code for the account page
      effect: write
      questions:
      - How do I sign in to the IBANforge account page without a password?
      - How long does the emailed 6-digit sign-in code stay valid?
      - Will the sign-in code be sent even if my address has no API keys?
      instructions:
      - text: Email a 6-digit account sign-in code to {email}.
        slots:
          email: requestBody.email
      - text: Send me a new code to sign in to the account page at {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/session'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange a sign-in code for an account session
      effect: write
      questions:
      - What happens after I enter the 6-digit code I received by email?
      - Why would a correct-looking sign-in code come back as invalid_code?
      - How long does an account page session last once I sign in?
      instructions:
      - text: Sign me in to the account page as {email} with code {code}.
        slots:
          email: requestBody.email
          code: requestBody.code
      - text: Open an account session using the emailed code {code} for {email}.
        slots:
          email: requestBody.email
          code: requestBody.code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: List every active key of the signed-in address
      effect: read
      questions:
      - Which API keys are attached to the email I signed in with?
      - Can I see each key's plan, calls this month and remaining allowance in one place?
      - How many deactivated keys does my address have?
      instructions:
      - text: Show all active API keys on my signed-in account.
      - text: Show page {page} of the keys on my account overview.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/keys/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the activity report of one account key
      effect: read
      questions:
      - Can I see the traffic and errors of one of my keys from the account page, by its prefix?
      - What is the longest window the account page report of a key can cover?
      instructions:
      - text: Show the account report for my key with prefix {prefix}.
        slots:
          prefix: query.prefix
      - text: Pull the last {days} days of activity for account key {prefix}.
        slots:
          prefix: query.prefix
          days: query.days
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account/logout'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign out of the account page
      effect: destructive
      questions:
      - How do I log out of the IBANforge account page?
      - Can I sign out of the account page in every browser at once?
      instructions:
      - text: Sign me out of the account page in this browser.
      - text: Sign out of the account page in every browser, with all set to {all}.
        slots:
          all: requestBody.all
      method: generated
      generated: '2026-09-26'