# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas App migration API
  version: 1.0.0
extends: openapi/nylas-app-migration-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['/v3/migration-tools/link-v2v3-apps'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a v2 application to a v3 application
      effect: write
      questions:
      - How do I connect my old v2 app to a new v3 app before migrating?
      - Do my v2 and v3 apps need to be in the same data center region?
      instructions:
      - text: Link my v2 application to my v3 application.
      - text: Pair the existing v2 app with its v3 counterpart for migration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/migration-tools/import-v2-app'].post
  update:
    x-apievangelist-phrasing:
      intent: Import v2 app settings into the linked v3 app
      effect: write
      questions:
      - Can I copy my v2 application's settings into the linked v3 app?
      - What has to happen before I import v2 app settings?
      instructions:
      - text: Import the v2 app settings into its linked v3 application.
      - text: Copy configuration from my linked v2 app into the v3 app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/migration-tools/grants/{account_id}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate one v2 account to a v3 grant
      effect: write
      questions:
      - How do I test-migrate a single v2 connected account to v3?
      - Can I create an invalid v3 grant if the account's credentials don't carry over?
      instructions:
      - text: Migrate v2 account {account} to a v3 grant.
        slots:
          account: path.account_id
      - text: Clone v2 account {account} to v3, allowing invalid grant creation.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/migration-tools/snapshot-batch-clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Batch-migrate v2 accounts to v3 grants
      effect: write
      questions:
      - How do I migrate all my remaining v2 accounts to v3 in one job?
      - Can I limit a batch migration to certain providers?
      instructions:
      - text: Start a batch clone of v2 accounts to v3 grants.
      - text: Batch-migrate {limit} v2 accounts to v3, skipping the first {offset}.
        slots:
          limit: requestBody.limit
          offset: requestBody.offset
      - text: Batch-migrate only {providers} v2 accounts to v3 grants.
        slots:
          providers: requestBody.providers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/migration-tools/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: Check migration job progress
      effect: read
      questions:
      - What's the progress of my running v2-to-v3 migration jobs?
      - Can I list only migration jobs that have completed?
      instructions:
      - text: Show my migration jobs.
      - text: List migration jobs with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'