# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Learn assignment API
  version: 1.0.0
extends: openapi/snyk-learn-assignment-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['/orgs/{org_id}/learn/assignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List Snyk Learn assignments in an organization
      effect: read
      questions:
      - What security training has been assigned to people in my org?
      - Can I see every Snyk Learn assignment across the organization?
      instructions:
      - text: List Learn assignments in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Show all training assignments for organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/learn/assignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign Snyk Learn lessons to users in bulk
      effect: write
      questions:
      - How do I assign security lessons to my whole team at once?
      - Can I set a due date and send an email notification when assigning training?
      - Is it possible to reset learners' progress when reassigning a lesson?
      instructions:
      - text: Assign these lessons to users in org {org_id} due {due_date}.
        slots:
          org_id: path.org_id
          due_date: requestBody.due_date
      - text: Create assignments in org {org_id} and email learners with message {email_custom_message}.
        slots:
          org_id: path.org_id
          email_custom_message: requestBody.email_custom_message
      - text: Bulk-assign training in org {org_id} listing {contact_name} at {contact_email} as the contact.
        slots:
          org_id: path.org_id
          contact_name: requestBody.contact_name
          contact_email: requestBody.contact_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/learn/assignments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete Learn assignments (DELETE)
      effect: destructive
      questions:
      - How do I remove several training assignments with a DELETE request?
      - Can assignments that belong to a Learning Program be deleted with the DELETE call?
      instructions:
      - text: Send a DELETE to remove these Learn assignments from org {org_id}.
        slots:
          org_id: path.org_id
      - text: Delete the listed assignments in organization {org_id} using the DELETE method.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/learn/assignments'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the due date of Learn assignments
      effect: write
      questions:
      - How do I extend the deadline on assigned security training?
      - Can I push back due dates for existing assignments in bulk?
      instructions:
      - text: Update the due date on these assignments in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Extend the deadline for the listed Learn assignments in organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/learn/assignments/bulk_delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete Learn assignments via POST
      effect: destructive
      questions:
      - Is there a POST bulk_delete endpoint for clients that can't send a DELETE body?
      - Can I delete many training assignments through the bulk_delete path?
      instructions:
      - text: Use the bulk_delete POST to remove these assignments from org {org_id}.
        slots:
          org_id: path.org_id
      - text: Post a bulk_delete request for the listed Learn assignments in organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'