# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Jobs API
  version: 1.0.0
extends: openapi/auth0-jobs-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: 5
- target: $.paths['/jobs/users-exports'].post
  update:
    x-apievangelist-phrasing:
      intent: Export users to a file
      effect: write
      questions:
      - How do I export all my Auth0 users to a file?
      - Can I export only users from one connection, in CSV or JSON?
      instructions:
      - text: Start a job exporting all users.
      - text: Export users from connection {connection_id} in {format} format.
        slots:
          connection_id: requestBody.connection_id
          format: requestBody.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/jobs/users-imports'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk import users into a connection
      effect: write
      questions:
      - How do I bulk import users from a file into a database connection?
      - Can an import update existing users instead of failing on duplicates?
      instructions:
      - text: Import the users file {users} into connection {connection_id}.
        slots:
          users: requestBody.users
          connection_id: requestBody.connection_id
      - text: Import {users} into connection {connection_id} with upsert set to {upsert}.
        slots:
          users: requestBody.users
          connection_id: requestBody.connection_id
          upsert: requestBody.upsert
      method: generated
      generated: '2026-10-01'
- target: $.paths['/jobs/verification-email'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a user an email verification email
      effect: write
      questions:
      - Can I resend the verify-your-email message to a user?
      - Why would a verification email not be sent even though the request succeeds?
      instructions:
      - text: Send a verification email to user {user_id}.
        slots:
          user_id: requestBody.user_id
      - text: Resend the email verification link to user {user_id} for application {client_id}.
        slots:
          user_id: requestBody.user_id
          client_id: requestBody.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a job's status
      effect: read
      questions:
      - Has my user import or export job finished yet?
      - What is the current status of a long-running job?
      instructions:
      - text: Get job {id}.
        slots:
          id: path.id
      - text: Check whether job {id} has completed.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/jobs/{id}/errors'].get
  update:
    x-apievangelist-phrasing:
      intent: Get error details for a failed job
      effect: read
      questions:
      - Why did my user import job fail?
      - Which records caused errors in a bulk job?
      instructions:
      - text: Get the error details of job {id}.
        slots:
          id: path.id
      - text: Show which users failed in job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'