# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Edge Impulse Email Verification API
  version: 1.0.0
extends: openapi/edge-impulse-email-verification-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: 4
- target: $.paths['/api/emails/{email}/request-verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an email verification code
      effect: write
      questions:
      - How do I get Edge Impulse to send an activation code to an email address?
      - Can I choose where the user lands after they click the verification email?
      instructions:
      - text: Send a verification code to {email} and redirect them to {redirectUrl} afterwards.
        slots:
          email: path.email
          redirectUrl: requestBody.redirectUrl
      - text: Request an email activation code for {email}, returning to {redirectUrl} once verified.
        slots:
          email: path.email
          redirectUrl: requestBody.redirectUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/emails/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an email address with a code
      effect: write
      questions:
      - What do I do with the verification code I received by email?
      - Can I confirm an email address by submitting the activation code from the message?
      instructions:
      - text: Verify my email address using code {code}.
        slots:
          code: requestBody.code
      - text: Submit verification code {code} to confirm the email.
        slots:
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/emails/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if an email is valid for sign-up
      effect: read
      questions:
      - Is this email address acceptable for creating a new account?
      - Can I check an address before sign-up so the account won't miss emailed features?
      instructions:
      - text: Check whether {email} is valid for account sign-up.
        slots:
          email: requestBody.email
      - text: Validate {email} before I register with it.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/emails/{emailId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of an email verification
      effect: read
      questions:
      - Has a pending email verification request been completed yet?
      - Where can I see the current state of a verification I requested?
      instructions:
      - text: Get the status of email verification {emailId}.
        slots:
          emailId: path.emailId
      - text: Check whether verification request {emailId} has been confirmed.
        slots:
          emailId: path.emailId
      method: generated
      generated: '2026-10-01'