# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for authentik Tasks API
  version: 1.0.0
extends: openapi/authentik-tasks-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: 10
- target: $.paths['/tasks/schedules/'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled background jobs
      effect: read
      questions:
      - Which recurring background jobs are scheduled in authentik?
      - Can I see only the schedules that are paused?
      instructions:
      - text: List all task schedules.
      - text: Show schedules for actor {actor_name} with paused = {paused}.
        slots:
          actor_name: query.actor_name
          paused: query.paused
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/schedules/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task schedule
      effect: read
      questions:
      - What crontab does a specific schedule run on?
      - Is a particular recurring job currently paused?
      instructions:
      - text: Get schedule {id}.
        slots:
          id: path.id
      - text: Show the crontab and paused state of schedule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/schedules/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a schedule's crontab and state
      effect: write
      questions:
      - Can I rewrite a schedule's full definition with a new crontab?
      - What fields must I send to replace a recurring job's schedule?
      instructions:
      - text: Replace schedule {id} with crontab {crontab}.
        slots:
          id: path.id
          crontab: requestBody.crontab
      - text: 'Overwrite schedule {id}: crontab {crontab}, paused {paused}.'
        slots:
          id: path.id
          crontab: requestBody.crontab
          paused: requestBody.paused
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/schedules/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Pause or retime a schedule
      effect: write
      questions:
      - How do I pause a recurring job without changing its timing?
      - Can I change only the crontab on an existing schedule?
      instructions:
      - text: Pause schedule {id} by setting paused to {paused}.
        slots:
          id: path.id
          paused: requestBody.paused
      - text: Change just the crontab of schedule {id} to {crontab}.
        slots:
          id: path.id
          crontab: requestBody.crontab
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/schedules/{id}/send/'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a schedule immediately
      effect: write
      questions:
      - Can I trigger a scheduled job right now instead of waiting for its next run?
      - Is there a way to kick off a recurring task on demand?
      instructions:
      - text: Trigger schedule {id} now.
        slots:
          id: path.id
      - text: Run the job behind schedule {id} immediately.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/tasks/'].get
  update:
    x-apievangelist-phrasing:
      intent: List background tasks
      effect: read
      questions:
      - Which background tasks have run recently, and which failed?
      - Can I filter tasks by queue, state or actor name?
      instructions:
      - text: List background tasks in state {state}.
        slots:
          state: query.state
      - text: Show tasks run by actor {actor_name} on queue {queue_name}.
        slots:
          actor_name: query.actor_name
          queue_name: query.queue_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/tasks/{message_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a background task
      effect: read
      questions:
      - What happened when a specific background task ran?
      - Can I look up a task's state and messages by its message id?
      instructions:
      - text: Get task {message_id}.
        slots:
          message_id: path.message_id
      - text: Show the state and log of task {message_id}.
        slots:
          message_id: path.message_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/tasks/{message_id}/retry/'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a background task
      effect: write
      questions:
      - Can I re-run a task that failed?
      - How do I retry one background job by its message id?
      instructions:
      - text: Retry task {message_id}.
        slots:
          message_id: path.message_id
      - text: Re-run the failed background task {message_id}.
        slots:
          message_id: path.message_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/tasks/status/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the overall task status summary
      effect: read
      questions:
      - Are my background tasks healthy overall?
      - What is the global count of tasks by status?
      instructions:
      - text: Show the global status summary across all tasks.
      - text: Summarize how many tasks are in each status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/workers/'].get
  update:
    x-apievangelist-phrasing:
      intent: Count connected workers
      effect: read
      questions:
      - How many worker processes are connected right now?
      - Is any background worker online to process tasks?
      instructions:
      - text: Get the number of currently connected workers.
      - text: Check whether workers are connected.
      method: generated
      generated: '2026-09-26'