# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Redocly Scout Todos API
  version: 1.0.0
extends: openapi/redocly-to-dos-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: 2
- target: $.paths['/orgs/{orgId}/projects/{projectId}/scout/todos'].get
  update:
    x-apievangelist-phrasing:
      intent: List Scout job todos for a project
      effect: read
      questions:
      - What job todos are waiting for Scout in my project?
      - Can I page through Scout todos with before and after cursors and a limit?
      instructions:
      - text: List all Scout todos for project {projectId} in org {orgId}.
        slots:
          projectId: path.projectId
          orgId: path.orgId
      - text: Show Scout todos in project {projectId} of org {orgId} sorted by {sort}, limit {limit}.
        slots:
          projectId: path.projectId
          orgId: path.orgId
          sort: query.sort
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{orgId}/projects/{projectId}/scout/todos'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a job todo for Scout on a commit
      effect: write
      questions:
      - How do I queue a job for Scout to process a specific repository commit?
      - Can I re-trigger Scout on a branch if a Git provider webhook was missed during an outage?
      - Which Git details, like branch and commit SHA, does a Scout todo need?
      instructions:
      - text: Create a {type} todo {id} for project {projectId} in org {orgId} on repo {repositoryId} branch {branch} at commit {commitSha}.
        slots:
          type: requestBody.type
          id: requestBody.id
          projectId: path.projectId
          orgId: path.orgId
          repositoryId: requestBody.repositoryId
          branch: requestBody.branch
          commitSha: requestBody.commitSha
      - text: Queue Scout job {id} of type {type} with status {status} for pull request {prId} in project {projectId}, org {orgId}.
        slots:
          id: requestBody.id
          type: requestBody.type
          status: requestBody.status
          prId: requestBody.prId
          projectId: path.projectId
          orgId: path.orgId
      method: generated
      generated: '2026-10-01'