Snyk API — Learn progress

naftiko: 1.0.0-alpha2
info:
  label: Snyk API — Learn progress
  description: 'Snyk API — Learn progress. 2 operations. Lead operation: Get collective learning progress (Early Access).
    Self-contained Naftiko capability covering one Snyk business surface.'
  tags:
  - Snyk
  - Learn progress
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SNYK_API_KEY: SNYK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-learn-progress
    baseUri: https://api.snyk.io/rest
    description: Snyk API — Learn progress business capability. Self-contained, no shared references.
    resources:
    - name: orgs-org_id-learn-progress-catalog
      path: /orgs/{org_id}/learn/progress/catalog
      operations:
      - name: getcatalogprogress
        method: GET
        description: Get collective learning progress (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization.
          required: true
        - name: type
          in: query
          type: string
          description: Filter by the learn catalog resource type
    - name: orgs-org_id-learn-progress-users
      path: /orgs/{org_id}/learn/progress/users
      operations:
      - name: getusersprogress
        method: GET
        description: Get individual user learning progress (Early Access)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: The unique identifier of the organization.
          required: true
        - name: type
          in: query
          type: string
          description: Filter by the learn catalog resource type
        - name: status
          in: query
          type: string
          description: Filter by progress status of the resources
    authentication:
      type: bearer
      token: '{{env.SNYK_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-learn-progress-rest
    port: 8080
    description: REST adapter for Snyk API — Learn progress. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/orgs/{org-id}/learn/progress/catalog
      name: orgs-org-id-learn-progress-catalog
      description: REST surface for orgs-org_id-learn-progress-catalog.
      operations:
      - method: GET
        name: getcatalogprogress
        description: Get collective learning progress (Early Access)
        call: rest-learn-progress.getcatalogprogress
        with:
          org_id: rest.org_id
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{org-id}/learn/progress/users
      name: orgs-org-id-learn-progress-users
      description: REST surface for orgs-org_id-learn-progress-users.
      operations:
      - method: GET
        name: getusersprogress
        description: Get individual user learning progress (Early Access)
        call: rest-learn-progress.getusersprogress
        with:
          org_id: rest.org_id
          type: rest.type
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-learn-progress-mcp
    port: 9090
    transport: http
    description: MCP adapter for Snyk API — Learn progress. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-collective-learning-progress-early
      description: Get collective learning progress (Early Access)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-learn-progress.getcatalogprogress
      with:
        org_id: tools.org_id
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: get-individual-user-learning-progress
      description: Get individual user learning progress (Early Access)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-learn-progress.getusersprogress
      with:
        org_id: tools.org_id
        type: tools.type
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.