Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Learn progress API

3 actions 3 updates phrasing extends openapi/snyk-learn-progress-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Snyk's API. It is a proposal applied on top of the contract, not a document Snyk publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/orgs/{org_id}/learn/progress/catalog'].get
$.paths['/orgs/{org_id}/learn/progress/users'].get

OpenAPI Overlay

Raw ↑ 
# 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 progress API
  version: 1.0.0
extends: openapi/snyk-learn-progress-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: 2
- target: $.paths['/orgs/{org_id}/learn/progress/catalog'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregate Snyk Learn progress per lesson
      effect: read
      questions:
      - How many people in my org have completed each security lesson?
      - Can I see collective progress on lessons covering a specific CWE or CVE?
      instructions:
      - text: Get collective learning progress for org {org_id}.
        slots:
          org_id: path.org_id
      - text: Show aggregated progress on lessons for {cwes} in org {org_id}.
        slots:
          cwes: query.cwes
          org_id: path.org_id
      - text: Count completed, in-progress and todo for {type} titled {title} in organization {org_id}.
        slots:
          type: query.type
          title: query.title
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/learn/progress/users'].get
  update:
    x-apievangelist-phrasing:
      intent: Get individual users' Snyk Learn progress
      effect: read
      questions:
      - Which developers have finished their assigned security training?
      - Can I see per-user completion dates for a lesson?
      instructions:
      - text: Get per-user learning progress for org {org_id}.
        slots:
          org_id: path.org_id
      - text: Show learning status for {emails} in org {org_id}.
        slots:
          emails: query.emails
          org_id: path.org_id
      - text: List users in org {org_id} with status {status} on {titles}.
        slots:
          org_id: path.org_id
          status: query.status
          titles: query.titles
      method: generated
      generated: '2026-09-26'